babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050
  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 { Scene } from "babylonjs/scene";
  9538. import { ActionManager } from "babylonjs/Actions/actionManager";
  9539. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9540. import { Node } from "babylonjs/node";
  9541. /**
  9542. * Interface used to define Action
  9543. */
  9544. export interface IAction {
  9545. /**
  9546. * Trigger for the action
  9547. */
  9548. trigger: number;
  9549. /** Options of the trigger */
  9550. triggerOptions: any;
  9551. /**
  9552. * Gets the trigger parameters
  9553. * @returns the trigger parameters
  9554. */
  9555. getTriggerParameter(): any;
  9556. /**
  9557. * Internal only - executes current action event
  9558. * @hidden
  9559. */
  9560. _executeCurrent(evt?: ActionEvent): void;
  9561. /**
  9562. * Serialize placeholder for child classes
  9563. * @param parent of child
  9564. * @returns the serialized object
  9565. */
  9566. serialize(parent: any): any;
  9567. /**
  9568. * Internal only
  9569. * @hidden
  9570. */
  9571. _prepare(): void;
  9572. /**
  9573. * Internal only - manager for action
  9574. * @hidden
  9575. */
  9576. _actionManager: AbstractActionManager;
  9577. /**
  9578. * Adds action to chain of actions, may be a DoNothingAction
  9579. * @param action defines the next action to execute
  9580. * @returns The action passed in
  9581. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9582. */
  9583. then(action: IAction): IAction;
  9584. }
  9585. /**
  9586. * The action to be carried out following a trigger
  9587. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9588. */
  9589. export class Action implements IAction {
  9590. /** the trigger, with or without parameters, for the action */
  9591. triggerOptions: any;
  9592. /**
  9593. * Trigger for the action
  9594. */
  9595. trigger: number;
  9596. /**
  9597. * Internal only - manager for action
  9598. * @hidden
  9599. */
  9600. _actionManager: ActionManager;
  9601. private _nextActiveAction;
  9602. private _child;
  9603. private _condition?;
  9604. private _triggerParameter;
  9605. /**
  9606. * An event triggered prior to action being executed.
  9607. */
  9608. onBeforeExecuteObservable: Observable<Action>;
  9609. /**
  9610. * Creates a new Action
  9611. * @param triggerOptions the trigger, with or without parameters, for the action
  9612. * @param condition an optional determinant of action
  9613. */
  9614. constructor(
  9615. /** the trigger, with or without parameters, for the action */
  9616. triggerOptions: any, condition?: Condition);
  9617. /**
  9618. * Internal only
  9619. * @hidden
  9620. */
  9621. _prepare(): void;
  9622. /**
  9623. * Gets the trigger parameters
  9624. * @returns the trigger parameters
  9625. */
  9626. getTriggerParameter(): any;
  9627. /**
  9628. * Internal only - executes current action event
  9629. * @hidden
  9630. */
  9631. _executeCurrent(evt?: ActionEvent): void;
  9632. /**
  9633. * Execute placeholder for child classes
  9634. * @param evt optional action event
  9635. */
  9636. execute(evt?: ActionEvent): void;
  9637. /**
  9638. * Skips to next active action
  9639. */
  9640. skipToNextActiveAction(): void;
  9641. /**
  9642. * Adds action to chain of actions, may be a DoNothingAction
  9643. * @param action defines the next action to execute
  9644. * @returns The action passed in
  9645. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9646. */
  9647. then(action: Action): Action;
  9648. /**
  9649. * Internal only
  9650. * @hidden
  9651. */
  9652. _getProperty(propertyPath: string): string;
  9653. /**
  9654. * Internal only
  9655. * @hidden
  9656. */
  9657. _getEffectiveTarget(target: any, propertyPath: string): any;
  9658. /**
  9659. * Serialize placeholder for child classes
  9660. * @param parent of child
  9661. * @returns the serialized object
  9662. */
  9663. serialize(parent: any): any;
  9664. /**
  9665. * Internal only called by serialize
  9666. * @hidden
  9667. */
  9668. protected _serialize(serializedAction: any, parent?: any): any;
  9669. /**
  9670. * Internal only
  9671. * @hidden
  9672. */
  9673. static _SerializeValueAsString: (value: any) => string;
  9674. /**
  9675. * Internal only
  9676. * @hidden
  9677. */
  9678. static _GetTargetProperty: (target: Scene | Node) => {
  9679. name: string;
  9680. targetType: string;
  9681. value: string;
  9682. };
  9683. }
  9684. }
  9685. declare module "babylonjs/Actions/condition" {
  9686. import { ActionManager } from "babylonjs/Actions/actionManager";
  9687. /**
  9688. * A Condition applied to an Action
  9689. */
  9690. export class Condition {
  9691. /**
  9692. * Internal only - manager for action
  9693. * @hidden
  9694. */
  9695. _actionManager: ActionManager;
  9696. /**
  9697. * Internal only
  9698. * @hidden
  9699. */
  9700. _evaluationId: number;
  9701. /**
  9702. * Internal only
  9703. * @hidden
  9704. */
  9705. _currentResult: boolean;
  9706. /**
  9707. * Creates a new Condition
  9708. * @param actionManager the manager of the action the condition is applied to
  9709. */
  9710. constructor(actionManager: ActionManager);
  9711. /**
  9712. * Check if the current condition is valid
  9713. * @returns a boolean
  9714. */
  9715. isValid(): boolean;
  9716. /**
  9717. * Internal only
  9718. * @hidden
  9719. */
  9720. _getProperty(propertyPath: string): string;
  9721. /**
  9722. * Internal only
  9723. * @hidden
  9724. */
  9725. _getEffectiveTarget(target: any, propertyPath: string): any;
  9726. /**
  9727. * Serialize placeholder for child classes
  9728. * @returns the serialized object
  9729. */
  9730. serialize(): any;
  9731. /**
  9732. * Internal only
  9733. * @hidden
  9734. */
  9735. protected _serialize(serializedCondition: any): any;
  9736. }
  9737. /**
  9738. * Defines specific conditional operators as extensions of Condition
  9739. */
  9740. export class ValueCondition extends Condition {
  9741. /** path to specify the property of the target the conditional operator uses */
  9742. propertyPath: string;
  9743. /** the value compared by the conditional operator against the current value of the property */
  9744. value: any;
  9745. /** the conditional operator, default ValueCondition.IsEqual */
  9746. operator: number;
  9747. /**
  9748. * Internal only
  9749. * @hidden
  9750. */
  9751. private static _IsEqual;
  9752. /**
  9753. * Internal only
  9754. * @hidden
  9755. */
  9756. private static _IsDifferent;
  9757. /**
  9758. * Internal only
  9759. * @hidden
  9760. */
  9761. private static _IsGreater;
  9762. /**
  9763. * Internal only
  9764. * @hidden
  9765. */
  9766. private static _IsLesser;
  9767. /**
  9768. * returns the number for IsEqual
  9769. */
  9770. static get IsEqual(): number;
  9771. /**
  9772. * Returns the number for IsDifferent
  9773. */
  9774. static get IsDifferent(): number;
  9775. /**
  9776. * Returns the number for IsGreater
  9777. */
  9778. static get IsGreater(): number;
  9779. /**
  9780. * Returns the number for IsLesser
  9781. */
  9782. static get IsLesser(): number;
  9783. /**
  9784. * Internal only The action manager for the condition
  9785. * @hidden
  9786. */
  9787. _actionManager: ActionManager;
  9788. /**
  9789. * Internal only
  9790. * @hidden
  9791. */
  9792. private _target;
  9793. /**
  9794. * Internal only
  9795. * @hidden
  9796. */
  9797. private _effectiveTarget;
  9798. /**
  9799. * Internal only
  9800. * @hidden
  9801. */
  9802. private _property;
  9803. /**
  9804. * Creates a new ValueCondition
  9805. * @param actionManager manager for the action the condition applies to
  9806. * @param target for the action
  9807. * @param propertyPath path to specify the property of the target the conditional operator uses
  9808. * @param value the value compared by the conditional operator against the current value of the property
  9809. * @param operator the conditional operator, default ValueCondition.IsEqual
  9810. */
  9811. constructor(actionManager: ActionManager, target: any,
  9812. /** path to specify the property of the target the conditional operator uses */
  9813. propertyPath: string,
  9814. /** the value compared by the conditional operator against the current value of the property */
  9815. value: any,
  9816. /** the conditional operator, default ValueCondition.IsEqual */
  9817. operator?: number);
  9818. /**
  9819. * Compares the given value with the property value for the specified conditional operator
  9820. * @returns the result of the comparison
  9821. */
  9822. isValid(): boolean;
  9823. /**
  9824. * Serialize the ValueCondition into a JSON compatible object
  9825. * @returns serialization object
  9826. */
  9827. serialize(): any;
  9828. /**
  9829. * Gets the name of the conditional operator for the ValueCondition
  9830. * @param operator the conditional operator
  9831. * @returns the name
  9832. */
  9833. static GetOperatorName(operator: number): string;
  9834. }
  9835. /**
  9836. * Defines a predicate condition as an extension of Condition
  9837. */
  9838. export class PredicateCondition extends Condition {
  9839. /** defines the predicate function used to validate the condition */
  9840. predicate: () => boolean;
  9841. /**
  9842. * Internal only - manager for action
  9843. * @hidden
  9844. */
  9845. _actionManager: ActionManager;
  9846. /**
  9847. * Creates a new PredicateCondition
  9848. * @param actionManager manager for the action the condition applies to
  9849. * @param predicate defines the predicate function used to validate the condition
  9850. */
  9851. constructor(actionManager: ActionManager,
  9852. /** defines the predicate function used to validate the condition */
  9853. predicate: () => boolean);
  9854. /**
  9855. * @returns the validity of the predicate condition
  9856. */
  9857. isValid(): boolean;
  9858. }
  9859. /**
  9860. * Defines a state condition as an extension of Condition
  9861. */
  9862. export class StateCondition extends Condition {
  9863. /** Value to compare with target state */
  9864. value: string;
  9865. /**
  9866. * Internal only - manager for action
  9867. * @hidden
  9868. */
  9869. _actionManager: ActionManager;
  9870. /**
  9871. * Internal only
  9872. * @hidden
  9873. */
  9874. private _target;
  9875. /**
  9876. * Creates a new StateCondition
  9877. * @param actionManager manager for the action the condition applies to
  9878. * @param target of the condition
  9879. * @param value to compare with target state
  9880. */
  9881. constructor(actionManager: ActionManager, target: any,
  9882. /** Value to compare with target state */
  9883. value: string);
  9884. /**
  9885. * Gets a boolean indicating if the current condition is met
  9886. * @returns the validity of the state
  9887. */
  9888. isValid(): boolean;
  9889. /**
  9890. * Serialize the StateCondition into a JSON compatible object
  9891. * @returns serialization object
  9892. */
  9893. serialize(): any;
  9894. }
  9895. }
  9896. declare module "babylonjs/Actions/directActions" {
  9897. import { Action } from "babylonjs/Actions/action";
  9898. import { Condition } from "babylonjs/Actions/condition";
  9899. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9900. /**
  9901. * This defines an action responsible to toggle a boolean once triggered.
  9902. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9903. */
  9904. export class SwitchBooleanAction extends Action {
  9905. /**
  9906. * The path to the boolean property in the target object
  9907. */
  9908. propertyPath: string;
  9909. private _target;
  9910. private _effectiveTarget;
  9911. private _property;
  9912. /**
  9913. * Instantiate the action
  9914. * @param triggerOptions defines the trigger options
  9915. * @param target defines the object containing the boolean
  9916. * @param propertyPath defines the path to the boolean property in the target object
  9917. * @param condition defines the trigger related conditions
  9918. */
  9919. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9920. /** @hidden */
  9921. _prepare(): void;
  9922. /**
  9923. * Execute the action toggle the boolean value.
  9924. */
  9925. execute(): void;
  9926. /**
  9927. * Serializes the actions and its related information.
  9928. * @param parent defines the object to serialize in
  9929. * @returns the serialized object
  9930. */
  9931. serialize(parent: any): any;
  9932. }
  9933. /**
  9934. * This defines an action responsible to set a the state field of the target
  9935. * to a desired value once triggered.
  9936. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9937. */
  9938. export class SetStateAction extends Action {
  9939. /**
  9940. * The value to store in the state field.
  9941. */
  9942. value: string;
  9943. private _target;
  9944. /**
  9945. * Instantiate the action
  9946. * @param triggerOptions defines the trigger options
  9947. * @param target defines the object containing the state property
  9948. * @param value defines the value to store in the state field
  9949. * @param condition defines the trigger related conditions
  9950. */
  9951. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9952. /**
  9953. * Execute the action and store the value on the target state property.
  9954. */
  9955. execute(): void;
  9956. /**
  9957. * Serializes the actions and its related information.
  9958. * @param parent defines the object to serialize in
  9959. * @returns the serialized object
  9960. */
  9961. serialize(parent: any): any;
  9962. }
  9963. /**
  9964. * This defines an action responsible to set a property of the target
  9965. * to a desired value once triggered.
  9966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9967. */
  9968. export class SetValueAction extends Action {
  9969. /**
  9970. * The path of the property to set in the target.
  9971. */
  9972. propertyPath: string;
  9973. /**
  9974. * The value to set in the property
  9975. */
  9976. value: any;
  9977. private _target;
  9978. private _effectiveTarget;
  9979. private _property;
  9980. /**
  9981. * Instantiate the action
  9982. * @param triggerOptions defines the trigger options
  9983. * @param target defines the object containing the property
  9984. * @param propertyPath defines the path of the property to set in the target
  9985. * @param value defines the value to set in the property
  9986. * @param condition defines the trigger related conditions
  9987. */
  9988. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9989. /** @hidden */
  9990. _prepare(): void;
  9991. /**
  9992. * Execute the action and set the targetted property to the desired value.
  9993. */
  9994. execute(): void;
  9995. /**
  9996. * Serializes the actions and its related information.
  9997. * @param parent defines the object to serialize in
  9998. * @returns the serialized object
  9999. */
  10000. serialize(parent: any): any;
  10001. }
  10002. /**
  10003. * This defines an action responsible to increment the target value
  10004. * to a desired value once triggered.
  10005. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10006. */
  10007. export class IncrementValueAction extends Action {
  10008. /**
  10009. * The path of the property to increment in the target.
  10010. */
  10011. propertyPath: string;
  10012. /**
  10013. * The value we should increment the property by.
  10014. */
  10015. value: any;
  10016. private _target;
  10017. private _effectiveTarget;
  10018. private _property;
  10019. /**
  10020. * Instantiate the action
  10021. * @param triggerOptions defines the trigger options
  10022. * @param target defines the object containing the property
  10023. * @param propertyPath defines the path of the property to increment in the target
  10024. * @param value defines the value value we should increment the property by
  10025. * @param condition defines the trigger related conditions
  10026. */
  10027. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10028. /** @hidden */
  10029. _prepare(): void;
  10030. /**
  10031. * Execute the action and increment the target of the value amount.
  10032. */
  10033. execute(): void;
  10034. /**
  10035. * Serializes the actions and its related information.
  10036. * @param parent defines the object to serialize in
  10037. * @returns the serialized object
  10038. */
  10039. serialize(parent: any): any;
  10040. }
  10041. /**
  10042. * This defines an action responsible to start an animation once triggered.
  10043. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10044. */
  10045. export class PlayAnimationAction extends Action {
  10046. /**
  10047. * Where the animation should start (animation frame)
  10048. */
  10049. from: number;
  10050. /**
  10051. * Where the animation should stop (animation frame)
  10052. */
  10053. to: number;
  10054. /**
  10055. * Define if the animation should loop or stop after the first play.
  10056. */
  10057. loop?: boolean;
  10058. private _target;
  10059. /**
  10060. * Instantiate the action
  10061. * @param triggerOptions defines the trigger options
  10062. * @param target defines the target animation or animation name
  10063. * @param from defines from where the animation should start (animation frame)
  10064. * @param end defines where the animation should stop (animation frame)
  10065. * @param loop defines if the animation should loop or stop after the first play
  10066. * @param condition defines the trigger related conditions
  10067. */
  10068. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10069. /** @hidden */
  10070. _prepare(): void;
  10071. /**
  10072. * Execute the action and play the animation.
  10073. */
  10074. execute(): void;
  10075. /**
  10076. * Serializes the actions and its related information.
  10077. * @param parent defines the object to serialize in
  10078. * @returns the serialized object
  10079. */
  10080. serialize(parent: any): any;
  10081. }
  10082. /**
  10083. * This defines an action responsible to stop an animation once triggered.
  10084. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10085. */
  10086. export class StopAnimationAction extends Action {
  10087. private _target;
  10088. /**
  10089. * Instantiate the action
  10090. * @param triggerOptions defines the trigger options
  10091. * @param target defines the target animation or animation name
  10092. * @param condition defines the trigger related conditions
  10093. */
  10094. constructor(triggerOptions: any, target: any, condition?: Condition);
  10095. /** @hidden */
  10096. _prepare(): void;
  10097. /**
  10098. * Execute the action and stop the animation.
  10099. */
  10100. execute(): void;
  10101. /**
  10102. * Serializes the actions and its related information.
  10103. * @param parent defines the object to serialize in
  10104. * @returns the serialized object
  10105. */
  10106. serialize(parent: any): any;
  10107. }
  10108. /**
  10109. * This defines an action responsible that does nothing once triggered.
  10110. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10111. */
  10112. export class DoNothingAction extends Action {
  10113. /**
  10114. * Instantiate the action
  10115. * @param triggerOptions defines the trigger options
  10116. * @param condition defines the trigger related conditions
  10117. */
  10118. constructor(triggerOptions?: any, condition?: Condition);
  10119. /**
  10120. * Execute the action and do nothing.
  10121. */
  10122. execute(): void;
  10123. /**
  10124. * Serializes the actions and its related information.
  10125. * @param parent defines the object to serialize in
  10126. * @returns the serialized object
  10127. */
  10128. serialize(parent: any): any;
  10129. }
  10130. /**
  10131. * This defines an action responsible to trigger several actions once triggered.
  10132. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10133. */
  10134. export class CombineAction extends Action {
  10135. /**
  10136. * The list of aggregated animations to run.
  10137. */
  10138. children: Action[];
  10139. /**
  10140. * Instantiate the action
  10141. * @param triggerOptions defines the trigger options
  10142. * @param children defines the list of aggregated animations to run
  10143. * @param condition defines the trigger related conditions
  10144. */
  10145. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10146. /** @hidden */
  10147. _prepare(): void;
  10148. /**
  10149. * Execute the action and executes all the aggregated actions.
  10150. */
  10151. execute(evt: ActionEvent): void;
  10152. /**
  10153. * Serializes the actions and its related information.
  10154. * @param parent defines the object to serialize in
  10155. * @returns the serialized object
  10156. */
  10157. serialize(parent: any): any;
  10158. }
  10159. /**
  10160. * This defines an action responsible to run code (external event) once triggered.
  10161. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10162. */
  10163. export class ExecuteCodeAction extends Action {
  10164. /**
  10165. * The callback function to run.
  10166. */
  10167. func: (evt: ActionEvent) => void;
  10168. /**
  10169. * Instantiate the action
  10170. * @param triggerOptions defines the trigger options
  10171. * @param func defines the callback function to run
  10172. * @param condition defines the trigger related conditions
  10173. */
  10174. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10175. /**
  10176. * Execute the action and run the attached code.
  10177. */
  10178. execute(evt: ActionEvent): void;
  10179. }
  10180. /**
  10181. * This defines an action responsible to set the parent property of the target once triggered.
  10182. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10183. */
  10184. export class SetParentAction extends Action {
  10185. private _parent;
  10186. private _target;
  10187. /**
  10188. * Instantiate the action
  10189. * @param triggerOptions defines the trigger options
  10190. * @param target defines the target containing the parent property
  10191. * @param parent defines from where the animation should start (animation frame)
  10192. * @param condition defines the trigger related conditions
  10193. */
  10194. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10195. /** @hidden */
  10196. _prepare(): void;
  10197. /**
  10198. * Execute the action and set the parent property.
  10199. */
  10200. execute(): void;
  10201. /**
  10202. * Serializes the actions and its related information.
  10203. * @param parent defines the object to serialize in
  10204. * @returns the serialized object
  10205. */
  10206. serialize(parent: any): any;
  10207. }
  10208. }
  10209. declare module "babylonjs/Actions/actionManager" {
  10210. import { Nullable } from "babylonjs/types";
  10211. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10212. import { Scene } from "babylonjs/scene";
  10213. import { IAction } from "babylonjs/Actions/action";
  10214. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10215. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10216. /**
  10217. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10218. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10219. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10220. */
  10221. export class ActionManager extends AbstractActionManager {
  10222. /**
  10223. * Nothing
  10224. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10225. */
  10226. static readonly NothingTrigger: number;
  10227. /**
  10228. * On pick
  10229. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10230. */
  10231. static readonly OnPickTrigger: number;
  10232. /**
  10233. * On left pick
  10234. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10235. */
  10236. static readonly OnLeftPickTrigger: number;
  10237. /**
  10238. * On right pick
  10239. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10240. */
  10241. static readonly OnRightPickTrigger: number;
  10242. /**
  10243. * On center pick
  10244. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10245. */
  10246. static readonly OnCenterPickTrigger: number;
  10247. /**
  10248. * On pick down
  10249. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10250. */
  10251. static readonly OnPickDownTrigger: number;
  10252. /**
  10253. * On double pick
  10254. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10255. */
  10256. static readonly OnDoublePickTrigger: number;
  10257. /**
  10258. * On pick up
  10259. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10260. */
  10261. static readonly OnPickUpTrigger: number;
  10262. /**
  10263. * On pick out.
  10264. * This trigger will only be raised if you also declared a OnPickDown
  10265. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10266. */
  10267. static readonly OnPickOutTrigger: number;
  10268. /**
  10269. * On long press
  10270. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10271. */
  10272. static readonly OnLongPressTrigger: number;
  10273. /**
  10274. * On pointer over
  10275. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10276. */
  10277. static readonly OnPointerOverTrigger: number;
  10278. /**
  10279. * On pointer out
  10280. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10281. */
  10282. static readonly OnPointerOutTrigger: number;
  10283. /**
  10284. * On every frame
  10285. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10286. */
  10287. static readonly OnEveryFrameTrigger: number;
  10288. /**
  10289. * On intersection enter
  10290. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10291. */
  10292. static readonly OnIntersectionEnterTrigger: number;
  10293. /**
  10294. * On intersection exit
  10295. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10296. */
  10297. static readonly OnIntersectionExitTrigger: number;
  10298. /**
  10299. * On key down
  10300. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10301. */
  10302. static readonly OnKeyDownTrigger: number;
  10303. /**
  10304. * On key up
  10305. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10306. */
  10307. static readonly OnKeyUpTrigger: number;
  10308. private _scene;
  10309. /**
  10310. * Creates a new action manager
  10311. * @param scene defines the hosting scene
  10312. */
  10313. constructor(scene: Scene);
  10314. /**
  10315. * Releases all associated resources
  10316. */
  10317. dispose(): void;
  10318. /**
  10319. * Gets hosting scene
  10320. * @returns the hosting scene
  10321. */
  10322. getScene(): Scene;
  10323. /**
  10324. * Does this action manager handles actions of any of the given triggers
  10325. * @param triggers defines the triggers to be tested
  10326. * @return a boolean indicating whether one (or more) of the triggers is handled
  10327. */
  10328. hasSpecificTriggers(triggers: number[]): boolean;
  10329. /**
  10330. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10331. * speed.
  10332. * @param triggerA defines the trigger to be tested
  10333. * @param triggerB defines the trigger to be tested
  10334. * @return a boolean indicating whether one (or more) of the triggers is handled
  10335. */
  10336. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10337. /**
  10338. * Does this action manager handles actions of a given trigger
  10339. * @param trigger defines the trigger to be tested
  10340. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10341. * @return whether the trigger is handled
  10342. */
  10343. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10344. /**
  10345. * Does this action manager has pointer triggers
  10346. */
  10347. get hasPointerTriggers(): boolean;
  10348. /**
  10349. * Does this action manager has pick triggers
  10350. */
  10351. get hasPickTriggers(): boolean;
  10352. /**
  10353. * Registers an action to this action manager
  10354. * @param action defines the action to be registered
  10355. * @return the action amended (prepared) after registration
  10356. */
  10357. registerAction(action: IAction): Nullable<IAction>;
  10358. /**
  10359. * Unregisters an action to this action manager
  10360. * @param action defines the action to be unregistered
  10361. * @return a boolean indicating whether the action has been unregistered
  10362. */
  10363. unregisterAction(action: IAction): Boolean;
  10364. /**
  10365. * Process a specific trigger
  10366. * @param trigger defines the trigger to process
  10367. * @param evt defines the event details to be processed
  10368. */
  10369. processTrigger(trigger: number, evt?: IActionEvent): void;
  10370. /** @hidden */
  10371. _getEffectiveTarget(target: any, propertyPath: string): any;
  10372. /** @hidden */
  10373. _getProperty(propertyPath: string): string;
  10374. /**
  10375. * Serialize this manager to a JSON object
  10376. * @param name defines the property name to store this manager
  10377. * @returns a JSON representation of this manager
  10378. */
  10379. serialize(name: string): any;
  10380. /**
  10381. * Creates a new ActionManager from a JSON data
  10382. * @param parsedActions defines the JSON data to read from
  10383. * @param object defines the hosting mesh
  10384. * @param scene defines the hosting scene
  10385. */
  10386. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10387. /**
  10388. * Get a trigger name by index
  10389. * @param trigger defines the trigger index
  10390. * @returns a trigger name
  10391. */
  10392. static GetTriggerName(trigger: number): string;
  10393. }
  10394. }
  10395. declare module "babylonjs/Sprites/sprite" {
  10396. import { Vector3 } from "babylonjs/Maths/math.vector";
  10397. import { Nullable } from "babylonjs/types";
  10398. import { ActionManager } from "babylonjs/Actions/actionManager";
  10399. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10400. import { Color4 } from "babylonjs/Maths/math.color";
  10401. import { Observable } from "babylonjs/Misc/observable";
  10402. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10403. import { Animation } from "babylonjs/Animations/animation";
  10404. /**
  10405. * Class used to represent a sprite
  10406. * @see https://doc.babylonjs.com/babylon101/sprites
  10407. */
  10408. export class Sprite implements IAnimatable {
  10409. /** defines the name */
  10410. name: string;
  10411. /** Gets or sets the current world position */
  10412. position: Vector3;
  10413. /** Gets or sets the main color */
  10414. color: Color4;
  10415. /** Gets or sets the width */
  10416. width: number;
  10417. /** Gets or sets the height */
  10418. height: number;
  10419. /** Gets or sets rotation angle */
  10420. angle: number;
  10421. /** Gets or sets the cell index in the sprite sheet */
  10422. cellIndex: number;
  10423. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10424. cellRef: string;
  10425. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10426. invertU: boolean;
  10427. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10428. invertV: boolean;
  10429. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10430. disposeWhenFinishedAnimating: boolean;
  10431. /** Gets the list of attached animations */
  10432. animations: Nullable<Array<Animation>>;
  10433. /** Gets or sets a boolean indicating if the sprite can be picked */
  10434. isPickable: boolean;
  10435. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10436. useAlphaForPicking: boolean;
  10437. /** @hidden */
  10438. _xOffset: number;
  10439. /** @hidden */
  10440. _yOffset: number;
  10441. /** @hidden */
  10442. _xSize: number;
  10443. /** @hidden */
  10444. _ySize: number;
  10445. /**
  10446. * Gets or sets the associated action manager
  10447. */
  10448. actionManager: Nullable<ActionManager>;
  10449. /**
  10450. * An event triggered when the control has been disposed
  10451. */
  10452. onDisposeObservable: Observable<Sprite>;
  10453. private _animationStarted;
  10454. private _loopAnimation;
  10455. private _fromIndex;
  10456. private _toIndex;
  10457. private _delay;
  10458. private _direction;
  10459. private _manager;
  10460. private _time;
  10461. private _onAnimationEnd;
  10462. /**
  10463. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10464. */
  10465. isVisible: boolean;
  10466. /**
  10467. * Gets or sets the sprite size
  10468. */
  10469. get size(): number;
  10470. set size(value: number);
  10471. /**
  10472. * Returns a boolean indicating if the animation is started
  10473. */
  10474. get animationStarted(): boolean;
  10475. /**
  10476. * Gets or sets the unique id of the sprite
  10477. */
  10478. uniqueId: number;
  10479. /**
  10480. * Gets the manager of this sprite
  10481. */
  10482. get manager(): ISpriteManager;
  10483. /**
  10484. * Creates a new Sprite
  10485. * @param name defines the name
  10486. * @param manager defines the manager
  10487. */
  10488. constructor(
  10489. /** defines the name */
  10490. name: string, manager: ISpriteManager);
  10491. /**
  10492. * Returns the string "Sprite"
  10493. * @returns "Sprite"
  10494. */
  10495. getClassName(): string;
  10496. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10497. get fromIndex(): number;
  10498. set fromIndex(value: number);
  10499. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10500. get toIndex(): number;
  10501. set toIndex(value: number);
  10502. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10503. get loopAnimation(): boolean;
  10504. set loopAnimation(value: boolean);
  10505. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10506. get delay(): number;
  10507. set delay(value: number);
  10508. /**
  10509. * Starts an animation
  10510. * @param from defines the initial key
  10511. * @param to defines the end key
  10512. * @param loop defines if the animation must loop
  10513. * @param delay defines the start delay (in ms)
  10514. * @param onAnimationEnd defines a callback to call when animation ends
  10515. */
  10516. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10517. /** Stops current animation (if any) */
  10518. stopAnimation(): void;
  10519. /** @hidden */
  10520. _animate(deltaTime: number): void;
  10521. /** Release associated resources */
  10522. dispose(): void;
  10523. /**
  10524. * Serializes the sprite to a JSON object
  10525. * @returns the JSON object
  10526. */
  10527. serialize(): any;
  10528. /**
  10529. * Parses a JSON object to create a new sprite
  10530. * @param parsedSprite The JSON object to parse
  10531. * @param manager defines the hosting manager
  10532. * @returns the new sprite
  10533. */
  10534. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10535. }
  10536. }
  10537. declare module "babylonjs/Collisions/pickingInfo" {
  10538. import { Nullable } from "babylonjs/types";
  10539. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10540. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10541. import { Sprite } from "babylonjs/Sprites/sprite";
  10542. import { Ray } from "babylonjs/Culling/ray";
  10543. /**
  10544. * Information about the result of picking within a scene
  10545. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10546. */
  10547. export class PickingInfo {
  10548. /** @hidden */
  10549. _pickingUnavailable: boolean;
  10550. /**
  10551. * If the pick collided with an object
  10552. */
  10553. hit: boolean;
  10554. /**
  10555. * Distance away where the pick collided
  10556. */
  10557. distance: number;
  10558. /**
  10559. * The location of pick collision
  10560. */
  10561. pickedPoint: Nullable<Vector3>;
  10562. /**
  10563. * The mesh corresponding the the pick collision
  10564. */
  10565. pickedMesh: Nullable<AbstractMesh>;
  10566. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10567. bu: number;
  10568. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10569. bv: number;
  10570. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10571. faceId: number;
  10572. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10573. subMeshFaceId: number;
  10574. /** Id of the the submesh that was picked */
  10575. subMeshId: number;
  10576. /** If a sprite was picked, this will be the sprite the pick collided with */
  10577. pickedSprite: Nullable<Sprite>;
  10578. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10579. thinInstanceIndex: number;
  10580. /**
  10581. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10582. */
  10583. originMesh: Nullable<AbstractMesh>;
  10584. /**
  10585. * The ray that was used to perform the picking.
  10586. */
  10587. ray: Nullable<Ray>;
  10588. /**
  10589. * Gets the normal correspodning to the face the pick collided with
  10590. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10591. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10592. * @returns The normal correspodning to the face the pick collided with
  10593. */
  10594. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10595. /**
  10596. * Gets the texture coordinates of where the pick occured
  10597. * @returns the vector containing the coordnates of the texture
  10598. */
  10599. getTextureCoordinates(): Nullable<Vector2>;
  10600. }
  10601. }
  10602. declare module "babylonjs/Culling/ray" {
  10603. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10604. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10605. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10606. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10607. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10608. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10609. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10610. import { Plane } from "babylonjs/Maths/math.plane";
  10611. /**
  10612. * Class representing a ray with position and direction
  10613. */
  10614. export class Ray {
  10615. /** origin point */
  10616. origin: Vector3;
  10617. /** direction */
  10618. direction: Vector3;
  10619. /** length of the ray */
  10620. length: number;
  10621. private static readonly _TmpVector3;
  10622. private _tmpRay;
  10623. /**
  10624. * Creates a new ray
  10625. * @param origin origin point
  10626. * @param direction direction
  10627. * @param length length of the ray
  10628. */
  10629. constructor(
  10630. /** origin point */
  10631. origin: Vector3,
  10632. /** direction */
  10633. direction: Vector3,
  10634. /** length of the ray */
  10635. length?: number);
  10636. /**
  10637. * Checks if the ray intersects a box
  10638. * This does not account for the ray lenght by design to improve perfs.
  10639. * @param minimum bound of the box
  10640. * @param maximum bound of the box
  10641. * @param intersectionTreshold extra extend to be added to the box in all direction
  10642. * @returns if the box was hit
  10643. */
  10644. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10645. /**
  10646. * Checks if the ray intersects a box
  10647. * This does not account for the ray lenght by design to improve perfs.
  10648. * @param box the bounding box to check
  10649. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10650. * @returns if the box was hit
  10651. */
  10652. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10653. /**
  10654. * If the ray hits a sphere
  10655. * @param sphere the bounding sphere to check
  10656. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10657. * @returns true if it hits the sphere
  10658. */
  10659. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10660. /**
  10661. * If the ray hits a triange
  10662. * @param vertex0 triangle vertex
  10663. * @param vertex1 triangle vertex
  10664. * @param vertex2 triangle vertex
  10665. * @returns intersection information if hit
  10666. */
  10667. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10668. /**
  10669. * Checks if ray intersects a plane
  10670. * @param plane the plane to check
  10671. * @returns the distance away it was hit
  10672. */
  10673. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10674. /**
  10675. * Calculate the intercept of a ray on a given axis
  10676. * @param axis to check 'x' | 'y' | 'z'
  10677. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10678. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10679. */
  10680. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10681. /**
  10682. * Checks if ray intersects a mesh
  10683. * @param mesh the mesh to check
  10684. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10685. * @returns picking info of the intersecton
  10686. */
  10687. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10688. /**
  10689. * Checks if ray intersects a mesh
  10690. * @param meshes the meshes to check
  10691. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10692. * @param results array to store result in
  10693. * @returns Array of picking infos
  10694. */
  10695. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10696. private _comparePickingInfo;
  10697. private static smallnum;
  10698. private static rayl;
  10699. /**
  10700. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10701. * @param sega the first point of the segment to test the intersection against
  10702. * @param segb the second point of the segment to test the intersection against
  10703. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10704. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10705. */
  10706. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10707. /**
  10708. * Update the ray from viewport position
  10709. * @param x position
  10710. * @param y y position
  10711. * @param viewportWidth viewport width
  10712. * @param viewportHeight viewport height
  10713. * @param world world matrix
  10714. * @param view view matrix
  10715. * @param projection projection matrix
  10716. * @returns this ray updated
  10717. */
  10718. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10719. /**
  10720. * Creates a ray with origin and direction of 0,0,0
  10721. * @returns the new ray
  10722. */
  10723. static Zero(): Ray;
  10724. /**
  10725. * Creates a new ray from screen space and viewport
  10726. * @param x position
  10727. * @param y y position
  10728. * @param viewportWidth viewport width
  10729. * @param viewportHeight viewport height
  10730. * @param world world matrix
  10731. * @param view view matrix
  10732. * @param projection projection matrix
  10733. * @returns new ray
  10734. */
  10735. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10736. /**
  10737. * 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
  10738. * transformed to the given world matrix.
  10739. * @param origin The origin point
  10740. * @param end The end point
  10741. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10742. * @returns the new ray
  10743. */
  10744. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10745. /**
  10746. * Transforms a ray by a matrix
  10747. * @param ray ray to transform
  10748. * @param matrix matrix to apply
  10749. * @returns the resulting new ray
  10750. */
  10751. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10752. /**
  10753. * Transforms a ray by a matrix
  10754. * @param ray ray to transform
  10755. * @param matrix matrix to apply
  10756. * @param result ray to store result in
  10757. */
  10758. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10759. /**
  10760. * Unproject a ray from screen space to object space
  10761. * @param sourceX defines the screen space x coordinate to use
  10762. * @param sourceY defines the screen space y coordinate to use
  10763. * @param viewportWidth defines the current width of the viewport
  10764. * @param viewportHeight defines the current height of the viewport
  10765. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10766. * @param view defines the view matrix to use
  10767. * @param projection defines the projection matrix to use
  10768. */
  10769. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10770. }
  10771. /**
  10772. * Type used to define predicate used to select faces when a mesh intersection is detected
  10773. */
  10774. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10775. module "babylonjs/scene" {
  10776. interface Scene {
  10777. /** @hidden */
  10778. _tempPickingRay: Nullable<Ray>;
  10779. /** @hidden */
  10780. _cachedRayForTransform: Ray;
  10781. /** @hidden */
  10782. _pickWithRayInverseMatrix: Matrix;
  10783. /** @hidden */
  10784. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10785. /** @hidden */
  10786. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10787. /** @hidden */
  10788. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10789. }
  10790. }
  10791. }
  10792. declare module "babylonjs/sceneComponent" {
  10793. import { Scene } from "babylonjs/scene";
  10794. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10795. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10796. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10797. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10798. import { Nullable } from "babylonjs/types";
  10799. import { Camera } from "babylonjs/Cameras/camera";
  10800. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10801. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10802. import { AbstractScene } from "babylonjs/abstractScene";
  10803. import { Mesh } from "babylonjs/Meshes/mesh";
  10804. /**
  10805. * Groups all the scene component constants in one place to ease maintenance.
  10806. * @hidden
  10807. */
  10808. export class SceneComponentConstants {
  10809. static readonly NAME_EFFECTLAYER: string;
  10810. static readonly NAME_LAYER: string;
  10811. static readonly NAME_LENSFLARESYSTEM: string;
  10812. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10813. static readonly NAME_PARTICLESYSTEM: string;
  10814. static readonly NAME_GAMEPAD: string;
  10815. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10816. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10817. static readonly NAME_PREPASSRENDERER: string;
  10818. static readonly NAME_DEPTHRENDERER: string;
  10819. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10820. static readonly NAME_SPRITE: string;
  10821. static readonly NAME_OUTLINERENDERER: string;
  10822. static readonly NAME_PROCEDURALTEXTURE: string;
  10823. static readonly NAME_SHADOWGENERATOR: string;
  10824. static readonly NAME_OCTREE: string;
  10825. static readonly NAME_PHYSICSENGINE: string;
  10826. static readonly NAME_AUDIO: string;
  10827. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10828. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10829. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10830. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10831. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10832. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10833. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10834. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10835. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10836. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10837. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10838. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10839. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10840. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10841. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10842. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10843. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10844. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10845. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10846. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10847. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10848. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10849. static readonly STEP_AFTERRENDER_AUDIO: number;
  10850. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10851. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10852. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10853. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10854. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10855. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10856. static readonly STEP_POINTERMOVE_SPRITE: number;
  10857. static readonly STEP_POINTERDOWN_SPRITE: number;
  10858. static readonly STEP_POINTERUP_SPRITE: number;
  10859. }
  10860. /**
  10861. * This represents a scene component.
  10862. *
  10863. * This is used to decouple the dependency the scene is having on the different workloads like
  10864. * layers, post processes...
  10865. */
  10866. export interface ISceneComponent {
  10867. /**
  10868. * The name of the component. Each component must have a unique name.
  10869. */
  10870. name: string;
  10871. /**
  10872. * The scene the component belongs to.
  10873. */
  10874. scene: Scene;
  10875. /**
  10876. * Register the component to one instance of a scene.
  10877. */
  10878. register(): void;
  10879. /**
  10880. * Rebuilds the elements related to this component in case of
  10881. * context lost for instance.
  10882. */
  10883. rebuild(): void;
  10884. /**
  10885. * Disposes the component and the associated ressources.
  10886. */
  10887. dispose(): void;
  10888. }
  10889. /**
  10890. * This represents a SERIALIZABLE scene component.
  10891. *
  10892. * This extends Scene Component to add Serialization methods on top.
  10893. */
  10894. export interface ISceneSerializableComponent extends ISceneComponent {
  10895. /**
  10896. * Adds all the elements from the container to the scene
  10897. * @param container the container holding the elements
  10898. */
  10899. addFromContainer(container: AbstractScene): void;
  10900. /**
  10901. * Removes all the elements in the container from the scene
  10902. * @param container contains the elements to remove
  10903. * @param dispose if the removed element should be disposed (default: false)
  10904. */
  10905. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10906. /**
  10907. * Serializes the component data to the specified json object
  10908. * @param serializationObject The object to serialize to
  10909. */
  10910. serialize(serializationObject: any): void;
  10911. }
  10912. /**
  10913. * Strong typing of a Mesh related stage step action
  10914. */
  10915. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10916. /**
  10917. * Strong typing of a Evaluate Sub Mesh related stage step action
  10918. */
  10919. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10920. /**
  10921. * Strong typing of a Active Mesh related stage step action
  10922. */
  10923. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10924. /**
  10925. * Strong typing of a Camera related stage step action
  10926. */
  10927. export type CameraStageAction = (camera: Camera) => void;
  10928. /**
  10929. * Strong typing of a Camera Frame buffer related stage step action
  10930. */
  10931. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10932. /**
  10933. * Strong typing of a Render Target related stage step action
  10934. */
  10935. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10936. /**
  10937. * Strong typing of a RenderingGroup related stage step action
  10938. */
  10939. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10940. /**
  10941. * Strong typing of a Mesh Render related stage step action
  10942. */
  10943. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10944. /**
  10945. * Strong typing of a simple stage step action
  10946. */
  10947. export type SimpleStageAction = () => void;
  10948. /**
  10949. * Strong typing of a render target action.
  10950. */
  10951. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10952. /**
  10953. * Strong typing of a pointer move action.
  10954. */
  10955. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10956. /**
  10957. * Strong typing of a pointer up/down action.
  10958. */
  10959. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10960. /**
  10961. * Representation of a stage in the scene (Basically a list of ordered steps)
  10962. * @hidden
  10963. */
  10964. export class Stage<T extends Function> extends Array<{
  10965. index: number;
  10966. component: ISceneComponent;
  10967. action: T;
  10968. }> {
  10969. /**
  10970. * Hide ctor from the rest of the world.
  10971. * @param items The items to add.
  10972. */
  10973. private constructor();
  10974. /**
  10975. * Creates a new Stage.
  10976. * @returns A new instance of a Stage
  10977. */
  10978. static Create<T extends Function>(): Stage<T>;
  10979. /**
  10980. * Registers a step in an ordered way in the targeted stage.
  10981. * @param index Defines the position to register the step in
  10982. * @param component Defines the component attached to the step
  10983. * @param action Defines the action to launch during the step
  10984. */
  10985. registerStep(index: number, component: ISceneComponent, action: T): void;
  10986. /**
  10987. * Clears all the steps from the stage.
  10988. */
  10989. clear(): void;
  10990. }
  10991. }
  10992. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10993. import { Nullable } from "babylonjs/types";
  10994. import { Observable } from "babylonjs/Misc/observable";
  10995. import { Scene } from "babylonjs/scene";
  10996. import { Sprite } from "babylonjs/Sprites/sprite";
  10997. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10998. import { Ray } from "babylonjs/Culling/ray";
  10999. import { Camera } from "babylonjs/Cameras/camera";
  11000. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11001. import { ISceneComponent } from "babylonjs/sceneComponent";
  11002. module "babylonjs/scene" {
  11003. interface Scene {
  11004. /** @hidden */
  11005. _pointerOverSprite: Nullable<Sprite>;
  11006. /** @hidden */
  11007. _pickedDownSprite: Nullable<Sprite>;
  11008. /** @hidden */
  11009. _tempSpritePickingRay: Nullable<Ray>;
  11010. /**
  11011. * All of the sprite managers added to this scene
  11012. * @see https://doc.babylonjs.com/babylon101/sprites
  11013. */
  11014. spriteManagers: Array<ISpriteManager>;
  11015. /**
  11016. * An event triggered when sprites rendering is about to start
  11017. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11018. */
  11019. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11020. /**
  11021. * An event triggered when sprites rendering is done
  11022. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11023. */
  11024. onAfterSpritesRenderingObservable: Observable<Scene>;
  11025. /** @hidden */
  11026. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11027. /** Launch a ray to try to pick a sprite in the scene
  11028. * @param x position on screen
  11029. * @param y position on screen
  11030. * @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
  11031. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11032. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11033. * @returns a PickingInfo
  11034. */
  11035. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11036. /** Use the given ray to pick a sprite in the scene
  11037. * @param ray The ray (in world space) to use to pick meshes
  11038. * @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
  11039. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11040. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11041. * @returns a PickingInfo
  11042. */
  11043. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11044. /** @hidden */
  11045. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11046. /** Launch a ray to try to pick sprites in the scene
  11047. * @param x position on screen
  11048. * @param y position on screen
  11049. * @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
  11050. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11051. * @returns a PickingInfo array
  11052. */
  11053. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11054. /** Use the given ray to pick sprites in the scene
  11055. * @param ray The ray (in world space) to use to pick meshes
  11056. * @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
  11057. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11058. * @returns a PickingInfo array
  11059. */
  11060. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11061. /**
  11062. * Force the sprite under the pointer
  11063. * @param sprite defines the sprite to use
  11064. */
  11065. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11066. /**
  11067. * Gets the sprite under the pointer
  11068. * @returns a Sprite or null if no sprite is under the pointer
  11069. */
  11070. getPointerOverSprite(): Nullable<Sprite>;
  11071. }
  11072. }
  11073. /**
  11074. * Defines the sprite scene component responsible to manage sprites
  11075. * in a given scene.
  11076. */
  11077. export class SpriteSceneComponent implements ISceneComponent {
  11078. /**
  11079. * The component name helpfull to identify the component in the list of scene components.
  11080. */
  11081. readonly name: string;
  11082. /**
  11083. * The scene the component belongs to.
  11084. */
  11085. scene: Scene;
  11086. /** @hidden */
  11087. private _spritePredicate;
  11088. /**
  11089. * Creates a new instance of the component for the given scene
  11090. * @param scene Defines the scene to register the component in
  11091. */
  11092. constructor(scene: Scene);
  11093. /**
  11094. * Registers the component in a given scene
  11095. */
  11096. register(): void;
  11097. /**
  11098. * Rebuilds the elements related to this component in case of
  11099. * context lost for instance.
  11100. */
  11101. rebuild(): void;
  11102. /**
  11103. * Disposes the component and the associated ressources.
  11104. */
  11105. dispose(): void;
  11106. private _pickSpriteButKeepRay;
  11107. private _pointerMove;
  11108. private _pointerDown;
  11109. private _pointerUp;
  11110. }
  11111. }
  11112. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11113. /** @hidden */
  11114. export var fogFragmentDeclaration: {
  11115. name: string;
  11116. shader: string;
  11117. };
  11118. }
  11119. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11120. /** @hidden */
  11121. export var fogFragment: {
  11122. name: string;
  11123. shader: string;
  11124. };
  11125. }
  11126. declare module "babylonjs/Shaders/sprites.fragment" {
  11127. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11128. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11129. /** @hidden */
  11130. export var spritesPixelShader: {
  11131. name: string;
  11132. shader: string;
  11133. };
  11134. }
  11135. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11136. /** @hidden */
  11137. export var fogVertexDeclaration: {
  11138. name: string;
  11139. shader: string;
  11140. };
  11141. }
  11142. declare module "babylonjs/Shaders/sprites.vertex" {
  11143. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11144. /** @hidden */
  11145. export var spritesVertexShader: {
  11146. name: string;
  11147. shader: string;
  11148. };
  11149. }
  11150. declare module "babylonjs/Sprites/spriteManager" {
  11151. import { IDisposable, Scene } from "babylonjs/scene";
  11152. import { Nullable } from "babylonjs/types";
  11153. import { Observable } from "babylonjs/Misc/observable";
  11154. import { Sprite } from "babylonjs/Sprites/sprite";
  11155. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11156. import { Camera } from "babylonjs/Cameras/camera";
  11157. import { Texture } from "babylonjs/Materials/Textures/texture";
  11158. import "babylonjs/Shaders/sprites.fragment";
  11159. import "babylonjs/Shaders/sprites.vertex";
  11160. import { Ray } from "babylonjs/Culling/ray";
  11161. /**
  11162. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11163. */
  11164. export interface ISpriteManager extends IDisposable {
  11165. /**
  11166. * Gets manager's name
  11167. */
  11168. name: string;
  11169. /**
  11170. * Restricts the camera to viewing objects with the same layerMask.
  11171. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11172. */
  11173. layerMask: number;
  11174. /**
  11175. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11176. */
  11177. isPickable: boolean;
  11178. /**
  11179. * Gets the hosting scene
  11180. */
  11181. scene: Scene;
  11182. /**
  11183. * Specifies the rendering group id for this mesh (0 by default)
  11184. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11185. */
  11186. renderingGroupId: number;
  11187. /**
  11188. * Defines the list of sprites managed by the manager.
  11189. */
  11190. sprites: Array<Sprite>;
  11191. /**
  11192. * Gets or sets the spritesheet texture
  11193. */
  11194. texture: Texture;
  11195. /** Defines the default width of a cell in the spritesheet */
  11196. cellWidth: number;
  11197. /** Defines the default height of a cell in the spritesheet */
  11198. cellHeight: number;
  11199. /**
  11200. * Tests the intersection of a sprite with a specific ray.
  11201. * @param ray The ray we are sending to test the collision
  11202. * @param camera The camera space we are sending rays in
  11203. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11204. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11205. * @returns picking info or null.
  11206. */
  11207. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11208. /**
  11209. * Intersects the sprites with a ray
  11210. * @param ray defines the ray to intersect with
  11211. * @param camera defines the current active camera
  11212. * @param predicate defines a predicate used to select candidate sprites
  11213. * @returns null if no hit or a PickingInfo array
  11214. */
  11215. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11216. /**
  11217. * Renders the list of sprites on screen.
  11218. */
  11219. render(): void;
  11220. }
  11221. /**
  11222. * Class used to manage multiple sprites on the same spritesheet
  11223. * @see https://doc.babylonjs.com/babylon101/sprites
  11224. */
  11225. export class SpriteManager implements ISpriteManager {
  11226. /** defines the manager's name */
  11227. name: string;
  11228. /** Define the Url to load snippets */
  11229. static SnippetUrl: string;
  11230. /** Snippet ID if the manager was created from the snippet server */
  11231. snippetId: string;
  11232. /** Gets the list of sprites */
  11233. sprites: Sprite[];
  11234. /** Gets or sets the rendering group id (0 by default) */
  11235. renderingGroupId: number;
  11236. /** Gets or sets camera layer mask */
  11237. layerMask: number;
  11238. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11239. fogEnabled: boolean;
  11240. /** Gets or sets a boolean indicating if the sprites are pickable */
  11241. isPickable: boolean;
  11242. /** Defines the default width of a cell in the spritesheet */
  11243. cellWidth: number;
  11244. /** Defines the default height of a cell in the spritesheet */
  11245. cellHeight: number;
  11246. /** Associative array from JSON sprite data file */
  11247. private _cellData;
  11248. /** Array of sprite names from JSON sprite data file */
  11249. private _spriteMap;
  11250. /** True when packed cell data from JSON file is ready*/
  11251. private _packedAndReady;
  11252. private _textureContent;
  11253. private _useInstancing;
  11254. /**
  11255. * An event triggered when the manager is disposed.
  11256. */
  11257. onDisposeObservable: Observable<SpriteManager>;
  11258. private _onDisposeObserver;
  11259. /**
  11260. * Callback called when the manager is disposed
  11261. */
  11262. set onDispose(callback: () => void);
  11263. private _capacity;
  11264. private _fromPacked;
  11265. private _spriteTexture;
  11266. private _epsilon;
  11267. private _scene;
  11268. private _vertexData;
  11269. private _buffer;
  11270. private _vertexBuffers;
  11271. private _spriteBuffer;
  11272. private _indexBuffer;
  11273. private _effectBase;
  11274. private _effectFog;
  11275. private _vertexBufferSize;
  11276. /**
  11277. * Gets or sets the unique id of the sprite
  11278. */
  11279. uniqueId: number;
  11280. /**
  11281. * Gets the array of sprites
  11282. */
  11283. get children(): Sprite[];
  11284. /**
  11285. * Gets the hosting scene
  11286. */
  11287. get scene(): Scene;
  11288. /**
  11289. * Gets the capacity of the manager
  11290. */
  11291. get capacity(): number;
  11292. /**
  11293. * Gets or sets the spritesheet texture
  11294. */
  11295. get texture(): Texture;
  11296. set texture(value: Texture);
  11297. private _blendMode;
  11298. /**
  11299. * Blend mode use to render the particle, it can be any of
  11300. * the static Constants.ALPHA_x properties provided in this class.
  11301. * Default value is Constants.ALPHA_COMBINE
  11302. */
  11303. get blendMode(): number;
  11304. set blendMode(blendMode: number);
  11305. /** Disables writing to the depth buffer when rendering the sprites.
  11306. * It can be handy to disable depth writing when using textures without alpha channel
  11307. * and setting some specific blend modes.
  11308. */
  11309. disableDepthWrite: boolean;
  11310. /**
  11311. * Creates a new sprite manager
  11312. * @param name defines the manager's name
  11313. * @param imgUrl defines the sprite sheet url
  11314. * @param capacity defines the maximum allowed number of sprites
  11315. * @param cellSize defines the size of a sprite cell
  11316. * @param scene defines the hosting scene
  11317. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11318. * @param samplingMode defines the smapling mode to use with spritesheet
  11319. * @param fromPacked set to false; do not alter
  11320. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11321. */
  11322. constructor(
  11323. /** defines the manager's name */
  11324. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11325. /**
  11326. * Returns the string "SpriteManager"
  11327. * @returns "SpriteManager"
  11328. */
  11329. getClassName(): string;
  11330. private _makePacked;
  11331. private _appendSpriteVertex;
  11332. private _checkTextureAlpha;
  11333. /**
  11334. * Intersects the sprites with a ray
  11335. * @param ray defines the ray to intersect with
  11336. * @param camera defines the current active camera
  11337. * @param predicate defines a predicate used to select candidate sprites
  11338. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11339. * @returns null if no hit or a PickingInfo
  11340. */
  11341. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11342. /**
  11343. * Intersects the sprites with a ray
  11344. * @param ray defines the ray to intersect with
  11345. * @param camera defines the current active camera
  11346. * @param predicate defines a predicate used to select candidate sprites
  11347. * @returns null if no hit or a PickingInfo array
  11348. */
  11349. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11350. /**
  11351. * Render all child sprites
  11352. */
  11353. render(): void;
  11354. /**
  11355. * Release associated resources
  11356. */
  11357. dispose(): void;
  11358. /**
  11359. * Serializes the sprite manager to a JSON object
  11360. * @param serializeTexture defines if the texture must be serialized as well
  11361. * @returns the JSON object
  11362. */
  11363. serialize(serializeTexture?: boolean): any;
  11364. /**
  11365. * Parses a JSON object to create a new sprite manager.
  11366. * @param parsedManager The JSON object to parse
  11367. * @param scene The scene to create the sprite managerin
  11368. * @param rootUrl The root url to use to load external dependencies like texture
  11369. * @returns the new sprite manager
  11370. */
  11371. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11372. /**
  11373. * Creates a sprite manager from a snippet saved in a remote file
  11374. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11375. * @param url defines the url to load from
  11376. * @param scene defines the hosting scene
  11377. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11378. * @returns a promise that will resolve to the new sprite manager
  11379. */
  11380. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11381. /**
  11382. * Creates a sprite manager from a snippet saved by the sprite editor
  11383. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11384. * @param scene defines the hosting scene
  11385. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11386. * @returns a promise that will resolve to the new sprite manager
  11387. */
  11388. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11389. }
  11390. }
  11391. declare module "babylonjs/Misc/gradients" {
  11392. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11393. /** Interface used by value gradients (color, factor, ...) */
  11394. export interface IValueGradient {
  11395. /**
  11396. * Gets or sets the gradient value (between 0 and 1)
  11397. */
  11398. gradient: number;
  11399. }
  11400. /** Class used to store color4 gradient */
  11401. export class ColorGradient implements IValueGradient {
  11402. /**
  11403. * Gets or sets the gradient value (between 0 and 1)
  11404. */
  11405. gradient: number;
  11406. /**
  11407. * Gets or sets first associated color
  11408. */
  11409. color1: Color4;
  11410. /**
  11411. * Gets or sets second associated color
  11412. */
  11413. color2?: Color4 | undefined;
  11414. /**
  11415. * Creates a new color4 gradient
  11416. * @param gradient gets or sets the gradient value (between 0 and 1)
  11417. * @param color1 gets or sets first associated color
  11418. * @param color2 gets or sets first second color
  11419. */
  11420. constructor(
  11421. /**
  11422. * Gets or sets the gradient value (between 0 and 1)
  11423. */
  11424. gradient: number,
  11425. /**
  11426. * Gets or sets first associated color
  11427. */
  11428. color1: Color4,
  11429. /**
  11430. * Gets or sets second associated color
  11431. */
  11432. color2?: Color4 | undefined);
  11433. /**
  11434. * Will get a color picked randomly between color1 and color2.
  11435. * If color2 is undefined then color1 will be used
  11436. * @param result defines the target Color4 to store the result in
  11437. */
  11438. getColorToRef(result: Color4): void;
  11439. }
  11440. /** Class used to store color 3 gradient */
  11441. export class Color3Gradient implements IValueGradient {
  11442. /**
  11443. * Gets or sets the gradient value (between 0 and 1)
  11444. */
  11445. gradient: number;
  11446. /**
  11447. * Gets or sets the associated color
  11448. */
  11449. color: Color3;
  11450. /**
  11451. * Creates a new color3 gradient
  11452. * @param gradient gets or sets the gradient value (between 0 and 1)
  11453. * @param color gets or sets associated color
  11454. */
  11455. constructor(
  11456. /**
  11457. * Gets or sets the gradient value (between 0 and 1)
  11458. */
  11459. gradient: number,
  11460. /**
  11461. * Gets or sets the associated color
  11462. */
  11463. color: Color3);
  11464. }
  11465. /** Class used to store factor gradient */
  11466. export class FactorGradient implements IValueGradient {
  11467. /**
  11468. * Gets or sets the gradient value (between 0 and 1)
  11469. */
  11470. gradient: number;
  11471. /**
  11472. * Gets or sets first associated factor
  11473. */
  11474. factor1: number;
  11475. /**
  11476. * Gets or sets second associated factor
  11477. */
  11478. factor2?: number | undefined;
  11479. /**
  11480. * Creates a new factor gradient
  11481. * @param gradient gets or sets the gradient value (between 0 and 1)
  11482. * @param factor1 gets or sets first associated factor
  11483. * @param factor2 gets or sets second associated factor
  11484. */
  11485. constructor(
  11486. /**
  11487. * Gets or sets the gradient value (between 0 and 1)
  11488. */
  11489. gradient: number,
  11490. /**
  11491. * Gets or sets first associated factor
  11492. */
  11493. factor1: number,
  11494. /**
  11495. * Gets or sets second associated factor
  11496. */
  11497. factor2?: number | undefined);
  11498. /**
  11499. * Will get a number picked randomly between factor1 and factor2.
  11500. * If factor2 is undefined then factor1 will be used
  11501. * @returns the picked number
  11502. */
  11503. getFactor(): number;
  11504. }
  11505. /**
  11506. * Helper used to simplify some generic gradient tasks
  11507. */
  11508. export class GradientHelper {
  11509. /**
  11510. * Gets the current gradient from an array of IValueGradient
  11511. * @param ratio defines the current ratio to get
  11512. * @param gradients defines the array of IValueGradient
  11513. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11514. */
  11515. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11516. }
  11517. }
  11518. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11519. import { Nullable } from "babylonjs/types";
  11520. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11521. import { Scene } from "babylonjs/scene";
  11522. module "babylonjs/Engines/thinEngine" {
  11523. interface ThinEngine {
  11524. /**
  11525. * Creates a raw texture
  11526. * @param data defines the data to store in the texture
  11527. * @param width defines the width of the texture
  11528. * @param height defines the height of the texture
  11529. * @param format defines the format of the data
  11530. * @param generateMipMaps defines if the engine should generate the mip levels
  11531. * @param invertY defines if data must be stored with Y axis inverted
  11532. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11533. * @param compression defines the compression used (null by default)
  11534. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11535. * @returns the raw texture inside an InternalTexture
  11536. */
  11537. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11538. /**
  11539. * Update a raw texture
  11540. * @param texture defines the texture to update
  11541. * @param data defines the data to store in the texture
  11542. * @param format defines the format of the data
  11543. * @param invertY defines if data must be stored with Y axis inverted
  11544. */
  11545. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11546. /**
  11547. * Update a raw texture
  11548. * @param texture defines the texture to update
  11549. * @param data defines the data to store in the texture
  11550. * @param format defines the format of the data
  11551. * @param invertY defines if data must be stored with Y axis inverted
  11552. * @param compression defines the compression used (null by default)
  11553. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11554. */
  11555. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11556. /**
  11557. * Creates a new raw cube texture
  11558. * @param data defines the array of data to use to create each face
  11559. * @param size defines the size of the textures
  11560. * @param format defines the format of the data
  11561. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11562. * @param generateMipMaps defines if the engine should generate the mip levels
  11563. * @param invertY defines if data must be stored with Y axis inverted
  11564. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11565. * @param compression defines the compression used (null by default)
  11566. * @returns the cube texture as an InternalTexture
  11567. */
  11568. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11569. /**
  11570. * Update a raw cube texture
  11571. * @param texture defines the texture to udpdate
  11572. * @param data defines the data to store
  11573. * @param format defines the data format
  11574. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11575. * @param invertY defines if data must be stored with Y axis inverted
  11576. */
  11577. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11578. /**
  11579. * Update a raw cube texture
  11580. * @param texture defines the texture to udpdate
  11581. * @param data defines the data to store
  11582. * @param format defines the data format
  11583. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11584. * @param invertY defines if data must be stored with Y axis inverted
  11585. * @param compression defines the compression used (null by default)
  11586. */
  11587. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11588. /**
  11589. * Update a raw cube texture
  11590. * @param texture defines the texture to udpdate
  11591. * @param data defines the data to store
  11592. * @param format defines the data format
  11593. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11594. * @param invertY defines if data must be stored with Y axis inverted
  11595. * @param compression defines the compression used (null by default)
  11596. * @param level defines which level of the texture to update
  11597. */
  11598. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11599. /**
  11600. * Creates a new raw cube texture from a specified url
  11601. * @param url defines the url where the data is located
  11602. * @param scene defines the current scene
  11603. * @param size defines the size of the textures
  11604. * @param format defines the format of the data
  11605. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11606. * @param noMipmap defines if the engine should avoid generating the mip levels
  11607. * @param callback defines a callback used to extract texture data from loaded data
  11608. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11609. * @param onLoad defines a callback called when texture is loaded
  11610. * @param onError defines a callback called if there is an error
  11611. * @returns the cube texture as an InternalTexture
  11612. */
  11613. 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;
  11614. /**
  11615. * Creates a new raw cube texture from a specified url
  11616. * @param url defines the url where the data is located
  11617. * @param scene defines the current scene
  11618. * @param size defines the size of the textures
  11619. * @param format defines the format of the data
  11620. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11621. * @param noMipmap defines if the engine should avoid generating the mip levels
  11622. * @param callback defines a callback used to extract texture data from loaded data
  11623. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11624. * @param onLoad defines a callback called when texture is loaded
  11625. * @param onError defines a callback called if there is an error
  11626. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11627. * @param invertY defines if data must be stored with Y axis inverted
  11628. * @returns the cube texture as an InternalTexture
  11629. */
  11630. 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;
  11631. /**
  11632. * Creates a new raw 3D texture
  11633. * @param data defines the data used to create the texture
  11634. * @param width defines the width of the texture
  11635. * @param height defines the height of the texture
  11636. * @param depth defines the depth of the texture
  11637. * @param format defines the format of the texture
  11638. * @param generateMipMaps defines if the engine must generate mip levels
  11639. * @param invertY defines if data must be stored with Y axis inverted
  11640. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11641. * @param compression defines the compressed used (can be null)
  11642. * @param textureType defines the compressed used (can be null)
  11643. * @returns a new raw 3D texture (stored in an InternalTexture)
  11644. */
  11645. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11646. /**
  11647. * Update a raw 3D texture
  11648. * @param texture defines the texture to update
  11649. * @param data defines the data to store
  11650. * @param format defines the data format
  11651. * @param invertY defines if data must be stored with Y axis inverted
  11652. */
  11653. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11654. /**
  11655. * Update a raw 3D texture
  11656. * @param texture defines the texture to update
  11657. * @param data defines the data to store
  11658. * @param format defines the data format
  11659. * @param invertY defines if data must be stored with Y axis inverted
  11660. * @param compression defines the used compression (can be null)
  11661. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11662. */
  11663. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11664. /**
  11665. * Creates a new raw 2D array texture
  11666. * @param data defines the data used to create the texture
  11667. * @param width defines the width of the texture
  11668. * @param height defines the height of the texture
  11669. * @param depth defines the number of layers of the texture
  11670. * @param format defines the format of the texture
  11671. * @param generateMipMaps defines if the engine must generate mip levels
  11672. * @param invertY defines if data must be stored with Y axis inverted
  11673. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11674. * @param compression defines the compressed used (can be null)
  11675. * @param textureType defines the compressed used (can be null)
  11676. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11677. */
  11678. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11679. /**
  11680. * Update a raw 2D array texture
  11681. * @param texture defines the texture to update
  11682. * @param data defines the data to store
  11683. * @param format defines the data format
  11684. * @param invertY defines if data must be stored with Y axis inverted
  11685. */
  11686. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11687. /**
  11688. * Update a raw 2D array texture
  11689. * @param texture defines the texture to update
  11690. * @param data defines the data to store
  11691. * @param format defines the data format
  11692. * @param invertY defines if data must be stored with Y axis inverted
  11693. * @param compression defines the used compression (can be null)
  11694. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11695. */
  11696. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11697. }
  11698. }
  11699. }
  11700. declare module "babylonjs/Materials/Textures/rawTexture" {
  11701. import { Texture } from "babylonjs/Materials/Textures/texture";
  11702. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11703. import { Nullable } from "babylonjs/types";
  11704. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11705. import { Scene } from "babylonjs/scene";
  11706. /**
  11707. * Raw texture can help creating a texture directly from an array of data.
  11708. * This can be super useful if you either get the data from an uncompressed source or
  11709. * if you wish to create your texture pixel by pixel.
  11710. */
  11711. export class RawTexture extends Texture {
  11712. /**
  11713. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11714. */
  11715. format: number;
  11716. /**
  11717. * Instantiates a new RawTexture.
  11718. * Raw texture can help creating a texture directly from an array of data.
  11719. * This can be super useful if you either get the data from an uncompressed source or
  11720. * if you wish to create your texture pixel by pixel.
  11721. * @param data define the array of data to use to create the texture
  11722. * @param width define the width of the texture
  11723. * @param height define the height of the texture
  11724. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11725. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11726. * @param generateMipMaps define whether mip maps should be generated or not
  11727. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11728. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11729. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11730. */
  11731. constructor(data: ArrayBufferView, width: number, height: number,
  11732. /**
  11733. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11734. */
  11735. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11736. /**
  11737. * Updates the texture underlying data.
  11738. * @param data Define the new data of the texture
  11739. */
  11740. update(data: ArrayBufferView): void;
  11741. /**
  11742. * Creates a luminance texture from some data.
  11743. * @param data Define the texture data
  11744. * @param width Define the width of the texture
  11745. * @param height Define the height of the texture
  11746. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11747. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11748. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11749. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11750. * @returns the luminance texture
  11751. */
  11752. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11753. /**
  11754. * Creates a luminance alpha texture from some data.
  11755. * @param data Define the texture data
  11756. * @param width Define the width of the texture
  11757. * @param height Define the height of the texture
  11758. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11759. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11760. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11761. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11762. * @returns the luminance alpha texture
  11763. */
  11764. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11765. /**
  11766. * Creates an alpha texture from some data.
  11767. * @param data Define the texture data
  11768. * @param width Define the width of the texture
  11769. * @param height Define the height of the texture
  11770. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11771. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11772. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11773. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11774. * @returns the alpha texture
  11775. */
  11776. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11777. /**
  11778. * Creates a RGB texture from some data.
  11779. * @param data Define the texture data
  11780. * @param width Define the width of the texture
  11781. * @param height Define the height of the texture
  11782. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11783. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11784. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11785. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11786. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11787. * @returns the RGB alpha texture
  11788. */
  11789. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11790. /**
  11791. * Creates a RGBA texture from some data.
  11792. * @param data Define the texture data
  11793. * @param width Define the width of the texture
  11794. * @param height Define the height of the texture
  11795. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11796. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11797. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11798. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11799. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11800. * @returns the RGBA texture
  11801. */
  11802. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11803. /**
  11804. * Creates a R texture from some data.
  11805. * @param data Define the texture data
  11806. * @param width Define the width of the texture
  11807. * @param height Define the height of the texture
  11808. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11809. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11810. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11811. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11812. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11813. * @returns the R texture
  11814. */
  11815. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11816. }
  11817. }
  11818. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11819. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11820. import { IndicesArray, DataArray } from "babylonjs/types";
  11821. module "babylonjs/Engines/thinEngine" {
  11822. interface ThinEngine {
  11823. /**
  11824. * Update a dynamic index buffer
  11825. * @param indexBuffer defines the target index buffer
  11826. * @param indices defines the data to update
  11827. * @param offset defines the offset in the target index buffer where update should start
  11828. */
  11829. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11830. /**
  11831. * Updates a dynamic vertex buffer.
  11832. * @param vertexBuffer the vertex buffer to update
  11833. * @param data the data used to update the vertex buffer
  11834. * @param byteOffset the byte offset of the data
  11835. * @param byteLength the byte length of the data
  11836. */
  11837. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11838. }
  11839. }
  11840. }
  11841. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11842. import { Scene } from "babylonjs/scene";
  11843. import { ISceneComponent } from "babylonjs/sceneComponent";
  11844. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11845. module "babylonjs/abstractScene" {
  11846. interface AbstractScene {
  11847. /**
  11848. * The list of procedural textures added to the scene
  11849. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11850. */
  11851. proceduralTextures: Array<ProceduralTexture>;
  11852. }
  11853. }
  11854. /**
  11855. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11856. * in a given scene.
  11857. */
  11858. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11859. /**
  11860. * The component name helpfull to identify the component in the list of scene components.
  11861. */
  11862. readonly name: string;
  11863. /**
  11864. * The scene the component belongs to.
  11865. */
  11866. scene: Scene;
  11867. /**
  11868. * Creates a new instance of the component for the given scene
  11869. * @param scene Defines the scene to register the component in
  11870. */
  11871. constructor(scene: Scene);
  11872. /**
  11873. * Registers the component in a given scene
  11874. */
  11875. register(): void;
  11876. /**
  11877. * Rebuilds the elements related to this component in case of
  11878. * context lost for instance.
  11879. */
  11880. rebuild(): void;
  11881. /**
  11882. * Disposes the component and the associated ressources.
  11883. */
  11884. dispose(): void;
  11885. private _beforeClear;
  11886. }
  11887. }
  11888. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11889. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11890. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11891. module "babylonjs/Engines/thinEngine" {
  11892. interface ThinEngine {
  11893. /**
  11894. * Creates a new render target cube texture
  11895. * @param size defines the size of the texture
  11896. * @param options defines the options used to create the texture
  11897. * @returns a new render target cube texture stored in an InternalTexture
  11898. */
  11899. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11900. }
  11901. }
  11902. }
  11903. declare module "babylonjs/Shaders/procedural.vertex" {
  11904. /** @hidden */
  11905. export var proceduralVertexShader: {
  11906. name: string;
  11907. shader: string;
  11908. };
  11909. }
  11910. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11911. import { Observable } from "babylonjs/Misc/observable";
  11912. import { Nullable } from "babylonjs/types";
  11913. import { Scene } from "babylonjs/scene";
  11914. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11915. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11916. import { Effect } from "babylonjs/Materials/effect";
  11917. import { Texture } from "babylonjs/Materials/Textures/texture";
  11918. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11919. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11920. import "babylonjs/Shaders/procedural.vertex";
  11921. /**
  11922. * 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.
  11923. * This is the base class of any Procedural texture and contains most of the shareable code.
  11924. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11925. */
  11926. export class ProceduralTexture extends Texture {
  11927. isCube: boolean;
  11928. /**
  11929. * Define if the texture is enabled or not (disabled texture will not render)
  11930. */
  11931. isEnabled: boolean;
  11932. /**
  11933. * Define if the texture must be cleared before rendering (default is true)
  11934. */
  11935. autoClear: boolean;
  11936. /**
  11937. * Callback called when the texture is generated
  11938. */
  11939. onGenerated: () => void;
  11940. /**
  11941. * Event raised when the texture is generated
  11942. */
  11943. onGeneratedObservable: Observable<ProceduralTexture>;
  11944. /** @hidden */
  11945. _generateMipMaps: boolean;
  11946. /** @hidden **/
  11947. _effect: Effect;
  11948. /** @hidden */
  11949. _textures: {
  11950. [key: string]: Texture;
  11951. };
  11952. /** @hidden */
  11953. protected _fallbackTexture: Nullable<Texture>;
  11954. private _size;
  11955. private _currentRefreshId;
  11956. private _frameId;
  11957. private _refreshRate;
  11958. private _vertexBuffers;
  11959. private _indexBuffer;
  11960. private _uniforms;
  11961. private _samplers;
  11962. private _fragment;
  11963. private _floats;
  11964. private _ints;
  11965. private _floatsArrays;
  11966. private _colors3;
  11967. private _colors4;
  11968. private _vectors2;
  11969. private _vectors3;
  11970. private _matrices;
  11971. private _fallbackTextureUsed;
  11972. private _fullEngine;
  11973. private _cachedDefines;
  11974. private _contentUpdateId;
  11975. private _contentData;
  11976. /**
  11977. * Instantiates a new procedural texture.
  11978. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  11979. * This is the base class of any Procedural texture and contains most of the shareable code.
  11980. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11981. * @param name Define the name of the texture
  11982. * @param size Define the size of the texture to create
  11983. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11984. * @param scene Define the scene the texture belongs to
  11985. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11986. * @param generateMipMaps Define if the texture should creates mip maps or not
  11987. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11988. */
  11989. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11990. /**
  11991. * The effect that is created when initializing the post process.
  11992. * @returns The created effect corresponding the the postprocess.
  11993. */
  11994. getEffect(): Effect;
  11995. /**
  11996. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11997. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11998. */
  11999. getContent(): Nullable<ArrayBufferView>;
  12000. private _createIndexBuffer;
  12001. /** @hidden */
  12002. _rebuild(): void;
  12003. /**
  12004. * Resets the texture in order to recreate its associated resources.
  12005. * This can be called in case of context loss
  12006. */
  12007. reset(): void;
  12008. protected _getDefines(): string;
  12009. /**
  12010. * Is the texture ready to be used ? (rendered at least once)
  12011. * @returns true if ready, otherwise, false.
  12012. */
  12013. isReady(): boolean;
  12014. /**
  12015. * Resets the refresh counter of the texture and start bak from scratch.
  12016. * Could be useful to regenerate the texture if it is setup to render only once.
  12017. */
  12018. resetRefreshCounter(): void;
  12019. /**
  12020. * Set the fragment shader to use in order to render the texture.
  12021. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12022. */
  12023. setFragment(fragment: any): void;
  12024. /**
  12025. * Define the refresh rate of the texture or the rendering frequency.
  12026. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12027. */
  12028. get refreshRate(): number;
  12029. set refreshRate(value: number);
  12030. /** @hidden */
  12031. _shouldRender(): boolean;
  12032. /**
  12033. * Get the size the texture is rendering at.
  12034. * @returns the size (texture is always squared)
  12035. */
  12036. getRenderSize(): number;
  12037. /**
  12038. * Resize the texture to new value.
  12039. * @param size Define the new size the texture should have
  12040. * @param generateMipMaps Define whether the new texture should create mip maps
  12041. */
  12042. resize(size: number, generateMipMaps: boolean): void;
  12043. private _checkUniform;
  12044. /**
  12045. * Set a texture in the shader program used to render.
  12046. * @param name Define the name of the uniform samplers as defined in the shader
  12047. * @param texture Define the texture to bind to this sampler
  12048. * @return the texture itself allowing "fluent" like uniform updates
  12049. */
  12050. setTexture(name: string, texture: Texture): ProceduralTexture;
  12051. /**
  12052. * Set a float in the shader.
  12053. * @param name Define the name of the uniform as defined in the shader
  12054. * @param value Define the value to give to the uniform
  12055. * @return the texture itself allowing "fluent" like uniform updates
  12056. */
  12057. setFloat(name: string, value: number): ProceduralTexture;
  12058. /**
  12059. * Set a int in the shader.
  12060. * @param name Define the name of the uniform as defined in the shader
  12061. * @param value Define the value to give to the uniform
  12062. * @return the texture itself allowing "fluent" like uniform updates
  12063. */
  12064. setInt(name: string, value: number): ProceduralTexture;
  12065. /**
  12066. * Set an array of floats in the shader.
  12067. * @param name Define the name of the uniform as defined in the shader
  12068. * @param value Define the value to give to the uniform
  12069. * @return the texture itself allowing "fluent" like uniform updates
  12070. */
  12071. setFloats(name: string, value: number[]): ProceduralTexture;
  12072. /**
  12073. * Set a vec3 in the shader from a Color3.
  12074. * @param name Define the name of the uniform as defined in the shader
  12075. * @param value Define the value to give to the uniform
  12076. * @return the texture itself allowing "fluent" like uniform updates
  12077. */
  12078. setColor3(name: string, value: Color3): ProceduralTexture;
  12079. /**
  12080. * Set a vec4 in the shader from a Color4.
  12081. * @param name Define the name of the uniform as defined in the shader
  12082. * @param value Define the value to give to the uniform
  12083. * @return the texture itself allowing "fluent" like uniform updates
  12084. */
  12085. setColor4(name: string, value: Color4): ProceduralTexture;
  12086. /**
  12087. * Set a vec2 in the shader from a Vector2.
  12088. * @param name Define the name of the uniform as defined in the shader
  12089. * @param value Define the value to give to the uniform
  12090. * @return the texture itself allowing "fluent" like uniform updates
  12091. */
  12092. setVector2(name: string, value: Vector2): ProceduralTexture;
  12093. /**
  12094. * Set a vec3 in the shader from a Vector3.
  12095. * @param name Define the name of the uniform as defined in the shader
  12096. * @param value Define the value to give to the uniform
  12097. * @return the texture itself allowing "fluent" like uniform updates
  12098. */
  12099. setVector3(name: string, value: Vector3): ProceduralTexture;
  12100. /**
  12101. * Set a mat4 in the shader from a MAtrix.
  12102. * @param name Define the name of the uniform as defined in the shader
  12103. * @param value Define the value to give to the uniform
  12104. * @return the texture itself allowing "fluent" like uniform updates
  12105. */
  12106. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12107. /**
  12108. * Render the texture to its associated render target.
  12109. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12110. */
  12111. render(useCameraPostProcess?: boolean): void;
  12112. /**
  12113. * Clone the texture.
  12114. * @returns the cloned texture
  12115. */
  12116. clone(): ProceduralTexture;
  12117. /**
  12118. * Dispose the texture and release its asoociated resources.
  12119. */
  12120. dispose(): void;
  12121. }
  12122. }
  12123. declare module "babylonjs/Particles/baseParticleSystem" {
  12124. import { Nullable } from "babylonjs/types";
  12125. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12127. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12128. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12129. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12130. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12131. import { Color4 } from "babylonjs/Maths/math.color";
  12132. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12133. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12134. import { Animation } from "babylonjs/Animations/animation";
  12135. import { Scene } from "babylonjs/scene";
  12136. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12137. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12138. /**
  12139. * This represents the base class for particle system in Babylon.
  12140. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12141. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12142. * @example https://doc.babylonjs.com/babylon101/particles
  12143. */
  12144. export class BaseParticleSystem {
  12145. /**
  12146. * Source color is added to the destination color without alpha affecting the result
  12147. */
  12148. static BLENDMODE_ONEONE: number;
  12149. /**
  12150. * Blend current color and particle color using particle’s alpha
  12151. */
  12152. static BLENDMODE_STANDARD: number;
  12153. /**
  12154. * Add current color and particle color multiplied by particle’s alpha
  12155. */
  12156. static BLENDMODE_ADD: number;
  12157. /**
  12158. * Multiply current color with particle color
  12159. */
  12160. static BLENDMODE_MULTIPLY: number;
  12161. /**
  12162. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12163. */
  12164. static BLENDMODE_MULTIPLYADD: number;
  12165. /**
  12166. * List of animations used by the particle system.
  12167. */
  12168. animations: Animation[];
  12169. /**
  12170. * Gets or sets the unique id of the particle system
  12171. */
  12172. uniqueId: number;
  12173. /**
  12174. * The id of the Particle system.
  12175. */
  12176. id: string;
  12177. /**
  12178. * The friendly name of the Particle system.
  12179. */
  12180. name: string;
  12181. /**
  12182. * Snippet ID if the particle system was created from the snippet server
  12183. */
  12184. snippetId: string;
  12185. /**
  12186. * The rendering group used by the Particle system to chose when to render.
  12187. */
  12188. renderingGroupId: number;
  12189. /**
  12190. * The emitter represents the Mesh or position we are attaching the particle system to.
  12191. */
  12192. emitter: Nullable<AbstractMesh | Vector3>;
  12193. /**
  12194. * The maximum number of particles to emit per frame
  12195. */
  12196. emitRate: number;
  12197. /**
  12198. * If you want to launch only a few particles at once, that can be done, as well.
  12199. */
  12200. manualEmitCount: number;
  12201. /**
  12202. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12203. */
  12204. updateSpeed: number;
  12205. /**
  12206. * The amount of time the particle system is running (depends of the overall update speed).
  12207. */
  12208. targetStopDuration: number;
  12209. /**
  12210. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12211. */
  12212. disposeOnStop: boolean;
  12213. /**
  12214. * Minimum power of emitting particles.
  12215. */
  12216. minEmitPower: number;
  12217. /**
  12218. * Maximum power of emitting particles.
  12219. */
  12220. maxEmitPower: number;
  12221. /**
  12222. * Minimum life time of emitting particles.
  12223. */
  12224. minLifeTime: number;
  12225. /**
  12226. * Maximum life time of emitting particles.
  12227. */
  12228. maxLifeTime: number;
  12229. /**
  12230. * Minimum Size of emitting particles.
  12231. */
  12232. minSize: number;
  12233. /**
  12234. * Maximum Size of emitting particles.
  12235. */
  12236. maxSize: number;
  12237. /**
  12238. * Minimum scale of emitting particles on X axis.
  12239. */
  12240. minScaleX: number;
  12241. /**
  12242. * Maximum scale of emitting particles on X axis.
  12243. */
  12244. maxScaleX: number;
  12245. /**
  12246. * Minimum scale of emitting particles on Y axis.
  12247. */
  12248. minScaleY: number;
  12249. /**
  12250. * Maximum scale of emitting particles on Y axis.
  12251. */
  12252. maxScaleY: number;
  12253. /**
  12254. * Gets or sets the minimal initial rotation in radians.
  12255. */
  12256. minInitialRotation: number;
  12257. /**
  12258. * Gets or sets the maximal initial rotation in radians.
  12259. */
  12260. maxInitialRotation: number;
  12261. /**
  12262. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12263. */
  12264. minAngularSpeed: number;
  12265. /**
  12266. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12267. */
  12268. maxAngularSpeed: number;
  12269. /**
  12270. * The texture used to render each particle. (this can be a spritesheet)
  12271. */
  12272. particleTexture: Nullable<BaseTexture>;
  12273. /**
  12274. * The layer mask we are rendering the particles through.
  12275. */
  12276. layerMask: number;
  12277. /**
  12278. * This can help using your own shader to render the particle system.
  12279. * The according effect will be created
  12280. */
  12281. customShader: any;
  12282. /**
  12283. * By default particle system starts as soon as they are created. This prevents the
  12284. * automatic start to happen and let you decide when to start emitting particles.
  12285. */
  12286. preventAutoStart: boolean;
  12287. private _noiseTexture;
  12288. /**
  12289. * Gets or sets a texture used to add random noise to particle positions
  12290. */
  12291. get noiseTexture(): Nullable<ProceduralTexture>;
  12292. set noiseTexture(value: Nullable<ProceduralTexture>);
  12293. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12294. noiseStrength: Vector3;
  12295. /**
  12296. * Callback triggered when the particle animation is ending.
  12297. */
  12298. onAnimationEnd: Nullable<() => void>;
  12299. /**
  12300. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12301. */
  12302. blendMode: number;
  12303. /**
  12304. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12305. * to override the particles.
  12306. */
  12307. forceDepthWrite: boolean;
  12308. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  12309. preWarmCycles: number;
  12310. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12311. preWarmStepOffset: number;
  12312. /**
  12313. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  12314. */
  12315. spriteCellChangeSpeed: number;
  12316. /**
  12317. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12318. */
  12319. startSpriteCellID: number;
  12320. /**
  12321. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12322. */
  12323. endSpriteCellID: number;
  12324. /**
  12325. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12326. */
  12327. spriteCellWidth: number;
  12328. /**
  12329. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12330. */
  12331. spriteCellHeight: number;
  12332. /**
  12333. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12334. */
  12335. spriteRandomStartCell: boolean;
  12336. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12337. translationPivot: Vector2;
  12338. /** @hidden */
  12339. protected _isAnimationSheetEnabled: boolean;
  12340. /**
  12341. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12342. */
  12343. beginAnimationOnStart: boolean;
  12344. /**
  12345. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12346. */
  12347. beginAnimationFrom: number;
  12348. /**
  12349. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12350. */
  12351. beginAnimationTo: number;
  12352. /**
  12353. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12354. */
  12355. beginAnimationLoop: boolean;
  12356. /**
  12357. * Gets or sets a world offset applied to all particles
  12358. */
  12359. worldOffset: Vector3;
  12360. /**
  12361. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12362. */
  12363. get isAnimationSheetEnabled(): boolean;
  12364. set isAnimationSheetEnabled(value: boolean);
  12365. /**
  12366. * Get hosting scene
  12367. * @returns the scene
  12368. */
  12369. getScene(): Nullable<Scene>;
  12370. /**
  12371. * You can use gravity if you want to give an orientation to your particles.
  12372. */
  12373. gravity: Vector3;
  12374. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12375. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12376. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12377. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12378. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12379. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12380. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12381. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12382. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12383. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12384. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12385. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12386. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12387. /**
  12388. * Defines the delay in milliseconds before starting the system (0 by default)
  12389. */
  12390. startDelay: number;
  12391. /**
  12392. * Gets the current list of drag gradients.
  12393. * You must use addDragGradient and removeDragGradient to udpate this list
  12394. * @returns the list of drag gradients
  12395. */
  12396. getDragGradients(): Nullable<Array<FactorGradient>>;
  12397. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12398. limitVelocityDamping: number;
  12399. /**
  12400. * Gets the current list of limit velocity gradients.
  12401. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12402. * @returns the list of limit velocity gradients
  12403. */
  12404. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12405. /**
  12406. * Gets the current list of color gradients.
  12407. * You must use addColorGradient and removeColorGradient to udpate this list
  12408. * @returns the list of color gradients
  12409. */
  12410. getColorGradients(): Nullable<Array<ColorGradient>>;
  12411. /**
  12412. * Gets the current list of size gradients.
  12413. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12414. * @returns the list of size gradients
  12415. */
  12416. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12417. /**
  12418. * Gets the current list of color remap gradients.
  12419. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12420. * @returns the list of color remap gradients
  12421. */
  12422. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12423. /**
  12424. * Gets the current list of alpha remap gradients.
  12425. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12426. * @returns the list of alpha remap gradients
  12427. */
  12428. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12429. /**
  12430. * Gets the current list of life time gradients.
  12431. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12432. * @returns the list of life time gradients
  12433. */
  12434. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12435. /**
  12436. * Gets the current list of angular speed gradients.
  12437. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12438. * @returns the list of angular speed gradients
  12439. */
  12440. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12441. /**
  12442. * Gets the current list of velocity gradients.
  12443. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12444. * @returns the list of velocity gradients
  12445. */
  12446. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12447. /**
  12448. * Gets the current list of start size gradients.
  12449. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12450. * @returns the list of start size gradients
  12451. */
  12452. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12453. /**
  12454. * Gets the current list of emit rate gradients.
  12455. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12456. * @returns the list of emit rate gradients
  12457. */
  12458. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12459. /**
  12460. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12461. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12462. */
  12463. get direction1(): Vector3;
  12464. set direction1(value: Vector3);
  12465. /**
  12466. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12467. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12468. */
  12469. get direction2(): Vector3;
  12470. set direction2(value: Vector3);
  12471. /**
  12472. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12473. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12474. */
  12475. get minEmitBox(): Vector3;
  12476. set minEmitBox(value: Vector3);
  12477. /**
  12478. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12479. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12480. */
  12481. get maxEmitBox(): Vector3;
  12482. set maxEmitBox(value: Vector3);
  12483. /**
  12484. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12485. */
  12486. color1: Color4;
  12487. /**
  12488. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12489. */
  12490. color2: Color4;
  12491. /**
  12492. * Color the particle will have at the end of its lifetime
  12493. */
  12494. colorDead: Color4;
  12495. /**
  12496. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12497. */
  12498. textureMask: Color4;
  12499. /**
  12500. * The particle emitter type defines the emitter used by the particle system.
  12501. * It can be for example box, sphere, or cone...
  12502. */
  12503. particleEmitterType: IParticleEmitterType;
  12504. /** @hidden */
  12505. _isSubEmitter: boolean;
  12506. /**
  12507. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12508. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12509. */
  12510. billboardMode: number;
  12511. protected _isBillboardBased: boolean;
  12512. /**
  12513. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12514. */
  12515. get isBillboardBased(): boolean;
  12516. set isBillboardBased(value: boolean);
  12517. /**
  12518. * The scene the particle system belongs to.
  12519. */
  12520. protected _scene: Nullable<Scene>;
  12521. /**
  12522. * The engine the particle system belongs to.
  12523. */
  12524. protected _engine: ThinEngine;
  12525. /**
  12526. * Local cache of defines for image processing.
  12527. */
  12528. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12529. /**
  12530. * Default configuration related to image processing available in the standard Material.
  12531. */
  12532. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12533. /**
  12534. * Gets the image processing configuration used either in this material.
  12535. */
  12536. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12537. /**
  12538. * Sets the Default image processing configuration used either in the this material.
  12539. *
  12540. * If sets to null, the scene one is in use.
  12541. */
  12542. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12543. /**
  12544. * Attaches a new image processing configuration to the Standard Material.
  12545. * @param configuration
  12546. */
  12547. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12548. /** @hidden */
  12549. protected _reset(): void;
  12550. /** @hidden */
  12551. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12552. /**
  12553. * Instantiates a particle system.
  12554. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12555. * @param name The name of the particle system
  12556. */
  12557. constructor(name: string);
  12558. /**
  12559. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12560. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12561. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12562. * @returns the emitter
  12563. */
  12564. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12565. /**
  12566. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12567. * @param radius The radius of the hemisphere to emit from
  12568. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12569. * @returns the emitter
  12570. */
  12571. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12572. /**
  12573. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12574. * @param radius The radius of the sphere to emit from
  12575. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12576. * @returns the emitter
  12577. */
  12578. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12579. /**
  12580. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12581. * @param radius The radius of the sphere to emit from
  12582. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12583. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12584. * @returns the emitter
  12585. */
  12586. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12587. /**
  12588. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12589. * @param radius The radius of the emission cylinder
  12590. * @param height The height of the emission cylinder
  12591. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12592. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12593. * @returns the emitter
  12594. */
  12595. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12596. /**
  12597. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12598. * @param radius The radius of the cylinder to emit from
  12599. * @param height The height of the emission cylinder
  12600. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12601. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12602. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12603. * @returns the emitter
  12604. */
  12605. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12606. /**
  12607. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12608. * @param radius The radius of the cone to emit from
  12609. * @param angle The base angle of the cone
  12610. * @returns the emitter
  12611. */
  12612. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12613. /**
  12614. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12615. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12616. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12617. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12618. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12619. * @returns the emitter
  12620. */
  12621. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12622. }
  12623. }
  12624. declare module "babylonjs/Particles/subEmitter" {
  12625. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12626. import { Scene } from "babylonjs/scene";
  12627. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12628. /**
  12629. * Type of sub emitter
  12630. */
  12631. export enum SubEmitterType {
  12632. /**
  12633. * Attached to the particle over it's lifetime
  12634. */
  12635. ATTACHED = 0,
  12636. /**
  12637. * Created when the particle dies
  12638. */
  12639. END = 1
  12640. }
  12641. /**
  12642. * Sub emitter class used to emit particles from an existing particle
  12643. */
  12644. export class SubEmitter {
  12645. /**
  12646. * the particle system to be used by the sub emitter
  12647. */
  12648. particleSystem: ParticleSystem;
  12649. /**
  12650. * Type of the submitter (Default: END)
  12651. */
  12652. type: SubEmitterType;
  12653. /**
  12654. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  12655. * Note: This only is supported when using an emitter of type Mesh
  12656. */
  12657. inheritDirection: boolean;
  12658. /**
  12659. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12660. */
  12661. inheritedVelocityAmount: number;
  12662. /**
  12663. * Creates a sub emitter
  12664. * @param particleSystem the particle system to be used by the sub emitter
  12665. */
  12666. constructor(
  12667. /**
  12668. * the particle system to be used by the sub emitter
  12669. */
  12670. particleSystem: ParticleSystem);
  12671. /**
  12672. * Clones the sub emitter
  12673. * @returns the cloned sub emitter
  12674. */
  12675. clone(): SubEmitter;
  12676. /**
  12677. * Serialize current object to a JSON object
  12678. * @returns the serialized object
  12679. */
  12680. serialize(): any;
  12681. /** @hidden */
  12682. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12683. /**
  12684. * Creates a new SubEmitter from a serialized JSON version
  12685. * @param serializationObject defines the JSON object to read from
  12686. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12687. * @param rootUrl defines the rootUrl for data loading
  12688. * @returns a new SubEmitter
  12689. */
  12690. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12691. /** Release associated resources */
  12692. dispose(): void;
  12693. }
  12694. }
  12695. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12696. /** @hidden */
  12697. export var imageProcessingDeclaration: {
  12698. name: string;
  12699. shader: string;
  12700. };
  12701. }
  12702. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12703. /** @hidden */
  12704. export var imageProcessingFunctions: {
  12705. name: string;
  12706. shader: string;
  12707. };
  12708. }
  12709. declare module "babylonjs/Shaders/particles.fragment" {
  12710. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12711. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12712. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12713. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12714. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12715. /** @hidden */
  12716. export var particlesPixelShader: {
  12717. name: string;
  12718. shader: string;
  12719. };
  12720. }
  12721. declare module "babylonjs/Shaders/particles.vertex" {
  12722. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12723. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12724. /** @hidden */
  12725. export var particlesVertexShader: {
  12726. name: string;
  12727. shader: string;
  12728. };
  12729. }
  12730. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12731. import { Nullable } from "babylonjs/types";
  12732. import { Plane } from "babylonjs/Maths/math";
  12733. /**
  12734. * Interface used to define entities containing multiple clip planes
  12735. */
  12736. export interface IClipPlanesHolder {
  12737. /**
  12738. * Gets or sets the active clipplane 1
  12739. */
  12740. clipPlane: Nullable<Plane>;
  12741. /**
  12742. * Gets or sets the active clipplane 2
  12743. */
  12744. clipPlane2: Nullable<Plane>;
  12745. /**
  12746. * Gets or sets the active clipplane 3
  12747. */
  12748. clipPlane3: Nullable<Plane>;
  12749. /**
  12750. * Gets or sets the active clipplane 4
  12751. */
  12752. clipPlane4: Nullable<Plane>;
  12753. /**
  12754. * Gets or sets the active clipplane 5
  12755. */
  12756. clipPlane5: Nullable<Plane>;
  12757. /**
  12758. * Gets or sets the active clipplane 6
  12759. */
  12760. clipPlane6: Nullable<Plane>;
  12761. }
  12762. }
  12763. declare module "babylonjs/Materials/thinMaterialHelper" {
  12764. import { Effect } from "babylonjs/Materials/effect";
  12765. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12766. /**
  12767. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12768. *
  12769. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12770. *
  12771. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12772. */
  12773. export class ThinMaterialHelper {
  12774. /**
  12775. * Binds the clip plane information from the holder to the effect.
  12776. * @param effect The effect we are binding the data to
  12777. * @param holder The entity containing the clip plane information
  12778. */
  12779. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12780. }
  12781. }
  12782. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12783. module "babylonjs/Engines/thinEngine" {
  12784. interface ThinEngine {
  12785. /**
  12786. * Sets alpha constants used by some alpha blending modes
  12787. * @param r defines the red component
  12788. * @param g defines the green component
  12789. * @param b defines the blue component
  12790. * @param a defines the alpha component
  12791. */
  12792. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12793. /**
  12794. * Sets the current alpha mode
  12795. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12796. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12797. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12798. */
  12799. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12800. /**
  12801. * Gets the current alpha mode
  12802. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12803. * @returns the current alpha mode
  12804. */
  12805. getAlphaMode(): number;
  12806. /**
  12807. * Sets the current alpha equation
  12808. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12809. */
  12810. setAlphaEquation(equation: number): void;
  12811. /**
  12812. * Gets the current alpha equation.
  12813. * @returns the current alpha equation
  12814. */
  12815. getAlphaEquation(): number;
  12816. }
  12817. }
  12818. }
  12819. declare module "babylonjs/Particles/particleSystem" {
  12820. import { Nullable } from "babylonjs/types";
  12821. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12822. import { Observable } from "babylonjs/Misc/observable";
  12823. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12824. import { Effect } from "babylonjs/Materials/effect";
  12825. import { IDisposable } from "babylonjs/scene";
  12826. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12827. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12828. import { Particle } from "babylonjs/Particles/particle";
  12829. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12830. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12831. import "babylonjs/Shaders/particles.fragment";
  12832. import "babylonjs/Shaders/particles.vertex";
  12833. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12834. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12835. import "babylonjs/Engines/Extensions/engine.alpha";
  12836. import { Scene } from "babylonjs/scene";
  12837. /**
  12838. * This represents a particle system in Babylon.
  12839. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12840. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12841. * @example https://doc.babylonjs.com/babylon101/particles
  12842. */
  12843. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12844. /**
  12845. * Billboard mode will only apply to Y axis
  12846. */
  12847. static readonly BILLBOARDMODE_Y: number;
  12848. /**
  12849. * Billboard mode will apply to all axes
  12850. */
  12851. static readonly BILLBOARDMODE_ALL: number;
  12852. /**
  12853. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12854. */
  12855. static readonly BILLBOARDMODE_STRETCHED: number;
  12856. /**
  12857. * This function can be defined to provide custom update for active particles.
  12858. * This function will be called instead of regular update (age, position, color, etc.).
  12859. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12860. */
  12861. updateFunction: (particles: Particle[]) => void;
  12862. private _emitterWorldMatrix;
  12863. /**
  12864. * This function can be defined to specify initial direction for every new particle.
  12865. * It by default use the emitterType defined function
  12866. */
  12867. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12868. /**
  12869. * This function can be defined to specify initial position for every new particle.
  12870. * It by default use the emitterType defined function
  12871. */
  12872. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12873. /**
  12874. * @hidden
  12875. */
  12876. _inheritedVelocityOffset: Vector3;
  12877. /**
  12878. * An event triggered when the system is disposed
  12879. */
  12880. onDisposeObservable: Observable<IParticleSystem>;
  12881. private _onDisposeObserver;
  12882. /**
  12883. * Sets a callback that will be triggered when the system is disposed
  12884. */
  12885. set onDispose(callback: () => void);
  12886. private _particles;
  12887. private _epsilon;
  12888. private _capacity;
  12889. private _stockParticles;
  12890. private _newPartsExcess;
  12891. private _vertexData;
  12892. private _vertexBuffer;
  12893. private _vertexBuffers;
  12894. private _spriteBuffer;
  12895. private _indexBuffer;
  12896. private _effect;
  12897. private _customEffect;
  12898. private _cachedDefines;
  12899. private _scaledColorStep;
  12900. private _colorDiff;
  12901. private _scaledDirection;
  12902. private _scaledGravity;
  12903. private _currentRenderId;
  12904. private _alive;
  12905. private _useInstancing;
  12906. private _started;
  12907. private _stopped;
  12908. private _actualFrame;
  12909. private _scaledUpdateSpeed;
  12910. private _vertexBufferSize;
  12911. /** @hidden */
  12912. _currentEmitRateGradient: Nullable<FactorGradient>;
  12913. /** @hidden */
  12914. _currentEmitRate1: number;
  12915. /** @hidden */
  12916. _currentEmitRate2: number;
  12917. /** @hidden */
  12918. _currentStartSizeGradient: Nullable<FactorGradient>;
  12919. /** @hidden */
  12920. _currentStartSize1: number;
  12921. /** @hidden */
  12922. _currentStartSize2: number;
  12923. private readonly _rawTextureWidth;
  12924. private _rampGradientsTexture;
  12925. private _useRampGradients;
  12926. /** Gets or sets a matrix to use to compute projection */
  12927. defaultProjectionMatrix: Matrix;
  12928. /** Gets or sets a matrix to use to compute view */
  12929. defaultViewMatrix: Matrix;
  12930. /** Gets or sets a boolean indicating that ramp gradients must be used
  12931. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12932. */
  12933. get useRampGradients(): boolean;
  12934. set useRampGradients(value: boolean);
  12935. /**
  12936. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  12937. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  12938. */
  12939. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12940. private _subEmitters;
  12941. /**
  12942. * @hidden
  12943. * If the particle systems emitter should be disposed when the particle system is disposed
  12944. */
  12945. _disposeEmitterOnDispose: boolean;
  12946. /**
  12947. * The current active Sub-systems, this property is used by the root particle system only.
  12948. */
  12949. activeSubSystems: Array<ParticleSystem>;
  12950. /**
  12951. * Specifies if the particles are updated in emitter local space or world space
  12952. */
  12953. isLocal: boolean;
  12954. private _rootParticleSystem;
  12955. /**
  12956. * Gets the current list of active particles
  12957. */
  12958. get particles(): Particle[];
  12959. /**
  12960. * Gets the number of particles active at the same time.
  12961. * @returns The number of active particles.
  12962. */
  12963. getActiveCount(): number;
  12964. /**
  12965. * Returns the string "ParticleSystem"
  12966. * @returns a string containing the class name
  12967. */
  12968. getClassName(): string;
  12969. /**
  12970. * Gets a boolean indicating that the system is stopping
  12971. * @returns true if the system is currently stopping
  12972. */
  12973. isStopping(): boolean;
  12974. /**
  12975. * Gets the custom effect used to render the particles
  12976. * @param blendMode Blend mode for which the effect should be retrieved
  12977. * @returns The effect
  12978. */
  12979. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12980. /**
  12981. * Sets the custom effect used to render the particles
  12982. * @param effect The effect to set
  12983. * @param blendMode Blend mode for which the effect should be set
  12984. */
  12985. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12986. /** @hidden */
  12987. private _onBeforeDrawParticlesObservable;
  12988. /**
  12989. * Observable that will be called just before the particles are drawn
  12990. */
  12991. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12992. /**
  12993. * Gets the name of the particle vertex shader
  12994. */
  12995. get vertexShaderName(): string;
  12996. /**
  12997. * Instantiates a particle system.
  12998. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12999. * @param name The name of the particle system
  13000. * @param capacity The max number of particles alive at the same time
  13001. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13002. * @param customEffect a custom effect used to change the way particles are rendered by default
  13003. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13004. * @param epsilon Offset used to render the particles
  13005. */
  13006. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13007. private _addFactorGradient;
  13008. private _removeFactorGradient;
  13009. /**
  13010. * Adds a new life time gradient
  13011. * @param gradient defines the gradient to use (between 0 and 1)
  13012. * @param factor defines the life time factor to affect to the specified gradient
  13013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13014. * @returns the current particle system
  13015. */
  13016. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13017. /**
  13018. * Remove a specific life time gradient
  13019. * @param gradient defines the gradient to remove
  13020. * @returns the current particle system
  13021. */
  13022. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13023. /**
  13024. * Adds a new size gradient
  13025. * @param gradient defines the gradient to use (between 0 and 1)
  13026. * @param factor defines the size factor to affect to the specified gradient
  13027. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13028. * @returns the current particle system
  13029. */
  13030. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13031. /**
  13032. * Remove a specific size gradient
  13033. * @param gradient defines the gradient to remove
  13034. * @returns the current particle system
  13035. */
  13036. removeSizeGradient(gradient: number): IParticleSystem;
  13037. /**
  13038. * Adds a new color remap gradient
  13039. * @param gradient defines the gradient to use (between 0 and 1)
  13040. * @param min defines the color remap minimal range
  13041. * @param max defines the color remap maximal range
  13042. * @returns the current particle system
  13043. */
  13044. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13045. /**
  13046. * Remove a specific color remap gradient
  13047. * @param gradient defines the gradient to remove
  13048. * @returns the current particle system
  13049. */
  13050. removeColorRemapGradient(gradient: number): IParticleSystem;
  13051. /**
  13052. * Adds a new alpha remap gradient
  13053. * @param gradient defines the gradient to use (between 0 and 1)
  13054. * @param min defines the alpha remap minimal range
  13055. * @param max defines the alpha remap maximal range
  13056. * @returns the current particle system
  13057. */
  13058. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13059. /**
  13060. * Remove a specific alpha remap gradient
  13061. * @param gradient defines the gradient to remove
  13062. * @returns the current particle system
  13063. */
  13064. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13065. /**
  13066. * Adds a new angular speed gradient
  13067. * @param gradient defines the gradient to use (between 0 and 1)
  13068. * @param factor defines the angular speed to affect to the specified gradient
  13069. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13070. * @returns the current particle system
  13071. */
  13072. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13073. /**
  13074. * Remove a specific angular speed gradient
  13075. * @param gradient defines the gradient to remove
  13076. * @returns the current particle system
  13077. */
  13078. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13079. /**
  13080. * Adds a new velocity gradient
  13081. * @param gradient defines the gradient to use (between 0 and 1)
  13082. * @param factor defines the velocity to affect to the specified gradient
  13083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13084. * @returns the current particle system
  13085. */
  13086. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13087. /**
  13088. * Remove a specific velocity gradient
  13089. * @param gradient defines the gradient to remove
  13090. * @returns the current particle system
  13091. */
  13092. removeVelocityGradient(gradient: number): IParticleSystem;
  13093. /**
  13094. * Adds a new limit velocity gradient
  13095. * @param gradient defines the gradient to use (between 0 and 1)
  13096. * @param factor defines the limit velocity value to affect to the specified gradient
  13097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13098. * @returns the current particle system
  13099. */
  13100. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13101. /**
  13102. * Remove a specific limit velocity gradient
  13103. * @param gradient defines the gradient to remove
  13104. * @returns the current particle system
  13105. */
  13106. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13107. /**
  13108. * Adds a new drag gradient
  13109. * @param gradient defines the gradient to use (between 0 and 1)
  13110. * @param factor defines the drag value to affect to the specified gradient
  13111. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13112. * @returns the current particle system
  13113. */
  13114. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13115. /**
  13116. * Remove a specific drag gradient
  13117. * @param gradient defines the gradient to remove
  13118. * @returns the current particle system
  13119. */
  13120. removeDragGradient(gradient: number): IParticleSystem;
  13121. /**
  13122. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13123. * @param gradient defines the gradient to use (between 0 and 1)
  13124. * @param factor defines the emit rate value to affect to the specified gradient
  13125. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13126. * @returns the current particle system
  13127. */
  13128. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13129. /**
  13130. * Remove a specific emit rate gradient
  13131. * @param gradient defines the gradient to remove
  13132. * @returns the current particle system
  13133. */
  13134. removeEmitRateGradient(gradient: number): IParticleSystem;
  13135. /**
  13136. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13137. * @param gradient defines the gradient to use (between 0 and 1)
  13138. * @param factor defines the start size value to affect to the specified gradient
  13139. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13140. * @returns the current particle system
  13141. */
  13142. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13143. /**
  13144. * Remove a specific start size gradient
  13145. * @param gradient defines the gradient to remove
  13146. * @returns the current particle system
  13147. */
  13148. removeStartSizeGradient(gradient: number): IParticleSystem;
  13149. private _createRampGradientTexture;
  13150. /**
  13151. * Gets the current list of ramp gradients.
  13152. * You must use addRampGradient and removeRampGradient to udpate this list
  13153. * @returns the list of ramp gradients
  13154. */
  13155. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13156. /** Force the system to rebuild all gradients that need to be resync */
  13157. forceRefreshGradients(): void;
  13158. private _syncRampGradientTexture;
  13159. /**
  13160. * Adds a new ramp gradient used to remap particle colors
  13161. * @param gradient defines the gradient to use (between 0 and 1)
  13162. * @param color defines the color to affect to the specified gradient
  13163. * @returns the current particle system
  13164. */
  13165. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13166. /**
  13167. * Remove a specific ramp gradient
  13168. * @param gradient defines the gradient to remove
  13169. * @returns the current particle system
  13170. */
  13171. removeRampGradient(gradient: number): ParticleSystem;
  13172. /**
  13173. * Adds a new color gradient
  13174. * @param gradient defines the gradient to use (between 0 and 1)
  13175. * @param color1 defines the color to affect to the specified gradient
  13176. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13177. * @returns this particle system
  13178. */
  13179. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13180. /**
  13181. * Remove a specific color gradient
  13182. * @param gradient defines the gradient to remove
  13183. * @returns this particle system
  13184. */
  13185. removeColorGradient(gradient: number): IParticleSystem;
  13186. private _fetchR;
  13187. protected _reset(): void;
  13188. private _resetEffect;
  13189. private _createVertexBuffers;
  13190. private _createIndexBuffer;
  13191. /**
  13192. * Gets the maximum number of particles active at the same time.
  13193. * @returns The max number of active particles.
  13194. */
  13195. getCapacity(): number;
  13196. /**
  13197. * Gets whether there are still active particles in the system.
  13198. * @returns True if it is alive, otherwise false.
  13199. */
  13200. isAlive(): boolean;
  13201. /**
  13202. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13203. * @returns True if it has been started, otherwise false.
  13204. */
  13205. isStarted(): boolean;
  13206. private _prepareSubEmitterInternalArray;
  13207. /**
  13208. * Starts the particle system and begins to emit
  13209. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13210. */
  13211. start(delay?: number): void;
  13212. /**
  13213. * Stops the particle system.
  13214. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  13215. */
  13216. stop(stopSubEmitters?: boolean): void;
  13217. /**
  13218. * Remove all active particles
  13219. */
  13220. reset(): void;
  13221. /**
  13222. * @hidden (for internal use only)
  13223. */
  13224. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13225. /**
  13226. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13227. * Its lifetime will start back at 0.
  13228. */
  13229. recycleParticle: (particle: Particle) => void;
  13230. private _stopSubEmitters;
  13231. private _createParticle;
  13232. private _removeFromRoot;
  13233. private _emitFromParticle;
  13234. private _update;
  13235. /** @hidden */
  13236. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13237. /** @hidden */
  13238. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13239. /**
  13240. * Fill the defines array according to the current settings of the particle system
  13241. * @param defines Array to be updated
  13242. * @param blendMode blend mode to take into account when updating the array
  13243. */
  13244. fillDefines(defines: Array<string>, blendMode: number): void;
  13245. /**
  13246. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13247. * @param uniforms Uniforms array to fill
  13248. * @param attributes Attributes array to fill
  13249. * @param samplers Samplers array to fill
  13250. */
  13251. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13252. /** @hidden */
  13253. private _getEffect;
  13254. /**
  13255. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13256. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13257. */
  13258. animate(preWarmOnly?: boolean): void;
  13259. private _appendParticleVertices;
  13260. /**
  13261. * Rebuilds the particle system.
  13262. */
  13263. rebuild(): void;
  13264. /**
  13265. * Is this system ready to be used/rendered
  13266. * @return true if the system is ready
  13267. */
  13268. isReady(): boolean;
  13269. private _render;
  13270. /**
  13271. * Renders the particle system in its current state.
  13272. * @returns the current number of particles
  13273. */
  13274. render(): number;
  13275. /**
  13276. * Disposes the particle system and free the associated resources
  13277. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13278. */
  13279. dispose(disposeTexture?: boolean): void;
  13280. /**
  13281. * Clones the particle system.
  13282. * @param name The name of the cloned object
  13283. * @param newEmitter The new emitter to use
  13284. * @returns the cloned particle system
  13285. */
  13286. clone(name: string, newEmitter: any): ParticleSystem;
  13287. /**
  13288. * Serializes the particle system to a JSON object
  13289. * @param serializeTexture defines if the texture must be serialized as well
  13290. * @returns the JSON object
  13291. */
  13292. serialize(serializeTexture?: boolean): any;
  13293. /** @hidden */
  13294. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13295. /** @hidden */
  13296. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13297. /**
  13298. * Parses a JSON object to create a particle system.
  13299. * @param parsedParticleSystem The JSON object to parse
  13300. * @param sceneOrEngine The scene or the engine to create the particle system in
  13301. * @param rootUrl The root url to use to load external dependencies like texture
  13302. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13303. * @returns the Parsed particle system
  13304. */
  13305. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13306. }
  13307. }
  13308. declare module "babylonjs/Particles/particle" {
  13309. import { Nullable } from "babylonjs/types";
  13310. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13311. import { Color4 } from "babylonjs/Maths/math.color";
  13312. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13313. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13314. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13315. /**
  13316. * A particle represents one of the element emitted by a particle system.
  13317. * This is mainly define by its coordinates, direction, velocity and age.
  13318. */
  13319. export class Particle {
  13320. /**
  13321. * The particle system the particle belongs to.
  13322. */
  13323. particleSystem: ParticleSystem;
  13324. private static _Count;
  13325. /**
  13326. * Unique ID of the particle
  13327. */
  13328. id: number;
  13329. /**
  13330. * The world position of the particle in the scene.
  13331. */
  13332. position: Vector3;
  13333. /**
  13334. * The world direction of the particle in the scene.
  13335. */
  13336. direction: Vector3;
  13337. /**
  13338. * The color of the particle.
  13339. */
  13340. color: Color4;
  13341. /**
  13342. * The color change of the particle per step.
  13343. */
  13344. colorStep: Color4;
  13345. /**
  13346. * Defines how long will the life of the particle be.
  13347. */
  13348. lifeTime: number;
  13349. /**
  13350. * The current age of the particle.
  13351. */
  13352. age: number;
  13353. /**
  13354. * The current size of the particle.
  13355. */
  13356. size: number;
  13357. /**
  13358. * The current scale of the particle.
  13359. */
  13360. scale: Vector2;
  13361. /**
  13362. * The current angle of the particle.
  13363. */
  13364. angle: number;
  13365. /**
  13366. * Defines how fast is the angle changing.
  13367. */
  13368. angularSpeed: number;
  13369. /**
  13370. * Defines the cell index used by the particle to be rendered from a sprite.
  13371. */
  13372. cellIndex: number;
  13373. /**
  13374. * The information required to support color remapping
  13375. */
  13376. remapData: Vector4;
  13377. /** @hidden */
  13378. _randomCellOffset?: number;
  13379. /** @hidden */
  13380. _initialDirection: Nullable<Vector3>;
  13381. /** @hidden */
  13382. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13383. /** @hidden */
  13384. _initialStartSpriteCellID: number;
  13385. /** @hidden */
  13386. _initialEndSpriteCellID: number;
  13387. /** @hidden */
  13388. _currentColorGradient: Nullable<ColorGradient>;
  13389. /** @hidden */
  13390. _currentColor1: Color4;
  13391. /** @hidden */
  13392. _currentColor2: Color4;
  13393. /** @hidden */
  13394. _currentSizeGradient: Nullable<FactorGradient>;
  13395. /** @hidden */
  13396. _currentSize1: number;
  13397. /** @hidden */
  13398. _currentSize2: number;
  13399. /** @hidden */
  13400. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13401. /** @hidden */
  13402. _currentAngularSpeed1: number;
  13403. /** @hidden */
  13404. _currentAngularSpeed2: number;
  13405. /** @hidden */
  13406. _currentVelocityGradient: Nullable<FactorGradient>;
  13407. /** @hidden */
  13408. _currentVelocity1: number;
  13409. /** @hidden */
  13410. _currentVelocity2: number;
  13411. /** @hidden */
  13412. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13413. /** @hidden */
  13414. _currentLimitVelocity1: number;
  13415. /** @hidden */
  13416. _currentLimitVelocity2: number;
  13417. /** @hidden */
  13418. _currentDragGradient: Nullable<FactorGradient>;
  13419. /** @hidden */
  13420. _currentDrag1: number;
  13421. /** @hidden */
  13422. _currentDrag2: number;
  13423. /** @hidden */
  13424. _randomNoiseCoordinates1: Vector3;
  13425. /** @hidden */
  13426. _randomNoiseCoordinates2: Vector3;
  13427. /** @hidden */
  13428. _localPosition?: Vector3;
  13429. /**
  13430. * Creates a new instance Particle
  13431. * @param particleSystem the particle system the particle belongs to
  13432. */
  13433. constructor(
  13434. /**
  13435. * The particle system the particle belongs to.
  13436. */
  13437. particleSystem: ParticleSystem);
  13438. private updateCellInfoFromSystem;
  13439. /**
  13440. * Defines how the sprite cell index is updated for the particle
  13441. */
  13442. updateCellIndex(): void;
  13443. /** @hidden */
  13444. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13445. /** @hidden */
  13446. _inheritParticleInfoToSubEmitters(): void;
  13447. /** @hidden */
  13448. _reset(): void;
  13449. /**
  13450. * Copy the properties of particle to another one.
  13451. * @param other the particle to copy the information to.
  13452. */
  13453. copyTo(other: Particle): void;
  13454. }
  13455. }
  13456. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Effect } from "babylonjs/Materials/effect";
  13459. import { Particle } from "babylonjs/Particles/particle";
  13460. import { Nullable } from "babylonjs/types";
  13461. import { Scene } from "babylonjs/scene";
  13462. /**
  13463. * Particle emitter represents a volume emitting particles.
  13464. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13465. */
  13466. export interface IParticleEmitterType {
  13467. /**
  13468. * Called by the particle System when the direction is computed for the created particle.
  13469. * @param worldMatrix is the world matrix of the particle system
  13470. * @param directionToUpdate is the direction vector to update with the result
  13471. * @param particle is the particle we are computed the direction for
  13472. * @param isLocal defines if the direction should be set in local space
  13473. */
  13474. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13475. /**
  13476. * Called by the particle System when the position is computed for the created particle.
  13477. * @param worldMatrix is the world matrix of the particle system
  13478. * @param positionToUpdate is the position vector to update with the result
  13479. * @param particle is the particle we are computed the position for
  13480. * @param isLocal defines if the position should be set in local space
  13481. */
  13482. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13483. /**
  13484. * Clones the current emitter and returns a copy of it
  13485. * @returns the new emitter
  13486. */
  13487. clone(): IParticleEmitterType;
  13488. /**
  13489. * Called by the GPUParticleSystem to setup the update shader
  13490. * @param effect defines the update shader
  13491. */
  13492. applyToShader(effect: Effect): void;
  13493. /**
  13494. * Returns a string to use to update the GPU particles update shader
  13495. * @returns the effect defines string
  13496. */
  13497. getEffectDefines(): string;
  13498. /**
  13499. * Returns a string representing the class name
  13500. * @returns a string containing the class name
  13501. */
  13502. getClassName(): string;
  13503. /**
  13504. * Serializes the particle system to a JSON object.
  13505. * @returns the JSON object
  13506. */
  13507. serialize(): any;
  13508. /**
  13509. * Parse properties from a JSON object
  13510. * @param serializationObject defines the JSON object
  13511. * @param scene defines the hosting scene
  13512. */
  13513. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13514. }
  13515. }
  13516. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13517. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13518. import { Effect } from "babylonjs/Materials/effect";
  13519. import { Particle } from "babylonjs/Particles/particle";
  13520. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13521. /**
  13522. * Particle emitter emitting particles from the inside of a box.
  13523. * It emits the particles randomly between 2 given directions.
  13524. */
  13525. export class BoxParticleEmitter implements IParticleEmitterType {
  13526. /**
  13527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13528. */
  13529. direction1: Vector3;
  13530. /**
  13531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13532. */
  13533. direction2: Vector3;
  13534. /**
  13535. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13536. */
  13537. minEmitBox: Vector3;
  13538. /**
  13539. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13540. */
  13541. maxEmitBox: Vector3;
  13542. /**
  13543. * Creates a new instance BoxParticleEmitter
  13544. */
  13545. constructor();
  13546. /**
  13547. * Called by the particle System when the direction is computed for the created particle.
  13548. * @param worldMatrix is the world matrix of the particle system
  13549. * @param directionToUpdate is the direction vector to update with the result
  13550. * @param particle is the particle we are computed the direction for
  13551. * @param isLocal defines if the direction should be set in local space
  13552. */
  13553. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13554. /**
  13555. * Called by the particle System when the position is computed for the created particle.
  13556. * @param worldMatrix is the world matrix of the particle system
  13557. * @param positionToUpdate is the position vector to update with the result
  13558. * @param particle is the particle we are computed the position for
  13559. * @param isLocal defines if the position should be set in local space
  13560. */
  13561. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13562. /**
  13563. * Clones the current emitter and returns a copy of it
  13564. * @returns the new emitter
  13565. */
  13566. clone(): BoxParticleEmitter;
  13567. /**
  13568. * Called by the GPUParticleSystem to setup the update shader
  13569. * @param effect defines the update shader
  13570. */
  13571. applyToShader(effect: Effect): void;
  13572. /**
  13573. * Returns a string to use to update the GPU particles update shader
  13574. * @returns a string containng the defines string
  13575. */
  13576. getEffectDefines(): string;
  13577. /**
  13578. * Returns the string "BoxParticleEmitter"
  13579. * @returns a string containing the class name
  13580. */
  13581. getClassName(): string;
  13582. /**
  13583. * Serializes the particle system to a JSON object.
  13584. * @returns the JSON object
  13585. */
  13586. serialize(): any;
  13587. /**
  13588. * Parse properties from a JSON object
  13589. * @param serializationObject defines the JSON object
  13590. */
  13591. parse(serializationObject: any): void;
  13592. }
  13593. }
  13594. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13595. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13596. import { Effect } from "babylonjs/Materials/effect";
  13597. import { Particle } from "babylonjs/Particles/particle";
  13598. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13599. /**
  13600. * Particle emitter emitting particles from the inside of a cone.
  13601. * It emits the particles alongside the cone volume from the base to the particle.
  13602. * The emission direction might be randomized.
  13603. */
  13604. export class ConeParticleEmitter implements IParticleEmitterType {
  13605. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13606. directionRandomizer: number;
  13607. private _radius;
  13608. private _angle;
  13609. private _height;
  13610. /**
  13611. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13612. */
  13613. radiusRange: number;
  13614. /**
  13615. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13616. */
  13617. heightRange: number;
  13618. /**
  13619. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13620. */
  13621. emitFromSpawnPointOnly: boolean;
  13622. /**
  13623. * Gets or sets the radius of the emission cone
  13624. */
  13625. get radius(): number;
  13626. set radius(value: number);
  13627. /**
  13628. * Gets or sets the angle of the emission cone
  13629. */
  13630. get angle(): number;
  13631. set angle(value: number);
  13632. private _buildHeight;
  13633. /**
  13634. * Creates a new instance ConeParticleEmitter
  13635. * @param radius the radius of the emission cone (1 by default)
  13636. * @param angle the cone base angle (PI by default)
  13637. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13638. */
  13639. constructor(radius?: number, angle?: number,
  13640. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13641. directionRandomizer?: number);
  13642. /**
  13643. * Called by the particle System when the direction is computed for the created particle.
  13644. * @param worldMatrix is the world matrix of the particle system
  13645. * @param directionToUpdate is the direction vector to update with the result
  13646. * @param particle is the particle we are computed the direction for
  13647. * @param isLocal defines if the direction should be set in local space
  13648. */
  13649. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13650. /**
  13651. * Called by the particle System when the position is computed for the created particle.
  13652. * @param worldMatrix is the world matrix of the particle system
  13653. * @param positionToUpdate is the position vector to update with the result
  13654. * @param particle is the particle we are computed the position for
  13655. * @param isLocal defines if the position should be set in local space
  13656. */
  13657. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13658. /**
  13659. * Clones the current emitter and returns a copy of it
  13660. * @returns the new emitter
  13661. */
  13662. clone(): ConeParticleEmitter;
  13663. /**
  13664. * Called by the GPUParticleSystem to setup the update shader
  13665. * @param effect defines the update shader
  13666. */
  13667. applyToShader(effect: Effect): void;
  13668. /**
  13669. * Returns a string to use to update the GPU particles update shader
  13670. * @returns a string containng the defines string
  13671. */
  13672. getEffectDefines(): string;
  13673. /**
  13674. * Returns the string "ConeParticleEmitter"
  13675. * @returns a string containing the class name
  13676. */
  13677. getClassName(): string;
  13678. /**
  13679. * Serializes the particle system to a JSON object.
  13680. * @returns the JSON object
  13681. */
  13682. serialize(): any;
  13683. /**
  13684. * Parse properties from a JSON object
  13685. * @param serializationObject defines the JSON object
  13686. */
  13687. parse(serializationObject: any): void;
  13688. }
  13689. }
  13690. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13691. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13692. import { Effect } from "babylonjs/Materials/effect";
  13693. import { Particle } from "babylonjs/Particles/particle";
  13694. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13695. /**
  13696. * Particle emitter emitting particles from the inside of a cylinder.
  13697. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13698. */
  13699. export class CylinderParticleEmitter implements IParticleEmitterType {
  13700. /**
  13701. * The radius of the emission cylinder.
  13702. */
  13703. radius: number;
  13704. /**
  13705. * The height of the emission cylinder.
  13706. */
  13707. height: number;
  13708. /**
  13709. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13710. */
  13711. radiusRange: number;
  13712. /**
  13713. * How much to randomize the particle direction [0-1].
  13714. */
  13715. directionRandomizer: number;
  13716. /**
  13717. * Creates a new instance CylinderParticleEmitter
  13718. * @param radius the radius of the emission cylinder (1 by default)
  13719. * @param height the height of the emission cylinder (1 by default)
  13720. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13721. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13722. */
  13723. constructor(
  13724. /**
  13725. * The radius of the emission cylinder.
  13726. */
  13727. radius?: number,
  13728. /**
  13729. * The height of the emission cylinder.
  13730. */
  13731. height?: number,
  13732. /**
  13733. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13734. */
  13735. radiusRange?: number,
  13736. /**
  13737. * How much to randomize the particle direction [0-1].
  13738. */
  13739. directionRandomizer?: number);
  13740. /**
  13741. * Called by the particle System when the direction is computed for the created particle.
  13742. * @param worldMatrix is the world matrix of the particle system
  13743. * @param directionToUpdate is the direction vector to update with the result
  13744. * @param particle is the particle we are computed the direction for
  13745. * @param isLocal defines if the direction should be set in local space
  13746. */
  13747. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13748. /**
  13749. * Called by the particle System when the position is computed for the created particle.
  13750. * @param worldMatrix is the world matrix of the particle system
  13751. * @param positionToUpdate is the position vector to update with the result
  13752. * @param particle is the particle we are computed the position for
  13753. * @param isLocal defines if the position should be set in local space
  13754. */
  13755. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13756. /**
  13757. * Clones the current emitter and returns a copy of it
  13758. * @returns the new emitter
  13759. */
  13760. clone(): CylinderParticleEmitter;
  13761. /**
  13762. * Called by the GPUParticleSystem to setup the update shader
  13763. * @param effect defines the update shader
  13764. */
  13765. applyToShader(effect: Effect): void;
  13766. /**
  13767. * Returns a string to use to update the GPU particles update shader
  13768. * @returns a string containng the defines string
  13769. */
  13770. getEffectDefines(): string;
  13771. /**
  13772. * Returns the string "CylinderParticleEmitter"
  13773. * @returns a string containing the class name
  13774. */
  13775. getClassName(): string;
  13776. /**
  13777. * Serializes the particle system to a JSON object.
  13778. * @returns the JSON object
  13779. */
  13780. serialize(): any;
  13781. /**
  13782. * Parse properties from a JSON object
  13783. * @param serializationObject defines the JSON object
  13784. */
  13785. parse(serializationObject: any): void;
  13786. }
  13787. /**
  13788. * Particle emitter emitting particles from the inside of a cylinder.
  13789. * It emits the particles randomly between two vectors.
  13790. */
  13791. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13792. /**
  13793. * The min limit of the emission direction.
  13794. */
  13795. direction1: Vector3;
  13796. /**
  13797. * The max limit of the emission direction.
  13798. */
  13799. direction2: Vector3;
  13800. /**
  13801. * Creates a new instance CylinderDirectedParticleEmitter
  13802. * @param radius the radius of the emission cylinder (1 by default)
  13803. * @param height the height of the emission cylinder (1 by default)
  13804. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13805. * @param direction1 the min limit of the emission direction (up vector by default)
  13806. * @param direction2 the max limit of the emission direction (up vector by default)
  13807. */
  13808. constructor(radius?: number, height?: number, radiusRange?: number,
  13809. /**
  13810. * The min limit of the emission direction.
  13811. */
  13812. direction1?: Vector3,
  13813. /**
  13814. * The max limit of the emission direction.
  13815. */
  13816. direction2?: Vector3);
  13817. /**
  13818. * Called by the particle System when the direction is computed for the created particle.
  13819. * @param worldMatrix is the world matrix of the particle system
  13820. * @param directionToUpdate is the direction vector to update with the result
  13821. * @param particle is the particle we are computed the direction for
  13822. */
  13823. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13824. /**
  13825. * Clones the current emitter and returns a copy of it
  13826. * @returns the new emitter
  13827. */
  13828. clone(): CylinderDirectedParticleEmitter;
  13829. /**
  13830. * Called by the GPUParticleSystem to setup the update shader
  13831. * @param effect defines the update shader
  13832. */
  13833. applyToShader(effect: Effect): void;
  13834. /**
  13835. * Returns a string to use to update the GPU particles update shader
  13836. * @returns a string containng the defines string
  13837. */
  13838. getEffectDefines(): string;
  13839. /**
  13840. * Returns the string "CylinderDirectedParticleEmitter"
  13841. * @returns a string containing the class name
  13842. */
  13843. getClassName(): string;
  13844. /**
  13845. * Serializes the particle system to a JSON object.
  13846. * @returns the JSON object
  13847. */
  13848. serialize(): any;
  13849. /**
  13850. * Parse properties from a JSON object
  13851. * @param serializationObject defines the JSON object
  13852. */
  13853. parse(serializationObject: any): void;
  13854. }
  13855. }
  13856. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13857. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13858. import { Effect } from "babylonjs/Materials/effect";
  13859. import { Particle } from "babylonjs/Particles/particle";
  13860. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13861. /**
  13862. * Particle emitter emitting particles from the inside of a hemisphere.
  13863. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13864. */
  13865. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13866. /**
  13867. * The radius of the emission hemisphere.
  13868. */
  13869. radius: number;
  13870. /**
  13871. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13872. */
  13873. radiusRange: number;
  13874. /**
  13875. * How much to randomize the particle direction [0-1].
  13876. */
  13877. directionRandomizer: number;
  13878. /**
  13879. * Creates a new instance HemisphericParticleEmitter
  13880. * @param radius the radius of the emission hemisphere (1 by default)
  13881. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13882. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13883. */
  13884. constructor(
  13885. /**
  13886. * The radius of the emission hemisphere.
  13887. */
  13888. radius?: number,
  13889. /**
  13890. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13891. */
  13892. radiusRange?: number,
  13893. /**
  13894. * How much to randomize the particle direction [0-1].
  13895. */
  13896. directionRandomizer?: number);
  13897. /**
  13898. * Called by the particle System when the direction is computed for the created particle.
  13899. * @param worldMatrix is the world matrix of the particle system
  13900. * @param directionToUpdate is the direction vector to update with the result
  13901. * @param particle is the particle we are computed the direction for
  13902. * @param isLocal defines if the direction should be set in local space
  13903. */
  13904. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13905. /**
  13906. * Called by the particle System when the position is computed for the created particle.
  13907. * @param worldMatrix is the world matrix of the particle system
  13908. * @param positionToUpdate is the position vector to update with the result
  13909. * @param particle is the particle we are computed the position for
  13910. * @param isLocal defines if the position should be set in local space
  13911. */
  13912. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13913. /**
  13914. * Clones the current emitter and returns a copy of it
  13915. * @returns the new emitter
  13916. */
  13917. clone(): HemisphericParticleEmitter;
  13918. /**
  13919. * Called by the GPUParticleSystem to setup the update shader
  13920. * @param effect defines the update shader
  13921. */
  13922. applyToShader(effect: Effect): void;
  13923. /**
  13924. * Returns a string to use to update the GPU particles update shader
  13925. * @returns a string containng the defines string
  13926. */
  13927. getEffectDefines(): string;
  13928. /**
  13929. * Returns the string "HemisphericParticleEmitter"
  13930. * @returns a string containing the class name
  13931. */
  13932. getClassName(): string;
  13933. /**
  13934. * Serializes the particle system to a JSON object.
  13935. * @returns the JSON object
  13936. */
  13937. serialize(): any;
  13938. /**
  13939. * Parse properties from a JSON object
  13940. * @param serializationObject defines the JSON object
  13941. */
  13942. parse(serializationObject: any): void;
  13943. }
  13944. }
  13945. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13946. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13947. import { Effect } from "babylonjs/Materials/effect";
  13948. import { Particle } from "babylonjs/Particles/particle";
  13949. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13950. /**
  13951. * Particle emitter emitting particles from a point.
  13952. * It emits the particles randomly between 2 given directions.
  13953. */
  13954. export class PointParticleEmitter implements IParticleEmitterType {
  13955. /**
  13956. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13957. */
  13958. direction1: Vector3;
  13959. /**
  13960. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13961. */
  13962. direction2: Vector3;
  13963. /**
  13964. * Creates a new instance PointParticleEmitter
  13965. */
  13966. constructor();
  13967. /**
  13968. * Called by the particle System when the direction is computed for the created particle.
  13969. * @param worldMatrix is the world matrix of the particle system
  13970. * @param directionToUpdate is the direction vector to update with the result
  13971. * @param particle is the particle we are computed the direction for
  13972. * @param isLocal defines if the direction should be set in local space
  13973. */
  13974. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13975. /**
  13976. * Called by the particle System when the position is computed for the created particle.
  13977. * @param worldMatrix is the world matrix of the particle system
  13978. * @param positionToUpdate is the position vector to update with the result
  13979. * @param particle is the particle we are computed the position for
  13980. * @param isLocal defines if the position should be set in local space
  13981. */
  13982. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13983. /**
  13984. * Clones the current emitter and returns a copy of it
  13985. * @returns the new emitter
  13986. */
  13987. clone(): PointParticleEmitter;
  13988. /**
  13989. * Called by the GPUParticleSystem to setup the update shader
  13990. * @param effect defines the update shader
  13991. */
  13992. applyToShader(effect: Effect): void;
  13993. /**
  13994. * Returns a string to use to update the GPU particles update shader
  13995. * @returns a string containng the defines string
  13996. */
  13997. getEffectDefines(): string;
  13998. /**
  13999. * Returns the string "PointParticleEmitter"
  14000. * @returns a string containing the class name
  14001. */
  14002. getClassName(): string;
  14003. /**
  14004. * Serializes the particle system to a JSON object.
  14005. * @returns the JSON object
  14006. */
  14007. serialize(): any;
  14008. /**
  14009. * Parse properties from a JSON object
  14010. * @param serializationObject defines the JSON object
  14011. */
  14012. parse(serializationObject: any): void;
  14013. }
  14014. }
  14015. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14016. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14017. import { Effect } from "babylonjs/Materials/effect";
  14018. import { Particle } from "babylonjs/Particles/particle";
  14019. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14020. /**
  14021. * Particle emitter emitting particles from the inside of a sphere.
  14022. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14023. */
  14024. export class SphereParticleEmitter implements IParticleEmitterType {
  14025. /**
  14026. * The radius of the emission sphere.
  14027. */
  14028. radius: number;
  14029. /**
  14030. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14031. */
  14032. radiusRange: number;
  14033. /**
  14034. * How much to randomize the particle direction [0-1].
  14035. */
  14036. directionRandomizer: number;
  14037. /**
  14038. * Creates a new instance SphereParticleEmitter
  14039. * @param radius the radius of the emission sphere (1 by default)
  14040. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14041. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14042. */
  14043. constructor(
  14044. /**
  14045. * The radius of the emission sphere.
  14046. */
  14047. radius?: number,
  14048. /**
  14049. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14050. */
  14051. radiusRange?: number,
  14052. /**
  14053. * How much to randomize the particle direction [0-1].
  14054. */
  14055. directionRandomizer?: number);
  14056. /**
  14057. * Called by the particle System when the direction is computed for the created particle.
  14058. * @param worldMatrix is the world matrix of the particle system
  14059. * @param directionToUpdate is the direction vector to update with the result
  14060. * @param particle is the particle we are computed the direction for
  14061. * @param isLocal defines if the direction should be set in local space
  14062. */
  14063. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14064. /**
  14065. * Called by the particle System when the position is computed for the created particle.
  14066. * @param worldMatrix is the world matrix of the particle system
  14067. * @param positionToUpdate is the position vector to update with the result
  14068. * @param particle is the particle we are computed the position for
  14069. * @param isLocal defines if the position should be set in local space
  14070. */
  14071. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14072. /**
  14073. * Clones the current emitter and returns a copy of it
  14074. * @returns the new emitter
  14075. */
  14076. clone(): SphereParticleEmitter;
  14077. /**
  14078. * Called by the GPUParticleSystem to setup the update shader
  14079. * @param effect defines the update shader
  14080. */
  14081. applyToShader(effect: Effect): void;
  14082. /**
  14083. * Returns a string to use to update the GPU particles update shader
  14084. * @returns a string containng the defines string
  14085. */
  14086. getEffectDefines(): string;
  14087. /**
  14088. * Returns the string "SphereParticleEmitter"
  14089. * @returns a string containing the class name
  14090. */
  14091. getClassName(): string;
  14092. /**
  14093. * Serializes the particle system to a JSON object.
  14094. * @returns the JSON object
  14095. */
  14096. serialize(): any;
  14097. /**
  14098. * Parse properties from a JSON object
  14099. * @param serializationObject defines the JSON object
  14100. */
  14101. parse(serializationObject: any): void;
  14102. }
  14103. /**
  14104. * Particle emitter emitting particles from the inside of a sphere.
  14105. * It emits the particles randomly between two vectors.
  14106. */
  14107. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14108. /**
  14109. * The min limit of the emission direction.
  14110. */
  14111. direction1: Vector3;
  14112. /**
  14113. * The max limit of the emission direction.
  14114. */
  14115. direction2: Vector3;
  14116. /**
  14117. * Creates a new instance SphereDirectedParticleEmitter
  14118. * @param radius the radius of the emission sphere (1 by default)
  14119. * @param direction1 the min limit of the emission direction (up vector by default)
  14120. * @param direction2 the max limit of the emission direction (up vector by default)
  14121. */
  14122. constructor(radius?: number,
  14123. /**
  14124. * The min limit of the emission direction.
  14125. */
  14126. direction1?: Vector3,
  14127. /**
  14128. * The max limit of the emission direction.
  14129. */
  14130. direction2?: Vector3);
  14131. /**
  14132. * Called by the particle System when the direction is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param directionToUpdate is the direction vector to update with the result
  14135. * @param particle is the particle we are computed the direction for
  14136. */
  14137. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14138. /**
  14139. * Clones the current emitter and returns a copy of it
  14140. * @returns the new emitter
  14141. */
  14142. clone(): SphereDirectedParticleEmitter;
  14143. /**
  14144. * Called by the GPUParticleSystem to setup the update shader
  14145. * @param effect defines the update shader
  14146. */
  14147. applyToShader(effect: Effect): void;
  14148. /**
  14149. * Returns a string to use to update the GPU particles update shader
  14150. * @returns a string containng the defines string
  14151. */
  14152. getEffectDefines(): string;
  14153. /**
  14154. * Returns the string "SphereDirectedParticleEmitter"
  14155. * @returns a string containing the class name
  14156. */
  14157. getClassName(): string;
  14158. /**
  14159. * Serializes the particle system to a JSON object.
  14160. * @returns the JSON object
  14161. */
  14162. serialize(): any;
  14163. /**
  14164. * Parse properties from a JSON object
  14165. * @param serializationObject defines the JSON object
  14166. */
  14167. parse(serializationObject: any): void;
  14168. }
  14169. }
  14170. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14171. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14172. import { Effect } from "babylonjs/Materials/effect";
  14173. import { Particle } from "babylonjs/Particles/particle";
  14174. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14175. import { Nullable } from "babylonjs/types";
  14176. /**
  14177. * Particle emitter emitting particles from a custom list of positions.
  14178. */
  14179. export class CustomParticleEmitter implements IParticleEmitterType {
  14180. /**
  14181. * Gets or sets the position generator that will create the inital position of each particle.
  14182. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14183. */
  14184. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14185. /**
  14186. * Gets or sets the destination generator that will create the final destination of each particle.
  14187. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14188. */
  14189. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14190. /**
  14191. * Creates a new instance CustomParticleEmitter
  14192. */
  14193. constructor();
  14194. /**
  14195. * Called by the particle System when the direction is computed for the created particle.
  14196. * @param worldMatrix is the world matrix of the particle system
  14197. * @param directionToUpdate is the direction vector to update with the result
  14198. * @param particle is the particle we are computed the direction for
  14199. * @param isLocal defines if the direction should be set in local space
  14200. */
  14201. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14202. /**
  14203. * Called by the particle System when the position is computed for the created particle.
  14204. * @param worldMatrix is the world matrix of the particle system
  14205. * @param positionToUpdate is the position vector to update with the result
  14206. * @param particle is the particle we are computed the position for
  14207. * @param isLocal defines if the position should be set in local space
  14208. */
  14209. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14210. /**
  14211. * Clones the current emitter and returns a copy of it
  14212. * @returns the new emitter
  14213. */
  14214. clone(): CustomParticleEmitter;
  14215. /**
  14216. * Called by the GPUParticleSystem to setup the update shader
  14217. * @param effect defines the update shader
  14218. */
  14219. applyToShader(effect: Effect): void;
  14220. /**
  14221. * Returns a string to use to update the GPU particles update shader
  14222. * @returns a string containng the defines string
  14223. */
  14224. getEffectDefines(): string;
  14225. /**
  14226. * Returns the string "PointParticleEmitter"
  14227. * @returns a string containing the class name
  14228. */
  14229. getClassName(): string;
  14230. /**
  14231. * Serializes the particle system to a JSON object.
  14232. * @returns the JSON object
  14233. */
  14234. serialize(): any;
  14235. /**
  14236. * Parse properties from a JSON object
  14237. * @param serializationObject defines the JSON object
  14238. */
  14239. parse(serializationObject: any): void;
  14240. }
  14241. }
  14242. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14243. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14244. import { Effect } from "babylonjs/Materials/effect";
  14245. import { Particle } from "babylonjs/Particles/particle";
  14246. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14247. import { Nullable } from "babylonjs/types";
  14248. import { Scene } from "babylonjs/scene";
  14249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14250. /**
  14251. * Particle emitter emitting particles from the inside of a box.
  14252. * It emits the particles randomly between 2 given directions.
  14253. */
  14254. export class MeshParticleEmitter implements IParticleEmitterType {
  14255. private _indices;
  14256. private _positions;
  14257. private _normals;
  14258. private _storedNormal;
  14259. private _mesh;
  14260. /**
  14261. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14262. */
  14263. direction1: Vector3;
  14264. /**
  14265. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14266. */
  14267. direction2: Vector3;
  14268. /**
  14269. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14270. */
  14271. useMeshNormalsForDirection: boolean;
  14272. /** Defines the mesh to use as source */
  14273. get mesh(): Nullable<AbstractMesh>;
  14274. set mesh(value: Nullable<AbstractMesh>);
  14275. /**
  14276. * Creates a new instance MeshParticleEmitter
  14277. * @param mesh defines the mesh to use as source
  14278. */
  14279. constructor(mesh?: Nullable<AbstractMesh>);
  14280. /**
  14281. * Called by the particle System when the direction is computed for the created particle.
  14282. * @param worldMatrix is the world matrix of the particle system
  14283. * @param directionToUpdate is the direction vector to update with the result
  14284. * @param particle is the particle we are computed the direction for
  14285. * @param isLocal defines if the direction should be set in local space
  14286. */
  14287. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14288. /**
  14289. * Called by the particle System when the position is computed for the created particle.
  14290. * @param worldMatrix is the world matrix of the particle system
  14291. * @param positionToUpdate is the position vector to update with the result
  14292. * @param particle is the particle we are computed the position for
  14293. * @param isLocal defines if the position should be set in local space
  14294. */
  14295. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14296. /**
  14297. * Clones the current emitter and returns a copy of it
  14298. * @returns the new emitter
  14299. */
  14300. clone(): MeshParticleEmitter;
  14301. /**
  14302. * Called by the GPUParticleSystem to setup the update shader
  14303. * @param effect defines the update shader
  14304. */
  14305. applyToShader(effect: Effect): void;
  14306. /**
  14307. * Returns a string to use to update the GPU particles update shader
  14308. * @returns a string containng the defines string
  14309. */
  14310. getEffectDefines(): string;
  14311. /**
  14312. * Returns the string "BoxParticleEmitter"
  14313. * @returns a string containing the class name
  14314. */
  14315. getClassName(): string;
  14316. /**
  14317. * Serializes the particle system to a JSON object.
  14318. * @returns the JSON object
  14319. */
  14320. serialize(): any;
  14321. /**
  14322. * Parse properties from a JSON object
  14323. * @param serializationObject defines the JSON object
  14324. * @param scene defines the hosting scene
  14325. */
  14326. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14327. }
  14328. }
  14329. declare module "babylonjs/Particles/EmitterTypes/index" {
  14330. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14331. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14332. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14333. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14334. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14335. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14336. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14337. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14338. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14339. }
  14340. declare module "babylonjs/Particles/IParticleSystem" {
  14341. import { Nullable } from "babylonjs/types";
  14342. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14343. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14345. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14346. import { Scene } from "babylonjs/scene";
  14347. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14348. import { Effect } from "babylonjs/Materials/effect";
  14349. import { Observable } from "babylonjs/Misc/observable";
  14350. import { Animation } from "babylonjs/Animations/animation";
  14351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14352. /**
  14353. * Interface representing a particle system in Babylon.js.
  14354. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14355. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14356. */
  14357. export interface IParticleSystem {
  14358. /**
  14359. * List of animations used by the particle system.
  14360. */
  14361. animations: Animation[];
  14362. /**
  14363. * The id of the Particle system.
  14364. */
  14365. id: string;
  14366. /**
  14367. * The name of the Particle system.
  14368. */
  14369. name: string;
  14370. /**
  14371. * The emitter represents the Mesh or position we are attaching the particle system to.
  14372. */
  14373. emitter: Nullable<AbstractMesh | Vector3>;
  14374. /**
  14375. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14376. */
  14377. isBillboardBased: boolean;
  14378. /**
  14379. * The rendering group used by the Particle system to chose when to render.
  14380. */
  14381. renderingGroupId: number;
  14382. /**
  14383. * The layer mask we are rendering the particles through.
  14384. */
  14385. layerMask: number;
  14386. /**
  14387. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14388. */
  14389. updateSpeed: number;
  14390. /**
  14391. * The amount of time the particle system is running (depends of the overall update speed).
  14392. */
  14393. targetStopDuration: number;
  14394. /**
  14395. * The texture used to render each particle. (this can be a spritesheet)
  14396. */
  14397. particleTexture: Nullable<BaseTexture>;
  14398. /**
  14399. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14400. */
  14401. blendMode: number;
  14402. /**
  14403. * Minimum life time of emitting particles.
  14404. */
  14405. minLifeTime: number;
  14406. /**
  14407. * Maximum life time of emitting particles.
  14408. */
  14409. maxLifeTime: number;
  14410. /**
  14411. * Minimum Size of emitting particles.
  14412. */
  14413. minSize: number;
  14414. /**
  14415. * Maximum Size of emitting particles.
  14416. */
  14417. maxSize: number;
  14418. /**
  14419. * Minimum scale of emitting particles on X axis.
  14420. */
  14421. minScaleX: number;
  14422. /**
  14423. * Maximum scale of emitting particles on X axis.
  14424. */
  14425. maxScaleX: number;
  14426. /**
  14427. * Minimum scale of emitting particles on Y axis.
  14428. */
  14429. minScaleY: number;
  14430. /**
  14431. * Maximum scale of emitting particles on Y axis.
  14432. */
  14433. maxScaleY: number;
  14434. /**
  14435. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14436. */
  14437. color1: Color4;
  14438. /**
  14439. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14440. */
  14441. color2: Color4;
  14442. /**
  14443. * Color the particle will have at the end of its lifetime.
  14444. */
  14445. colorDead: Color4;
  14446. /**
  14447. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14448. */
  14449. emitRate: number;
  14450. /**
  14451. * You can use gravity if you want to give an orientation to your particles.
  14452. */
  14453. gravity: Vector3;
  14454. /**
  14455. * Minimum power of emitting particles.
  14456. */
  14457. minEmitPower: number;
  14458. /**
  14459. * Maximum power of emitting particles.
  14460. */
  14461. maxEmitPower: number;
  14462. /**
  14463. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14464. */
  14465. minAngularSpeed: number;
  14466. /**
  14467. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14468. */
  14469. maxAngularSpeed: number;
  14470. /**
  14471. * Gets or sets the minimal initial rotation in radians.
  14472. */
  14473. minInitialRotation: number;
  14474. /**
  14475. * Gets or sets the maximal initial rotation in radians.
  14476. */
  14477. maxInitialRotation: number;
  14478. /**
  14479. * The particle emitter type defines the emitter used by the particle system.
  14480. * It can be for example box, sphere, or cone...
  14481. */
  14482. particleEmitterType: Nullable<IParticleEmitterType>;
  14483. /**
  14484. * Defines the delay in milliseconds before starting the system (0 by default)
  14485. */
  14486. startDelay: number;
  14487. /**
  14488. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  14489. */
  14490. preWarmCycles: number;
  14491. /**
  14492. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14493. */
  14494. preWarmStepOffset: number;
  14495. /**
  14496. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  14497. */
  14498. spriteCellChangeSpeed: number;
  14499. /**
  14500. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14501. */
  14502. startSpriteCellID: number;
  14503. /**
  14504. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14505. */
  14506. endSpriteCellID: number;
  14507. /**
  14508. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14509. */
  14510. spriteCellWidth: number;
  14511. /**
  14512. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14513. */
  14514. spriteCellHeight: number;
  14515. /**
  14516. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14517. */
  14518. spriteRandomStartCell: boolean;
  14519. /**
  14520. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14521. */
  14522. isAnimationSheetEnabled: boolean;
  14523. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14524. translationPivot: Vector2;
  14525. /**
  14526. * Gets or sets a texture used to add random noise to particle positions
  14527. */
  14528. noiseTexture: Nullable<BaseTexture>;
  14529. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14530. noiseStrength: Vector3;
  14531. /**
  14532. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14533. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14534. */
  14535. billboardMode: number;
  14536. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14537. limitVelocityDamping: number;
  14538. /**
  14539. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14540. */
  14541. beginAnimationOnStart: boolean;
  14542. /**
  14543. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14544. */
  14545. beginAnimationFrom: number;
  14546. /**
  14547. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14548. */
  14549. beginAnimationTo: number;
  14550. /**
  14551. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14552. */
  14553. beginAnimationLoop: boolean;
  14554. /**
  14555. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14556. */
  14557. disposeOnStop: boolean;
  14558. /**
  14559. * Specifies if the particles are updated in emitter local space or world space
  14560. */
  14561. isLocal: boolean;
  14562. /** Snippet ID if the particle system was created from the snippet server */
  14563. snippetId: string;
  14564. /** Gets or sets a matrix to use to compute projection */
  14565. defaultProjectionMatrix: Matrix;
  14566. /**
  14567. * Gets the maximum number of particles active at the same time.
  14568. * @returns The max number of active particles.
  14569. */
  14570. getCapacity(): number;
  14571. /**
  14572. * Gets the number of particles active at the same time.
  14573. * @returns The number of active particles.
  14574. */
  14575. getActiveCount(): number;
  14576. /**
  14577. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14578. * @returns True if it has been started, otherwise false.
  14579. */
  14580. isStarted(): boolean;
  14581. /**
  14582. * Animates the particle system for this frame.
  14583. */
  14584. animate(): void;
  14585. /**
  14586. * Renders the particle system in its current state.
  14587. * @returns the current number of particles
  14588. */
  14589. render(): number;
  14590. /**
  14591. * Dispose the particle system and frees its associated resources.
  14592. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14593. */
  14594. dispose(disposeTexture?: boolean): void;
  14595. /**
  14596. * An event triggered when the system is disposed
  14597. */
  14598. onDisposeObservable: Observable<IParticleSystem>;
  14599. /**
  14600. * Clones the particle system.
  14601. * @param name The name of the cloned object
  14602. * @param newEmitter The new emitter to use
  14603. * @returns the cloned particle system
  14604. */
  14605. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14606. /**
  14607. * Serializes the particle system to a JSON object
  14608. * @param serializeTexture defines if the texture must be serialized as well
  14609. * @returns the JSON object
  14610. */
  14611. serialize(serializeTexture: boolean): any;
  14612. /**
  14613. * Rebuild the particle system
  14614. */
  14615. rebuild(): void;
  14616. /** Force the system to rebuild all gradients that need to be resync */
  14617. forceRefreshGradients(): void;
  14618. /**
  14619. * Starts the particle system and begins to emit
  14620. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14621. */
  14622. start(delay?: number): void;
  14623. /**
  14624. * Stops the particle system.
  14625. */
  14626. stop(): void;
  14627. /**
  14628. * Remove all active particles
  14629. */
  14630. reset(): void;
  14631. /**
  14632. * Gets a boolean indicating that the system is stopping
  14633. * @returns true if the system is currently stopping
  14634. */
  14635. isStopping(): boolean;
  14636. /**
  14637. * Is this system ready to be used/rendered
  14638. * @return true if the system is ready
  14639. */
  14640. isReady(): boolean;
  14641. /**
  14642. * Returns the string "ParticleSystem"
  14643. * @returns a string containing the class name
  14644. */
  14645. getClassName(): string;
  14646. /**
  14647. * Gets the custom effect used to render the particles
  14648. * @param blendMode Blend mode for which the effect should be retrieved
  14649. * @returns The effect
  14650. */
  14651. getCustomEffect(blendMode: number): Nullable<Effect>;
  14652. /**
  14653. * Sets the custom effect used to render the particles
  14654. * @param effect The effect to set
  14655. * @param blendMode Blend mode for which the effect should be set
  14656. */
  14657. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14658. /**
  14659. * Fill the defines array according to the current settings of the particle system
  14660. * @param defines Array to be updated
  14661. * @param blendMode blend mode to take into account when updating the array
  14662. */
  14663. fillDefines(defines: Array<string>, blendMode: number): void;
  14664. /**
  14665. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14666. * @param uniforms Uniforms array to fill
  14667. * @param attributes Attributes array to fill
  14668. * @param samplers Samplers array to fill
  14669. */
  14670. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14671. /**
  14672. * Observable that will be called just before the particles are drawn
  14673. */
  14674. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14675. /**
  14676. * Gets the name of the particle vertex shader
  14677. */
  14678. vertexShaderName: string;
  14679. /**
  14680. * Adds a new color gradient
  14681. * @param gradient defines the gradient to use (between 0 and 1)
  14682. * @param color1 defines the color to affect to the specified gradient
  14683. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14684. * @returns the current particle system
  14685. */
  14686. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14687. /**
  14688. * Remove a specific color gradient
  14689. * @param gradient defines the gradient to remove
  14690. * @returns the current particle system
  14691. */
  14692. removeColorGradient(gradient: number): IParticleSystem;
  14693. /**
  14694. * Adds a new size gradient
  14695. * @param gradient defines the gradient to use (between 0 and 1)
  14696. * @param factor defines the size factor to affect to the specified gradient
  14697. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14698. * @returns the current particle system
  14699. */
  14700. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14701. /**
  14702. * Remove a specific size gradient
  14703. * @param gradient defines the gradient to remove
  14704. * @returns the current particle system
  14705. */
  14706. removeSizeGradient(gradient: number): IParticleSystem;
  14707. /**
  14708. * Gets the current list of color gradients.
  14709. * You must use addColorGradient and removeColorGradient to udpate this list
  14710. * @returns the list of color gradients
  14711. */
  14712. getColorGradients(): Nullable<Array<ColorGradient>>;
  14713. /**
  14714. * Gets the current list of size gradients.
  14715. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14716. * @returns the list of size gradients
  14717. */
  14718. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14719. /**
  14720. * Gets the current list of angular speed gradients.
  14721. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14722. * @returns the list of angular speed gradients
  14723. */
  14724. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14725. /**
  14726. * Adds a new angular speed gradient
  14727. * @param gradient defines the gradient to use (between 0 and 1)
  14728. * @param factor defines the angular speed to affect to the specified gradient
  14729. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14730. * @returns the current particle system
  14731. */
  14732. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14733. /**
  14734. * Remove a specific angular speed gradient
  14735. * @param gradient defines the gradient to remove
  14736. * @returns the current particle system
  14737. */
  14738. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14739. /**
  14740. * Gets the current list of velocity gradients.
  14741. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14742. * @returns the list of velocity gradients
  14743. */
  14744. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14745. /**
  14746. * Adds a new velocity gradient
  14747. * @param gradient defines the gradient to use (between 0 and 1)
  14748. * @param factor defines the velocity to affect to the specified gradient
  14749. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14750. * @returns the current particle system
  14751. */
  14752. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14753. /**
  14754. * Remove a specific velocity gradient
  14755. * @param gradient defines the gradient to remove
  14756. * @returns the current particle system
  14757. */
  14758. removeVelocityGradient(gradient: number): IParticleSystem;
  14759. /**
  14760. * Gets the current list of limit velocity gradients.
  14761. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14762. * @returns the list of limit velocity gradients
  14763. */
  14764. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14765. /**
  14766. * Adds a new limit velocity gradient
  14767. * @param gradient defines the gradient to use (between 0 and 1)
  14768. * @param factor defines the limit velocity to affect to the specified gradient
  14769. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14770. * @returns the current particle system
  14771. */
  14772. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14773. /**
  14774. * Remove a specific limit velocity gradient
  14775. * @param gradient defines the gradient to remove
  14776. * @returns the current particle system
  14777. */
  14778. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14779. /**
  14780. * Adds a new drag gradient
  14781. * @param gradient defines the gradient to use (between 0 and 1)
  14782. * @param factor defines the drag to affect to the specified gradient
  14783. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14784. * @returns the current particle system
  14785. */
  14786. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14787. /**
  14788. * Remove a specific drag gradient
  14789. * @param gradient defines the gradient to remove
  14790. * @returns the current particle system
  14791. */
  14792. removeDragGradient(gradient: number): IParticleSystem;
  14793. /**
  14794. * Gets the current list of drag gradients.
  14795. * You must use addDragGradient and removeDragGradient to udpate this list
  14796. * @returns the list of drag gradients
  14797. */
  14798. getDragGradients(): Nullable<Array<FactorGradient>>;
  14799. /**
  14800. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14801. * @param gradient defines the gradient to use (between 0 and 1)
  14802. * @param factor defines the emit rate to affect to the specified gradient
  14803. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14804. * @returns the current particle system
  14805. */
  14806. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14807. /**
  14808. * Remove a specific emit rate gradient
  14809. * @param gradient defines the gradient to remove
  14810. * @returns the current particle system
  14811. */
  14812. removeEmitRateGradient(gradient: number): IParticleSystem;
  14813. /**
  14814. * Gets the current list of emit rate gradients.
  14815. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14816. * @returns the list of emit rate gradients
  14817. */
  14818. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14819. /**
  14820. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14821. * @param gradient defines the gradient to use (between 0 and 1)
  14822. * @param factor defines the start size to affect to the specified gradient
  14823. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14824. * @returns the current particle system
  14825. */
  14826. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14827. /**
  14828. * Remove a specific start size gradient
  14829. * @param gradient defines the gradient to remove
  14830. * @returns the current particle system
  14831. */
  14832. removeStartSizeGradient(gradient: number): IParticleSystem;
  14833. /**
  14834. * Gets the current list of start size gradients.
  14835. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14836. * @returns the list of start size gradients
  14837. */
  14838. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14839. /**
  14840. * Adds a new life time gradient
  14841. * @param gradient defines the gradient to use (between 0 and 1)
  14842. * @param factor defines the life time factor to affect to the specified gradient
  14843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14844. * @returns the current particle system
  14845. */
  14846. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14847. /**
  14848. * Remove a specific life time gradient
  14849. * @param gradient defines the gradient to remove
  14850. * @returns the current particle system
  14851. */
  14852. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14853. /**
  14854. * Gets the current list of life time gradients.
  14855. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14856. * @returns the list of life time gradients
  14857. */
  14858. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14859. /**
  14860. * Gets the current list of color gradients.
  14861. * You must use addColorGradient and removeColorGradient to udpate this list
  14862. * @returns the list of color gradients
  14863. */
  14864. getColorGradients(): Nullable<Array<ColorGradient>>;
  14865. /**
  14866. * Adds a new ramp gradient used to remap particle colors
  14867. * @param gradient defines the gradient to use (between 0 and 1)
  14868. * @param color defines the color to affect to the specified gradient
  14869. * @returns the current particle system
  14870. */
  14871. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14872. /**
  14873. * Gets the current list of ramp gradients.
  14874. * You must use addRampGradient and removeRampGradient to udpate this list
  14875. * @returns the list of ramp gradients
  14876. */
  14877. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14878. /** Gets or sets a boolean indicating that ramp gradients must be used
  14879. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14880. */
  14881. useRampGradients: boolean;
  14882. /**
  14883. * Adds a new color remap gradient
  14884. * @param gradient defines the gradient to use (between 0 and 1)
  14885. * @param min defines the color remap minimal range
  14886. * @param max defines the color remap maximal range
  14887. * @returns the current particle system
  14888. */
  14889. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14890. /**
  14891. * Gets the current list of color remap gradients.
  14892. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14893. * @returns the list of color remap gradients
  14894. */
  14895. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14896. /**
  14897. * Adds a new alpha remap gradient
  14898. * @param gradient defines the gradient to use (between 0 and 1)
  14899. * @param min defines the alpha remap minimal range
  14900. * @param max defines the alpha remap maximal range
  14901. * @returns the current particle system
  14902. */
  14903. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14904. /**
  14905. * Gets the current list of alpha remap gradients.
  14906. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14907. * @returns the list of alpha remap gradients
  14908. */
  14909. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14910. /**
  14911. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14912. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14913. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14914. * @returns the emitter
  14915. */
  14916. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14917. /**
  14918. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14919. * @param radius The radius of the hemisphere to emit from
  14920. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14921. * @returns the emitter
  14922. */
  14923. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14924. /**
  14925. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14926. * @param radius The radius of the sphere to emit from
  14927. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14928. * @returns the emitter
  14929. */
  14930. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14931. /**
  14932. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14933. * @param radius The radius of the sphere to emit from
  14934. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14935. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14936. * @returns the emitter
  14937. */
  14938. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14939. /**
  14940. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14941. * @param radius The radius of the emission cylinder
  14942. * @param height The height of the emission cylinder
  14943. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14944. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14945. * @returns the emitter
  14946. */
  14947. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14948. /**
  14949. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14950. * @param radius The radius of the cylinder to emit from
  14951. * @param height The height of the emission cylinder
  14952. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14953. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14954. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14955. * @returns the emitter
  14956. */
  14957. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14958. /**
  14959. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14960. * @param radius The radius of the cone to emit from
  14961. * @param angle The base angle of the cone
  14962. * @returns the emitter
  14963. */
  14964. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14965. /**
  14966. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14967. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14968. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14969. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14970. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14971. * @returns the emitter
  14972. */
  14973. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14974. /**
  14975. * Get hosting scene
  14976. * @returns the scene
  14977. */
  14978. getScene(): Nullable<Scene>;
  14979. }
  14980. }
  14981. declare module "babylonjs/Meshes/transformNode" {
  14982. import { DeepImmutable } from "babylonjs/types";
  14983. import { Observable } from "babylonjs/Misc/observable";
  14984. import { Nullable } from "babylonjs/types";
  14985. import { Camera } from "babylonjs/Cameras/camera";
  14986. import { Scene } from "babylonjs/scene";
  14987. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14988. import { Node } from "babylonjs/node";
  14989. import { Bone } from "babylonjs/Bones/bone";
  14990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14991. import { Space } from "babylonjs/Maths/math.axis";
  14992. /**
  14993. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  14994. * @see https://doc.babylonjs.com/how_to/transformnode
  14995. */
  14996. export class TransformNode extends Node {
  14997. /**
  14998. * Object will not rotate to face the camera
  14999. */
  15000. static BILLBOARDMODE_NONE: number;
  15001. /**
  15002. * Object will rotate to face the camera but only on the x axis
  15003. */
  15004. static BILLBOARDMODE_X: number;
  15005. /**
  15006. * Object will rotate to face the camera but only on the y axis
  15007. */
  15008. static BILLBOARDMODE_Y: number;
  15009. /**
  15010. * Object will rotate to face the camera but only on the z axis
  15011. */
  15012. static BILLBOARDMODE_Z: number;
  15013. /**
  15014. * Object will rotate to face the camera
  15015. */
  15016. static BILLBOARDMODE_ALL: number;
  15017. /**
  15018. * Object will rotate to face the camera's position instead of orientation
  15019. */
  15020. static BILLBOARDMODE_USE_POSITION: number;
  15021. private static _TmpRotation;
  15022. private static _TmpScaling;
  15023. private static _TmpTranslation;
  15024. private _forward;
  15025. private _forwardInverted;
  15026. private _up;
  15027. private _right;
  15028. private _rightInverted;
  15029. private _position;
  15030. private _rotation;
  15031. private _rotationQuaternion;
  15032. protected _scaling: Vector3;
  15033. protected _isDirty: boolean;
  15034. private _transformToBoneReferal;
  15035. private _isAbsoluteSynced;
  15036. private _billboardMode;
  15037. /**
  15038. * Gets or sets the billboard mode. Default is 0.
  15039. *
  15040. * | Value | Type | Description |
  15041. * | --- | --- | --- |
  15042. * | 0 | BILLBOARDMODE_NONE | |
  15043. * | 1 | BILLBOARDMODE_X | |
  15044. * | 2 | BILLBOARDMODE_Y | |
  15045. * | 4 | BILLBOARDMODE_Z | |
  15046. * | 7 | BILLBOARDMODE_ALL | |
  15047. *
  15048. */
  15049. get billboardMode(): number;
  15050. set billboardMode(value: number);
  15051. private _preserveParentRotationForBillboard;
  15052. /**
  15053. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15054. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15055. */
  15056. get preserveParentRotationForBillboard(): boolean;
  15057. set preserveParentRotationForBillboard(value: boolean);
  15058. /**
  15059. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  15060. */
  15061. scalingDeterminant: number;
  15062. private _infiniteDistance;
  15063. /**
  15064. * Gets or sets the distance of the object to max, often used by skybox
  15065. */
  15066. get infiniteDistance(): boolean;
  15067. set infiniteDistance(value: boolean);
  15068. /**
  15069. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15070. * By default the system will update normals to compensate
  15071. */
  15072. ignoreNonUniformScaling: boolean;
  15073. /**
  15074. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  15075. */
  15076. reIntegrateRotationIntoRotationQuaternion: boolean;
  15077. /** @hidden */
  15078. _poseMatrix: Nullable<Matrix>;
  15079. /** @hidden */
  15080. _localMatrix: Matrix;
  15081. private _usePivotMatrix;
  15082. private _absolutePosition;
  15083. private _absoluteScaling;
  15084. private _absoluteRotationQuaternion;
  15085. private _pivotMatrix;
  15086. private _pivotMatrixInverse;
  15087. protected _postMultiplyPivotMatrix: boolean;
  15088. protected _isWorldMatrixFrozen: boolean;
  15089. /** @hidden */
  15090. _indexInSceneTransformNodesArray: number;
  15091. /**
  15092. * An event triggered after the world matrix is updated
  15093. */
  15094. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15095. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15096. /**
  15097. * Gets a string identifying the name of the class
  15098. * @returns "TransformNode" string
  15099. */
  15100. getClassName(): string;
  15101. /**
  15102. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15103. */
  15104. get position(): Vector3;
  15105. set position(newPosition: Vector3);
  15106. /**
  15107. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15108. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15109. */
  15110. get rotation(): Vector3;
  15111. set rotation(newRotation: Vector3);
  15112. /**
  15113. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15114. */
  15115. get scaling(): Vector3;
  15116. set scaling(newScaling: Vector3);
  15117. /**
  15118. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  15119. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15120. */
  15121. get rotationQuaternion(): Nullable<Quaternion>;
  15122. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15123. /**
  15124. * The forward direction of that transform in world space.
  15125. */
  15126. get forward(): Vector3;
  15127. /**
  15128. * The up direction of that transform in world space.
  15129. */
  15130. get up(): Vector3;
  15131. /**
  15132. * The right direction of that transform in world space.
  15133. */
  15134. get right(): Vector3;
  15135. /**
  15136. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15137. * @param matrix the matrix to copy the pose from
  15138. * @returns this TransformNode.
  15139. */
  15140. updatePoseMatrix(matrix: Matrix): TransformNode;
  15141. /**
  15142. * Returns the mesh Pose matrix.
  15143. * @returns the pose matrix
  15144. */
  15145. getPoseMatrix(): Matrix;
  15146. /** @hidden */
  15147. _isSynchronized(): boolean;
  15148. /** @hidden */
  15149. _initCache(): void;
  15150. /**
  15151. * Flag the transform node as dirty (Forcing it to update everything)
  15152. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15153. * @returns this transform node
  15154. */
  15155. markAsDirty(property: string): TransformNode;
  15156. /**
  15157. * Returns the current mesh absolute position.
  15158. * Returns a Vector3.
  15159. */
  15160. get absolutePosition(): Vector3;
  15161. /**
  15162. * Returns the current mesh absolute scaling.
  15163. * Returns a Vector3.
  15164. */
  15165. get absoluteScaling(): Vector3;
  15166. /**
  15167. * Returns the current mesh absolute rotation.
  15168. * Returns a Quaternion.
  15169. */
  15170. get absoluteRotationQuaternion(): Quaternion;
  15171. /**
  15172. * Sets a new matrix to apply before all other transformation
  15173. * @param matrix defines the transform matrix
  15174. * @returns the current TransformNode
  15175. */
  15176. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15177. /**
  15178. * Sets a new pivot matrix to the current node
  15179. * @param matrix defines the new pivot matrix to use
  15180. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  15181. * @returns the current TransformNode
  15182. */
  15183. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15184. /**
  15185. * Returns the mesh pivot matrix.
  15186. * Default : Identity.
  15187. * @returns the matrix
  15188. */
  15189. getPivotMatrix(): Matrix;
  15190. /**
  15191. * Instantiate (when possible) or clone that node with its hierarchy
  15192. * @param newParent defines the new parent to use for the instance (or clone)
  15193. * @param options defines options to configure how copy is done
  15194. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15195. * @returns an instance (or a clone) of the current node with its hiearchy
  15196. */
  15197. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15198. doNotInstantiate: boolean;
  15199. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15200. /**
  15201. * Prevents the World matrix to be computed any longer
  15202. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15203. * @returns the TransformNode.
  15204. */
  15205. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15206. /**
  15207. * Allows back the World matrix computation.
  15208. * @returns the TransformNode.
  15209. */
  15210. unfreezeWorldMatrix(): this;
  15211. /**
  15212. * True if the World matrix has been frozen.
  15213. */
  15214. get isWorldMatrixFrozen(): boolean;
  15215. /**
  15216. * Retuns the mesh absolute position in the World.
  15217. * @returns a Vector3.
  15218. */
  15219. getAbsolutePosition(): Vector3;
  15220. /**
  15221. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15222. * @param absolutePosition the absolute position to set
  15223. * @returns the TransformNode.
  15224. */
  15225. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15226. /**
  15227. * Sets the mesh position in its local space.
  15228. * @param vector3 the position to set in localspace
  15229. * @returns the TransformNode.
  15230. */
  15231. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15232. /**
  15233. * Returns the mesh position in the local space from the current World matrix values.
  15234. * @returns a new Vector3.
  15235. */
  15236. getPositionExpressedInLocalSpace(): Vector3;
  15237. /**
  15238. * Translates the mesh along the passed Vector3 in its local space.
  15239. * @param vector3 the distance to translate in localspace
  15240. * @returns the TransformNode.
  15241. */
  15242. locallyTranslate(vector3: Vector3): TransformNode;
  15243. private static _lookAtVectorCache;
  15244. /**
  15245. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15246. * @param targetPoint the position (must be in same space as current mesh) to look at
  15247. * @param yawCor optional yaw (y-axis) correction in radians
  15248. * @param pitchCor optional pitch (x-axis) correction in radians
  15249. * @param rollCor optional roll (z-axis) correction in radians
  15250. * @param space the choosen space of the target
  15251. * @returns the TransformNode.
  15252. */
  15253. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15254. /**
  15255. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15256. * This Vector3 is expressed in the World space.
  15257. * @param localAxis axis to rotate
  15258. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15259. */
  15260. getDirection(localAxis: Vector3): Vector3;
  15261. /**
  15262. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15263. * localAxis is expressed in the mesh local space.
  15264. * result is computed in the Wordl space from the mesh World matrix.
  15265. * @param localAxis axis to rotate
  15266. * @param result the resulting transformnode
  15267. * @returns this TransformNode.
  15268. */
  15269. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15270. /**
  15271. * Sets this transform node rotation to the given local axis.
  15272. * @param localAxis the axis in local space
  15273. * @param yawCor optional yaw (y-axis) correction in radians
  15274. * @param pitchCor optional pitch (x-axis) correction in radians
  15275. * @param rollCor optional roll (z-axis) correction in radians
  15276. * @returns this TransformNode
  15277. */
  15278. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15279. /**
  15280. * Sets a new pivot point to the current node
  15281. * @param point defines the new pivot point to use
  15282. * @param space defines if the point is in world or local space (local by default)
  15283. * @returns the current TransformNode
  15284. */
  15285. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15286. /**
  15287. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15288. * @returns the pivot point
  15289. */
  15290. getPivotPoint(): Vector3;
  15291. /**
  15292. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15293. * @param result the vector3 to store the result
  15294. * @returns this TransformNode.
  15295. */
  15296. getPivotPointToRef(result: Vector3): TransformNode;
  15297. /**
  15298. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15299. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15300. */
  15301. getAbsolutePivotPoint(): Vector3;
  15302. /**
  15303. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15304. * @param result vector3 to store the result
  15305. * @returns this TransformNode.
  15306. */
  15307. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15308. /**
  15309. * Defines the passed node as the parent of the current node.
  15310. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15311. * @see https://doc.babylonjs.com/how_to/parenting
  15312. * @param node the node ot set as the parent
  15313. * @returns this TransformNode.
  15314. */
  15315. setParent(node: Nullable<Node>): TransformNode;
  15316. private _nonUniformScaling;
  15317. /**
  15318. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15319. */
  15320. get nonUniformScaling(): boolean;
  15321. /** @hidden */
  15322. _updateNonUniformScalingState(value: boolean): boolean;
  15323. /**
  15324. * Attach the current TransformNode to another TransformNode associated with a bone
  15325. * @param bone Bone affecting the TransformNode
  15326. * @param affectedTransformNode TransformNode associated with the bone
  15327. * @returns this object
  15328. */
  15329. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15330. /**
  15331. * Detach the transform node if its associated with a bone
  15332. * @returns this object
  15333. */
  15334. detachFromBone(): TransformNode;
  15335. private static _rotationAxisCache;
  15336. /**
  15337. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15338. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15339. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15340. * The passed axis is also normalized.
  15341. * @param axis the axis to rotate around
  15342. * @param amount the amount to rotate in radians
  15343. * @param space Space to rotate in (Default: local)
  15344. * @returns the TransformNode.
  15345. */
  15346. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15347. /**
  15348. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15349. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15350. * The passed axis is also normalized. .
  15351. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15352. * @param point the point to rotate around
  15353. * @param axis the axis to rotate around
  15354. * @param amount the amount to rotate in radians
  15355. * @returns the TransformNode
  15356. */
  15357. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15358. /**
  15359. * Translates the mesh along the axis vector for the passed distance in the given space.
  15360. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15361. * @param axis the axis to translate in
  15362. * @param distance the distance to translate
  15363. * @param space Space to rotate in (Default: local)
  15364. * @returns the TransformNode.
  15365. */
  15366. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15367. /**
  15368. * Adds a rotation step to the mesh current rotation.
  15369. * x, y, z are Euler angles expressed in radians.
  15370. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15371. * This means this rotation is made in the mesh local space only.
  15372. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15373. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15374. * ```javascript
  15375. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15376. * ```
  15377. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15378. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  15379. * @param x Rotation to add
  15380. * @param y Rotation to add
  15381. * @param z Rotation to add
  15382. * @returns the TransformNode.
  15383. */
  15384. addRotation(x: number, y: number, z: number): TransformNode;
  15385. /**
  15386. * @hidden
  15387. */
  15388. protected _getEffectiveParent(): Nullable<Node>;
  15389. /**
  15390. * Computes the world matrix of the node
  15391. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15392. * @returns the world matrix
  15393. */
  15394. computeWorldMatrix(force?: boolean): Matrix;
  15395. /**
  15396. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15397. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15398. */
  15399. resetLocalMatrix(independentOfChildren?: boolean): void;
  15400. protected _afterComputeWorldMatrix(): void;
  15401. /**
  15402. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15403. * @param func callback function to add
  15404. *
  15405. * @returns the TransformNode.
  15406. */
  15407. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15408. /**
  15409. * Removes a registered callback function.
  15410. * @param func callback function to remove
  15411. * @returns the TransformNode.
  15412. */
  15413. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15414. /**
  15415. * Gets the position of the current mesh in camera space
  15416. * @param camera defines the camera to use
  15417. * @returns a position
  15418. */
  15419. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15420. /**
  15421. * Returns the distance from the mesh to the active camera
  15422. * @param camera defines the camera to use
  15423. * @returns the distance
  15424. */
  15425. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15426. /**
  15427. * Clone the current transform node
  15428. * @param name Name of the new clone
  15429. * @param newParent New parent for the clone
  15430. * @param doNotCloneChildren Do not clone children hierarchy
  15431. * @returns the new transform node
  15432. */
  15433. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15434. /**
  15435. * Serializes the objects information.
  15436. * @param currentSerializationObject defines the object to serialize in
  15437. * @returns the serialized object
  15438. */
  15439. serialize(currentSerializationObject?: any): any;
  15440. /**
  15441. * Returns a new TransformNode object parsed from the source provided.
  15442. * @param parsedTransformNode is the source.
  15443. * @param scene the scne the object belongs to
  15444. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15445. * @returns a new TransformNode object parsed from the source provided.
  15446. */
  15447. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15448. /**
  15449. * Get all child-transformNodes of this node
  15450. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  15451. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  15452. * @returns an array of TransformNode
  15453. */
  15454. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15455. /**
  15456. * Releases resources associated with this transform node.
  15457. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15458. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15459. */
  15460. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15461. /**
  15462. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15463. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15464. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15465. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15466. * @returns the current mesh
  15467. */
  15468. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15469. private _syncAbsoluteScalingAndRotation;
  15470. }
  15471. }
  15472. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15473. /**
  15474. * Class used to override all child animations of a given target
  15475. */
  15476. export class AnimationPropertiesOverride {
  15477. /**
  15478. * Gets or sets a value indicating if animation blending must be used
  15479. */
  15480. enableBlending: boolean;
  15481. /**
  15482. * Gets or sets the blending speed to use when enableBlending is true
  15483. */
  15484. blendingSpeed: number;
  15485. /**
  15486. * Gets or sets the default loop mode to use
  15487. */
  15488. loopMode: number;
  15489. }
  15490. }
  15491. declare module "babylonjs/Bones/bone" {
  15492. import { Skeleton } from "babylonjs/Bones/skeleton";
  15493. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15494. import { Nullable } from "babylonjs/types";
  15495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15496. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15497. import { Node } from "babylonjs/node";
  15498. import { Space } from "babylonjs/Maths/math.axis";
  15499. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15500. /**
  15501. * Class used to store bone information
  15502. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15503. */
  15504. export class Bone extends Node {
  15505. /**
  15506. * defines the bone name
  15507. */
  15508. name: string;
  15509. private static _tmpVecs;
  15510. private static _tmpQuat;
  15511. private static _tmpMats;
  15512. /**
  15513. * Gets the list of child bones
  15514. */
  15515. children: Bone[];
  15516. /** Gets the animations associated with this bone */
  15517. animations: import("babylonjs/Animations/animation").Animation[];
  15518. /**
  15519. * Gets or sets bone length
  15520. */
  15521. length: number;
  15522. /**
  15523. * @hidden Internal only
  15524. * Set this value to map this bone to a different index in the transform matrices
  15525. * Set this value to -1 to exclude the bone from the transform matrices
  15526. */
  15527. _index: Nullable<number>;
  15528. private _skeleton;
  15529. private _localMatrix;
  15530. private _restPose;
  15531. private _bindPose;
  15532. private _baseMatrix;
  15533. private _absoluteTransform;
  15534. private _invertedAbsoluteTransform;
  15535. private _parent;
  15536. private _scalingDeterminant;
  15537. private _worldTransform;
  15538. private _localScaling;
  15539. private _localRotation;
  15540. private _localPosition;
  15541. private _needToDecompose;
  15542. private _needToCompose;
  15543. /** @hidden */
  15544. _linkedTransformNode: Nullable<TransformNode>;
  15545. /** @hidden */
  15546. _waitingTransformNodeId: Nullable<string>;
  15547. /** @hidden */
  15548. get _matrix(): Matrix;
  15549. /** @hidden */
  15550. set _matrix(value: Matrix);
  15551. /**
  15552. * Create a new bone
  15553. * @param name defines the bone name
  15554. * @param skeleton defines the parent skeleton
  15555. * @param parentBone defines the parent (can be null if the bone is the root)
  15556. * @param localMatrix defines the local matrix
  15557. * @param restPose defines the rest pose matrix
  15558. * @param baseMatrix defines the base matrix
  15559. * @param index defines index of the bone in the hiearchy
  15560. */
  15561. constructor(
  15562. /**
  15563. * defines the bone name
  15564. */
  15565. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15566. /**
  15567. * Gets the current object class name.
  15568. * @return the class name
  15569. */
  15570. getClassName(): string;
  15571. /**
  15572. * Gets the parent skeleton
  15573. * @returns a skeleton
  15574. */
  15575. getSkeleton(): Skeleton;
  15576. /**
  15577. * Gets parent bone
  15578. * @returns a bone or null if the bone is the root of the bone hierarchy
  15579. */
  15580. getParent(): Nullable<Bone>;
  15581. /**
  15582. * Returns an array containing the root bones
  15583. * @returns an array containing the root bones
  15584. */
  15585. getChildren(): Array<Bone>;
  15586. /**
  15587. * Gets the node index in matrix array generated for rendering
  15588. * @returns the node index
  15589. */
  15590. getIndex(): number;
  15591. /**
  15592. * Sets the parent bone
  15593. * @param parent defines the parent (can be null if the bone is the root)
  15594. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15595. */
  15596. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15597. /**
  15598. * Gets the local matrix
  15599. * @returns a matrix
  15600. */
  15601. getLocalMatrix(): Matrix;
  15602. /**
  15603. * Gets the base matrix (initial matrix which remains unchanged)
  15604. * @returns a matrix
  15605. */
  15606. getBaseMatrix(): Matrix;
  15607. /**
  15608. * Gets the rest pose matrix
  15609. * @returns a matrix
  15610. */
  15611. getRestPose(): Matrix;
  15612. /**
  15613. * Sets the rest pose matrix
  15614. * @param matrix the local-space rest pose to set for this bone
  15615. */
  15616. setRestPose(matrix: Matrix): void;
  15617. /**
  15618. * Gets the bind pose matrix
  15619. * @returns the bind pose matrix
  15620. */
  15621. getBindPose(): Matrix;
  15622. /**
  15623. * Sets the bind pose matrix
  15624. * @param matrix the local-space bind pose to set for this bone
  15625. */
  15626. setBindPose(matrix: Matrix): void;
  15627. /**
  15628. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15629. */
  15630. getWorldMatrix(): Matrix;
  15631. /**
  15632. * Sets the local matrix to rest pose matrix
  15633. */
  15634. returnToRest(): void;
  15635. /**
  15636. * Gets the inverse of the absolute transform matrix.
  15637. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15638. * @returns a matrix
  15639. */
  15640. getInvertedAbsoluteTransform(): Matrix;
  15641. /**
  15642. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15643. * @returns a matrix
  15644. */
  15645. getAbsoluteTransform(): Matrix;
  15646. /**
  15647. * Links with the given transform node.
  15648. * The local matrix of this bone is copied from the transform node every frame.
  15649. * @param transformNode defines the transform node to link to
  15650. */
  15651. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15652. /**
  15653. * Gets the node used to drive the bone's transformation
  15654. * @returns a transform node or null
  15655. */
  15656. getTransformNode(): Nullable<TransformNode>;
  15657. /** Gets or sets current position (in local space) */
  15658. get position(): Vector3;
  15659. set position(newPosition: Vector3);
  15660. /** Gets or sets current rotation (in local space) */
  15661. get rotation(): Vector3;
  15662. set rotation(newRotation: Vector3);
  15663. /** Gets or sets current rotation quaternion (in local space) */
  15664. get rotationQuaternion(): Quaternion;
  15665. set rotationQuaternion(newRotation: Quaternion);
  15666. /** Gets or sets current scaling (in local space) */
  15667. get scaling(): Vector3;
  15668. set scaling(newScaling: Vector3);
  15669. /**
  15670. * Gets the animation properties override
  15671. */
  15672. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15673. private _decompose;
  15674. private _compose;
  15675. /**
  15676. * Update the base and local matrices
  15677. * @param matrix defines the new base or local matrix
  15678. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15679. * @param updateLocalMatrix defines if the local matrix should be updated
  15680. */
  15681. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15682. /** @hidden */
  15683. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15684. /**
  15685. * Flag the bone as dirty (Forcing it to update everything)
  15686. */
  15687. markAsDirty(): void;
  15688. /** @hidden */
  15689. _markAsDirtyAndCompose(): void;
  15690. private _markAsDirtyAndDecompose;
  15691. /**
  15692. * Translate the bone in local or world space
  15693. * @param vec The amount to translate the bone
  15694. * @param space The space that the translation is in
  15695. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15696. */
  15697. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15698. /**
  15699. * Set the postion of the bone in local or world space
  15700. * @param position The position to set the bone
  15701. * @param space The space that the position is in
  15702. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15703. */
  15704. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15705. /**
  15706. * Set the absolute position of the bone (world space)
  15707. * @param position The position to set the bone
  15708. * @param mesh The mesh that this bone is attached to
  15709. */
  15710. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15711. /**
  15712. * Scale the bone on the x, y and z axes (in local space)
  15713. * @param x The amount to scale the bone on the x axis
  15714. * @param y The amount to scale the bone on the y axis
  15715. * @param z The amount to scale the bone on the z axis
  15716. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15717. */
  15718. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15719. /**
  15720. * Set the bone scaling in local space
  15721. * @param scale defines the scaling vector
  15722. */
  15723. setScale(scale: Vector3): void;
  15724. /**
  15725. * Gets the current scaling in local space
  15726. * @returns the current scaling vector
  15727. */
  15728. getScale(): Vector3;
  15729. /**
  15730. * Gets the current scaling in local space and stores it in a target vector
  15731. * @param result defines the target vector
  15732. */
  15733. getScaleToRef(result: Vector3): void;
  15734. /**
  15735. * Set the yaw, pitch, and roll of the bone in local or world space
  15736. * @param yaw The rotation of the bone on the y axis
  15737. * @param pitch The rotation of the bone on the x axis
  15738. * @param roll The rotation of the bone on the z axis
  15739. * @param space The space that the axes of rotation are in
  15740. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15741. */
  15742. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15743. /**
  15744. * Add a rotation to the bone on an axis in local or world space
  15745. * @param axis The axis to rotate the bone on
  15746. * @param amount The amount to rotate the bone
  15747. * @param space The space that the axis is in
  15748. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15749. */
  15750. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15751. /**
  15752. * Set the rotation of the bone to a particular axis angle in local or world space
  15753. * @param axis The axis to rotate the bone on
  15754. * @param angle The angle that the bone should be rotated to
  15755. * @param space The space that the axis is in
  15756. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15757. */
  15758. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15759. /**
  15760. * Set the euler rotation of the bone in local of world space
  15761. * @param rotation The euler rotation that the bone should be set to
  15762. * @param space The space that the rotation is in
  15763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15764. */
  15765. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15766. /**
  15767. * Set the quaternion rotation of the bone in local of world space
  15768. * @param quat The quaternion rotation that the bone should be set to
  15769. * @param space The space that the rotation is in
  15770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15771. */
  15772. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15773. /**
  15774. * Set the rotation matrix of the bone in local of world space
  15775. * @param rotMat The rotation matrix that the bone should be set to
  15776. * @param space The space that the rotation is in
  15777. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15778. */
  15779. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15780. private _rotateWithMatrix;
  15781. private _getNegativeRotationToRef;
  15782. /**
  15783. * Get the position of the bone in local or world space
  15784. * @param space The space that the returned position is in
  15785. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15786. * @returns The position of the bone
  15787. */
  15788. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15789. /**
  15790. * Copy the position of the bone to a vector3 in local or world space
  15791. * @param space The space that the returned position is in
  15792. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15793. * @param result The vector3 to copy the position to
  15794. */
  15795. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15796. /**
  15797. * Get the absolute position of the bone (world space)
  15798. * @param mesh The mesh that this bone is attached to
  15799. * @returns The absolute position of the bone
  15800. */
  15801. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15802. /**
  15803. * Copy the absolute position of the bone (world space) to the result param
  15804. * @param mesh The mesh that this bone is attached to
  15805. * @param result The vector3 to copy the absolute position to
  15806. */
  15807. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15808. /**
  15809. * Compute the absolute transforms of this bone and its children
  15810. */
  15811. computeAbsoluteTransforms(): void;
  15812. /**
  15813. * Get the world direction from an axis that is in the local space of the bone
  15814. * @param localAxis The local direction that is used to compute the world direction
  15815. * @param mesh The mesh that this bone is attached to
  15816. * @returns The world direction
  15817. */
  15818. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15819. /**
  15820. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15821. * @param localAxis The local direction that is used to compute the world direction
  15822. * @param mesh The mesh that this bone is attached to
  15823. * @param result The vector3 that the world direction will be copied to
  15824. */
  15825. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15826. /**
  15827. * Get the euler rotation of the bone in local or world space
  15828. * @param space The space that the rotation should be in
  15829. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15830. * @returns The euler rotation
  15831. */
  15832. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15833. /**
  15834. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15835. * @param space The space that the rotation should be in
  15836. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15837. * @param result The vector3 that the rotation should be copied to
  15838. */
  15839. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15840. /**
  15841. * Get the quaternion rotation of the bone in either local or world space
  15842. * @param space The space that the rotation should be in
  15843. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15844. * @returns The quaternion rotation
  15845. */
  15846. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15847. /**
  15848. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15849. * @param space The space that the rotation should be in
  15850. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15851. * @param result The quaternion that the rotation should be copied to
  15852. */
  15853. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15854. /**
  15855. * Get the rotation matrix of the bone in local or world space
  15856. * @param space The space that the rotation should be in
  15857. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15858. * @returns The rotation matrix
  15859. */
  15860. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15861. /**
  15862. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15863. * @param space The space that the rotation should be in
  15864. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15865. * @param result The quaternion that the rotation should be copied to
  15866. */
  15867. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15868. /**
  15869. * Get the world position of a point that is in the local space of the bone
  15870. * @param position The local position
  15871. * @param mesh The mesh that this bone is attached to
  15872. * @returns The world position
  15873. */
  15874. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15875. /**
  15876. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15877. * @param position The local position
  15878. * @param mesh The mesh that this bone is attached to
  15879. * @param result The vector3 that the world position should be copied to
  15880. */
  15881. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15882. /**
  15883. * Get the local position of a point that is in world space
  15884. * @param position The world position
  15885. * @param mesh The mesh that this bone is attached to
  15886. * @returns The local position
  15887. */
  15888. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15889. /**
  15890. * Get the local position of a point that is in world space and copy it to the result param
  15891. * @param position The world position
  15892. * @param mesh The mesh that this bone is attached to
  15893. * @param result The vector3 that the local position should be copied to
  15894. */
  15895. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15896. }
  15897. }
  15898. declare module "babylonjs/Animations/runtimeAnimation" {
  15899. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15900. import { Animatable } from "babylonjs/Animations/animatable";
  15901. import { Scene } from "babylonjs/scene";
  15902. /**
  15903. * Defines a runtime animation
  15904. */
  15905. export class RuntimeAnimation {
  15906. private _events;
  15907. /**
  15908. * The current frame of the runtime animation
  15909. */
  15910. private _currentFrame;
  15911. /**
  15912. * The animation used by the runtime animation
  15913. */
  15914. private _animation;
  15915. /**
  15916. * The target of the runtime animation
  15917. */
  15918. private _target;
  15919. /**
  15920. * The initiating animatable
  15921. */
  15922. private _host;
  15923. /**
  15924. * The original value of the runtime animation
  15925. */
  15926. private _originalValue;
  15927. /**
  15928. * The original blend value of the runtime animation
  15929. */
  15930. private _originalBlendValue;
  15931. /**
  15932. * The offsets cache of the runtime animation
  15933. */
  15934. private _offsetsCache;
  15935. /**
  15936. * The high limits cache of the runtime animation
  15937. */
  15938. private _highLimitsCache;
  15939. /**
  15940. * Specifies if the runtime animation has been stopped
  15941. */
  15942. private _stopped;
  15943. /**
  15944. * The blending factor of the runtime animation
  15945. */
  15946. private _blendingFactor;
  15947. /**
  15948. * The BabylonJS scene
  15949. */
  15950. private _scene;
  15951. /**
  15952. * The current value of the runtime animation
  15953. */
  15954. private _currentValue;
  15955. /** @hidden */
  15956. _animationState: _IAnimationState;
  15957. /**
  15958. * The active target of the runtime animation
  15959. */
  15960. private _activeTargets;
  15961. private _currentActiveTarget;
  15962. private _directTarget;
  15963. /**
  15964. * The target path of the runtime animation
  15965. */
  15966. private _targetPath;
  15967. /**
  15968. * The weight of the runtime animation
  15969. */
  15970. private _weight;
  15971. /**
  15972. * The ratio offset of the runtime animation
  15973. */
  15974. private _ratioOffset;
  15975. /**
  15976. * The previous delay of the runtime animation
  15977. */
  15978. private _previousDelay;
  15979. /**
  15980. * The previous ratio of the runtime animation
  15981. */
  15982. private _previousRatio;
  15983. private _enableBlending;
  15984. private _keys;
  15985. private _minFrame;
  15986. private _maxFrame;
  15987. private _minValue;
  15988. private _maxValue;
  15989. private _targetIsArray;
  15990. /**
  15991. * Gets the current frame of the runtime animation
  15992. */
  15993. get currentFrame(): number;
  15994. /**
  15995. * Gets the weight of the runtime animation
  15996. */
  15997. get weight(): number;
  15998. /**
  15999. * Gets the current value of the runtime animation
  16000. */
  16001. get currentValue(): any;
  16002. /**
  16003. * Gets the target path of the runtime animation
  16004. */
  16005. get targetPath(): string;
  16006. /**
  16007. * Gets the actual target of the runtime animation
  16008. */
  16009. get target(): any;
  16010. /**
  16011. * Gets the additive state of the runtime animation
  16012. */
  16013. get isAdditive(): boolean;
  16014. /** @hidden */
  16015. _onLoop: () => void;
  16016. /**
  16017. * Create a new RuntimeAnimation object
  16018. * @param target defines the target of the animation
  16019. * @param animation defines the source animation object
  16020. * @param scene defines the hosting scene
  16021. * @param host defines the initiating Animatable
  16022. */
  16023. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16024. private _preparePath;
  16025. /**
  16026. * Gets the animation from the runtime animation
  16027. */
  16028. get animation(): Animation;
  16029. /**
  16030. * Resets the runtime animation to the beginning
  16031. * @param restoreOriginal defines whether to restore the target property to the original value
  16032. */
  16033. reset(restoreOriginal?: boolean): void;
  16034. /**
  16035. * Specifies if the runtime animation is stopped
  16036. * @returns Boolean specifying if the runtime animation is stopped
  16037. */
  16038. isStopped(): boolean;
  16039. /**
  16040. * Disposes of the runtime animation
  16041. */
  16042. dispose(): void;
  16043. /**
  16044. * Apply the interpolated value to the target
  16045. * @param currentValue defines the value computed by the animation
  16046. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16047. */
  16048. setValue(currentValue: any, weight: number): void;
  16049. private _getOriginalValues;
  16050. private _setValue;
  16051. /**
  16052. * Gets the loop pmode of the runtime animation
  16053. * @returns Loop Mode
  16054. */
  16055. private _getCorrectLoopMode;
  16056. /**
  16057. * Move the current animation to a given frame
  16058. * @param frame defines the frame to move to
  16059. */
  16060. goToFrame(frame: number): void;
  16061. /**
  16062. * @hidden Internal use only
  16063. */
  16064. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16065. /**
  16066. * Execute the current animation
  16067. * @param delay defines the delay to add to the current frame
  16068. * @param from defines the lower bound of the animation range
  16069. * @param to defines the upper bound of the animation range
  16070. * @param loop defines if the current animation must loop
  16071. * @param speedRatio defines the current speed ratio
  16072. * @param weight defines the weight of the animation (default is -1 so no weight)
  16073. * @param onLoop optional callback called when animation loops
  16074. * @returns a boolean indicating if the animation is running
  16075. */
  16076. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16077. }
  16078. }
  16079. declare module "babylonjs/Animations/animatable" {
  16080. import { Animation } from "babylonjs/Animations/animation";
  16081. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16082. import { Nullable } from "babylonjs/types";
  16083. import { Observable } from "babylonjs/Misc/observable";
  16084. import { Scene } from "babylonjs/scene";
  16085. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16086. import { Node } from "babylonjs/node";
  16087. /**
  16088. * Class used to store an actual running animation
  16089. */
  16090. export class Animatable {
  16091. /** defines the target object */
  16092. target: any;
  16093. /** defines the starting frame number (default is 0) */
  16094. fromFrame: number;
  16095. /** defines the ending frame number (default is 100) */
  16096. toFrame: number;
  16097. /** defines if the animation must loop (default is false) */
  16098. loopAnimation: boolean;
  16099. /** defines a callback to call when animation ends if it is not looping */
  16100. onAnimationEnd?: (() => void) | null | undefined;
  16101. /** defines a callback to call when animation loops */
  16102. onAnimationLoop?: (() => void) | null | undefined;
  16103. /** defines whether the animation should be evaluated additively */
  16104. isAdditive: boolean;
  16105. private _localDelayOffset;
  16106. private _pausedDelay;
  16107. private _runtimeAnimations;
  16108. private _paused;
  16109. private _scene;
  16110. private _speedRatio;
  16111. private _weight;
  16112. private _syncRoot;
  16113. /**
  16114. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16115. * This will only apply for non looping animation (default is true)
  16116. */
  16117. disposeOnEnd: boolean;
  16118. /**
  16119. * Gets a boolean indicating if the animation has started
  16120. */
  16121. animationStarted: boolean;
  16122. /**
  16123. * Observer raised when the animation ends
  16124. */
  16125. onAnimationEndObservable: Observable<Animatable>;
  16126. /**
  16127. * Observer raised when the animation loops
  16128. */
  16129. onAnimationLoopObservable: Observable<Animatable>;
  16130. /**
  16131. * Gets the root Animatable used to synchronize and normalize animations
  16132. */
  16133. get syncRoot(): Nullable<Animatable>;
  16134. /**
  16135. * Gets the current frame of the first RuntimeAnimation
  16136. * Used to synchronize Animatables
  16137. */
  16138. get masterFrame(): number;
  16139. /**
  16140. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16141. */
  16142. get weight(): number;
  16143. set weight(value: number);
  16144. /**
  16145. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16146. */
  16147. get speedRatio(): number;
  16148. set speedRatio(value: number);
  16149. /**
  16150. * Creates a new Animatable
  16151. * @param scene defines the hosting scene
  16152. * @param target defines the target object
  16153. * @param fromFrame defines the starting frame number (default is 0)
  16154. * @param toFrame defines the ending frame number (default is 100)
  16155. * @param loopAnimation defines if the animation must loop (default is false)
  16156. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16157. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16158. * @param animations defines a group of animation to add to the new Animatable
  16159. * @param onAnimationLoop defines a callback to call when animation loops
  16160. * @param isAdditive defines whether the animation should be evaluated additively
  16161. */
  16162. constructor(scene: Scene,
  16163. /** defines the target object */
  16164. target: any,
  16165. /** defines the starting frame number (default is 0) */
  16166. fromFrame?: number,
  16167. /** defines the ending frame number (default is 100) */
  16168. toFrame?: number,
  16169. /** defines if the animation must loop (default is false) */
  16170. loopAnimation?: boolean, speedRatio?: number,
  16171. /** defines a callback to call when animation ends if it is not looping */
  16172. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16173. /** defines a callback to call when animation loops */
  16174. onAnimationLoop?: (() => void) | null | undefined,
  16175. /** defines whether the animation should be evaluated additively */
  16176. isAdditive?: boolean);
  16177. /**
  16178. * Synchronize and normalize current Animatable with a source Animatable
  16179. * This is useful when using animation weights and when animations are not of the same length
  16180. * @param root defines the root Animatable to synchronize with
  16181. * @returns the current Animatable
  16182. */
  16183. syncWith(root: Animatable): Animatable;
  16184. /**
  16185. * Gets the list of runtime animations
  16186. * @returns an array of RuntimeAnimation
  16187. */
  16188. getAnimations(): RuntimeAnimation[];
  16189. /**
  16190. * Adds more animations to the current animatable
  16191. * @param target defines the target of the animations
  16192. * @param animations defines the new animations to add
  16193. */
  16194. appendAnimations(target: any, animations: Animation[]): void;
  16195. /**
  16196. * Gets the source animation for a specific property
  16197. * @param property defines the propertyu to look for
  16198. * @returns null or the source animation for the given property
  16199. */
  16200. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16201. /**
  16202. * Gets the runtime animation for a specific property
  16203. * @param property defines the propertyu to look for
  16204. * @returns null or the runtime animation for the given property
  16205. */
  16206. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16207. /**
  16208. * Resets the animatable to its original state
  16209. */
  16210. reset(): void;
  16211. /**
  16212. * Allows the animatable to blend with current running animations
  16213. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16214. * @param blendingSpeed defines the blending speed to use
  16215. */
  16216. enableBlending(blendingSpeed: number): void;
  16217. /**
  16218. * Disable animation blending
  16219. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16220. */
  16221. disableBlending(): void;
  16222. /**
  16223. * Jump directly to a given frame
  16224. * @param frame defines the frame to jump to
  16225. */
  16226. goToFrame(frame: number): void;
  16227. /**
  16228. * Pause the animation
  16229. */
  16230. pause(): void;
  16231. /**
  16232. * Restart the animation
  16233. */
  16234. restart(): void;
  16235. private _raiseOnAnimationEnd;
  16236. /**
  16237. * Stop and delete the current animation
  16238. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16239. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  16240. */
  16241. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16242. /**
  16243. * Wait asynchronously for the animation to end
  16244. * @returns a promise which will be fullfilled when the animation ends
  16245. */
  16246. waitAsync(): Promise<Animatable>;
  16247. /** @hidden */
  16248. _animate(delay: number): boolean;
  16249. }
  16250. module "babylonjs/scene" {
  16251. interface Scene {
  16252. /** @hidden */
  16253. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16254. /** @hidden */
  16255. _processLateAnimationBindingsForMatrices(holder: {
  16256. totalWeight: number;
  16257. totalAdditiveWeight: number;
  16258. animations: RuntimeAnimation[];
  16259. additiveAnimations: RuntimeAnimation[];
  16260. originalValue: Matrix;
  16261. }): any;
  16262. /** @hidden */
  16263. _processLateAnimationBindingsForQuaternions(holder: {
  16264. totalWeight: number;
  16265. totalAdditiveWeight: number;
  16266. animations: RuntimeAnimation[];
  16267. additiveAnimations: RuntimeAnimation[];
  16268. originalValue: Quaternion;
  16269. }, refQuaternion: Quaternion): Quaternion;
  16270. /** @hidden */
  16271. _processLateAnimationBindings(): void;
  16272. /**
  16273. * Will start the animation sequence of a given target
  16274. * @param target defines the target
  16275. * @param from defines from which frame should animation start
  16276. * @param to defines until which frame should animation run.
  16277. * @param weight defines the weight to apply to the animation (1.0 by default)
  16278. * @param loop defines if the animation loops
  16279. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16280. * @param onAnimationEnd defines the function to be executed when the animation ends
  16281. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16282. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16283. * @param onAnimationLoop defines the callback to call when an animation loops
  16284. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16285. * @returns the animatable object created for this animation
  16286. */
  16287. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16288. /**
  16289. * Will start the animation sequence of a given target
  16290. * @param target defines the target
  16291. * @param from defines from which frame should animation start
  16292. * @param to defines until which frame should animation run.
  16293. * @param loop defines if the animation loops
  16294. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16295. * @param onAnimationEnd defines the function to be executed when the animation ends
  16296. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16297. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16298. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16299. * @param onAnimationLoop defines the callback to call when an animation loops
  16300. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16301. * @returns the animatable object created for this animation
  16302. */
  16303. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16304. /**
  16305. * Will start the animation sequence of a given target and its hierarchy
  16306. * @param target defines the target
  16307. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16308. * @param from defines from which frame should animation start
  16309. * @param to defines until which frame should animation run.
  16310. * @param loop defines if the animation loops
  16311. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16312. * @param onAnimationEnd defines the function to be executed when the animation ends
  16313. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16314. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16315. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16316. * @param onAnimationLoop defines the callback to call when an animation loops
  16317. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16318. * @returns the list of created animatables
  16319. */
  16320. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16321. /**
  16322. * Begin a new animation on a given node
  16323. * @param target defines the target where the animation will take place
  16324. * @param animations defines the list of animations to start
  16325. * @param from defines the initial value
  16326. * @param to defines the final value
  16327. * @param loop defines if you want animation to loop (off by default)
  16328. * @param speedRatio defines the speed ratio to apply to all animations
  16329. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16330. * @param onAnimationLoop defines the callback to call when an animation loops
  16331. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16332. * @returns the list of created animatables
  16333. */
  16334. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16335. /**
  16336. * Begin a new animation on a given node and its hierarchy
  16337. * @param target defines the root node where the animation will take place
  16338. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16339. * @param animations defines the list of animations to start
  16340. * @param from defines the initial value
  16341. * @param to defines the final value
  16342. * @param loop defines if you want animation to loop (off by default)
  16343. * @param speedRatio defines the speed ratio to apply to all animations
  16344. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16345. * @param onAnimationLoop defines the callback to call when an animation loops
  16346. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16347. * @returns the list of animatables created for all nodes
  16348. */
  16349. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16350. /**
  16351. * Gets the animatable associated with a specific target
  16352. * @param target defines the target of the animatable
  16353. * @returns the required animatable if found
  16354. */
  16355. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16356. /**
  16357. * Gets all animatables associated with a given target
  16358. * @param target defines the target to look animatables for
  16359. * @returns an array of Animatables
  16360. */
  16361. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16362. /**
  16363. * Stops and removes all animations that have been applied to the scene
  16364. */
  16365. stopAllAnimations(): void;
  16366. /**
  16367. * Gets the current delta time used by animation engine
  16368. */
  16369. deltaTime: number;
  16370. }
  16371. }
  16372. module "babylonjs/Bones/bone" {
  16373. interface Bone {
  16374. /**
  16375. * Copy an animation range from another bone
  16376. * @param source defines the source bone
  16377. * @param rangeName defines the range name to copy
  16378. * @param frameOffset defines the frame offset
  16379. * @param rescaleAsRequired defines if rescaling must be applied if required
  16380. * @param skelDimensionsRatio defines the scaling ratio
  16381. * @returns true if operation was successful
  16382. */
  16383. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16384. }
  16385. }
  16386. }
  16387. declare module "babylonjs/Bones/skeleton" {
  16388. import { Bone } from "babylonjs/Bones/bone";
  16389. import { Observable } from "babylonjs/Misc/observable";
  16390. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16391. import { Scene } from "babylonjs/scene";
  16392. import { Nullable } from "babylonjs/types";
  16393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16394. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16395. import { Animatable } from "babylonjs/Animations/animatable";
  16396. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16397. import { Animation } from "babylonjs/Animations/animation";
  16398. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16399. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16400. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16401. /**
  16402. * Class used to handle skinning animations
  16403. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16404. */
  16405. export class Skeleton implements IAnimatable {
  16406. /** defines the skeleton name */
  16407. name: string;
  16408. /** defines the skeleton Id */
  16409. id: string;
  16410. /**
  16411. * Defines the list of child bones
  16412. */
  16413. bones: Bone[];
  16414. /**
  16415. * Defines an estimate of the dimension of the skeleton at rest
  16416. */
  16417. dimensionsAtRest: Vector3;
  16418. /**
  16419. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16420. */
  16421. needInitialSkinMatrix: boolean;
  16422. /**
  16423. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16424. */
  16425. overrideMesh: Nullable<AbstractMesh>;
  16426. /**
  16427. * Gets the list of animations attached to this skeleton
  16428. */
  16429. animations: Array<Animation>;
  16430. private _scene;
  16431. private _isDirty;
  16432. private _transformMatrices;
  16433. private _transformMatrixTexture;
  16434. private _meshesWithPoseMatrix;
  16435. private _animatables;
  16436. private _identity;
  16437. private _synchronizedWithMesh;
  16438. private _ranges;
  16439. private _lastAbsoluteTransformsUpdateId;
  16440. private _canUseTextureForBones;
  16441. private _uniqueId;
  16442. /** @hidden */
  16443. _numBonesWithLinkedTransformNode: number;
  16444. /** @hidden */
  16445. _hasWaitingData: Nullable<boolean>;
  16446. /**
  16447. * Specifies if the skeleton should be serialized
  16448. */
  16449. doNotSerialize: boolean;
  16450. private _useTextureToStoreBoneMatrices;
  16451. /**
  16452. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16453. * Please note that this option is not available if the hardware does not support it
  16454. */
  16455. get useTextureToStoreBoneMatrices(): boolean;
  16456. set useTextureToStoreBoneMatrices(value: boolean);
  16457. private _animationPropertiesOverride;
  16458. /**
  16459. * Gets or sets the animation properties override
  16460. */
  16461. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16462. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16463. /**
  16464. * List of inspectable custom properties (used by the Inspector)
  16465. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16466. */
  16467. inspectableCustomProperties: IInspectable[];
  16468. /**
  16469. * An observable triggered before computing the skeleton's matrices
  16470. */
  16471. onBeforeComputeObservable: Observable<Skeleton>;
  16472. /**
  16473. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16474. */
  16475. get isUsingTextureForMatrices(): boolean;
  16476. /**
  16477. * Gets the unique ID of this skeleton
  16478. */
  16479. get uniqueId(): number;
  16480. /**
  16481. * Creates a new skeleton
  16482. * @param name defines the skeleton name
  16483. * @param id defines the skeleton Id
  16484. * @param scene defines the hosting scene
  16485. */
  16486. constructor(
  16487. /** defines the skeleton name */
  16488. name: string,
  16489. /** defines the skeleton Id */
  16490. id: string, scene: Scene);
  16491. /**
  16492. * Gets the current object class name.
  16493. * @return the class name
  16494. */
  16495. getClassName(): string;
  16496. /**
  16497. * Returns an array containing the root bones
  16498. * @returns an array containing the root bones
  16499. */
  16500. getChildren(): Array<Bone>;
  16501. /**
  16502. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16503. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16504. * @returns a Float32Array containing matrices data
  16505. */
  16506. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16507. /**
  16508. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16509. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16510. * @returns a raw texture containing the data
  16511. */
  16512. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16513. /**
  16514. * Gets the current hosting scene
  16515. * @returns a scene object
  16516. */
  16517. getScene(): Scene;
  16518. /**
  16519. * Gets a string representing the current skeleton data
  16520. * @param fullDetails defines a boolean indicating if we want a verbose version
  16521. * @returns a string representing the current skeleton data
  16522. */
  16523. toString(fullDetails?: boolean): string;
  16524. /**
  16525. * Get bone's index searching by name
  16526. * @param name defines bone's name to search for
  16527. * @return the indice of the bone. Returns -1 if not found
  16528. */
  16529. getBoneIndexByName(name: string): number;
  16530. /**
  16531. * Creater a new animation range
  16532. * @param name defines the name of the range
  16533. * @param from defines the start key
  16534. * @param to defines the end key
  16535. */
  16536. createAnimationRange(name: string, from: number, to: number): void;
  16537. /**
  16538. * Delete a specific animation range
  16539. * @param name defines the name of the range
  16540. * @param deleteFrames defines if frames must be removed as well
  16541. */
  16542. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16543. /**
  16544. * Gets a specific animation range
  16545. * @param name defines the name of the range to look for
  16546. * @returns the requested animation range or null if not found
  16547. */
  16548. getAnimationRange(name: string): Nullable<AnimationRange>;
  16549. /**
  16550. * Gets the list of all animation ranges defined on this skeleton
  16551. * @returns an array
  16552. */
  16553. getAnimationRanges(): Nullable<AnimationRange>[];
  16554. /**
  16555. * Copy animation range from a source skeleton.
  16556. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16557. * @param source defines the source skeleton
  16558. * @param name defines the name of the range to copy
  16559. * @param rescaleAsRequired defines if rescaling must be applied if required
  16560. * @returns true if operation was successful
  16561. */
  16562. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16563. /**
  16564. * Forces the skeleton to go to rest pose
  16565. */
  16566. returnToRest(): void;
  16567. private _getHighestAnimationFrame;
  16568. /**
  16569. * Begin a specific animation range
  16570. * @param name defines the name of the range to start
  16571. * @param loop defines if looping must be turned on (false by default)
  16572. * @param speedRatio defines the speed ratio to apply (1 by default)
  16573. * @param onAnimationEnd defines a callback which will be called when animation will end
  16574. * @returns a new animatable
  16575. */
  16576. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16577. /**
  16578. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16579. * @param skeleton defines the Skeleton containing the animation range to convert
  16580. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16581. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16582. * @returns the original skeleton
  16583. */
  16584. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16585. /** @hidden */
  16586. _markAsDirty(): void;
  16587. /** @hidden */
  16588. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16589. /** @hidden */
  16590. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16591. private _computeTransformMatrices;
  16592. /**
  16593. * Build all resources required to render a skeleton
  16594. */
  16595. prepare(): void;
  16596. /**
  16597. * Gets the list of animatables currently running for this skeleton
  16598. * @returns an array of animatables
  16599. */
  16600. getAnimatables(): IAnimatable[];
  16601. /**
  16602. * Clone the current skeleton
  16603. * @param name defines the name of the new skeleton
  16604. * @param id defines the id of the new skeleton
  16605. * @returns the new skeleton
  16606. */
  16607. clone(name: string, id?: string): Skeleton;
  16608. /**
  16609. * Enable animation blending for this skeleton
  16610. * @param blendingSpeed defines the blending speed to apply
  16611. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16612. */
  16613. enableBlending(blendingSpeed?: number): void;
  16614. /**
  16615. * Releases all resources associated with the current skeleton
  16616. */
  16617. dispose(): void;
  16618. /**
  16619. * Serialize the skeleton in a JSON object
  16620. * @returns a JSON object
  16621. */
  16622. serialize(): any;
  16623. /**
  16624. * Creates a new skeleton from serialized data
  16625. * @param parsedSkeleton defines the serialized data
  16626. * @param scene defines the hosting scene
  16627. * @returns a new skeleton
  16628. */
  16629. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16630. /**
  16631. * Compute all node absolute transforms
  16632. * @param forceUpdate defines if computation must be done even if cache is up to date
  16633. */
  16634. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16635. /**
  16636. * Gets the root pose matrix
  16637. * @returns a matrix
  16638. */
  16639. getPoseMatrix(): Nullable<Matrix>;
  16640. /**
  16641. * Sorts bones per internal index
  16642. */
  16643. sortBones(): void;
  16644. private _sortBones;
  16645. }
  16646. }
  16647. declare module "babylonjs/Meshes/instancedMesh" {
  16648. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16649. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16650. import { Camera } from "babylonjs/Cameras/camera";
  16651. import { Node } from "babylonjs/node";
  16652. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16653. import { Mesh } from "babylonjs/Meshes/mesh";
  16654. import { Material } from "babylonjs/Materials/material";
  16655. import { Skeleton } from "babylonjs/Bones/skeleton";
  16656. import { Light } from "babylonjs/Lights/light";
  16657. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16658. /**
  16659. * Creates an instance based on a source mesh.
  16660. */
  16661. export class InstancedMesh extends AbstractMesh {
  16662. private _sourceMesh;
  16663. private _currentLOD;
  16664. /** @hidden */
  16665. _indexInSourceMeshInstanceArray: number;
  16666. constructor(name: string, source: Mesh);
  16667. /**
  16668. * Returns the string "InstancedMesh".
  16669. */
  16670. getClassName(): string;
  16671. /** Gets the list of lights affecting that mesh */
  16672. get lightSources(): Light[];
  16673. _resyncLightSources(): void;
  16674. _resyncLightSource(light: Light): void;
  16675. _removeLightSource(light: Light, dispose: boolean): void;
  16676. /**
  16677. * If the source mesh receives shadows
  16678. */
  16679. get receiveShadows(): boolean;
  16680. /**
  16681. * The material of the source mesh
  16682. */
  16683. get material(): Nullable<Material>;
  16684. /**
  16685. * Visibility of the source mesh
  16686. */
  16687. get visibility(): number;
  16688. /**
  16689. * Skeleton of the source mesh
  16690. */
  16691. get skeleton(): Nullable<Skeleton>;
  16692. /**
  16693. * Rendering ground id of the source mesh
  16694. */
  16695. get renderingGroupId(): number;
  16696. set renderingGroupId(value: number);
  16697. /**
  16698. * Returns the total number of vertices (integer).
  16699. */
  16700. getTotalVertices(): number;
  16701. /**
  16702. * Returns a positive integer : the total number of indices in this mesh geometry.
  16703. * @returns the numner of indices or zero if the mesh has no geometry.
  16704. */
  16705. getTotalIndices(): number;
  16706. /**
  16707. * The source mesh of the instance
  16708. */
  16709. get sourceMesh(): Mesh;
  16710. /**
  16711. * Creates a new InstancedMesh object from the mesh model.
  16712. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16713. * @param name defines the name of the new instance
  16714. * @returns a new InstancedMesh
  16715. */
  16716. createInstance(name: string): InstancedMesh;
  16717. /**
  16718. * Is this node ready to be used/rendered
  16719. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16720. * @return {boolean} is it ready
  16721. */
  16722. isReady(completeCheck?: boolean): boolean;
  16723. /**
  16724. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16725. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16726. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  16727. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16728. */
  16729. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16730. /**
  16731. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16732. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16733. * The `data` are either a numeric array either a Float32Array.
  16734. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16735. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  16736. * Note that a new underlying VertexBuffer object is created each call.
  16737. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16738. *
  16739. * Possible `kind` values :
  16740. * - VertexBuffer.PositionKind
  16741. * - VertexBuffer.UVKind
  16742. * - VertexBuffer.UV2Kind
  16743. * - VertexBuffer.UV3Kind
  16744. * - VertexBuffer.UV4Kind
  16745. * - VertexBuffer.UV5Kind
  16746. * - VertexBuffer.UV6Kind
  16747. * - VertexBuffer.ColorKind
  16748. * - VertexBuffer.MatricesIndicesKind
  16749. * - VertexBuffer.MatricesIndicesExtraKind
  16750. * - VertexBuffer.MatricesWeightsKind
  16751. * - VertexBuffer.MatricesWeightsExtraKind
  16752. *
  16753. * Returns the Mesh.
  16754. */
  16755. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16756. /**
  16757. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16758. * If the mesh has no geometry, it is simply returned as it is.
  16759. * The `data` are either a numeric array either a Float32Array.
  16760. * No new underlying VertexBuffer object is created.
  16761. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16762. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16763. *
  16764. * Possible `kind` values :
  16765. * - VertexBuffer.PositionKind
  16766. * - VertexBuffer.UVKind
  16767. * - VertexBuffer.UV2Kind
  16768. * - VertexBuffer.UV3Kind
  16769. * - VertexBuffer.UV4Kind
  16770. * - VertexBuffer.UV5Kind
  16771. * - VertexBuffer.UV6Kind
  16772. * - VertexBuffer.ColorKind
  16773. * - VertexBuffer.MatricesIndicesKind
  16774. * - VertexBuffer.MatricesIndicesExtraKind
  16775. * - VertexBuffer.MatricesWeightsKind
  16776. * - VertexBuffer.MatricesWeightsExtraKind
  16777. *
  16778. * Returns the Mesh.
  16779. */
  16780. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16781. /**
  16782. * Sets the mesh indices.
  16783. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16784. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16785. * This method creates a new index buffer each call.
  16786. * Returns the Mesh.
  16787. */
  16788. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16789. /**
  16790. * Boolean : True if the mesh owns the requested kind of data.
  16791. */
  16792. isVerticesDataPresent(kind: string): boolean;
  16793. /**
  16794. * Returns an array of indices (IndicesArray).
  16795. */
  16796. getIndices(): Nullable<IndicesArray>;
  16797. get _positions(): Nullable<Vector3[]>;
  16798. /**
  16799. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16800. * This means the mesh underlying bounding box and sphere are recomputed.
  16801. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16802. * @returns the current mesh
  16803. */
  16804. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16805. /** @hidden */
  16806. _preActivate(): InstancedMesh;
  16807. /** @hidden */
  16808. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16809. /** @hidden */
  16810. _postActivate(): void;
  16811. getWorldMatrix(): Matrix;
  16812. get isAnInstance(): boolean;
  16813. /**
  16814. * Returns the current associated LOD AbstractMesh.
  16815. */
  16816. getLOD(camera: Camera): AbstractMesh;
  16817. /** @hidden */
  16818. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16819. /** @hidden */
  16820. _syncSubMeshes(): InstancedMesh;
  16821. /** @hidden */
  16822. _generatePointsArray(): boolean;
  16823. /** @hidden */
  16824. _updateBoundingInfo(): AbstractMesh;
  16825. /**
  16826. * Creates a new InstancedMesh from the current mesh.
  16827. * - name (string) : the cloned mesh name
  16828. * - newParent (optional Node) : the optional Node to parent the clone to.
  16829. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16830. *
  16831. * Returns the clone.
  16832. */
  16833. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16834. /**
  16835. * Disposes the InstancedMesh.
  16836. * Returns nothing.
  16837. */
  16838. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16839. }
  16840. module "babylonjs/Meshes/mesh" {
  16841. interface Mesh {
  16842. /**
  16843. * Register a custom buffer that will be instanced
  16844. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16845. * @param kind defines the buffer kind
  16846. * @param stride defines the stride in floats
  16847. */
  16848. registerInstancedBuffer(kind: string, stride: number): void;
  16849. /**
  16850. * true to use the edge renderer for all instances of this mesh
  16851. */
  16852. edgesShareWithInstances: boolean;
  16853. /** @hidden */
  16854. _userInstancedBuffersStorage: {
  16855. data: {
  16856. [key: string]: Float32Array;
  16857. };
  16858. sizes: {
  16859. [key: string]: number;
  16860. };
  16861. vertexBuffers: {
  16862. [key: string]: Nullable<VertexBuffer>;
  16863. };
  16864. strides: {
  16865. [key: string]: number;
  16866. };
  16867. };
  16868. }
  16869. }
  16870. module "babylonjs/Meshes/abstractMesh" {
  16871. interface AbstractMesh {
  16872. /**
  16873. * Object used to store instanced buffers defined by user
  16874. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16875. */
  16876. instancedBuffers: {
  16877. [key: string]: any;
  16878. };
  16879. }
  16880. }
  16881. }
  16882. declare module "babylonjs/Materials/shaderMaterial" {
  16883. import { Nullable } from "babylonjs/types";
  16884. import { Scene } from "babylonjs/scene";
  16885. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16886. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16887. import { Mesh } from "babylonjs/Meshes/mesh";
  16888. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16889. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16890. import { Effect } from "babylonjs/Materials/effect";
  16891. import { Material } from "babylonjs/Materials/material";
  16892. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16893. /**
  16894. * Defines the options associated with the creation of a shader material.
  16895. */
  16896. export interface IShaderMaterialOptions {
  16897. /**
  16898. * Does the material work in alpha blend mode
  16899. */
  16900. needAlphaBlending: boolean;
  16901. /**
  16902. * Does the material work in alpha test mode
  16903. */
  16904. needAlphaTesting: boolean;
  16905. /**
  16906. * The list of attribute names used in the shader
  16907. */
  16908. attributes: string[];
  16909. /**
  16910. * The list of unifrom names used in the shader
  16911. */
  16912. uniforms: string[];
  16913. /**
  16914. * The list of UBO names used in the shader
  16915. */
  16916. uniformBuffers: string[];
  16917. /**
  16918. * The list of sampler names used in the shader
  16919. */
  16920. samplers: string[];
  16921. /**
  16922. * The list of defines used in the shader
  16923. */
  16924. defines: string[];
  16925. }
  16926. /**
  16927. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16928. *
  16929. * This returned material effects how the mesh will look based on the code in the shaders.
  16930. *
  16931. * @see https://doc.babylonjs.com/how_to/shader_material
  16932. */
  16933. export class ShaderMaterial extends Material {
  16934. private _shaderPath;
  16935. private _options;
  16936. private _textures;
  16937. private _textureArrays;
  16938. private _floats;
  16939. private _ints;
  16940. private _floatsArrays;
  16941. private _colors3;
  16942. private _colors3Arrays;
  16943. private _colors4;
  16944. private _colors4Arrays;
  16945. private _vectors2;
  16946. private _vectors3;
  16947. private _vectors4;
  16948. private _matrices;
  16949. private _matrixArrays;
  16950. private _matrices3x3;
  16951. private _matrices2x2;
  16952. private _vectors2Arrays;
  16953. private _vectors3Arrays;
  16954. private _vectors4Arrays;
  16955. private _cachedWorldViewMatrix;
  16956. private _cachedWorldViewProjectionMatrix;
  16957. private _renderId;
  16958. private _multiview;
  16959. private _cachedDefines;
  16960. /** Define the Url to load snippets */
  16961. static SnippetUrl: string;
  16962. /** Snippet ID if the material was created from the snippet server */
  16963. snippetId: string;
  16964. /**
  16965. * Instantiate a new shader material.
  16966. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16967. * This returned material effects how the mesh will look based on the code in the shaders.
  16968. * @see https://doc.babylonjs.com/how_to/shader_material
  16969. * @param name Define the name of the material in the scene
  16970. * @param scene Define the scene the material belongs to
  16971. * @param shaderPath Defines the route to the shader code in one of three ways:
  16972. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16973. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16974. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16975. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16976. * @param options Define the options used to create the shader
  16977. */
  16978. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16979. /**
  16980. * Gets the shader path used to define the shader code
  16981. * It can be modified to trigger a new compilation
  16982. */
  16983. get shaderPath(): any;
  16984. /**
  16985. * Sets the shader path used to define the shader code
  16986. * It can be modified to trigger a new compilation
  16987. */
  16988. set shaderPath(shaderPath: any);
  16989. /**
  16990. * Gets the options used to compile the shader.
  16991. * They can be modified to trigger a new compilation
  16992. */
  16993. get options(): IShaderMaterialOptions;
  16994. /**
  16995. * Gets the current class name of the material e.g. "ShaderMaterial"
  16996. * Mainly use in serialization.
  16997. * @returns the class name
  16998. */
  16999. getClassName(): string;
  17000. /**
  17001. * Specifies if the material will require alpha blending
  17002. * @returns a boolean specifying if alpha blending is needed
  17003. */
  17004. needAlphaBlending(): boolean;
  17005. /**
  17006. * Specifies if this material should be rendered in alpha test mode
  17007. * @returns a boolean specifying if an alpha test is needed.
  17008. */
  17009. needAlphaTesting(): boolean;
  17010. private _checkUniform;
  17011. /**
  17012. * Set a texture in the shader.
  17013. * @param name Define the name of the uniform samplers as defined in the shader
  17014. * @param texture Define the texture to bind to this sampler
  17015. * @return the material itself allowing "fluent" like uniform updates
  17016. */
  17017. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17018. /**
  17019. * Set a texture array in the shader.
  17020. * @param name Define the name of the uniform sampler array as defined in the shader
  17021. * @param textures Define the list of textures to bind to this sampler
  17022. * @return the material itself allowing "fluent" like uniform updates
  17023. */
  17024. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17025. /**
  17026. * Set a float in the shader.
  17027. * @param name Define the name of the uniform as defined in the shader
  17028. * @param value Define the value to give to the uniform
  17029. * @return the material itself allowing "fluent" like uniform updates
  17030. */
  17031. setFloat(name: string, value: number): ShaderMaterial;
  17032. /**
  17033. * Set a int in the shader.
  17034. * @param name Define the name of the uniform as defined in the shader
  17035. * @param value Define the value to give to the uniform
  17036. * @return the material itself allowing "fluent" like uniform updates
  17037. */
  17038. setInt(name: string, value: number): ShaderMaterial;
  17039. /**
  17040. * Set an array of floats in the shader.
  17041. * @param name Define the name of the uniform as defined in the shader
  17042. * @param value Define the value to give to the uniform
  17043. * @return the material itself allowing "fluent" like uniform updates
  17044. */
  17045. setFloats(name: string, value: number[]): ShaderMaterial;
  17046. /**
  17047. * Set a vec3 in the shader from a Color3.
  17048. * @param name Define the name of the uniform as defined in the shader
  17049. * @param value Define the value to give to the uniform
  17050. * @return the material itself allowing "fluent" like uniform updates
  17051. */
  17052. setColor3(name: string, value: Color3): ShaderMaterial;
  17053. /**
  17054. * Set a vec3 array in the shader from a Color3 array.
  17055. * @param name Define the name of the uniform as defined in the shader
  17056. * @param value Define the value to give to the uniform
  17057. * @return the material itself allowing "fluent" like uniform updates
  17058. */
  17059. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17060. /**
  17061. * Set a vec4 in the shader from a Color4.
  17062. * @param name Define the name of the uniform as defined in the shader
  17063. * @param value Define the value to give to the uniform
  17064. * @return the material itself allowing "fluent" like uniform updates
  17065. */
  17066. setColor4(name: string, value: Color4): ShaderMaterial;
  17067. /**
  17068. * Set a vec4 array in the shader from a Color4 array.
  17069. * @param name Define the name of the uniform as defined in the shader
  17070. * @param value Define the value to give to the uniform
  17071. * @return the material itself allowing "fluent" like uniform updates
  17072. */
  17073. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17074. /**
  17075. * Set a vec2 in the shader from a Vector2.
  17076. * @param name Define the name of the uniform as defined in the shader
  17077. * @param value Define the value to give to the uniform
  17078. * @return the material itself allowing "fluent" like uniform updates
  17079. */
  17080. setVector2(name: string, value: Vector2): ShaderMaterial;
  17081. /**
  17082. * Set a vec3 in the shader from a Vector3.
  17083. * @param name Define the name of the uniform as defined in the shader
  17084. * @param value Define the value to give to the uniform
  17085. * @return the material itself allowing "fluent" like uniform updates
  17086. */
  17087. setVector3(name: string, value: Vector3): ShaderMaterial;
  17088. /**
  17089. * Set a vec4 in the shader from a Vector4.
  17090. * @param name Define the name of the uniform as defined in the shader
  17091. * @param value Define the value to give to the uniform
  17092. * @return the material itself allowing "fluent" like uniform updates
  17093. */
  17094. setVector4(name: string, value: Vector4): ShaderMaterial;
  17095. /**
  17096. * Set a mat4 in the shader from a Matrix.
  17097. * @param name Define the name of the uniform as defined in the shader
  17098. * @param value Define the value to give to the uniform
  17099. * @return the material itself allowing "fluent" like uniform updates
  17100. */
  17101. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17102. /**
  17103. * Set a float32Array in the shader from a matrix array.
  17104. * @param name Define the name of the uniform as defined in the shader
  17105. * @param value Define the value to give to the uniform
  17106. * @return the material itself allowing "fluent" like uniform updates
  17107. */
  17108. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17109. /**
  17110. * Set a mat3 in the shader from a Float32Array.
  17111. * @param name Define the name of the uniform as defined in the shader
  17112. * @param value Define the value to give to the uniform
  17113. * @return the material itself allowing "fluent" like uniform updates
  17114. */
  17115. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17116. /**
  17117. * Set a mat2 in the shader from a Float32Array.
  17118. * @param name Define the name of the uniform as defined in the shader
  17119. * @param value Define the value to give to the uniform
  17120. * @return the material itself allowing "fluent" like uniform updates
  17121. */
  17122. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17123. /**
  17124. * Set a vec2 array in the shader from a number array.
  17125. * @param name Define the name of the uniform as defined in the shader
  17126. * @param value Define the value to give to the uniform
  17127. * @return the material itself allowing "fluent" like uniform updates
  17128. */
  17129. setArray2(name: string, value: number[]): ShaderMaterial;
  17130. /**
  17131. * Set a vec3 array in the shader from a number array.
  17132. * @param name Define the name of the uniform as defined in the shader
  17133. * @param value Define the value to give to the uniform
  17134. * @return the material itself allowing "fluent" like uniform updates
  17135. */
  17136. setArray3(name: string, value: number[]): ShaderMaterial;
  17137. /**
  17138. * Set a vec4 array in the shader from a number array.
  17139. * @param name Define the name of the uniform as defined in the shader
  17140. * @param value Define the value to give to the uniform
  17141. * @return the material itself allowing "fluent" like uniform updates
  17142. */
  17143. setArray4(name: string, value: number[]): ShaderMaterial;
  17144. private _checkCache;
  17145. /**
  17146. * Specifies that the submesh is ready to be used
  17147. * @param mesh defines the mesh to check
  17148. * @param subMesh defines which submesh to check
  17149. * @param useInstances specifies that instances should be used
  17150. * @returns a boolean indicating that the submesh is ready or not
  17151. */
  17152. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17153. /**
  17154. * Checks if the material is ready to render the requested mesh
  17155. * @param mesh Define the mesh to render
  17156. * @param useInstances Define whether or not the material is used with instances
  17157. * @returns true if ready, otherwise false
  17158. */
  17159. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17160. /**
  17161. * Binds the world matrix to the material
  17162. * @param world defines the world transformation matrix
  17163. * @param effectOverride - If provided, use this effect instead of internal effect
  17164. */
  17165. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17166. /**
  17167. * Binds the submesh to this material by preparing the effect and shader to draw
  17168. * @param world defines the world transformation matrix
  17169. * @param mesh defines the mesh containing the submesh
  17170. * @param subMesh defines the submesh to bind the material to
  17171. */
  17172. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17173. /**
  17174. * Binds the material to the mesh
  17175. * @param world defines the world transformation matrix
  17176. * @param mesh defines the mesh to bind the material to
  17177. * @param effectOverride - If provided, use this effect instead of internal effect
  17178. */
  17179. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17180. protected _afterBind(mesh?: Mesh): void;
  17181. /**
  17182. * Gets the active textures from the material
  17183. * @returns an array of textures
  17184. */
  17185. getActiveTextures(): BaseTexture[];
  17186. /**
  17187. * Specifies if the material uses a texture
  17188. * @param texture defines the texture to check against the material
  17189. * @returns a boolean specifying if the material uses the texture
  17190. */
  17191. hasTexture(texture: BaseTexture): boolean;
  17192. /**
  17193. * Makes a duplicate of the material, and gives it a new name
  17194. * @param name defines the new name for the duplicated material
  17195. * @returns the cloned material
  17196. */
  17197. clone(name: string): ShaderMaterial;
  17198. /**
  17199. * Disposes the material
  17200. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17201. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17202. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17203. */
  17204. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17205. /**
  17206. * Serializes this material in a JSON representation
  17207. * @returns the serialized material object
  17208. */
  17209. serialize(): any;
  17210. /**
  17211. * Creates a shader material from parsed shader material data
  17212. * @param source defines the JSON represnetation of the material
  17213. * @param scene defines the hosting scene
  17214. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17215. * @returns a new material
  17216. */
  17217. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17218. /**
  17219. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17220. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17221. * @param url defines the url to load from
  17222. * @param scene defines the hosting scene
  17223. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17224. * @returns a promise that will resolve to the new ShaderMaterial
  17225. */
  17226. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17227. /**
  17228. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17229. * @param snippetId defines the snippet to load
  17230. * @param scene defines the hosting scene
  17231. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17232. * @returns a promise that will resolve to the new ShaderMaterial
  17233. */
  17234. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17235. }
  17236. }
  17237. declare module "babylonjs/Shaders/color.fragment" {
  17238. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17239. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17240. /** @hidden */
  17241. export var colorPixelShader: {
  17242. name: string;
  17243. shader: string;
  17244. };
  17245. }
  17246. declare module "babylonjs/Shaders/color.vertex" {
  17247. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17248. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17249. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17250. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17251. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17252. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17253. /** @hidden */
  17254. export var colorVertexShader: {
  17255. name: string;
  17256. shader: string;
  17257. };
  17258. }
  17259. declare module "babylonjs/Meshes/linesMesh" {
  17260. import { Nullable } from "babylonjs/types";
  17261. import { Scene } from "babylonjs/scene";
  17262. import { Color3 } from "babylonjs/Maths/math.color";
  17263. import { Node } from "babylonjs/node";
  17264. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17265. import { Mesh } from "babylonjs/Meshes/mesh";
  17266. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17267. import { Effect } from "babylonjs/Materials/effect";
  17268. import { Material } from "babylonjs/Materials/material";
  17269. import "babylonjs/Shaders/color.fragment";
  17270. import "babylonjs/Shaders/color.vertex";
  17271. /**
  17272. * Line mesh
  17273. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17274. */
  17275. export class LinesMesh extends Mesh {
  17276. /**
  17277. * If vertex color should be applied to the mesh
  17278. */
  17279. readonly useVertexColor?: boolean | undefined;
  17280. /**
  17281. * If vertex alpha should be applied to the mesh
  17282. */
  17283. readonly useVertexAlpha?: boolean | undefined;
  17284. /**
  17285. * Color of the line (Default: White)
  17286. */
  17287. color: Color3;
  17288. /**
  17289. * Alpha of the line (Default: 1)
  17290. */
  17291. alpha: number;
  17292. /**
  17293. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17294. * This margin is expressed in world space coordinates, so its value may vary.
  17295. * Default value is 0.1
  17296. */
  17297. intersectionThreshold: number;
  17298. private _colorShader;
  17299. private color4;
  17300. /**
  17301. * Creates a new LinesMesh
  17302. * @param name defines the name
  17303. * @param scene defines the hosting scene
  17304. * @param parent defines the parent mesh if any
  17305. * @param source defines the optional source LinesMesh used to clone data from
  17306. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17307. * When false, achieved by calling a clone(), also passing False.
  17308. * This will make creation of children, recursive.
  17309. * @param useVertexColor defines if this LinesMesh supports vertex color
  17310. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17311. */
  17312. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17313. /**
  17314. * If vertex color should be applied to the mesh
  17315. */
  17316. useVertexColor?: boolean | undefined,
  17317. /**
  17318. * If vertex alpha should be applied to the mesh
  17319. */
  17320. useVertexAlpha?: boolean | undefined);
  17321. private _addClipPlaneDefine;
  17322. private _removeClipPlaneDefine;
  17323. isReady(): boolean;
  17324. /**
  17325. * Returns the string "LineMesh"
  17326. */
  17327. getClassName(): string;
  17328. /**
  17329. * @hidden
  17330. */
  17331. get material(): Material;
  17332. /**
  17333. * @hidden
  17334. */
  17335. set material(value: Material);
  17336. /**
  17337. * @hidden
  17338. */
  17339. get checkCollisions(): boolean;
  17340. /** @hidden */
  17341. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17342. /** @hidden */
  17343. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17344. /**
  17345. * Disposes of the line mesh
  17346. * @param doNotRecurse If children should be disposed
  17347. */
  17348. dispose(doNotRecurse?: boolean): void;
  17349. /**
  17350. * Returns a new LineMesh object cloned from the current one.
  17351. */
  17352. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17353. /**
  17354. * Creates a new InstancedLinesMesh object from the mesh model.
  17355. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17356. * @param name defines the name of the new instance
  17357. * @returns a new InstancedLinesMesh
  17358. */
  17359. createInstance(name: string): InstancedLinesMesh;
  17360. }
  17361. /**
  17362. * Creates an instance based on a source LinesMesh
  17363. */
  17364. export class InstancedLinesMesh extends InstancedMesh {
  17365. /**
  17366. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17367. * This margin is expressed in world space coordinates, so its value may vary.
  17368. * Initilized with the intersectionThreshold value of the source LinesMesh
  17369. */
  17370. intersectionThreshold: number;
  17371. constructor(name: string, source: LinesMesh);
  17372. /**
  17373. * Returns the string "InstancedLinesMesh".
  17374. */
  17375. getClassName(): string;
  17376. }
  17377. }
  17378. declare module "babylonjs/Shaders/line.fragment" {
  17379. /** @hidden */
  17380. export var linePixelShader: {
  17381. name: string;
  17382. shader: string;
  17383. };
  17384. }
  17385. declare module "babylonjs/Shaders/line.vertex" {
  17386. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17387. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17388. /** @hidden */
  17389. export var lineVertexShader: {
  17390. name: string;
  17391. shader: string;
  17392. };
  17393. }
  17394. declare module "babylonjs/Rendering/edgesRenderer" {
  17395. import { Nullable } from "babylonjs/types";
  17396. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17397. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17398. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17399. import { IDisposable } from "babylonjs/scene";
  17400. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17401. import "babylonjs/Shaders/line.fragment";
  17402. import "babylonjs/Shaders/line.vertex";
  17403. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17404. import { SmartArray } from "babylonjs/Misc/smartArray";
  17405. module "babylonjs/scene" {
  17406. interface Scene {
  17407. /** @hidden */
  17408. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17409. }
  17410. }
  17411. module "babylonjs/Meshes/abstractMesh" {
  17412. interface AbstractMesh {
  17413. /**
  17414. * Gets the edgesRenderer associated with the mesh
  17415. */
  17416. edgesRenderer: Nullable<EdgesRenderer>;
  17417. }
  17418. }
  17419. module "babylonjs/Meshes/linesMesh" {
  17420. interface LinesMesh {
  17421. /**
  17422. * Enables the edge rendering mode on the mesh.
  17423. * This mode makes the mesh edges visible
  17424. * @param epsilon defines the maximal distance between two angles to detect a face
  17425. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17426. * @returns the currentAbstractMesh
  17427. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17428. */
  17429. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17430. }
  17431. }
  17432. module "babylonjs/Meshes/linesMesh" {
  17433. interface InstancedLinesMesh {
  17434. /**
  17435. * Enables the edge rendering mode on the mesh.
  17436. * This mode makes the mesh edges visible
  17437. * @param epsilon defines the maximal distance between two angles to detect a face
  17438. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17439. * @returns the current InstancedLinesMesh
  17440. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17441. */
  17442. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17443. }
  17444. }
  17445. /**
  17446. * Defines the minimum contract an Edges renderer should follow.
  17447. */
  17448. export interface IEdgesRenderer extends IDisposable {
  17449. /**
  17450. * Gets or sets a boolean indicating if the edgesRenderer is active
  17451. */
  17452. isEnabled: boolean;
  17453. /**
  17454. * Renders the edges of the attached mesh,
  17455. */
  17456. render(): void;
  17457. /**
  17458. * Checks wether or not the edges renderer is ready to render.
  17459. * @return true if ready, otherwise false.
  17460. */
  17461. isReady(): boolean;
  17462. /**
  17463. * List of instances to render in case the source mesh has instances
  17464. */
  17465. customInstances: SmartArray<Matrix>;
  17466. }
  17467. /**
  17468. * Defines the additional options of the edges renderer
  17469. */
  17470. export interface IEdgesRendererOptions {
  17471. /**
  17472. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17473. * If not defined, the default value is true
  17474. */
  17475. useAlternateEdgeFinder?: boolean;
  17476. /**
  17477. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17478. * If not defined, the default value is true.
  17479. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  17480. * This option is used only if useAlternateEdgeFinder = true
  17481. */
  17482. useFastVertexMerger?: boolean;
  17483. /**
  17484. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17485. * The default value is 1e-6
  17486. * This option is used only if useAlternateEdgeFinder = true
  17487. */
  17488. epsilonVertexMerge?: number;
  17489. /**
  17490. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  17491. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  17492. * This option is used only if useAlternateEdgeFinder = true
  17493. */
  17494. applyTessellation?: boolean;
  17495. /**
  17496. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  17497. * The default value is 1e-6
  17498. * This option is used only if useAlternateEdgeFinder = true
  17499. */
  17500. epsilonVertexAligned?: number;
  17501. }
  17502. /**
  17503. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17504. */
  17505. export class EdgesRenderer implements IEdgesRenderer {
  17506. /**
  17507. * Define the size of the edges with an orthographic camera
  17508. */
  17509. edgesWidthScalerForOrthographic: number;
  17510. /**
  17511. * Define the size of the edges with a perspective camera
  17512. */
  17513. edgesWidthScalerForPerspective: number;
  17514. protected _source: AbstractMesh;
  17515. protected _linesPositions: number[];
  17516. protected _linesNormals: number[];
  17517. protected _linesIndices: number[];
  17518. protected _epsilon: number;
  17519. protected _indicesCount: number;
  17520. protected _lineShader: ShaderMaterial;
  17521. protected _ib: DataBuffer;
  17522. protected _buffers: {
  17523. [key: string]: Nullable<VertexBuffer>;
  17524. };
  17525. protected _buffersForInstances: {
  17526. [key: string]: Nullable<VertexBuffer>;
  17527. };
  17528. protected _checkVerticesInsteadOfIndices: boolean;
  17529. protected _options: Nullable<IEdgesRendererOptions>;
  17530. private _meshRebuildObserver;
  17531. private _meshDisposeObserver;
  17532. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17533. isEnabled: boolean;
  17534. /**
  17535. * List of instances to render in case the source mesh has instances
  17536. */
  17537. customInstances: SmartArray<Matrix>;
  17538. private static GetShader;
  17539. /**
  17540. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17541. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17542. * @param source Mesh used to create edges
  17543. * @param epsilon sum of angles in adjacency to check for edge
  17544. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17545. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17546. * @param options The options to apply when generating the edges
  17547. */
  17548. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17549. protected _prepareRessources(): void;
  17550. /** @hidden */
  17551. _rebuild(): void;
  17552. /**
  17553. * Releases the required resources for the edges renderer
  17554. */
  17555. dispose(): void;
  17556. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17557. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17558. /**
  17559. * Checks if the pair of p0 and p1 is en edge
  17560. * @param faceIndex
  17561. * @param edge
  17562. * @param faceNormals
  17563. * @param p0
  17564. * @param p1
  17565. * @private
  17566. */
  17567. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17568. /**
  17569. * push line into the position, normal and index buffer
  17570. * @protected
  17571. */
  17572. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17573. /**
  17574. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17575. */
  17576. private _tessellateTriangle;
  17577. private _generateEdgesLinesAlternate;
  17578. /**
  17579. * Generates lines edges from adjacencjes
  17580. * @private
  17581. */
  17582. _generateEdgesLines(): void;
  17583. /**
  17584. * Checks wether or not the edges renderer is ready to render.
  17585. * @return true if ready, otherwise false.
  17586. */
  17587. isReady(): boolean;
  17588. /**
  17589. * Renders the edges of the attached mesh,
  17590. */
  17591. render(): void;
  17592. }
  17593. /**
  17594. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17595. */
  17596. export class LineEdgesRenderer extends EdgesRenderer {
  17597. /**
  17598. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17599. * @param source LineMesh used to generate edges
  17600. * @param epsilon not important (specified angle for edge detection)
  17601. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17602. */
  17603. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17604. /**
  17605. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17606. */
  17607. _generateEdgesLines(): void;
  17608. }
  17609. }
  17610. declare module "babylonjs/Rendering/renderingGroup" {
  17611. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17612. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17613. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17614. import { Nullable } from "babylonjs/types";
  17615. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17616. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17617. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17618. import { Material } from "babylonjs/Materials/material";
  17619. import { Scene } from "babylonjs/scene";
  17620. /**
  17621. * This represents the object necessary to create a rendering group.
  17622. * This is exclusively used and created by the rendering manager.
  17623. * To modify the behavior, you use the available helpers in your scene or meshes.
  17624. * @hidden
  17625. */
  17626. export class RenderingGroup {
  17627. index: number;
  17628. private static _zeroVector;
  17629. private _scene;
  17630. private _opaqueSubMeshes;
  17631. private _transparentSubMeshes;
  17632. private _alphaTestSubMeshes;
  17633. private _depthOnlySubMeshes;
  17634. private _particleSystems;
  17635. private _spriteManagers;
  17636. private _opaqueSortCompareFn;
  17637. private _alphaTestSortCompareFn;
  17638. private _transparentSortCompareFn;
  17639. private _renderOpaque;
  17640. private _renderAlphaTest;
  17641. private _renderTransparent;
  17642. /** @hidden */
  17643. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17644. onBeforeTransparentRendering: () => void;
  17645. /**
  17646. * Set the opaque sort comparison function.
  17647. * If null the sub meshes will be render in the order they were created
  17648. */
  17649. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17650. /**
  17651. * Set the alpha test sort comparison function.
  17652. * If null the sub meshes will be render in the order they were created
  17653. */
  17654. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17655. /**
  17656. * Set the transparent sort comparison function.
  17657. * If null the sub meshes will be render in the order they were created
  17658. */
  17659. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17660. /**
  17661. * Creates a new rendering group.
  17662. * @param index The rendering group index
  17663. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17664. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17665. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17666. */
  17667. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17668. /**
  17669. * Render all the sub meshes contained in the group.
  17670. * @param customRenderFunction Used to override the default render behaviour of the group.
  17671. * @returns true if rendered some submeshes.
  17672. */
  17673. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17674. /**
  17675. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17676. * @param subMeshes The submeshes to render
  17677. */
  17678. private renderOpaqueSorted;
  17679. /**
  17680. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17681. * @param subMeshes The submeshes to render
  17682. */
  17683. private renderAlphaTestSorted;
  17684. /**
  17685. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17686. * @param subMeshes The submeshes to render
  17687. */
  17688. private renderTransparentSorted;
  17689. /**
  17690. * Renders the submeshes in a specified order.
  17691. * @param subMeshes The submeshes to sort before render
  17692. * @param sortCompareFn The comparison function use to sort
  17693. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17694. * @param transparent Specifies to activate blending if true
  17695. */
  17696. private static renderSorted;
  17697. /**
  17698. * Renders the submeshes in the order they were dispatched (no sort applied).
  17699. * @param subMeshes The submeshes to render
  17700. */
  17701. private static renderUnsorted;
  17702. /**
  17703. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17704. * are rendered back to front if in the same alpha index.
  17705. *
  17706. * @param a The first submesh
  17707. * @param b The second submesh
  17708. * @returns The result of the comparison
  17709. */
  17710. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17711. /**
  17712. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17713. * are rendered back to front.
  17714. *
  17715. * @param a The first submesh
  17716. * @param b The second submesh
  17717. * @returns The result of the comparison
  17718. */
  17719. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17720. /**
  17721. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17722. * are rendered front to back (prevent overdraw).
  17723. *
  17724. * @param a The first submesh
  17725. * @param b The second submesh
  17726. * @returns The result of the comparison
  17727. */
  17728. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17729. /**
  17730. * Resets the different lists of submeshes to prepare a new frame.
  17731. */
  17732. prepare(): void;
  17733. dispose(): void;
  17734. /**
  17735. * Inserts the submesh in its correct queue depending on its material.
  17736. * @param subMesh The submesh to dispatch
  17737. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17738. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17739. */
  17740. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17741. dispatchSprites(spriteManager: ISpriteManager): void;
  17742. dispatchParticles(particleSystem: IParticleSystem): void;
  17743. private _renderParticles;
  17744. private _renderSprites;
  17745. }
  17746. }
  17747. declare module "babylonjs/Rendering/renderingManager" {
  17748. import { Nullable } from "babylonjs/types";
  17749. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17750. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17751. import { SmartArray } from "babylonjs/Misc/smartArray";
  17752. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17753. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17754. import { Material } from "babylonjs/Materials/material";
  17755. import { Scene } from "babylonjs/scene";
  17756. import { Camera } from "babylonjs/Cameras/camera";
  17757. /**
  17758. * Interface describing the different options available in the rendering manager
  17759. * regarding Auto Clear between groups.
  17760. */
  17761. export interface IRenderingManagerAutoClearSetup {
  17762. /**
  17763. * Defines whether or not autoclear is enable.
  17764. */
  17765. autoClear: boolean;
  17766. /**
  17767. * Defines whether or not to autoclear the depth buffer.
  17768. */
  17769. depth: boolean;
  17770. /**
  17771. * Defines whether or not to autoclear the stencil buffer.
  17772. */
  17773. stencil: boolean;
  17774. }
  17775. /**
  17776. * This class is used by the onRenderingGroupObservable
  17777. */
  17778. export class RenderingGroupInfo {
  17779. /**
  17780. * The Scene that being rendered
  17781. */
  17782. scene: Scene;
  17783. /**
  17784. * The camera currently used for the rendering pass
  17785. */
  17786. camera: Nullable<Camera>;
  17787. /**
  17788. * The ID of the renderingGroup being processed
  17789. */
  17790. renderingGroupId: number;
  17791. }
  17792. /**
  17793. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17794. * It is enable to manage the different groups as well as the different necessary sort functions.
  17795. * This should not be used directly aside of the few static configurations
  17796. */
  17797. export class RenderingManager {
  17798. /**
  17799. * The max id used for rendering groups (not included)
  17800. */
  17801. static MAX_RENDERINGGROUPS: number;
  17802. /**
  17803. * The min id used for rendering groups (included)
  17804. */
  17805. static MIN_RENDERINGGROUPS: number;
  17806. /**
  17807. * Used to globally prevent autoclearing scenes.
  17808. */
  17809. static AUTOCLEAR: boolean;
  17810. /**
  17811. * @hidden
  17812. */
  17813. _useSceneAutoClearSetup: boolean;
  17814. private _scene;
  17815. private _renderingGroups;
  17816. private _depthStencilBufferAlreadyCleaned;
  17817. private _autoClearDepthStencil;
  17818. private _customOpaqueSortCompareFn;
  17819. private _customAlphaTestSortCompareFn;
  17820. private _customTransparentSortCompareFn;
  17821. private _renderingGroupInfo;
  17822. /**
  17823. * Instantiates a new rendering group for a particular scene
  17824. * @param scene Defines the scene the groups belongs to
  17825. */
  17826. constructor(scene: Scene);
  17827. private _clearDepthStencilBuffer;
  17828. /**
  17829. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17830. * @hidden
  17831. */
  17832. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17833. /**
  17834. * Resets the different information of the group to prepare a new frame
  17835. * @hidden
  17836. */
  17837. reset(): void;
  17838. /**
  17839. * Dispose and release the group and its associated resources.
  17840. * @hidden
  17841. */
  17842. dispose(): void;
  17843. /**
  17844. * Clear the info related to rendering groups preventing retention points during dispose.
  17845. */
  17846. freeRenderingGroups(): void;
  17847. private _prepareRenderingGroup;
  17848. /**
  17849. * Add a sprite manager to the rendering manager in order to render it this frame.
  17850. * @param spriteManager Define the sprite manager to render
  17851. */
  17852. dispatchSprites(spriteManager: ISpriteManager): void;
  17853. /**
  17854. * Add a particle system to the rendering manager in order to render it this frame.
  17855. * @param particleSystem Define the particle system to render
  17856. */
  17857. dispatchParticles(particleSystem: IParticleSystem): void;
  17858. /**
  17859. * Add a submesh to the manager in order to render it this frame
  17860. * @param subMesh The submesh to dispatch
  17861. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17862. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17863. */
  17864. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17865. /**
  17866. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17867. * This allowed control for front to back rendering or reversly depending of the special needs.
  17868. *
  17869. * @param renderingGroupId The rendering group id corresponding to its index
  17870. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17871. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17872. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17873. */
  17874. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  17875. /**
  17876. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17877. *
  17878. * @param renderingGroupId The rendering group id corresponding to its index
  17879. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17880. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17881. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17882. */
  17883. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17884. /**
  17885. * Gets the current auto clear configuration for one rendering group of the rendering
  17886. * manager.
  17887. * @param index the rendering group index to get the information for
  17888. * @returns The auto clear setup for the requested rendering group
  17889. */
  17890. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17891. }
  17892. }
  17893. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17894. import { SmartArray } from "babylonjs/Misc/smartArray";
  17895. import { Nullable } from "babylonjs/types";
  17896. import { Scene } from "babylonjs/scene";
  17897. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17898. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17899. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17900. import { Mesh } from "babylonjs/Meshes/mesh";
  17901. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17902. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17903. import { Effect } from "babylonjs/Materials/effect";
  17904. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17905. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17906. import "babylonjs/Shaders/shadowMap.fragment";
  17907. import "babylonjs/Shaders/shadowMap.vertex";
  17908. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17909. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17910. import { Observable } from "babylonjs/Misc/observable";
  17911. /**
  17912. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17913. */
  17914. export interface ICustomShaderOptions {
  17915. /**
  17916. * Gets or sets the custom shader name to use
  17917. */
  17918. shaderName: string;
  17919. /**
  17920. * The list of attribute names used in the shader
  17921. */
  17922. attributes?: string[];
  17923. /**
  17924. * The list of unifrom names used in the shader
  17925. */
  17926. uniforms?: string[];
  17927. /**
  17928. * The list of sampler names used in the shader
  17929. */
  17930. samplers?: string[];
  17931. /**
  17932. * The list of defines used in the shader
  17933. */
  17934. defines?: string[];
  17935. }
  17936. /**
  17937. * Interface to implement to create a shadow generator compatible with BJS.
  17938. */
  17939. export interface IShadowGenerator {
  17940. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17941. id: string;
  17942. /**
  17943. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17944. * @returns The render target texture if present otherwise, null
  17945. */
  17946. getShadowMap(): Nullable<RenderTargetTexture>;
  17947. /**
  17948. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17949. * @param subMesh The submesh we want to render in the shadow map
  17950. * @param useInstances Defines wether will draw in the map using instances
  17951. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17952. * @returns true if ready otherwise, false
  17953. */
  17954. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17955. /**
  17956. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17957. * @param defines Defines of the material we want to update
  17958. * @param lightIndex Index of the light in the enabled light list of the material
  17959. */
  17960. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17961. /**
  17962. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17963. * defined in the generator but impacting the effect).
  17964. * It implies the unifroms available on the materials are the standard BJS ones.
  17965. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17966. * @param effect The effect we are binfing the information for
  17967. */
  17968. bindShadowLight(lightIndex: string, effect: Effect): void;
  17969. /**
  17970. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17971. * (eq to shadow prjection matrix * light transform matrix)
  17972. * @returns The transform matrix used to create the shadow map
  17973. */
  17974. getTransformMatrix(): Matrix;
  17975. /**
  17976. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17977. * Cube and 2D textures for instance.
  17978. */
  17979. recreateShadowMap(): void;
  17980. /**
  17981. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17982. * @param onCompiled Callback triggered at the and of the effects compilation
  17983. * @param options Sets of optional options forcing the compilation with different modes
  17984. */
  17985. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17986. useInstances: boolean;
  17987. }>): void;
  17988. /**
  17989. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17990. * @param options Sets of optional options forcing the compilation with different modes
  17991. * @returns A promise that resolves when the compilation completes
  17992. */
  17993. forceCompilationAsync(options?: Partial<{
  17994. useInstances: boolean;
  17995. }>): Promise<void>;
  17996. /**
  17997. * Serializes the shadow generator setup to a json object.
  17998. * @returns The serialized JSON object
  17999. */
  18000. serialize(): any;
  18001. /**
  18002. * Disposes the Shadow map and related Textures and effects.
  18003. */
  18004. dispose(): void;
  18005. }
  18006. /**
  18007. * Default implementation IShadowGenerator.
  18008. * This is the main object responsible of generating shadows in the framework.
  18009. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18010. */
  18011. export class ShadowGenerator implements IShadowGenerator {
  18012. /**
  18013. * Name of the shadow generator class
  18014. */
  18015. static CLASSNAME: string;
  18016. /**
  18017. * Shadow generator mode None: no filtering applied.
  18018. */
  18019. static readonly FILTER_NONE: number;
  18020. /**
  18021. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18022. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18023. */
  18024. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18025. /**
  18026. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18027. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18028. */
  18029. static readonly FILTER_POISSONSAMPLING: number;
  18030. /**
  18031. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18032. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18033. */
  18034. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18035. /**
  18036. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18037. * edge artifacts on steep falloff.
  18038. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18039. */
  18040. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18041. /**
  18042. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18043. * edge artifacts on steep falloff.
  18044. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18045. */
  18046. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18047. /**
  18048. * Shadow generator mode PCF: Percentage Closer Filtering
  18049. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18050. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18051. */
  18052. static readonly FILTER_PCF: number;
  18053. /**
  18054. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18055. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18056. * Contact Hardening
  18057. */
  18058. static readonly FILTER_PCSS: number;
  18059. /**
  18060. * Reserved for PCF and PCSS
  18061. * Highest Quality.
  18062. *
  18063. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18064. *
  18065. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18066. */
  18067. static readonly QUALITY_HIGH: number;
  18068. /**
  18069. * Reserved for PCF and PCSS
  18070. * Good tradeoff for quality/perf cross devices
  18071. *
  18072. * Execute PCF on a 3*3 kernel.
  18073. *
  18074. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18075. */
  18076. static readonly QUALITY_MEDIUM: number;
  18077. /**
  18078. * Reserved for PCF and PCSS
  18079. * The lowest quality but the fastest.
  18080. *
  18081. * Execute PCF on a 1*1 kernel.
  18082. *
  18083. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18084. */
  18085. static readonly QUALITY_LOW: number;
  18086. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18087. id: string;
  18088. /** Gets or sets the custom shader name to use */
  18089. customShaderOptions: ICustomShaderOptions;
  18090. /**
  18091. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18092. */
  18093. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18094. /**
  18095. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18096. */
  18097. onAfterShadowMapRenderObservable: Observable<Effect>;
  18098. /**
  18099. * Observable triggered before a mesh is rendered in the shadow map.
  18100. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18101. */
  18102. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18103. /**
  18104. * Observable triggered after a mesh is rendered in the shadow map.
  18105. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18106. */
  18107. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18108. protected _bias: number;
  18109. /**
  18110. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18111. */
  18112. get bias(): number;
  18113. /**
  18114. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18115. */
  18116. set bias(bias: number);
  18117. protected _normalBias: number;
  18118. /**
  18119. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18120. */
  18121. get normalBias(): number;
  18122. /**
  18123. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18124. */
  18125. set normalBias(normalBias: number);
  18126. protected _blurBoxOffset: number;
  18127. /**
  18128. * Gets the blur box offset: offset applied during the blur pass.
  18129. * Only useful if useKernelBlur = false
  18130. */
  18131. get blurBoxOffset(): number;
  18132. /**
  18133. * Sets the blur box offset: offset applied during the blur pass.
  18134. * Only useful if useKernelBlur = false
  18135. */
  18136. set blurBoxOffset(value: number);
  18137. protected _blurScale: number;
  18138. /**
  18139. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18140. * 2 means half of the size.
  18141. */
  18142. get blurScale(): number;
  18143. /**
  18144. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18145. * 2 means half of the size.
  18146. */
  18147. set blurScale(value: number);
  18148. protected _blurKernel: number;
  18149. /**
  18150. * Gets the blur kernel: kernel size of the blur pass.
  18151. * Only useful if useKernelBlur = true
  18152. */
  18153. get blurKernel(): number;
  18154. /**
  18155. * Sets the blur kernel: kernel size of the blur pass.
  18156. * Only useful if useKernelBlur = true
  18157. */
  18158. set blurKernel(value: number);
  18159. protected _useKernelBlur: boolean;
  18160. /**
  18161. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18162. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18163. */
  18164. get useKernelBlur(): boolean;
  18165. /**
  18166. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18167. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18168. */
  18169. set useKernelBlur(value: boolean);
  18170. protected _depthScale: number;
  18171. /**
  18172. * Gets the depth scale used in ESM mode.
  18173. */
  18174. get depthScale(): number;
  18175. /**
  18176. * Sets the depth scale used in ESM mode.
  18177. * This can override the scale stored on the light.
  18178. */
  18179. set depthScale(value: number);
  18180. protected _validateFilter(filter: number): number;
  18181. protected _filter: number;
  18182. /**
  18183. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18184. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18185. */
  18186. get filter(): number;
  18187. /**
  18188. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18189. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18190. */
  18191. set filter(value: number);
  18192. /**
  18193. * Gets if the current filter is set to Poisson Sampling.
  18194. */
  18195. get usePoissonSampling(): boolean;
  18196. /**
  18197. * Sets the current filter to Poisson Sampling.
  18198. */
  18199. set usePoissonSampling(value: boolean);
  18200. /**
  18201. * Gets if the current filter is set to ESM.
  18202. */
  18203. get useExponentialShadowMap(): boolean;
  18204. /**
  18205. * Sets the current filter is to ESM.
  18206. */
  18207. set useExponentialShadowMap(value: boolean);
  18208. /**
  18209. * Gets if the current filter is set to filtered ESM.
  18210. */
  18211. get useBlurExponentialShadowMap(): boolean;
  18212. /**
  18213. * Gets if the current filter is set to filtered ESM.
  18214. */
  18215. set useBlurExponentialShadowMap(value: boolean);
  18216. /**
  18217. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18218. * exponential to prevent steep falloff artifacts).
  18219. */
  18220. get useCloseExponentialShadowMap(): boolean;
  18221. /**
  18222. * Sets the current filter to "close ESM" (using the inverse of the
  18223. * exponential to prevent steep falloff artifacts).
  18224. */
  18225. set useCloseExponentialShadowMap(value: boolean);
  18226. /**
  18227. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18228. * exponential to prevent steep falloff artifacts).
  18229. */
  18230. get useBlurCloseExponentialShadowMap(): boolean;
  18231. /**
  18232. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18233. * exponential to prevent steep falloff artifacts).
  18234. */
  18235. set useBlurCloseExponentialShadowMap(value: boolean);
  18236. /**
  18237. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18238. */
  18239. get usePercentageCloserFiltering(): boolean;
  18240. /**
  18241. * Sets the current filter to "PCF" (percentage closer filtering).
  18242. */
  18243. set usePercentageCloserFiltering(value: boolean);
  18244. protected _filteringQuality: number;
  18245. /**
  18246. * Gets the PCF or PCSS Quality.
  18247. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18248. */
  18249. get filteringQuality(): number;
  18250. /**
  18251. * Sets the PCF or PCSS Quality.
  18252. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18253. */
  18254. set filteringQuality(filteringQuality: number);
  18255. /**
  18256. * Gets if the current filter is set to "PCSS" (contact hardening).
  18257. */
  18258. get useContactHardeningShadow(): boolean;
  18259. /**
  18260. * Sets the current filter to "PCSS" (contact hardening).
  18261. */
  18262. set useContactHardeningShadow(value: boolean);
  18263. protected _contactHardeningLightSizeUVRatio: number;
  18264. /**
  18265. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18266. * Using a ratio helps keeping shape stability independently of the map size.
  18267. *
  18268. * It does not account for the light projection as it was having too much
  18269. * instability during the light setup or during light position changes.
  18270. *
  18271. * Only valid if useContactHardeningShadow is true.
  18272. */
  18273. get contactHardeningLightSizeUVRatio(): number;
  18274. /**
  18275. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18276. * Using a ratio helps keeping shape stability independently of the map size.
  18277. *
  18278. * It does not account for the light projection as it was having too much
  18279. * instability during the light setup or during light position changes.
  18280. *
  18281. * Only valid if useContactHardeningShadow is true.
  18282. */
  18283. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18284. protected _darkness: number;
  18285. /** Gets or sets the actual darkness of a shadow */
  18286. get darkness(): number;
  18287. set darkness(value: number);
  18288. /**
  18289. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18290. * 0 means strongest and 1 would means no shadow.
  18291. * @returns the darkness.
  18292. */
  18293. getDarkness(): number;
  18294. /**
  18295. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18296. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18297. * @returns the shadow generator allowing fluent coding.
  18298. */
  18299. setDarkness(darkness: number): ShadowGenerator;
  18300. protected _transparencyShadow: boolean;
  18301. /** Gets or sets the ability to have transparent shadow */
  18302. get transparencyShadow(): boolean;
  18303. set transparencyShadow(value: boolean);
  18304. /**
  18305. * Sets the ability to have transparent shadow (boolean).
  18306. * @param transparent True if transparent else False
  18307. * @returns the shadow generator allowing fluent coding
  18308. */
  18309. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18310. /**
  18311. * Enables or disables shadows with varying strength based on the transparency
  18312. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18313. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18314. * mesh.visibility * alphaTexture.a
  18315. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18316. */
  18317. enableSoftTransparentShadow: boolean;
  18318. protected _shadowMap: Nullable<RenderTargetTexture>;
  18319. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18320. /**
  18321. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18322. * @returns The render target texture if present otherwise, null
  18323. */
  18324. getShadowMap(): Nullable<RenderTargetTexture>;
  18325. /**
  18326. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18327. * @returns The render target texture if the shadow map is present otherwise, null
  18328. */
  18329. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18330. /**
  18331. * Gets the class name of that object
  18332. * @returns "ShadowGenerator"
  18333. */
  18334. getClassName(): string;
  18335. /**
  18336. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18337. * @param mesh Mesh to add
  18338. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18339. * @returns the Shadow Generator itself
  18340. */
  18341. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18342. /**
  18343. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18344. * @param mesh Mesh to remove
  18345. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18346. * @returns the Shadow Generator itself
  18347. */
  18348. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18349. /**
  18350. * Controls the extent to which the shadows fade out at the edge of the frustum
  18351. */
  18352. frustumEdgeFalloff: number;
  18353. protected _light: IShadowLight;
  18354. /**
  18355. * Returns the associated light object.
  18356. * @returns the light generating the shadow
  18357. */
  18358. getLight(): IShadowLight;
  18359. /**
  18360. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18361. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18362. * It might on the other hand introduce peter panning.
  18363. */
  18364. forceBackFacesOnly: boolean;
  18365. protected _scene: Scene;
  18366. protected _lightDirection: Vector3;
  18367. protected _effect: Effect;
  18368. protected _viewMatrix: Matrix;
  18369. protected _projectionMatrix: Matrix;
  18370. protected _transformMatrix: Matrix;
  18371. protected _cachedPosition: Vector3;
  18372. protected _cachedDirection: Vector3;
  18373. protected _cachedDefines: string;
  18374. protected _currentRenderID: number;
  18375. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18376. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18377. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18378. protected _blurPostProcesses: PostProcess[];
  18379. protected _mapSize: number;
  18380. protected _currentFaceIndex: number;
  18381. protected _currentFaceIndexCache: number;
  18382. protected _textureType: number;
  18383. protected _defaultTextureMatrix: Matrix;
  18384. protected _storedUniqueId: Nullable<number>;
  18385. /** @hidden */
  18386. static _SceneComponentInitialization: (scene: Scene) => void;
  18387. /**
  18388. * Creates a ShadowGenerator object.
  18389. * A ShadowGenerator is the required tool to use the shadows.
  18390. * Each light casting shadows needs to use its own ShadowGenerator.
  18391. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18392. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18393. * @param light The light object generating the shadows.
  18394. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  18395. */
  18396. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18397. protected _initializeGenerator(): void;
  18398. protected _createTargetRenderTexture(): void;
  18399. protected _initializeShadowMap(): void;
  18400. protected _initializeBlurRTTAndPostProcesses(): void;
  18401. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18402. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18403. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18404. protected _applyFilterValues(): void;
  18405. /**
  18406. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18407. * @param onCompiled Callback triggered at the and of the effects compilation
  18408. * @param options Sets of optional options forcing the compilation with different modes
  18409. */
  18410. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18411. useInstances: boolean;
  18412. }>): void;
  18413. /**
  18414. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18415. * @param options Sets of optional options forcing the compilation with different modes
  18416. * @returns A promise that resolves when the compilation completes
  18417. */
  18418. forceCompilationAsync(options?: Partial<{
  18419. useInstances: boolean;
  18420. }>): Promise<void>;
  18421. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18422. private _prepareShadowDefines;
  18423. /**
  18424. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18425. * @param subMesh The submesh we want to render in the shadow map
  18426. * @param useInstances Defines wether will draw in the map using instances
  18427. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18428. * @returns true if ready otherwise, false
  18429. */
  18430. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18431. /**
  18432. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18433. * @param defines Defines of the material we want to update
  18434. * @param lightIndex Index of the light in the enabled light list of the material
  18435. */
  18436. prepareDefines(defines: any, lightIndex: number): void;
  18437. /**
  18438. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18439. * defined in the generator but impacting the effect).
  18440. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18441. * @param effect The effect we are binfing the information for
  18442. */
  18443. bindShadowLight(lightIndex: string, effect: Effect): void;
  18444. /**
  18445. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18446. * (eq to shadow prjection matrix * light transform matrix)
  18447. * @returns The transform matrix used to create the shadow map
  18448. */
  18449. getTransformMatrix(): Matrix;
  18450. /**
  18451. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18452. * Cube and 2D textures for instance.
  18453. */
  18454. recreateShadowMap(): void;
  18455. protected _disposeBlurPostProcesses(): void;
  18456. protected _disposeRTTandPostProcesses(): void;
  18457. /**
  18458. * Disposes the ShadowGenerator.
  18459. * Returns nothing.
  18460. */
  18461. dispose(): void;
  18462. /**
  18463. * Serializes the shadow generator setup to a json object.
  18464. * @returns The serialized JSON object
  18465. */
  18466. serialize(): any;
  18467. /**
  18468. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18469. * @param parsedShadowGenerator The JSON object to parse
  18470. * @param scene The scene to create the shadow map for
  18471. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18472. * @returns The parsed shadow generator
  18473. */
  18474. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18475. }
  18476. }
  18477. declare module "babylonjs/Lights/light" {
  18478. import { Nullable } from "babylonjs/types";
  18479. import { Scene } from "babylonjs/scene";
  18480. import { Vector3 } from "babylonjs/Maths/math.vector";
  18481. import { Color3 } from "babylonjs/Maths/math.color";
  18482. import { Node } from "babylonjs/node";
  18483. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18484. import { Effect } from "babylonjs/Materials/effect";
  18485. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18486. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18487. /**
  18488. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18489. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18490. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  18491. */
  18492. export abstract class Light extends Node {
  18493. /**
  18494. * Falloff Default: light is falling off following the material specification:
  18495. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18496. */
  18497. static readonly FALLOFF_DEFAULT: number;
  18498. /**
  18499. * Falloff Physical: light is falling off following the inverse squared distance law.
  18500. */
  18501. static readonly FALLOFF_PHYSICAL: number;
  18502. /**
  18503. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18504. * to enhance interoperability with other engines.
  18505. */
  18506. static readonly FALLOFF_GLTF: number;
  18507. /**
  18508. * Falloff Standard: light is falling off like in the standard material
  18509. * to enhance interoperability with other materials.
  18510. */
  18511. static readonly FALLOFF_STANDARD: number;
  18512. /**
  18513. * If every light affecting the material is in this lightmapMode,
  18514. * material.lightmapTexture adds or multiplies
  18515. * (depends on material.useLightmapAsShadowmap)
  18516. * after every other light calculations.
  18517. */
  18518. static readonly LIGHTMAP_DEFAULT: number;
  18519. /**
  18520. * material.lightmapTexture as only diffuse lighting from this light
  18521. * adds only specular lighting from this light
  18522. * adds dynamic shadows
  18523. */
  18524. static readonly LIGHTMAP_SPECULAR: number;
  18525. /**
  18526. * material.lightmapTexture as only lighting
  18527. * no light calculation from this light
  18528. * only adds dynamic shadows from this light
  18529. */
  18530. static readonly LIGHTMAP_SHADOWSONLY: number;
  18531. /**
  18532. * Each light type uses the default quantity according to its type:
  18533. * point/spot lights use luminous intensity
  18534. * directional lights use illuminance
  18535. */
  18536. static readonly INTENSITYMODE_AUTOMATIC: number;
  18537. /**
  18538. * lumen (lm)
  18539. */
  18540. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18541. /**
  18542. * candela (lm/sr)
  18543. */
  18544. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18545. /**
  18546. * lux (lm/m^2)
  18547. */
  18548. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18549. /**
  18550. * nit (cd/m^2)
  18551. */
  18552. static readonly INTENSITYMODE_LUMINANCE: number;
  18553. /**
  18554. * Light type const id of the point light.
  18555. */
  18556. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18557. /**
  18558. * Light type const id of the directional light.
  18559. */
  18560. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18561. /**
  18562. * Light type const id of the spot light.
  18563. */
  18564. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18565. /**
  18566. * Light type const id of the hemispheric light.
  18567. */
  18568. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18569. /**
  18570. * Diffuse gives the basic color to an object.
  18571. */
  18572. diffuse: Color3;
  18573. /**
  18574. * Specular produces a highlight color on an object.
  18575. * Note: This is note affecting PBR materials.
  18576. */
  18577. specular: Color3;
  18578. /**
  18579. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18580. * falling off base on range or angle.
  18581. * This can be set to any values in Light.FALLOFF_x.
  18582. *
  18583. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18584. * other types of materials.
  18585. */
  18586. falloffType: number;
  18587. /**
  18588. * Strength of the light.
  18589. * Note: By default it is define in the framework own unit.
  18590. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18591. */
  18592. intensity: number;
  18593. private _range;
  18594. protected _inverseSquaredRange: number;
  18595. /**
  18596. * Defines how far from the source the light is impacting in scene units.
  18597. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18598. */
  18599. get range(): number;
  18600. /**
  18601. * Defines how far from the source the light is impacting in scene units.
  18602. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18603. */
  18604. set range(value: number);
  18605. /**
  18606. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18607. * of light.
  18608. */
  18609. private _photometricScale;
  18610. private _intensityMode;
  18611. /**
  18612. * Gets the photometric scale used to interpret the intensity.
  18613. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18614. */
  18615. get intensityMode(): number;
  18616. /**
  18617. * Sets the photometric scale used to interpret the intensity.
  18618. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18619. */
  18620. set intensityMode(value: number);
  18621. private _radius;
  18622. /**
  18623. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18624. */
  18625. get radius(): number;
  18626. /**
  18627. * sets the light radius used by PBR Materials to simulate soft area lights.
  18628. */
  18629. set radius(value: number);
  18630. private _renderPriority;
  18631. /**
  18632. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18633. * exceeding the number allowed of the materials.
  18634. */
  18635. renderPriority: number;
  18636. private _shadowEnabled;
  18637. /**
  18638. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18639. * the current shadow generator.
  18640. */
  18641. get shadowEnabled(): boolean;
  18642. /**
  18643. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18644. * the current shadow generator.
  18645. */
  18646. set shadowEnabled(value: boolean);
  18647. private _includedOnlyMeshes;
  18648. /**
  18649. * Gets the only meshes impacted by this light.
  18650. */
  18651. get includedOnlyMeshes(): AbstractMesh[];
  18652. /**
  18653. * Sets the only meshes impacted by this light.
  18654. */
  18655. set includedOnlyMeshes(value: AbstractMesh[]);
  18656. private _excludedMeshes;
  18657. /**
  18658. * Gets the meshes not impacted by this light.
  18659. */
  18660. get excludedMeshes(): AbstractMesh[];
  18661. /**
  18662. * Sets the meshes not impacted by this light.
  18663. */
  18664. set excludedMeshes(value: AbstractMesh[]);
  18665. private _excludeWithLayerMask;
  18666. /**
  18667. * Gets the layer id use to find what meshes are not impacted by the light.
  18668. * Inactive if 0
  18669. */
  18670. get excludeWithLayerMask(): number;
  18671. /**
  18672. * Sets the layer id use to find what meshes are not impacted by the light.
  18673. * Inactive if 0
  18674. */
  18675. set excludeWithLayerMask(value: number);
  18676. private _includeOnlyWithLayerMask;
  18677. /**
  18678. * Gets the layer id use to find what meshes are impacted by the light.
  18679. * Inactive if 0
  18680. */
  18681. get includeOnlyWithLayerMask(): number;
  18682. /**
  18683. * Sets the layer id use to find what meshes are impacted by the light.
  18684. * Inactive if 0
  18685. */
  18686. set includeOnlyWithLayerMask(value: number);
  18687. private _lightmapMode;
  18688. /**
  18689. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18690. */
  18691. get lightmapMode(): number;
  18692. /**
  18693. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18694. */
  18695. set lightmapMode(value: number);
  18696. /**
  18697. * Shadow generator associted to the light.
  18698. * @hidden Internal use only.
  18699. */
  18700. _shadowGenerator: Nullable<IShadowGenerator>;
  18701. /**
  18702. * @hidden Internal use only.
  18703. */
  18704. _excludedMeshesIds: string[];
  18705. /**
  18706. * @hidden Internal use only.
  18707. */
  18708. _includedOnlyMeshesIds: string[];
  18709. /**
  18710. * The current light unifom buffer.
  18711. * @hidden Internal use only.
  18712. */
  18713. _uniformBuffer: UniformBuffer;
  18714. /** @hidden */
  18715. _renderId: number;
  18716. /**
  18717. * Creates a Light object in the scene.
  18718. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18719. * @param name The firendly name of the light
  18720. * @param scene The scene the light belongs too
  18721. */
  18722. constructor(name: string, scene: Scene);
  18723. protected abstract _buildUniformLayout(): void;
  18724. /**
  18725. * Sets the passed Effect "effect" with the Light information.
  18726. * @param effect The effect to update
  18727. * @param lightIndex The index of the light in the effect to update
  18728. * @returns The light
  18729. */
  18730. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18731. /**
  18732. * Sets the passed Effect "effect" with the Light textures.
  18733. * @param effect The effect to update
  18734. * @param lightIndex The index of the light in the effect to update
  18735. * @returns The light
  18736. */
  18737. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18738. /**
  18739. * Binds the lights information from the scene to the effect for the given mesh.
  18740. * @param lightIndex Light index
  18741. * @param scene The scene where the light belongs to
  18742. * @param effect The effect we are binding the data to
  18743. * @param useSpecular Defines if specular is supported
  18744. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18745. */
  18746. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18747. /**
  18748. * Sets the passed Effect "effect" with the Light information.
  18749. * @param effect The effect to update
  18750. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18751. * @returns The light
  18752. */
  18753. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18754. /**
  18755. * Returns the string "Light".
  18756. * @returns the class name
  18757. */
  18758. getClassName(): string;
  18759. /** @hidden */
  18760. readonly _isLight: boolean;
  18761. /**
  18762. * Converts the light information to a readable string for debug purpose.
  18763. * @param fullDetails Supports for multiple levels of logging within scene loading
  18764. * @returns the human readable light info
  18765. */
  18766. toString(fullDetails?: boolean): string;
  18767. /** @hidden */
  18768. protected _syncParentEnabledState(): void;
  18769. /**
  18770. * Set the enabled state of this node.
  18771. * @param value - the new enabled state
  18772. */
  18773. setEnabled(value: boolean): void;
  18774. /**
  18775. * Returns the Light associated shadow generator if any.
  18776. * @return the associated shadow generator.
  18777. */
  18778. getShadowGenerator(): Nullable<IShadowGenerator>;
  18779. /**
  18780. * Returns a Vector3, the absolute light position in the World.
  18781. * @returns the world space position of the light
  18782. */
  18783. getAbsolutePosition(): Vector3;
  18784. /**
  18785. * Specifies if the light will affect the passed mesh.
  18786. * @param mesh The mesh to test against the light
  18787. * @return true the mesh is affected otherwise, false.
  18788. */
  18789. canAffectMesh(mesh: AbstractMesh): boolean;
  18790. /**
  18791. * Sort function to order lights for rendering.
  18792. * @param a First Light object to compare to second.
  18793. * @param b Second Light object to compare first.
  18794. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18795. */
  18796. static CompareLightsPriority(a: Light, b: Light): number;
  18797. /**
  18798. * Releases resources associated with this node.
  18799. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18800. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18801. */
  18802. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18803. /**
  18804. * Returns the light type ID (integer).
  18805. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18806. */
  18807. getTypeID(): number;
  18808. /**
  18809. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18810. * @returns the scaled intensity in intensity mode unit
  18811. */
  18812. getScaledIntensity(): number;
  18813. /**
  18814. * Returns a new Light object, named "name", from the current one.
  18815. * @param name The name of the cloned light
  18816. * @param newParent The parent of this light, if it has one
  18817. * @returns the new created light
  18818. */
  18819. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18820. /**
  18821. * Serializes the current light into a Serialization object.
  18822. * @returns the serialized object.
  18823. */
  18824. serialize(): any;
  18825. /**
  18826. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18827. * This new light is named "name" and added to the passed scene.
  18828. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18829. * @param name The friendly name of the light
  18830. * @param scene The scene the new light will belong to
  18831. * @returns the constructor function
  18832. */
  18833. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18834. /**
  18835. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18836. * @param parsedLight The JSON representation of the light
  18837. * @param scene The scene to create the parsed light in
  18838. * @returns the created light after parsing
  18839. */
  18840. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18841. private _hookArrayForExcluded;
  18842. private _hookArrayForIncludedOnly;
  18843. private _resyncMeshes;
  18844. /**
  18845. * Forces the meshes to update their light related information in their rendering used effects
  18846. * @hidden Internal Use Only
  18847. */
  18848. _markMeshesAsLightDirty(): void;
  18849. /**
  18850. * Recomputes the cached photometric scale if needed.
  18851. */
  18852. private _computePhotometricScale;
  18853. /**
  18854. * Returns the Photometric Scale according to the light type and intensity mode.
  18855. */
  18856. private _getPhotometricScale;
  18857. /**
  18858. * Reorder the light in the scene according to their defined priority.
  18859. * @hidden Internal Use Only
  18860. */
  18861. _reorderLightsInScene(): void;
  18862. /**
  18863. * Prepares the list of defines specific to the light type.
  18864. * @param defines the list of defines
  18865. * @param lightIndex defines the index of the light for the effect
  18866. */
  18867. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18868. }
  18869. }
  18870. declare module "babylonjs/Cameras/targetCamera" {
  18871. import { Nullable } from "babylonjs/types";
  18872. import { Camera } from "babylonjs/Cameras/camera";
  18873. import { Scene } from "babylonjs/scene";
  18874. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18875. /**
  18876. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18877. * This is the base of the follow, arc rotate cameras and Free camera
  18878. * @see https://doc.babylonjs.com/features/cameras
  18879. */
  18880. export class TargetCamera extends Camera {
  18881. private static _RigCamTransformMatrix;
  18882. private static _TargetTransformMatrix;
  18883. private static _TargetFocalPoint;
  18884. private _tmpUpVector;
  18885. private _tmpTargetVector;
  18886. /**
  18887. * Define the current direction the camera is moving to
  18888. */
  18889. cameraDirection: Vector3;
  18890. /**
  18891. * Define the current rotation the camera is rotating to
  18892. */
  18893. cameraRotation: Vector2;
  18894. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18895. ignoreParentScaling: boolean;
  18896. /**
  18897. * When set, the up vector of the camera will be updated by the rotation of the camera
  18898. */
  18899. updateUpVectorFromRotation: boolean;
  18900. private _tmpQuaternion;
  18901. /**
  18902. * Define the current rotation of the camera
  18903. */
  18904. rotation: Vector3;
  18905. /**
  18906. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18907. */
  18908. rotationQuaternion: Quaternion;
  18909. /**
  18910. * Define the current speed of the camera
  18911. */
  18912. speed: number;
  18913. /**
  18914. * Add constraint to the camera to prevent it to move freely in all directions and
  18915. * around all axis.
  18916. */
  18917. noRotationConstraint: boolean;
  18918. /**
  18919. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18920. * panning
  18921. */
  18922. invertRotation: boolean;
  18923. /**
  18924. * Speed multiplier for inverse camera panning
  18925. */
  18926. inverseRotationSpeed: number;
  18927. /**
  18928. * Define the current target of the camera as an object or a position.
  18929. */
  18930. lockedTarget: any;
  18931. /** @hidden */
  18932. _currentTarget: Vector3;
  18933. /** @hidden */
  18934. _initialFocalDistance: number;
  18935. /** @hidden */
  18936. _viewMatrix: Matrix;
  18937. /** @hidden */
  18938. _camMatrix: Matrix;
  18939. /** @hidden */
  18940. _cameraTransformMatrix: Matrix;
  18941. /** @hidden */
  18942. _cameraRotationMatrix: Matrix;
  18943. /** @hidden */
  18944. _referencePoint: Vector3;
  18945. /** @hidden */
  18946. _transformedReferencePoint: Vector3;
  18947. /** @hidden */
  18948. _reset: () => void;
  18949. private _defaultUp;
  18950. /**
  18951. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18952. * This is the base of the follow, arc rotate cameras and Free camera
  18953. * @see https://doc.babylonjs.com/features/cameras
  18954. * @param name Defines the name of the camera in the scene
  18955. * @param position Defines the start position of the camera in the scene
  18956. * @param scene Defines the scene the camera belongs to
  18957. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18958. */
  18959. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18960. /**
  18961. * Gets the position in front of the camera at a given distance.
  18962. * @param distance The distance from the camera we want the position to be
  18963. * @returns the position
  18964. */
  18965. getFrontPosition(distance: number): Vector3;
  18966. /** @hidden */
  18967. _getLockedTargetPosition(): Nullable<Vector3>;
  18968. private _storedPosition;
  18969. private _storedRotation;
  18970. private _storedRotationQuaternion;
  18971. /**
  18972. * Store current camera state of the camera (fov, position, rotation, etc..)
  18973. * @returns the camera
  18974. */
  18975. storeState(): Camera;
  18976. /**
  18977. * Restored camera state. You must call storeState() first
  18978. * @returns whether it was successful or not
  18979. * @hidden
  18980. */
  18981. _restoreStateValues(): boolean;
  18982. /** @hidden */
  18983. _initCache(): void;
  18984. /** @hidden */
  18985. _updateCache(ignoreParentClass?: boolean): void;
  18986. /** @hidden */
  18987. _isSynchronizedViewMatrix(): boolean;
  18988. /** @hidden */
  18989. _computeLocalCameraSpeed(): number;
  18990. /**
  18991. * Defines the target the camera should look at.
  18992. * @param target Defines the new target as a Vector or a mesh
  18993. */
  18994. setTarget(target: Vector3): void;
  18995. /**
  18996. * Defines the target point of the camera.
  18997. * The camera looks towards it form the radius distance.
  18998. */
  18999. get target(): Vector3;
  19000. set target(value: Vector3);
  19001. /**
  19002. * Return the current target position of the camera. This value is expressed in local space.
  19003. * @returns the target position
  19004. */
  19005. getTarget(): Vector3;
  19006. /** @hidden */
  19007. _decideIfNeedsToMove(): boolean;
  19008. /** @hidden */
  19009. _updatePosition(): void;
  19010. /** @hidden */
  19011. _checkInputs(): void;
  19012. protected _updateCameraRotationMatrix(): void;
  19013. /**
  19014. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  19015. * @returns the current camera
  19016. */
  19017. private _rotateUpVectorWithCameraRotationMatrix;
  19018. private _cachedRotationZ;
  19019. private _cachedQuaternionRotationZ;
  19020. /** @hidden */
  19021. _getViewMatrix(): Matrix;
  19022. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19023. /**
  19024. * @hidden
  19025. */
  19026. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19027. /**
  19028. * @hidden
  19029. */
  19030. _updateRigCameras(): void;
  19031. private _getRigCamPositionAndTarget;
  19032. /**
  19033. * Gets the current object class name.
  19034. * @return the class name
  19035. */
  19036. getClassName(): string;
  19037. }
  19038. }
  19039. declare module "babylonjs/Events/keyboardEvents" {
  19040. /**
  19041. * Gather the list of keyboard event types as constants.
  19042. */
  19043. export class KeyboardEventTypes {
  19044. /**
  19045. * The keydown event is fired when a key becomes active (pressed).
  19046. */
  19047. static readonly KEYDOWN: number;
  19048. /**
  19049. * The keyup event is fired when a key has been released.
  19050. */
  19051. static readonly KEYUP: number;
  19052. }
  19053. /**
  19054. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19055. */
  19056. export class KeyboardInfo {
  19057. /**
  19058. * Defines the type of event (KeyboardEventTypes)
  19059. */
  19060. type: number;
  19061. /**
  19062. * Defines the related dom event
  19063. */
  19064. event: KeyboardEvent;
  19065. /**
  19066. * Instantiates a new keyboard info.
  19067. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19068. * @param type Defines the type of event (KeyboardEventTypes)
  19069. * @param event Defines the related dom event
  19070. */
  19071. constructor(
  19072. /**
  19073. * Defines the type of event (KeyboardEventTypes)
  19074. */
  19075. type: number,
  19076. /**
  19077. * Defines the related dom event
  19078. */
  19079. event: KeyboardEvent);
  19080. }
  19081. /**
  19082. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19083. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19084. */
  19085. export class KeyboardInfoPre extends KeyboardInfo {
  19086. /**
  19087. * Defines the type of event (KeyboardEventTypes)
  19088. */
  19089. type: number;
  19090. /**
  19091. * Defines the related dom event
  19092. */
  19093. event: KeyboardEvent;
  19094. /**
  19095. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19096. */
  19097. skipOnPointerObservable: boolean;
  19098. /**
  19099. * Instantiates a new keyboard pre info.
  19100. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19101. * @param type Defines the type of event (KeyboardEventTypes)
  19102. * @param event Defines the related dom event
  19103. */
  19104. constructor(
  19105. /**
  19106. * Defines the type of event (KeyboardEventTypes)
  19107. */
  19108. type: number,
  19109. /**
  19110. * Defines the related dom event
  19111. */
  19112. event: KeyboardEvent);
  19113. }
  19114. }
  19115. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19116. import { Nullable } from "babylonjs/types";
  19117. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19118. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19119. /**
  19120. * Manage the keyboard inputs to control the movement of a free camera.
  19121. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19122. */
  19123. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19124. /**
  19125. * Defines the camera the input is attached to.
  19126. */
  19127. camera: FreeCamera;
  19128. /**
  19129. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19130. */
  19131. keysUp: number[];
  19132. /**
  19133. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19134. */
  19135. keysUpward: number[];
  19136. /**
  19137. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19138. */
  19139. keysDown: number[];
  19140. /**
  19141. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19142. */
  19143. keysDownward: number[];
  19144. /**
  19145. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19146. */
  19147. keysLeft: number[];
  19148. /**
  19149. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19150. */
  19151. keysRight: number[];
  19152. private _keys;
  19153. private _onCanvasBlurObserver;
  19154. private _onKeyboardObserver;
  19155. private _engine;
  19156. private _scene;
  19157. /**
  19158. * Attach the input controls to a specific dom element to get the input from.
  19159. * @param element Defines the element the controls should be listened from
  19160. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19161. */
  19162. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19163. /**
  19164. * Detach the current controls from the specified dom element.
  19165. * @param element Defines the element to stop listening the inputs from
  19166. */
  19167. detachControl(element: Nullable<HTMLElement>): void;
  19168. /**
  19169. * Update the current camera state depending on the inputs that have been used this frame.
  19170. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19171. */
  19172. checkInputs(): void;
  19173. /**
  19174. * Gets the class name of the current intput.
  19175. * @returns the class name
  19176. */
  19177. getClassName(): string;
  19178. /** @hidden */
  19179. _onLostFocus(): void;
  19180. /**
  19181. * Get the friendly name associated with the input class.
  19182. * @returns the input friendly name
  19183. */
  19184. getSimpleName(): string;
  19185. }
  19186. }
  19187. declare module "babylonjs/Events/pointerEvents" {
  19188. import { Nullable } from "babylonjs/types";
  19189. import { Vector2 } from "babylonjs/Maths/math.vector";
  19190. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19191. import { Ray } from "babylonjs/Culling/ray";
  19192. /**
  19193. * Gather the list of pointer event types as constants.
  19194. */
  19195. export class PointerEventTypes {
  19196. /**
  19197. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  19198. */
  19199. static readonly POINTERDOWN: number;
  19200. /**
  19201. * The pointerup event is fired when a pointer is no longer active.
  19202. */
  19203. static readonly POINTERUP: number;
  19204. /**
  19205. * The pointermove event is fired when a pointer changes coordinates.
  19206. */
  19207. static readonly POINTERMOVE: number;
  19208. /**
  19209. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19210. */
  19211. static readonly POINTERWHEEL: number;
  19212. /**
  19213. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19214. */
  19215. static readonly POINTERPICK: number;
  19216. /**
  19217. * The pointertap event is fired when a the object has been touched and released without drag.
  19218. */
  19219. static readonly POINTERTAP: number;
  19220. /**
  19221. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19222. */
  19223. static readonly POINTERDOUBLETAP: number;
  19224. }
  19225. /**
  19226. * Base class of pointer info types.
  19227. */
  19228. export class PointerInfoBase {
  19229. /**
  19230. * Defines the type of event (PointerEventTypes)
  19231. */
  19232. type: number;
  19233. /**
  19234. * Defines the related dom event
  19235. */
  19236. event: PointerEvent | MouseWheelEvent;
  19237. /**
  19238. * Instantiates the base class of pointers info.
  19239. * @param type Defines the type of event (PointerEventTypes)
  19240. * @param event Defines the related dom event
  19241. */
  19242. constructor(
  19243. /**
  19244. * Defines the type of event (PointerEventTypes)
  19245. */
  19246. type: number,
  19247. /**
  19248. * Defines the related dom event
  19249. */
  19250. event: PointerEvent | MouseWheelEvent);
  19251. }
  19252. /**
  19253. * This class is used to store pointer related info for the onPrePointerObservable event.
  19254. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19255. */
  19256. export class PointerInfoPre extends PointerInfoBase {
  19257. /**
  19258. * Ray from a pointer if availible (eg. 6dof controller)
  19259. */
  19260. ray: Nullable<Ray>;
  19261. /**
  19262. * Defines the local position of the pointer on the canvas.
  19263. */
  19264. localPosition: Vector2;
  19265. /**
  19266. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19267. */
  19268. skipOnPointerObservable: boolean;
  19269. /**
  19270. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19271. * @param type Defines the type of event (PointerEventTypes)
  19272. * @param event Defines the related dom event
  19273. * @param localX Defines the local x coordinates of the pointer when the event occured
  19274. * @param localY Defines the local y coordinates of the pointer when the event occured
  19275. */
  19276. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19277. }
  19278. /**
  19279. * This type contains all the data related to a pointer event in Babylon.js.
  19280. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  19281. */
  19282. export class PointerInfo extends PointerInfoBase {
  19283. /**
  19284. * Defines the picking info associated to the info (if any)\
  19285. */
  19286. pickInfo: Nullable<PickingInfo>;
  19287. /**
  19288. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19289. * @param type Defines the type of event (PointerEventTypes)
  19290. * @param event Defines the related dom event
  19291. * @param pickInfo Defines the picking info associated to the info (if any)\
  19292. */
  19293. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19294. /**
  19295. * Defines the picking info associated to the info (if any)\
  19296. */
  19297. pickInfo: Nullable<PickingInfo>);
  19298. }
  19299. /**
  19300. * Data relating to a touch event on the screen.
  19301. */
  19302. export interface PointerTouch {
  19303. /**
  19304. * X coordinate of touch.
  19305. */
  19306. x: number;
  19307. /**
  19308. * Y coordinate of touch.
  19309. */
  19310. y: number;
  19311. /**
  19312. * Id of touch. Unique for each finger.
  19313. */
  19314. pointerId: number;
  19315. /**
  19316. * Event type passed from DOM.
  19317. */
  19318. type: any;
  19319. }
  19320. }
  19321. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19322. import { Observable } from "babylonjs/Misc/observable";
  19323. import { Nullable } from "babylonjs/types";
  19324. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19325. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19326. /**
  19327. * Manage the mouse inputs to control the movement of a free camera.
  19328. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19329. */
  19330. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19331. /**
  19332. * Define if touch is enabled in the mouse input
  19333. */
  19334. touchEnabled: boolean;
  19335. /**
  19336. * Defines the camera the input is attached to.
  19337. */
  19338. camera: FreeCamera;
  19339. /**
  19340. * Defines the buttons associated with the input to handle camera move.
  19341. */
  19342. buttons: number[];
  19343. /**
  19344. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19345. */
  19346. angularSensibility: number;
  19347. private _pointerInput;
  19348. private _onMouseMove;
  19349. private _observer;
  19350. private previousPosition;
  19351. /**
  19352. * Observable for when a pointer move event occurs containing the move offset
  19353. */
  19354. onPointerMovedObservable: Observable<{
  19355. offsetX: number;
  19356. offsetY: number;
  19357. }>;
  19358. /**
  19359. * @hidden
  19360. * If the camera should be rotated automatically based on pointer movement
  19361. */
  19362. _allowCameraRotation: boolean;
  19363. /**
  19364. * Manage the mouse inputs to control the movement of a free camera.
  19365. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19366. * @param touchEnabled Defines if touch is enabled or not
  19367. */
  19368. constructor(
  19369. /**
  19370. * Define if touch is enabled in the mouse input
  19371. */
  19372. touchEnabled?: boolean);
  19373. /**
  19374. * Attach the input controls to a specific dom element to get the input from.
  19375. * @param element Defines the element the controls should be listened from
  19376. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19377. */
  19378. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19379. /**
  19380. * Called on JS contextmenu event.
  19381. * Override this method to provide functionality.
  19382. */
  19383. protected onContextMenu(evt: PointerEvent): void;
  19384. /**
  19385. * Detach the current controls from the specified dom element.
  19386. * @param element Defines the element to stop listening the inputs from
  19387. */
  19388. detachControl(element: Nullable<HTMLElement>): void;
  19389. /**
  19390. * Gets the class name of the current intput.
  19391. * @returns the class name
  19392. */
  19393. getClassName(): string;
  19394. /**
  19395. * Get the friendly name associated with the input class.
  19396. * @returns the input friendly name
  19397. */
  19398. getSimpleName(): string;
  19399. }
  19400. }
  19401. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19402. import { Nullable } from "babylonjs/types";
  19403. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19404. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19405. /**
  19406. * Manage the touch inputs to control the movement of a free camera.
  19407. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19408. */
  19409. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19410. /**
  19411. * Define if mouse events can be treated as touch events
  19412. */
  19413. allowMouse: boolean;
  19414. /**
  19415. * Defines the camera the input is attached to.
  19416. */
  19417. camera: FreeCamera;
  19418. /**
  19419. * Defines the touch sensibility for rotation.
  19420. * The higher the faster.
  19421. */
  19422. touchAngularSensibility: number;
  19423. /**
  19424. * Defines the touch sensibility for move.
  19425. * The higher the faster.
  19426. */
  19427. touchMoveSensibility: number;
  19428. private _offsetX;
  19429. private _offsetY;
  19430. private _pointerPressed;
  19431. private _pointerInput;
  19432. private _observer;
  19433. private _onLostFocus;
  19434. /**
  19435. * Manage the touch inputs to control the movement of a free camera.
  19436. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19437. * @param allowMouse Defines if mouse events can be treated as touch events
  19438. */
  19439. constructor(
  19440. /**
  19441. * Define if mouse events can be treated as touch events
  19442. */
  19443. allowMouse?: boolean);
  19444. /**
  19445. * Attach the input controls to a specific dom element to get the input from.
  19446. * @param element Defines the element the controls should be listened from
  19447. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19448. */
  19449. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19450. /**
  19451. * Detach the current controls from the specified dom element.
  19452. * @param element Defines the element to stop listening the inputs from
  19453. */
  19454. detachControl(element: Nullable<HTMLElement>): void;
  19455. /**
  19456. * Update the current camera state depending on the inputs that have been used this frame.
  19457. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19458. */
  19459. checkInputs(): void;
  19460. /**
  19461. * Gets the class name of the current intput.
  19462. * @returns the class name
  19463. */
  19464. getClassName(): string;
  19465. /**
  19466. * Get the friendly name associated with the input class.
  19467. * @returns the input friendly name
  19468. */
  19469. getSimpleName(): string;
  19470. }
  19471. }
  19472. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19473. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19474. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19475. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19476. import { Nullable } from "babylonjs/types";
  19477. /**
  19478. * Default Inputs manager for the FreeCamera.
  19479. * It groups all the default supported inputs for ease of use.
  19480. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19481. */
  19482. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19483. /**
  19484. * @hidden
  19485. */
  19486. _mouseInput: Nullable<FreeCameraMouseInput>;
  19487. /**
  19488. * Instantiates a new FreeCameraInputsManager.
  19489. * @param camera Defines the camera the inputs belong to
  19490. */
  19491. constructor(camera: FreeCamera);
  19492. /**
  19493. * Add keyboard input support to the input manager.
  19494. * @returns the current input manager
  19495. */
  19496. addKeyboard(): FreeCameraInputsManager;
  19497. /**
  19498. * Add mouse input support to the input manager.
  19499. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19500. * @returns the current input manager
  19501. */
  19502. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19503. /**
  19504. * Removes the mouse input support from the manager
  19505. * @returns the current input manager
  19506. */
  19507. removeMouse(): FreeCameraInputsManager;
  19508. /**
  19509. * Add touch input support to the input manager.
  19510. * @returns the current input manager
  19511. */
  19512. addTouch(): FreeCameraInputsManager;
  19513. /**
  19514. * Remove all attached input methods from a camera
  19515. */
  19516. clear(): void;
  19517. }
  19518. }
  19519. declare module "babylonjs/Cameras/freeCamera" {
  19520. import { Vector3 } from "babylonjs/Maths/math.vector";
  19521. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19522. import { Scene } from "babylonjs/scene";
  19523. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19524. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19525. /**
  19526. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19527. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19528. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19529. */
  19530. export class FreeCamera extends TargetCamera {
  19531. /**
  19532. * Define the collision ellipsoid of the camera.
  19533. * This is helpful to simulate a camera body like the player body around the camera
  19534. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19535. */
  19536. ellipsoid: Vector3;
  19537. /**
  19538. * Define an offset for the position of the ellipsoid around the camera.
  19539. * This can be helpful to determine the center of the body near the gravity center of the body
  19540. * instead of its head.
  19541. */
  19542. ellipsoidOffset: Vector3;
  19543. /**
  19544. * Enable or disable collisions of the camera with the rest of the scene objects.
  19545. */
  19546. checkCollisions: boolean;
  19547. /**
  19548. * Enable or disable gravity on the camera.
  19549. */
  19550. applyGravity: boolean;
  19551. /**
  19552. * Define the input manager associated to the camera.
  19553. */
  19554. inputs: FreeCameraInputsManager;
  19555. /**
  19556. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19557. * Higher values reduce sensitivity.
  19558. */
  19559. get angularSensibility(): number;
  19560. /**
  19561. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19562. * Higher values reduce sensitivity.
  19563. */
  19564. set angularSensibility(value: number);
  19565. /**
  19566. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19567. */
  19568. get keysUp(): number[];
  19569. set keysUp(value: number[]);
  19570. /**
  19571. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19572. */
  19573. get keysUpward(): number[];
  19574. set keysUpward(value: number[]);
  19575. /**
  19576. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19577. */
  19578. get keysDown(): number[];
  19579. set keysDown(value: number[]);
  19580. /**
  19581. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19582. */
  19583. get keysDownward(): number[];
  19584. set keysDownward(value: number[]);
  19585. /**
  19586. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19587. */
  19588. get keysLeft(): number[];
  19589. set keysLeft(value: number[]);
  19590. /**
  19591. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19592. */
  19593. get keysRight(): number[];
  19594. set keysRight(value: number[]);
  19595. /**
  19596. * Event raised when the camera collide with a mesh in the scene.
  19597. */
  19598. onCollide: (collidedMesh: AbstractMesh) => void;
  19599. private _collider;
  19600. private _needMoveForGravity;
  19601. private _oldPosition;
  19602. private _diffPosition;
  19603. private _newPosition;
  19604. /** @hidden */
  19605. _localDirection: Vector3;
  19606. /** @hidden */
  19607. _transformedDirection: Vector3;
  19608. /**
  19609. * Instantiates a Free Camera.
  19610. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19611. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19612. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19613. * @param name Define the name of the camera in the scene
  19614. * @param position Define the start position of the camera in the scene
  19615. * @param scene Define the scene the camera belongs to
  19616. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19617. */
  19618. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19619. /**
  19620. * Attached controls to the current camera.
  19621. * @param element Defines the element the controls should be listened from
  19622. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19623. */
  19624. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19625. /**
  19626. * Detach the current controls from the camera.
  19627. * The camera will stop reacting to inputs.
  19628. * @param element Defines the element to stop listening the inputs from
  19629. */
  19630. detachControl(element: HTMLElement): void;
  19631. private _collisionMask;
  19632. /**
  19633. * Define a collision mask to limit the list of object the camera can collide with
  19634. */
  19635. get collisionMask(): number;
  19636. set collisionMask(mask: number);
  19637. /** @hidden */
  19638. _collideWithWorld(displacement: Vector3): void;
  19639. private _onCollisionPositionChange;
  19640. /** @hidden */
  19641. _checkInputs(): void;
  19642. /** @hidden */
  19643. _decideIfNeedsToMove(): boolean;
  19644. /** @hidden */
  19645. _updatePosition(): void;
  19646. /**
  19647. * Destroy the camera and release the current resources hold by it.
  19648. */
  19649. dispose(): void;
  19650. /**
  19651. * Gets the current object class name.
  19652. * @return the class name
  19653. */
  19654. getClassName(): string;
  19655. }
  19656. }
  19657. declare module "babylonjs/Gamepads/gamepad" {
  19658. import { Observable } from "babylonjs/Misc/observable";
  19659. /**
  19660. * Represents a gamepad control stick position
  19661. */
  19662. export class StickValues {
  19663. /**
  19664. * The x component of the control stick
  19665. */
  19666. x: number;
  19667. /**
  19668. * The y component of the control stick
  19669. */
  19670. y: number;
  19671. /**
  19672. * Initializes the gamepad x and y control stick values
  19673. * @param x The x component of the gamepad control stick value
  19674. * @param y The y component of the gamepad control stick value
  19675. */
  19676. constructor(
  19677. /**
  19678. * The x component of the control stick
  19679. */
  19680. x: number,
  19681. /**
  19682. * The y component of the control stick
  19683. */
  19684. y: number);
  19685. }
  19686. /**
  19687. * An interface which manages callbacks for gamepad button changes
  19688. */
  19689. export interface GamepadButtonChanges {
  19690. /**
  19691. * Called when a gamepad has been changed
  19692. */
  19693. changed: boolean;
  19694. /**
  19695. * Called when a gamepad press event has been triggered
  19696. */
  19697. pressChanged: boolean;
  19698. /**
  19699. * Called when a touch event has been triggered
  19700. */
  19701. touchChanged: boolean;
  19702. /**
  19703. * Called when a value has changed
  19704. */
  19705. valueChanged: boolean;
  19706. }
  19707. /**
  19708. * Represents a gamepad
  19709. */
  19710. export class Gamepad {
  19711. /**
  19712. * The id of the gamepad
  19713. */
  19714. id: string;
  19715. /**
  19716. * The index of the gamepad
  19717. */
  19718. index: number;
  19719. /**
  19720. * The browser gamepad
  19721. */
  19722. browserGamepad: any;
  19723. /**
  19724. * Specifies what type of gamepad this represents
  19725. */
  19726. type: number;
  19727. private _leftStick;
  19728. private _rightStick;
  19729. /** @hidden */
  19730. _isConnected: boolean;
  19731. private _leftStickAxisX;
  19732. private _leftStickAxisY;
  19733. private _rightStickAxisX;
  19734. private _rightStickAxisY;
  19735. /**
  19736. * Triggered when the left control stick has been changed
  19737. */
  19738. private _onleftstickchanged;
  19739. /**
  19740. * Triggered when the right control stick has been changed
  19741. */
  19742. private _onrightstickchanged;
  19743. /**
  19744. * Represents a gamepad controller
  19745. */
  19746. static GAMEPAD: number;
  19747. /**
  19748. * Represents a generic controller
  19749. */
  19750. static GENERIC: number;
  19751. /**
  19752. * Represents an XBox controller
  19753. */
  19754. static XBOX: number;
  19755. /**
  19756. * Represents a pose-enabled controller
  19757. */
  19758. static POSE_ENABLED: number;
  19759. /**
  19760. * Represents an Dual Shock controller
  19761. */
  19762. static DUALSHOCK: number;
  19763. /**
  19764. * Specifies whether the left control stick should be Y-inverted
  19765. */
  19766. protected _invertLeftStickY: boolean;
  19767. /**
  19768. * Specifies if the gamepad has been connected
  19769. */
  19770. get isConnected(): boolean;
  19771. /**
  19772. * Initializes the gamepad
  19773. * @param id The id of the gamepad
  19774. * @param index The index of the gamepad
  19775. * @param browserGamepad The browser gamepad
  19776. * @param leftStickX The x component of the left joystick
  19777. * @param leftStickY The y component of the left joystick
  19778. * @param rightStickX The x component of the right joystick
  19779. * @param rightStickY The y component of the right joystick
  19780. */
  19781. constructor(
  19782. /**
  19783. * The id of the gamepad
  19784. */
  19785. id: string,
  19786. /**
  19787. * The index of the gamepad
  19788. */
  19789. index: number,
  19790. /**
  19791. * The browser gamepad
  19792. */
  19793. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19794. /**
  19795. * Callback triggered when the left joystick has changed
  19796. * @param callback
  19797. */
  19798. onleftstickchanged(callback: (values: StickValues) => void): void;
  19799. /**
  19800. * Callback triggered when the right joystick has changed
  19801. * @param callback
  19802. */
  19803. onrightstickchanged(callback: (values: StickValues) => void): void;
  19804. /**
  19805. * Gets the left joystick
  19806. */
  19807. get leftStick(): StickValues;
  19808. /**
  19809. * Sets the left joystick values
  19810. */
  19811. set leftStick(newValues: StickValues);
  19812. /**
  19813. * Gets the right joystick
  19814. */
  19815. get rightStick(): StickValues;
  19816. /**
  19817. * Sets the right joystick value
  19818. */
  19819. set rightStick(newValues: StickValues);
  19820. /**
  19821. * Updates the gamepad joystick positions
  19822. */
  19823. update(): void;
  19824. /**
  19825. * Disposes the gamepad
  19826. */
  19827. dispose(): void;
  19828. }
  19829. /**
  19830. * Represents a generic gamepad
  19831. */
  19832. export class GenericPad extends Gamepad {
  19833. private _buttons;
  19834. private _onbuttondown;
  19835. private _onbuttonup;
  19836. /**
  19837. * Observable triggered when a button has been pressed
  19838. */
  19839. onButtonDownObservable: Observable<number>;
  19840. /**
  19841. * Observable triggered when a button has been released
  19842. */
  19843. onButtonUpObservable: Observable<number>;
  19844. /**
  19845. * Callback triggered when a button has been pressed
  19846. * @param callback Called when a button has been pressed
  19847. */
  19848. onbuttondown(callback: (buttonPressed: number) => void): void;
  19849. /**
  19850. * Callback triggered when a button has been released
  19851. * @param callback Called when a button has been released
  19852. */
  19853. onbuttonup(callback: (buttonReleased: number) => void): void;
  19854. /**
  19855. * Initializes the generic gamepad
  19856. * @param id The id of the generic gamepad
  19857. * @param index The index of the generic gamepad
  19858. * @param browserGamepad The browser gamepad
  19859. */
  19860. constructor(id: string, index: number, browserGamepad: any);
  19861. private _setButtonValue;
  19862. /**
  19863. * Updates the generic gamepad
  19864. */
  19865. update(): void;
  19866. /**
  19867. * Disposes the generic gamepad
  19868. */
  19869. dispose(): void;
  19870. }
  19871. }
  19872. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19873. import { Observable } from "babylonjs/Misc/observable";
  19874. import { Nullable } from "babylonjs/types";
  19875. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19876. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19878. import { Ray } from "babylonjs/Culling/ray";
  19879. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19880. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19881. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19882. /**
  19883. * Defines the types of pose enabled controllers that are supported
  19884. */
  19885. export enum PoseEnabledControllerType {
  19886. /**
  19887. * HTC Vive
  19888. */
  19889. VIVE = 0,
  19890. /**
  19891. * Oculus Rift
  19892. */
  19893. OCULUS = 1,
  19894. /**
  19895. * Windows mixed reality
  19896. */
  19897. WINDOWS = 2,
  19898. /**
  19899. * Samsung gear VR
  19900. */
  19901. GEAR_VR = 3,
  19902. /**
  19903. * Google Daydream
  19904. */
  19905. DAYDREAM = 4,
  19906. /**
  19907. * Generic
  19908. */
  19909. GENERIC = 5
  19910. }
  19911. /**
  19912. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19913. */
  19914. export interface MutableGamepadButton {
  19915. /**
  19916. * Value of the button/trigger
  19917. */
  19918. value: number;
  19919. /**
  19920. * If the button/trigger is currently touched
  19921. */
  19922. touched: boolean;
  19923. /**
  19924. * If the button/trigger is currently pressed
  19925. */
  19926. pressed: boolean;
  19927. }
  19928. /**
  19929. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19930. * @hidden
  19931. */
  19932. export interface ExtendedGamepadButton extends GamepadButton {
  19933. /**
  19934. * If the button/trigger is currently pressed
  19935. */
  19936. readonly pressed: boolean;
  19937. /**
  19938. * If the button/trigger is currently touched
  19939. */
  19940. readonly touched: boolean;
  19941. /**
  19942. * Value of the button/trigger
  19943. */
  19944. readonly value: number;
  19945. }
  19946. /** @hidden */
  19947. export interface _GamePadFactory {
  19948. /**
  19949. * Returns whether or not the current gamepad can be created for this type of controller.
  19950. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19951. * @returns true if it can be created, otherwise false
  19952. */
  19953. canCreate(gamepadInfo: any): boolean;
  19954. /**
  19955. * Creates a new instance of the Gamepad.
  19956. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19957. * @returns the new gamepad instance
  19958. */
  19959. create(gamepadInfo: any): Gamepad;
  19960. }
  19961. /**
  19962. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19963. */
  19964. export class PoseEnabledControllerHelper {
  19965. /** @hidden */
  19966. static _ControllerFactories: _GamePadFactory[];
  19967. /** @hidden */
  19968. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19969. /**
  19970. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19971. * @param vrGamepad the gamepad to initialized
  19972. * @returns a vr controller of the type the gamepad identified as
  19973. */
  19974. static InitiateController(vrGamepad: any): Gamepad;
  19975. }
  19976. /**
  19977. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19978. */
  19979. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19980. /**
  19981. * If the controller is used in a webXR session
  19982. */
  19983. isXR: boolean;
  19984. private _deviceRoomPosition;
  19985. private _deviceRoomRotationQuaternion;
  19986. /**
  19987. * The device position in babylon space
  19988. */
  19989. devicePosition: Vector3;
  19990. /**
  19991. * The device rotation in babylon space
  19992. */
  19993. deviceRotationQuaternion: Quaternion;
  19994. /**
  19995. * The scale factor of the device in babylon space
  19996. */
  19997. deviceScaleFactor: number;
  19998. /**
  19999. * (Likely devicePosition should be used instead) The device position in its room space
  20000. */
  20001. position: Vector3;
  20002. /**
  20003. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20004. */
  20005. rotationQuaternion: Quaternion;
  20006. /**
  20007. * The type of controller (Eg. Windows mixed reality)
  20008. */
  20009. controllerType: PoseEnabledControllerType;
  20010. protected _calculatedPosition: Vector3;
  20011. private _calculatedRotation;
  20012. /**
  20013. * The raw pose from the device
  20014. */
  20015. rawPose: DevicePose;
  20016. private _trackPosition;
  20017. private _maxRotationDistFromHeadset;
  20018. private _draggedRoomRotation;
  20019. /**
  20020. * @hidden
  20021. */
  20022. _disableTrackPosition(fixedPosition: Vector3): void;
  20023. /**
  20024. * Internal, the mesh attached to the controller
  20025. * @hidden
  20026. */
  20027. _mesh: Nullable<AbstractMesh>;
  20028. private _poseControlledCamera;
  20029. private _leftHandSystemQuaternion;
  20030. /**
  20031. * Internal, matrix used to convert room space to babylon space
  20032. * @hidden
  20033. */
  20034. _deviceToWorld: Matrix;
  20035. /**
  20036. * Node to be used when casting a ray from the controller
  20037. * @hidden
  20038. */
  20039. _pointingPoseNode: Nullable<TransformNode>;
  20040. /**
  20041. * Name of the child mesh that can be used to cast a ray from the controller
  20042. */
  20043. static readonly POINTING_POSE: string;
  20044. /**
  20045. * Creates a new PoseEnabledController from a gamepad
  20046. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20047. */
  20048. constructor(browserGamepad: any);
  20049. private _workingMatrix;
  20050. /**
  20051. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20052. */
  20053. update(): void;
  20054. /**
  20055. * Updates only the pose device and mesh without doing any button event checking
  20056. */
  20057. protected _updatePoseAndMesh(): void;
  20058. /**
  20059. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20060. * @param poseData raw pose fromthe device
  20061. */
  20062. updateFromDevice(poseData: DevicePose): void;
  20063. /**
  20064. * @hidden
  20065. */
  20066. _meshAttachedObservable: Observable<AbstractMesh>;
  20067. /**
  20068. * Attaches a mesh to the controller
  20069. * @param mesh the mesh to be attached
  20070. */
  20071. attachToMesh(mesh: AbstractMesh): void;
  20072. /**
  20073. * Attaches the controllers mesh to a camera
  20074. * @param camera the camera the mesh should be attached to
  20075. */
  20076. attachToPoseControlledCamera(camera: TargetCamera): void;
  20077. /**
  20078. * Disposes of the controller
  20079. */
  20080. dispose(): void;
  20081. /**
  20082. * The mesh that is attached to the controller
  20083. */
  20084. get mesh(): Nullable<AbstractMesh>;
  20085. /**
  20086. * Gets the ray of the controller in the direction the controller is pointing
  20087. * @param length the length the resulting ray should be
  20088. * @returns a ray in the direction the controller is pointing
  20089. */
  20090. getForwardRay(length?: number): Ray;
  20091. }
  20092. }
  20093. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20094. import { Observable } from "babylonjs/Misc/observable";
  20095. import { Scene } from "babylonjs/scene";
  20096. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20097. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20098. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20099. import { Nullable } from "babylonjs/types";
  20100. /**
  20101. * Defines the WebVRController object that represents controllers tracked in 3D space
  20102. */
  20103. export abstract class WebVRController extends PoseEnabledController {
  20104. /**
  20105. * Internal, the default controller model for the controller
  20106. */
  20107. protected _defaultModel: Nullable<AbstractMesh>;
  20108. /**
  20109. * Fired when the trigger state has changed
  20110. */
  20111. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20112. /**
  20113. * Fired when the main button state has changed
  20114. */
  20115. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20116. /**
  20117. * Fired when the secondary button state has changed
  20118. */
  20119. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20120. /**
  20121. * Fired when the pad state has changed
  20122. */
  20123. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20124. /**
  20125. * Fired when controllers stick values have changed
  20126. */
  20127. onPadValuesChangedObservable: Observable<StickValues>;
  20128. /**
  20129. * Array of button availible on the controller
  20130. */
  20131. protected _buttons: Array<MutableGamepadButton>;
  20132. private _onButtonStateChange;
  20133. /**
  20134. * Fired when a controller button's state has changed
  20135. * @param callback the callback containing the button that was modified
  20136. */
  20137. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20138. /**
  20139. * X and Y axis corresponding to the controllers joystick
  20140. */
  20141. pad: StickValues;
  20142. /**
  20143. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20144. */
  20145. hand: string;
  20146. /**
  20147. * The default controller model for the controller
  20148. */
  20149. get defaultModel(): Nullable<AbstractMesh>;
  20150. /**
  20151. * Creates a new WebVRController from a gamepad
  20152. * @param vrGamepad the gamepad that the WebVRController should be created from
  20153. */
  20154. constructor(vrGamepad: any);
  20155. /**
  20156. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20157. */
  20158. update(): void;
  20159. /**
  20160. * Function to be called when a button is modified
  20161. */
  20162. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20163. /**
  20164. * Loads a mesh and attaches it to the controller
  20165. * @param scene the scene the mesh should be added to
  20166. * @param meshLoaded callback for when the mesh has been loaded
  20167. */
  20168. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20169. private _setButtonValue;
  20170. private _changes;
  20171. private _checkChanges;
  20172. /**
  20173. * Disposes of th webVRCOntroller
  20174. */
  20175. dispose(): void;
  20176. }
  20177. }
  20178. declare module "babylonjs/Lights/hemisphericLight" {
  20179. import { Nullable } from "babylonjs/types";
  20180. import { Scene } from "babylonjs/scene";
  20181. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20182. import { Color3 } from "babylonjs/Maths/math.color";
  20183. import { Effect } from "babylonjs/Materials/effect";
  20184. import { Light } from "babylonjs/Lights/light";
  20185. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20186. /**
  20187. * The HemisphericLight simulates the ambient environment light,
  20188. * so the passed direction is the light reflection direction, not the incoming direction.
  20189. */
  20190. export class HemisphericLight extends Light {
  20191. /**
  20192. * The groundColor is the light in the opposite direction to the one specified during creation.
  20193. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  20194. */
  20195. groundColor: Color3;
  20196. /**
  20197. * The light reflection direction, not the incoming direction.
  20198. */
  20199. direction: Vector3;
  20200. /**
  20201. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20202. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20203. * The HemisphericLight can't cast shadows.
  20204. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20205. * @param name The friendly name of the light
  20206. * @param direction The direction of the light reflection
  20207. * @param scene The scene the light belongs to
  20208. */
  20209. constructor(name: string, direction: Vector3, scene: Scene);
  20210. protected _buildUniformLayout(): void;
  20211. /**
  20212. * Returns the string "HemisphericLight".
  20213. * @return The class name
  20214. */
  20215. getClassName(): string;
  20216. /**
  20217. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20218. * Returns the updated direction.
  20219. * @param target The target the direction should point to
  20220. * @return The computed direction
  20221. */
  20222. setDirectionToTarget(target: Vector3): Vector3;
  20223. /**
  20224. * Returns the shadow generator associated to the light.
  20225. * @returns Always null for hemispheric lights because it does not support shadows.
  20226. */
  20227. getShadowGenerator(): Nullable<IShadowGenerator>;
  20228. /**
  20229. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20230. * @param effect The effect to update
  20231. * @param lightIndex The index of the light in the effect to update
  20232. * @returns The hemispheric light
  20233. */
  20234. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20235. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20236. /**
  20237. * Computes the world matrix of the node
  20238. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20239. * @param useWasUpdatedFlag defines a reserved property
  20240. * @returns the world matrix
  20241. */
  20242. computeWorldMatrix(): Matrix;
  20243. /**
  20244. * Returns the integer 3.
  20245. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20246. */
  20247. getTypeID(): number;
  20248. /**
  20249. * Prepares the list of defines specific to the light type.
  20250. * @param defines the list of defines
  20251. * @param lightIndex defines the index of the light for the effect
  20252. */
  20253. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20254. }
  20255. }
  20256. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20257. /** @hidden */
  20258. export var vrMultiviewToSingleviewPixelShader: {
  20259. name: string;
  20260. shader: string;
  20261. };
  20262. }
  20263. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20264. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20265. import { Scene } from "babylonjs/scene";
  20266. /**
  20267. * Renders to multiple views with a single draw call
  20268. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20269. */
  20270. export class MultiviewRenderTarget extends RenderTargetTexture {
  20271. /**
  20272. * Creates a multiview render target
  20273. * @param scene scene used with the render target
  20274. * @param size the size of the render target (used for each view)
  20275. */
  20276. constructor(scene: Scene, size?: number | {
  20277. width: number;
  20278. height: number;
  20279. } | {
  20280. ratio: number;
  20281. });
  20282. /**
  20283. * @hidden
  20284. * @param faceIndex the face index, if its a cube texture
  20285. */
  20286. _bindFrameBuffer(faceIndex?: number): void;
  20287. /**
  20288. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20289. * @returns the view count
  20290. */
  20291. getViewCount(): number;
  20292. }
  20293. }
  20294. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20295. import { Camera } from "babylonjs/Cameras/camera";
  20296. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20297. import { Nullable } from "babylonjs/types";
  20298. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20299. import { Matrix } from "babylonjs/Maths/math.vector";
  20300. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20301. module "babylonjs/Engines/engine" {
  20302. interface Engine {
  20303. /**
  20304. * Creates a new multiview render target
  20305. * @param width defines the width of the texture
  20306. * @param height defines the height of the texture
  20307. * @returns the created multiview texture
  20308. */
  20309. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20310. /**
  20311. * Binds a multiview framebuffer to be drawn to
  20312. * @param multiviewTexture texture to bind
  20313. */
  20314. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20315. }
  20316. }
  20317. module "babylonjs/Cameras/camera" {
  20318. interface Camera {
  20319. /**
  20320. * @hidden
  20321. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20322. */
  20323. _useMultiviewToSingleView: boolean;
  20324. /**
  20325. * @hidden
  20326. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20327. */
  20328. _multiviewTexture: Nullable<RenderTargetTexture>;
  20329. /**
  20330. * @hidden
  20331. * ensures the multiview texture of the camera exists and has the specified width/height
  20332. * @param width height to set on the multiview texture
  20333. * @param height width to set on the multiview texture
  20334. */
  20335. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20336. }
  20337. }
  20338. module "babylonjs/scene" {
  20339. interface Scene {
  20340. /** @hidden */
  20341. _transformMatrixR: Matrix;
  20342. /** @hidden */
  20343. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20344. /** @hidden */
  20345. _createMultiviewUbo(): void;
  20346. /** @hidden */
  20347. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20348. /** @hidden */
  20349. _renderMultiviewToSingleView(camera: Camera): void;
  20350. }
  20351. }
  20352. }
  20353. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20354. import { Camera } from "babylonjs/Cameras/camera";
  20355. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20356. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20357. import "babylonjs/Engines/Extensions/engine.multiview";
  20358. /**
  20359. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20360. * This will not be used for webXR as it supports displaying texture arrays directly
  20361. */
  20362. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20363. /**
  20364. * Gets a string identifying the name of the class
  20365. * @returns "VRMultiviewToSingleviewPostProcess" string
  20366. */
  20367. getClassName(): string;
  20368. /**
  20369. * Initializes a VRMultiviewToSingleview
  20370. * @param name name of the post process
  20371. * @param camera camera to be applied to
  20372. * @param scaleFactor scaling factor to the size of the output texture
  20373. */
  20374. constructor(name: string, camera: Camera, scaleFactor: number);
  20375. }
  20376. }
  20377. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20378. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20379. import { Nullable } from "babylonjs/types";
  20380. import { Size } from "babylonjs/Maths/math.size";
  20381. import { Observable } from "babylonjs/Misc/observable";
  20382. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20383. /**
  20384. * Interface used to define additional presentation attributes
  20385. */
  20386. export interface IVRPresentationAttributes {
  20387. /**
  20388. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20389. */
  20390. highRefreshRate: boolean;
  20391. /**
  20392. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20393. */
  20394. foveationLevel: number;
  20395. }
  20396. module "babylonjs/Engines/engine" {
  20397. interface Engine {
  20398. /** @hidden */
  20399. _vrDisplay: any;
  20400. /** @hidden */
  20401. _vrSupported: boolean;
  20402. /** @hidden */
  20403. _oldSize: Size;
  20404. /** @hidden */
  20405. _oldHardwareScaleFactor: number;
  20406. /** @hidden */
  20407. _vrExclusivePointerMode: boolean;
  20408. /** @hidden */
  20409. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20410. /** @hidden */
  20411. _onVRDisplayPointerRestricted: () => void;
  20412. /** @hidden */
  20413. _onVRDisplayPointerUnrestricted: () => void;
  20414. /** @hidden */
  20415. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20416. /** @hidden */
  20417. _onVrDisplayDisconnect: Nullable<() => void>;
  20418. /** @hidden */
  20419. _onVrDisplayPresentChange: Nullable<() => void>;
  20420. /**
  20421. * Observable signaled when VR display mode changes
  20422. */
  20423. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20424. /**
  20425. * Observable signaled when VR request present is complete
  20426. */
  20427. onVRRequestPresentComplete: Observable<boolean>;
  20428. /**
  20429. * Observable signaled when VR request present starts
  20430. */
  20431. onVRRequestPresentStart: Observable<Engine>;
  20432. /**
  20433. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20434. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20435. */
  20436. isInVRExclusivePointerMode: boolean;
  20437. /**
  20438. * Gets a boolean indicating if a webVR device was detected
  20439. * @returns true if a webVR device was detected
  20440. */
  20441. isVRDevicePresent(): boolean;
  20442. /**
  20443. * Gets the current webVR device
  20444. * @returns the current webVR device (or null)
  20445. */
  20446. getVRDevice(): any;
  20447. /**
  20448. * Initializes a webVR display and starts listening to display change events
  20449. * The onVRDisplayChangedObservable will be notified upon these changes
  20450. * @returns A promise containing a VRDisplay and if vr is supported
  20451. */
  20452. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20453. /** @hidden */
  20454. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20455. /**
  20456. * Gets or sets the presentation attributes used to configure VR rendering
  20457. */
  20458. vrPresentationAttributes?: IVRPresentationAttributes;
  20459. /**
  20460. * Call this function to switch to webVR mode
  20461. * Will do nothing if webVR is not supported or if there is no webVR device
  20462. * @param options the webvr options provided to the camera. mainly used for multiview
  20463. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20464. */
  20465. enableVR(options: WebVROptions): void;
  20466. /** @hidden */
  20467. _onVRFullScreenTriggered(): void;
  20468. }
  20469. }
  20470. }
  20471. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20472. import { Nullable } from "babylonjs/types";
  20473. import { Observable } from "babylonjs/Misc/observable";
  20474. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20475. import { Scene } from "babylonjs/scene";
  20476. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20477. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20478. import { Node } from "babylonjs/node";
  20479. import { Ray } from "babylonjs/Culling/ray";
  20480. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20481. import "babylonjs/Engines/Extensions/engine.webVR";
  20482. /**
  20483. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20484. * IMPORTANT!! The data is right-hand data.
  20485. * @export
  20486. * @interface DevicePose
  20487. */
  20488. export interface DevicePose {
  20489. /**
  20490. * The position of the device, values in array are [x,y,z].
  20491. */
  20492. readonly position: Nullable<Float32Array>;
  20493. /**
  20494. * The linearVelocity of the device, values in array are [x,y,z].
  20495. */
  20496. readonly linearVelocity: Nullable<Float32Array>;
  20497. /**
  20498. * The linearAcceleration of the device, values in array are [x,y,z].
  20499. */
  20500. readonly linearAcceleration: Nullable<Float32Array>;
  20501. /**
  20502. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20503. */
  20504. readonly orientation: Nullable<Float32Array>;
  20505. /**
  20506. * The angularVelocity of the device, values in array are [x,y,z].
  20507. */
  20508. readonly angularVelocity: Nullable<Float32Array>;
  20509. /**
  20510. * The angularAcceleration of the device, values in array are [x,y,z].
  20511. */
  20512. readonly angularAcceleration: Nullable<Float32Array>;
  20513. }
  20514. /**
  20515. * Interface representing a pose controlled object in Babylon.
  20516. * A pose controlled object has both regular pose values as well as pose values
  20517. * from an external device such as a VR head mounted display
  20518. */
  20519. export interface PoseControlled {
  20520. /**
  20521. * The position of the object in babylon space.
  20522. */
  20523. position: Vector3;
  20524. /**
  20525. * The rotation quaternion of the object in babylon space.
  20526. */
  20527. rotationQuaternion: Quaternion;
  20528. /**
  20529. * The position of the device in babylon space.
  20530. */
  20531. devicePosition?: Vector3;
  20532. /**
  20533. * The rotation quaternion of the device in babylon space.
  20534. */
  20535. deviceRotationQuaternion: Quaternion;
  20536. /**
  20537. * The raw pose coming from the device.
  20538. */
  20539. rawPose: Nullable<DevicePose>;
  20540. /**
  20541. * The scale of the device to be used when translating from device space to babylon space.
  20542. */
  20543. deviceScaleFactor: number;
  20544. /**
  20545. * Updates the poseControlled values based on the input device pose.
  20546. * @param poseData the pose data to update the object with
  20547. */
  20548. updateFromDevice(poseData: DevicePose): void;
  20549. }
  20550. /**
  20551. * Set of options to customize the webVRCamera
  20552. */
  20553. export interface WebVROptions {
  20554. /**
  20555. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20556. */
  20557. trackPosition?: boolean;
  20558. /**
  20559. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20560. */
  20561. positionScale?: number;
  20562. /**
  20563. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20564. */
  20565. displayName?: string;
  20566. /**
  20567. * Should the native controller meshes be initialized. (default: true)
  20568. */
  20569. controllerMeshes?: boolean;
  20570. /**
  20571. * Creating a default HemiLight only on controllers. (default: true)
  20572. */
  20573. defaultLightingOnControllers?: boolean;
  20574. /**
  20575. * If you don't want to use the default VR button of the helper. (default: false)
  20576. */
  20577. useCustomVRButton?: boolean;
  20578. /**
  20579. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20580. */
  20581. customVRButton?: HTMLButtonElement;
  20582. /**
  20583. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20584. */
  20585. rayLength?: number;
  20586. /**
  20587. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20588. */
  20589. defaultHeight?: number;
  20590. /**
  20591. * If multiview should be used if availible (default: false)
  20592. */
  20593. useMultiview?: boolean;
  20594. }
  20595. /**
  20596. * This represents a WebVR camera.
  20597. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20598. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20599. */
  20600. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20601. private webVROptions;
  20602. /**
  20603. * @hidden
  20604. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20605. */
  20606. _vrDevice: any;
  20607. /**
  20608. * The rawPose of the vrDevice.
  20609. */
  20610. rawPose: Nullable<DevicePose>;
  20611. private _onVREnabled;
  20612. private _specsVersion;
  20613. private _attached;
  20614. private _frameData;
  20615. protected _descendants: Array<Node>;
  20616. private _deviceRoomPosition;
  20617. /** @hidden */
  20618. _deviceRoomRotationQuaternion: Quaternion;
  20619. private _standingMatrix;
  20620. /**
  20621. * Represents device position in babylon space.
  20622. */
  20623. devicePosition: Vector3;
  20624. /**
  20625. * Represents device rotation in babylon space.
  20626. */
  20627. deviceRotationQuaternion: Quaternion;
  20628. /**
  20629. * The scale of the device to be used when translating from device space to babylon space.
  20630. */
  20631. deviceScaleFactor: number;
  20632. private _deviceToWorld;
  20633. private _worldToDevice;
  20634. /**
  20635. * References to the webVR controllers for the vrDevice.
  20636. */
  20637. controllers: Array<WebVRController>;
  20638. /**
  20639. * Emits an event when a controller is attached.
  20640. */
  20641. onControllersAttachedObservable: Observable<WebVRController[]>;
  20642. /**
  20643. * Emits an event when a controller's mesh has been loaded;
  20644. */
  20645. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20646. /**
  20647. * Emits an event when the HMD's pose has been updated.
  20648. */
  20649. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20650. private _poseSet;
  20651. /**
  20652. * If the rig cameras be used as parent instead of this camera.
  20653. */
  20654. rigParenting: boolean;
  20655. private _lightOnControllers;
  20656. private _defaultHeight?;
  20657. /**
  20658. * Instantiates a WebVRFreeCamera.
  20659. * @param name The name of the WebVRFreeCamera
  20660. * @param position The starting anchor position for the camera
  20661. * @param scene The scene the camera belongs to
  20662. * @param webVROptions a set of customizable options for the webVRCamera
  20663. */
  20664. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20665. /**
  20666. * Gets the device distance from the ground in meters.
  20667. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  20668. */
  20669. deviceDistanceToRoomGround(): number;
  20670. /**
  20671. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20672. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20673. */
  20674. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20675. /**
  20676. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20677. * @returns A promise with a boolean set to if the standing matrix is supported.
  20678. */
  20679. useStandingMatrixAsync(): Promise<boolean>;
  20680. /**
  20681. * Disposes the camera
  20682. */
  20683. dispose(): void;
  20684. /**
  20685. * Gets a vrController by name.
  20686. * @param name The name of the controller to retreive
  20687. * @returns the controller matching the name specified or null if not found
  20688. */
  20689. getControllerByName(name: string): Nullable<WebVRController>;
  20690. private _leftController;
  20691. /**
  20692. * The controller corresponding to the users left hand.
  20693. */
  20694. get leftController(): Nullable<WebVRController>;
  20695. private _rightController;
  20696. /**
  20697. * The controller corresponding to the users right hand.
  20698. */
  20699. get rightController(): Nullable<WebVRController>;
  20700. /**
  20701. * Casts a ray forward from the vrCamera's gaze.
  20702. * @param length Length of the ray (default: 100)
  20703. * @returns the ray corresponding to the gaze
  20704. */
  20705. getForwardRay(length?: number): Ray;
  20706. /**
  20707. * @hidden
  20708. * Updates the camera based on device's frame data
  20709. */
  20710. _checkInputs(): void;
  20711. /**
  20712. * Updates the poseControlled values based on the input device pose.
  20713. * @param poseData Pose coming from the device
  20714. */
  20715. updateFromDevice(poseData: DevicePose): void;
  20716. private _htmlElementAttached;
  20717. private _detachIfAttached;
  20718. /**
  20719. * WebVR's attach control will start broadcasting frames to the device.
  20720. * Note that in certain browsers (chrome for example) this function must be called
  20721. * within a user-interaction callback. Example:
  20722. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20723. *
  20724. * @param element html element to attach the vrDevice to
  20725. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20726. */
  20727. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20728. /**
  20729. * Detaches the camera from the html element and disables VR
  20730. *
  20731. * @param element html element to detach from
  20732. */
  20733. detachControl(element: HTMLElement): void;
  20734. /**
  20735. * @returns the name of this class
  20736. */
  20737. getClassName(): string;
  20738. /**
  20739. * Calls resetPose on the vrDisplay
  20740. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20741. */
  20742. resetToCurrentRotation(): void;
  20743. /**
  20744. * @hidden
  20745. * Updates the rig cameras (left and right eye)
  20746. */
  20747. _updateRigCameras(): void;
  20748. private _workingVector;
  20749. private _oneVector;
  20750. private _workingMatrix;
  20751. private updateCacheCalled;
  20752. private _correctPositionIfNotTrackPosition;
  20753. /**
  20754. * @hidden
  20755. * Updates the cached values of the camera
  20756. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20757. */
  20758. _updateCache(ignoreParentClass?: boolean): void;
  20759. /**
  20760. * @hidden
  20761. * Get current device position in babylon world
  20762. */
  20763. _computeDevicePosition(): void;
  20764. /**
  20765. * Updates the current device position and rotation in the babylon world
  20766. */
  20767. update(): void;
  20768. /**
  20769. * @hidden
  20770. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20771. * @returns an identity matrix
  20772. */
  20773. _getViewMatrix(): Matrix;
  20774. private _tmpMatrix;
  20775. /**
  20776. * This function is called by the two RIG cameras.
  20777. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20778. * @hidden
  20779. */
  20780. _getWebVRViewMatrix(): Matrix;
  20781. /** @hidden */
  20782. _getWebVRProjectionMatrix(): Matrix;
  20783. private _onGamepadConnectedObserver;
  20784. private _onGamepadDisconnectedObserver;
  20785. private _updateCacheWhenTrackingDisabledObserver;
  20786. /**
  20787. * Initializes the controllers and their meshes
  20788. */
  20789. initControllers(): void;
  20790. }
  20791. }
  20792. declare module "babylonjs/Materials/materialHelper" {
  20793. import { Nullable } from "babylonjs/types";
  20794. import { Scene } from "babylonjs/scene";
  20795. import { Engine } from "babylonjs/Engines/engine";
  20796. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20797. import { Light } from "babylonjs/Lights/light";
  20798. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20799. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20800. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20801. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20802. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20803. /**
  20804. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20805. *
  20806. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20807. *
  20808. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20809. */
  20810. export class MaterialHelper {
  20811. /**
  20812. * Bind the current view position to an effect.
  20813. * @param effect The effect to be bound
  20814. * @param scene The scene the eyes position is used from
  20815. * @param variableName name of the shader variable that will hold the eye position
  20816. */
  20817. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20818. /**
  20819. * Helps preparing the defines values about the UVs in used in the effect.
  20820. * UVs are shared as much as we can accross channels in the shaders.
  20821. * @param texture The texture we are preparing the UVs for
  20822. * @param defines The defines to update
  20823. * @param key The channel key "diffuse", "specular"... used in the shader
  20824. */
  20825. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20826. /**
  20827. * Binds a texture matrix value to its corrsponding uniform
  20828. * @param texture The texture to bind the matrix for
  20829. * @param uniformBuffer The uniform buffer receivin the data
  20830. * @param key The channel key "diffuse", "specular"... used in the shader
  20831. */
  20832. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20833. /**
  20834. * Gets the current status of the fog (should it be enabled?)
  20835. * @param mesh defines the mesh to evaluate for fog support
  20836. * @param scene defines the hosting scene
  20837. * @returns true if fog must be enabled
  20838. */
  20839. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20840. /**
  20841. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20842. * @param mesh defines the current mesh
  20843. * @param scene defines the current scene
  20844. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20845. * @param pointsCloud defines if point cloud rendering has to be turned on
  20846. * @param fogEnabled defines if fog has to be turned on
  20847. * @param alphaTest defines if alpha testing has to be turned on
  20848. * @param defines defines the current list of defines
  20849. */
  20850. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20851. /**
  20852. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20853. * @param scene defines the current scene
  20854. * @param engine defines the current engine
  20855. * @param defines specifies the list of active defines
  20856. * @param useInstances defines if instances have to be turned on
  20857. * @param useClipPlane defines if clip plane have to be turned on
  20858. * @param useInstances defines if instances have to be turned on
  20859. * @param useThinInstances defines if thin instances have to be turned on
  20860. */
  20861. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20862. /**
  20863. * Prepares the defines for bones
  20864. * @param mesh The mesh containing the geometry data we will draw
  20865. * @param defines The defines to update
  20866. */
  20867. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20868. /**
  20869. * Prepares the defines for morph targets
  20870. * @param mesh The mesh containing the geometry data we will draw
  20871. * @param defines The defines to update
  20872. */
  20873. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20874. /**
  20875. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20876. * @param mesh The mesh containing the geometry data we will draw
  20877. * @param defines The defines to update
  20878. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20879. * @param useBones Precise whether bones should be used or not (override mesh info)
  20880. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20881. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20882. * @returns false if defines are considered not dirty and have not been checked
  20883. */
  20884. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20885. /**
  20886. * Prepares the defines related to multiview
  20887. * @param scene The scene we are intending to draw
  20888. * @param defines The defines to update
  20889. */
  20890. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20891. /**
  20892. * Prepares the defines related to the prepass
  20893. * @param scene The scene we are intending to draw
  20894. * @param defines The defines to update
  20895. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20896. */
  20897. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20898. /**
  20899. * Prepares the defines related to the light information passed in parameter
  20900. * @param scene The scene we are intending to draw
  20901. * @param mesh The mesh the effect is compiling for
  20902. * @param light The light the effect is compiling for
  20903. * @param lightIndex The index of the light
  20904. * @param defines The defines to update
  20905. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20906. * @param state Defines the current state regarding what is needed (normals, etc...)
  20907. */
  20908. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20909. needNormals: boolean;
  20910. needRebuild: boolean;
  20911. shadowEnabled: boolean;
  20912. specularEnabled: boolean;
  20913. lightmapMode: boolean;
  20914. }): void;
  20915. /**
  20916. * Prepares the defines related to the light information passed in parameter
  20917. * @param scene The scene we are intending to draw
  20918. * @param mesh The mesh the effect is compiling for
  20919. * @param defines The defines to update
  20920. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20921. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20922. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20923. * @returns true if normals will be required for the rest of the effect
  20924. */
  20925. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20926. /**
  20927. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20928. * @param lightIndex defines the light index
  20929. * @param uniformsList The uniform list
  20930. * @param samplersList The sampler list
  20931. * @param projectedLightTexture defines if projected texture must be used
  20932. * @param uniformBuffersList defines an optional list of uniform buffers
  20933. */
  20934. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20935. /**
  20936. * Prepares the uniforms and samplers list to be used in the effect
  20937. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20938. * @param samplersList The sampler list
  20939. * @param defines The defines helping in the list generation
  20940. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20941. */
  20942. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20943. /**
  20944. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20945. * @param defines The defines to update while falling back
  20946. * @param fallbacks The authorized effect fallbacks
  20947. * @param maxSimultaneousLights The maximum number of lights allowed
  20948. * @param rank the current rank of the Effect
  20949. * @returns The newly affected rank
  20950. */
  20951. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20952. private static _TmpMorphInfluencers;
  20953. /**
  20954. * Prepares the list of attributes required for morph targets according to the effect defines.
  20955. * @param attribs The current list of supported attribs
  20956. * @param mesh The mesh to prepare the morph targets attributes for
  20957. * @param influencers The number of influencers
  20958. */
  20959. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20960. /**
  20961. * Prepares the list of attributes required for morph targets according to the effect defines.
  20962. * @param attribs The current list of supported attribs
  20963. * @param mesh The mesh to prepare the morph targets attributes for
  20964. * @param defines The current Defines of the effect
  20965. */
  20966. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20967. /**
  20968. * Prepares the list of attributes required for bones according to the effect defines.
  20969. * @param attribs The current list of supported attribs
  20970. * @param mesh The mesh to prepare the bones attributes for
  20971. * @param defines The current Defines of the effect
  20972. * @param fallbacks The current efffect fallback strategy
  20973. */
  20974. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20975. /**
  20976. * Check and prepare the list of attributes required for instances according to the effect defines.
  20977. * @param attribs The current list of supported attribs
  20978. * @param defines The current MaterialDefines of the effect
  20979. */
  20980. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20981. /**
  20982. * Add the list of attributes required for instances to the attribs array.
  20983. * @param attribs The current list of supported attribs
  20984. */
  20985. static PushAttributesForInstances(attribs: string[]): void;
  20986. /**
  20987. * Binds the light information to the effect.
  20988. * @param light The light containing the generator
  20989. * @param effect The effect we are binding the data to
  20990. * @param lightIndex The light index in the effect used to render
  20991. */
  20992. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20993. /**
  20994. * Binds the lights information from the scene to the effect for the given mesh.
  20995. * @param light Light to bind
  20996. * @param lightIndex Light index
  20997. * @param scene The scene where the light belongs to
  20998. * @param effect The effect we are binding the data to
  20999. * @param useSpecular Defines if specular is supported
  21000. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21001. */
  21002. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21003. /**
  21004. * Binds the lights information from the scene to the effect for the given mesh.
  21005. * @param scene The scene the lights belongs to
  21006. * @param mesh The mesh we are binding the information to render
  21007. * @param effect The effect we are binding the data to
  21008. * @param defines The generated defines for the effect
  21009. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21010. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21011. */
  21012. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21013. private static _tempFogColor;
  21014. /**
  21015. * Binds the fog information from the scene to the effect for the given mesh.
  21016. * @param scene The scene the lights belongs to
  21017. * @param mesh The mesh we are binding the information to render
  21018. * @param effect The effect we are binding the data to
  21019. * @param linearSpace Defines if the fog effect is applied in linear space
  21020. */
  21021. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21022. /**
  21023. * Binds the bones information from the mesh to the effect.
  21024. * @param mesh The mesh we are binding the information to render
  21025. * @param effect The effect we are binding the data to
  21026. */
  21027. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21028. /**
  21029. * Binds the morph targets information from the mesh to the effect.
  21030. * @param abstractMesh The mesh we are binding the information to render
  21031. * @param effect The effect we are binding the data to
  21032. */
  21033. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21034. /**
  21035. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21036. * @param defines The generated defines used in the effect
  21037. * @param effect The effect we are binding the data to
  21038. * @param scene The scene we are willing to render with logarithmic scale for
  21039. */
  21040. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21041. /**
  21042. * Binds the clip plane information from the scene to the effect.
  21043. * @param scene The scene the clip plane information are extracted from
  21044. * @param effect The effect we are binding the data to
  21045. */
  21046. static BindClipPlane(effect: Effect, scene: Scene): void;
  21047. }
  21048. }
  21049. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21050. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21051. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21052. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21053. import { Nullable } from "babylonjs/types";
  21054. import { Effect } from "babylonjs/Materials/effect";
  21055. import { Matrix } from "babylonjs/Maths/math.vector";
  21056. import { Scene } from "babylonjs/scene";
  21057. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21058. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21059. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21060. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21061. import { Observable } from "babylonjs/Misc/observable";
  21062. /**
  21063. * Block used to expose an input value
  21064. */
  21065. export class InputBlock extends NodeMaterialBlock {
  21066. private _mode;
  21067. private _associatedVariableName;
  21068. private _storedValue;
  21069. private _valueCallback;
  21070. private _type;
  21071. private _animationType;
  21072. /** Gets or set a value used to limit the range of float values */
  21073. min: number;
  21074. /** Gets or set a value used to limit the range of float values */
  21075. max: number;
  21076. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21077. isBoolean: boolean;
  21078. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21079. matrixMode: number;
  21080. /** @hidden */
  21081. _systemValue: Nullable<NodeMaterialSystemValues>;
  21082. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21083. visibleInInspector: boolean;
  21084. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21085. isConstant: boolean;
  21086. /** Gets or sets the group to use to display this block in the Inspector */
  21087. groupInInspector: string;
  21088. /** Gets an observable raised when the value is changed */
  21089. onValueChangedObservable: Observable<InputBlock>;
  21090. /**
  21091. * Gets or sets the connection point type (default is float)
  21092. */
  21093. get type(): NodeMaterialBlockConnectionPointTypes;
  21094. /**
  21095. * Creates a new InputBlock
  21096. * @param name defines the block name
  21097. * @param target defines the target of that block (Vertex by default)
  21098. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21099. */
  21100. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21101. /**
  21102. * Validates if a name is a reserve word.
  21103. * @param newName the new name to be given to the node.
  21104. * @returns false if the name is a reserve word, else true.
  21105. */
  21106. validateBlockName(newName: string): boolean;
  21107. /**
  21108. * Gets the output component
  21109. */
  21110. get output(): NodeMaterialConnectionPoint;
  21111. /**
  21112. * Set the source of this connection point to a vertex attribute
  21113. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21114. * @returns the current connection point
  21115. */
  21116. setAsAttribute(attributeName?: string): InputBlock;
  21117. /**
  21118. * Set the source of this connection point to a system value
  21119. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21120. * @returns the current connection point
  21121. */
  21122. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21123. /**
  21124. * Gets or sets the value of that point.
  21125. * Please note that this value will be ignored if valueCallback is defined
  21126. */
  21127. get value(): any;
  21128. set value(value: any);
  21129. /**
  21130. * Gets or sets a callback used to get the value of that point.
  21131. * Please note that setting this value will force the connection point to ignore the value property
  21132. */
  21133. get valueCallback(): () => any;
  21134. set valueCallback(value: () => any);
  21135. /**
  21136. * Gets or sets the associated variable name in the shader
  21137. */
  21138. get associatedVariableName(): string;
  21139. set associatedVariableName(value: string);
  21140. /** Gets or sets the type of animation applied to the input */
  21141. get animationType(): AnimatedInputBlockTypes;
  21142. set animationType(value: AnimatedInputBlockTypes);
  21143. /**
  21144. * Gets a boolean indicating that this connection point not defined yet
  21145. */
  21146. get isUndefined(): boolean;
  21147. /**
  21148. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21149. * In this case the connection point name must be the name of the uniform to use.
  21150. * Can only be set on inputs
  21151. */
  21152. get isUniform(): boolean;
  21153. set isUniform(value: boolean);
  21154. /**
  21155. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21156. * In this case the connection point name must be the name of the attribute to use
  21157. * Can only be set on inputs
  21158. */
  21159. get isAttribute(): boolean;
  21160. set isAttribute(value: boolean);
  21161. /**
  21162. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21163. * Can only be set on exit points
  21164. */
  21165. get isVarying(): boolean;
  21166. set isVarying(value: boolean);
  21167. /**
  21168. * Gets a boolean indicating that the current connection point is a system value
  21169. */
  21170. get isSystemValue(): boolean;
  21171. /**
  21172. * Gets or sets the current well known value or null if not defined as a system value
  21173. */
  21174. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21175. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21176. /**
  21177. * Gets the current class name
  21178. * @returns the class name
  21179. */
  21180. getClassName(): string;
  21181. /**
  21182. * Animate the input if animationType !== None
  21183. * @param scene defines the rendering scene
  21184. */
  21185. animate(scene: Scene): void;
  21186. private _emitDefine;
  21187. initialize(state: NodeMaterialBuildState): void;
  21188. /**
  21189. * Set the input block to its default value (based on its type)
  21190. */
  21191. setDefaultValue(): void;
  21192. private _emitConstant;
  21193. /** @hidden */
  21194. get _noContextSwitch(): boolean;
  21195. private _emit;
  21196. /** @hidden */
  21197. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21198. /** @hidden */
  21199. _transmit(effect: Effect, scene: Scene): void;
  21200. protected _buildBlock(state: NodeMaterialBuildState): void;
  21201. protected _dumpPropertiesCode(): string;
  21202. dispose(): void;
  21203. serialize(): any;
  21204. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21205. }
  21206. }
  21207. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21208. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21209. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21210. import { Nullable } from "babylonjs/types";
  21211. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21212. import { Observable } from "babylonjs/Misc/observable";
  21213. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21214. /**
  21215. * Enum used to define the compatibility state between two connection points
  21216. */
  21217. export enum NodeMaterialConnectionPointCompatibilityStates {
  21218. /** Points are compatibles */
  21219. Compatible = 0,
  21220. /** Points are incompatible because of their types */
  21221. TypeIncompatible = 1,
  21222. /** Points are incompatible because of their targets (vertex vs fragment) */
  21223. TargetIncompatible = 2
  21224. }
  21225. /**
  21226. * Defines the direction of a connection point
  21227. */
  21228. export enum NodeMaterialConnectionPointDirection {
  21229. /** Input */
  21230. Input = 0,
  21231. /** Output */
  21232. Output = 1
  21233. }
  21234. /**
  21235. * Defines a connection point for a block
  21236. */
  21237. export class NodeMaterialConnectionPoint {
  21238. /** @hidden */
  21239. _ownerBlock: NodeMaterialBlock;
  21240. /** @hidden */
  21241. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21242. private _endpoints;
  21243. private _associatedVariableName;
  21244. private _direction;
  21245. /** @hidden */
  21246. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21247. /** @hidden */
  21248. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21249. private _type;
  21250. /** @hidden */
  21251. _enforceAssociatedVariableName: boolean;
  21252. /** Gets the direction of the point */
  21253. get direction(): NodeMaterialConnectionPointDirection;
  21254. /** Indicates that this connection point needs dual validation before being connected to another point */
  21255. needDualDirectionValidation: boolean;
  21256. /**
  21257. * Gets or sets the additional types supported by this connection point
  21258. */
  21259. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21260. /**
  21261. * Gets or sets the additional types excluded by this connection point
  21262. */
  21263. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21264. /**
  21265. * Observable triggered when this point is connected
  21266. */
  21267. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21268. /**
  21269. * Gets or sets the associated variable name in the shader
  21270. */
  21271. get associatedVariableName(): string;
  21272. set associatedVariableName(value: string);
  21273. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21274. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21275. /**
  21276. * Gets or sets the connection point type (default is float)
  21277. */
  21278. get type(): NodeMaterialBlockConnectionPointTypes;
  21279. set type(value: NodeMaterialBlockConnectionPointTypes);
  21280. /**
  21281. * Gets or sets the connection point name
  21282. */
  21283. name: string;
  21284. /**
  21285. * Gets or sets the connection point name
  21286. */
  21287. displayName: string;
  21288. /**
  21289. * Gets or sets a boolean indicating that this connection point can be omitted
  21290. */
  21291. isOptional: boolean;
  21292. /**
  21293. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21294. */
  21295. isExposedOnFrame: boolean;
  21296. /**
  21297. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21298. */
  21299. define: string;
  21300. /** @hidden */
  21301. _prioritizeVertex: boolean;
  21302. private _target;
  21303. /** Gets or sets the target of that connection point */
  21304. get target(): NodeMaterialBlockTargets;
  21305. set target(value: NodeMaterialBlockTargets);
  21306. /**
  21307. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21308. */
  21309. get isConnected(): boolean;
  21310. /**
  21311. * Gets a boolean indicating that the current point is connected to an input block
  21312. */
  21313. get isConnectedToInputBlock(): boolean;
  21314. /**
  21315. * Gets a the connected input block (if any)
  21316. */
  21317. get connectInputBlock(): Nullable<InputBlock>;
  21318. /** Get the other side of the connection (if any) */
  21319. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21320. /** Get the block that owns this connection point */
  21321. get ownerBlock(): NodeMaterialBlock;
  21322. /** Get the block connected on the other side of this connection (if any) */
  21323. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21324. /** Get the block connected on the endpoints of this connection (if any) */
  21325. get connectedBlocks(): Array<NodeMaterialBlock>;
  21326. /** Gets the list of connected endpoints */
  21327. get endpoints(): NodeMaterialConnectionPoint[];
  21328. /** Gets a boolean indicating if that output point is connected to at least one input */
  21329. get hasEndpoints(): boolean;
  21330. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21331. get isConnectedInVertexShader(): boolean;
  21332. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21333. get isConnectedInFragmentShader(): boolean;
  21334. /**
  21335. * Creates a block suitable to be used as an input for this input point.
  21336. * If null is returned, a block based on the point type will be created.
  21337. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21338. */
  21339. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21340. /**
  21341. * Creates a new connection point
  21342. * @param name defines the connection point name
  21343. * @param ownerBlock defines the block hosting this connection point
  21344. * @param direction defines the direction of the connection point
  21345. */
  21346. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21347. /**
  21348. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21349. * @returns the class name
  21350. */
  21351. getClassName(): string;
  21352. /**
  21353. * Gets a boolean indicating if the current point can be connected to another point
  21354. * @param connectionPoint defines the other connection point
  21355. * @returns a boolean
  21356. */
  21357. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21358. /**
  21359. * Gets a number indicating if the current point can be connected to another point
  21360. * @param connectionPoint defines the other connection point
  21361. * @returns a number defining the compatibility state
  21362. */
  21363. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21364. /**
  21365. * Connect this point to another connection point
  21366. * @param connectionPoint defines the other connection point
  21367. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21368. * @returns the current connection point
  21369. */
  21370. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21371. /**
  21372. * Disconnect this point from one of his endpoint
  21373. * @param endpoint defines the other connection point
  21374. * @returns the current connection point
  21375. */
  21376. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21377. /**
  21378. * Serializes this point in a JSON representation
  21379. * @param isInput defines if the connection point is an input (default is true)
  21380. * @returns the serialized point object
  21381. */
  21382. serialize(isInput?: boolean): any;
  21383. /**
  21384. * Release resources
  21385. */
  21386. dispose(): void;
  21387. }
  21388. }
  21389. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21390. /**
  21391. * Enum used to define the material modes
  21392. */
  21393. export enum NodeMaterialModes {
  21394. /** Regular material */
  21395. Material = 0,
  21396. /** For post process */
  21397. PostProcess = 1,
  21398. /** For particle system */
  21399. Particle = 2
  21400. }
  21401. }
  21402. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21403. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21404. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21405. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21406. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21408. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21409. import { Effect } from "babylonjs/Materials/effect";
  21410. import { Mesh } from "babylonjs/Meshes/mesh";
  21411. import { Nullable } from "babylonjs/types";
  21412. import { Texture } from "babylonjs/Materials/Textures/texture";
  21413. import { Scene } from "babylonjs/scene";
  21414. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21415. /**
  21416. * Block used to read a texture from a sampler
  21417. */
  21418. export class TextureBlock extends NodeMaterialBlock {
  21419. private _defineName;
  21420. private _linearDefineName;
  21421. private _gammaDefineName;
  21422. private _tempTextureRead;
  21423. private _samplerName;
  21424. private _transformedUVName;
  21425. private _textureTransformName;
  21426. private _textureInfoName;
  21427. private _mainUVName;
  21428. private _mainUVDefineName;
  21429. private _fragmentOnly;
  21430. /**
  21431. * Gets or sets the texture associated with the node
  21432. */
  21433. texture: Nullable<Texture>;
  21434. /**
  21435. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21436. */
  21437. convertToGammaSpace: boolean;
  21438. /**
  21439. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21440. */
  21441. convertToLinearSpace: boolean;
  21442. /**
  21443. * Create a new TextureBlock
  21444. * @param name defines the block name
  21445. */
  21446. constructor(name: string, fragmentOnly?: boolean);
  21447. /**
  21448. * Gets the current class name
  21449. * @returns the class name
  21450. */
  21451. getClassName(): string;
  21452. /**
  21453. * Gets the uv input component
  21454. */
  21455. get uv(): NodeMaterialConnectionPoint;
  21456. /**
  21457. * Gets the rgba output component
  21458. */
  21459. get rgba(): NodeMaterialConnectionPoint;
  21460. /**
  21461. * Gets the rgb output component
  21462. */
  21463. get rgb(): NodeMaterialConnectionPoint;
  21464. /**
  21465. * Gets the r output component
  21466. */
  21467. get r(): NodeMaterialConnectionPoint;
  21468. /**
  21469. * Gets the g output component
  21470. */
  21471. get g(): NodeMaterialConnectionPoint;
  21472. /**
  21473. * Gets the b output component
  21474. */
  21475. get b(): NodeMaterialConnectionPoint;
  21476. /**
  21477. * Gets the a output component
  21478. */
  21479. get a(): NodeMaterialConnectionPoint;
  21480. get target(): NodeMaterialBlockTargets;
  21481. autoConfigure(material: NodeMaterial): void;
  21482. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21483. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21484. isReady(): boolean;
  21485. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21486. private get _isMixed();
  21487. private _injectVertexCode;
  21488. private _writeTextureRead;
  21489. private _writeOutput;
  21490. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21491. protected _dumpPropertiesCode(): string;
  21492. serialize(): any;
  21493. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21494. }
  21495. }
  21496. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21497. /** @hidden */
  21498. export var reflectionFunction: {
  21499. name: string;
  21500. shader: string;
  21501. };
  21502. }
  21503. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21504. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21505. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21506. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21507. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21508. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21509. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21510. import { Effect } from "babylonjs/Materials/effect";
  21511. import { Mesh } from "babylonjs/Meshes/mesh";
  21512. import { Nullable } from "babylonjs/types";
  21513. import { Scene } from "babylonjs/scene";
  21514. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21515. /**
  21516. * Base block used to read a reflection texture from a sampler
  21517. */
  21518. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21519. /** @hidden */
  21520. _define3DName: string;
  21521. /** @hidden */
  21522. _defineCubicName: string;
  21523. /** @hidden */
  21524. _defineExplicitName: string;
  21525. /** @hidden */
  21526. _defineProjectionName: string;
  21527. /** @hidden */
  21528. _defineLocalCubicName: string;
  21529. /** @hidden */
  21530. _defineSphericalName: string;
  21531. /** @hidden */
  21532. _definePlanarName: string;
  21533. /** @hidden */
  21534. _defineEquirectangularName: string;
  21535. /** @hidden */
  21536. _defineMirroredEquirectangularFixedName: string;
  21537. /** @hidden */
  21538. _defineEquirectangularFixedName: string;
  21539. /** @hidden */
  21540. _defineSkyboxName: string;
  21541. /** @hidden */
  21542. _defineOppositeZ: string;
  21543. /** @hidden */
  21544. _cubeSamplerName: string;
  21545. /** @hidden */
  21546. _2DSamplerName: string;
  21547. protected _positionUVWName: string;
  21548. protected _directionWName: string;
  21549. protected _reflectionVectorName: string;
  21550. /** @hidden */
  21551. _reflectionCoordsName: string;
  21552. /** @hidden */
  21553. _reflectionMatrixName: string;
  21554. protected _reflectionColorName: string;
  21555. /**
  21556. * Gets or sets the texture associated with the node
  21557. */
  21558. texture: Nullable<BaseTexture>;
  21559. /**
  21560. * Create a new ReflectionTextureBaseBlock
  21561. * @param name defines the block name
  21562. */
  21563. constructor(name: string);
  21564. /**
  21565. * Gets the current class name
  21566. * @returns the class name
  21567. */
  21568. getClassName(): string;
  21569. /**
  21570. * Gets the world position input component
  21571. */
  21572. abstract get position(): NodeMaterialConnectionPoint;
  21573. /**
  21574. * Gets the world position input component
  21575. */
  21576. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21577. /**
  21578. * Gets the world normal input component
  21579. */
  21580. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21581. /**
  21582. * Gets the world input component
  21583. */
  21584. abstract get world(): NodeMaterialConnectionPoint;
  21585. /**
  21586. * Gets the camera (or eye) position component
  21587. */
  21588. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21589. /**
  21590. * Gets the view input component
  21591. */
  21592. abstract get view(): NodeMaterialConnectionPoint;
  21593. protected _getTexture(): Nullable<BaseTexture>;
  21594. autoConfigure(material: NodeMaterial): void;
  21595. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21596. isReady(): boolean;
  21597. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21598. /**
  21599. * Gets the code to inject in the vertex shader
  21600. * @param state current state of the node material building
  21601. * @returns the shader code
  21602. */
  21603. handleVertexSide(state: NodeMaterialBuildState): string;
  21604. /**
  21605. * Handles the inits for the fragment code path
  21606. * @param state node material build state
  21607. */
  21608. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21609. /**
  21610. * Generates the reflection coords code for the fragment code path
  21611. * @param worldNormalVarName name of the world normal variable
  21612. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21613. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21614. * @returns the shader code
  21615. */
  21616. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21617. /**
  21618. * Generates the reflection color code for the fragment code path
  21619. * @param lodVarName name of the lod variable
  21620. * @param swizzleLookupTexture swizzle to use for the final color variable
  21621. * @returns the shader code
  21622. */
  21623. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21624. /**
  21625. * Generates the code corresponding to the connected output points
  21626. * @param state node material build state
  21627. * @param varName name of the variable to output
  21628. * @returns the shader code
  21629. */
  21630. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21631. protected _buildBlock(state: NodeMaterialBuildState): this;
  21632. protected _dumpPropertiesCode(): string;
  21633. serialize(): any;
  21634. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21635. }
  21636. }
  21637. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21638. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21639. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21640. import { Nullable } from "babylonjs/types";
  21641. /**
  21642. * Defines a connection point to be used for points with a custom object type
  21643. */
  21644. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21645. private _blockType;
  21646. private _blockName;
  21647. private _nameForCheking?;
  21648. /**
  21649. * Creates a new connection point
  21650. * @param name defines the connection point name
  21651. * @param ownerBlock defines the block hosting this connection point
  21652. * @param direction defines the direction of the connection point
  21653. */
  21654. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21655. /**
  21656. * Gets a number indicating if the current point can be connected to another point
  21657. * @param connectionPoint defines the other connection point
  21658. * @returns a number defining the compatibility state
  21659. */
  21660. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21661. /**
  21662. * Creates a block suitable to be used as an input for this input point.
  21663. * If null is returned, a block based on the point type will be created.
  21664. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21665. */
  21666. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21667. }
  21668. }
  21669. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21670. /**
  21671. * Enum defining the type of properties that can be edited in the property pages in the NME
  21672. */
  21673. export enum PropertyTypeForEdition {
  21674. /** property is a boolean */
  21675. Boolean = 0,
  21676. /** property is a float */
  21677. Float = 1,
  21678. /** property is a Vector2 */
  21679. Vector2 = 2,
  21680. /** property is a list of values */
  21681. List = 3
  21682. }
  21683. /**
  21684. * Interface that defines an option in a variable of type list
  21685. */
  21686. export interface IEditablePropertyListOption {
  21687. /** label of the option */
  21688. "label": string;
  21689. /** value of the option */
  21690. "value": number;
  21691. }
  21692. /**
  21693. * Interface that defines the options available for an editable property
  21694. */
  21695. export interface IEditablePropertyOption {
  21696. /** min value */
  21697. "min"?: number;
  21698. /** max value */
  21699. "max"?: number;
  21700. /** notifiers: indicates which actions to take when the property is changed */
  21701. "notifiers"?: {
  21702. /** the material should be rebuilt */
  21703. "rebuild"?: boolean;
  21704. /** the preview should be updated */
  21705. "update"?: boolean;
  21706. };
  21707. /** list of the options for a variable of type list */
  21708. "options"?: IEditablePropertyListOption[];
  21709. }
  21710. /**
  21711. * Interface that describes an editable property
  21712. */
  21713. export interface IPropertyDescriptionForEdition {
  21714. /** name of the property */
  21715. "propertyName": string;
  21716. /** display name of the property */
  21717. "displayName": string;
  21718. /** type of the property */
  21719. "type": PropertyTypeForEdition;
  21720. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21721. "groupName": string;
  21722. /** options for the property */
  21723. "options": IEditablePropertyOption;
  21724. }
  21725. /**
  21726. * Decorator that flags a property in a node material block as being editable
  21727. */
  21728. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21729. }
  21730. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21731. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21732. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21733. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21734. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21735. import { Nullable } from "babylonjs/types";
  21736. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21737. import { Mesh } from "babylonjs/Meshes/mesh";
  21738. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21739. import { Effect } from "babylonjs/Materials/effect";
  21740. import { Scene } from "babylonjs/scene";
  21741. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21742. /**
  21743. * Block used to implement the refraction part of the sub surface module of the PBR material
  21744. */
  21745. export class RefractionBlock extends NodeMaterialBlock {
  21746. /** @hidden */
  21747. _define3DName: string;
  21748. /** @hidden */
  21749. _refractionMatrixName: string;
  21750. /** @hidden */
  21751. _defineLODRefractionAlpha: string;
  21752. /** @hidden */
  21753. _defineLinearSpecularRefraction: string;
  21754. /** @hidden */
  21755. _defineOppositeZ: string;
  21756. /** @hidden */
  21757. _cubeSamplerName: string;
  21758. /** @hidden */
  21759. _2DSamplerName: string;
  21760. /** @hidden */
  21761. _vRefractionMicrosurfaceInfosName: string;
  21762. /** @hidden */
  21763. _vRefractionInfosName: string;
  21764. private _scene;
  21765. /**
  21766. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21767. * Materials half opaque for instance using refraction could benefit from this control.
  21768. */
  21769. linkRefractionWithTransparency: boolean;
  21770. /**
  21771. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21772. */
  21773. invertRefractionY: boolean;
  21774. /**
  21775. * Gets or sets the texture associated with the node
  21776. */
  21777. texture: Nullable<BaseTexture>;
  21778. /**
  21779. * Create a new RefractionBlock
  21780. * @param name defines the block name
  21781. */
  21782. constructor(name: string);
  21783. /**
  21784. * Gets the current class name
  21785. * @returns the class name
  21786. */
  21787. getClassName(): string;
  21788. /**
  21789. * Gets the intensity input component
  21790. */
  21791. get intensity(): NodeMaterialConnectionPoint;
  21792. /**
  21793. * Gets the index of refraction input component
  21794. */
  21795. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21796. /**
  21797. * Gets the tint at distance input component
  21798. */
  21799. get tintAtDistance(): NodeMaterialConnectionPoint;
  21800. /**
  21801. * Gets the view input component
  21802. */
  21803. get view(): NodeMaterialConnectionPoint;
  21804. /**
  21805. * Gets the refraction object output component
  21806. */
  21807. get refraction(): NodeMaterialConnectionPoint;
  21808. /**
  21809. * Returns true if the block has a texture
  21810. */
  21811. get hasTexture(): boolean;
  21812. protected _getTexture(): Nullable<BaseTexture>;
  21813. autoConfigure(material: NodeMaterial): void;
  21814. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21815. isReady(): boolean;
  21816. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21817. /**
  21818. * Gets the main code of the block (fragment side)
  21819. * @param state current state of the node material building
  21820. * @returns the shader code
  21821. */
  21822. getCode(state: NodeMaterialBuildState): string;
  21823. protected _buildBlock(state: NodeMaterialBuildState): this;
  21824. protected _dumpPropertiesCode(): string;
  21825. serialize(): any;
  21826. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21827. }
  21828. }
  21829. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21830. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21831. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21832. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21833. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21834. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21835. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21836. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21837. import { Nullable } from "babylonjs/types";
  21838. import { Scene } from "babylonjs/scene";
  21839. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21840. /**
  21841. * Base block used as input for post process
  21842. */
  21843. export class CurrentScreenBlock extends NodeMaterialBlock {
  21844. private _samplerName;
  21845. private _linearDefineName;
  21846. private _gammaDefineName;
  21847. private _mainUVName;
  21848. private _tempTextureRead;
  21849. /**
  21850. * Gets or sets the texture associated with the node
  21851. */
  21852. texture: Nullable<BaseTexture>;
  21853. /**
  21854. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21855. */
  21856. convertToGammaSpace: boolean;
  21857. /**
  21858. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21859. */
  21860. convertToLinearSpace: boolean;
  21861. /**
  21862. * Create a new CurrentScreenBlock
  21863. * @param name defines the block name
  21864. */
  21865. constructor(name: string);
  21866. /**
  21867. * Gets the current class name
  21868. * @returns the class name
  21869. */
  21870. getClassName(): string;
  21871. /**
  21872. * Gets the uv input component
  21873. */
  21874. get uv(): NodeMaterialConnectionPoint;
  21875. /**
  21876. * Gets the rgba output component
  21877. */
  21878. get rgba(): NodeMaterialConnectionPoint;
  21879. /**
  21880. * Gets the rgb output component
  21881. */
  21882. get rgb(): NodeMaterialConnectionPoint;
  21883. /**
  21884. * Gets the r output component
  21885. */
  21886. get r(): NodeMaterialConnectionPoint;
  21887. /**
  21888. * Gets the g output component
  21889. */
  21890. get g(): NodeMaterialConnectionPoint;
  21891. /**
  21892. * Gets the b output component
  21893. */
  21894. get b(): NodeMaterialConnectionPoint;
  21895. /**
  21896. * Gets the a output component
  21897. */
  21898. get a(): NodeMaterialConnectionPoint;
  21899. /**
  21900. * Initialize the block and prepare the context for build
  21901. * @param state defines the state that will be used for the build
  21902. */
  21903. initialize(state: NodeMaterialBuildState): void;
  21904. get target(): NodeMaterialBlockTargets;
  21905. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21906. isReady(): boolean;
  21907. private _injectVertexCode;
  21908. private _writeTextureRead;
  21909. private _writeOutput;
  21910. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21911. serialize(): any;
  21912. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21913. }
  21914. }
  21915. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21916. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21917. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21918. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21919. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21920. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21921. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21922. import { Nullable } from "babylonjs/types";
  21923. import { Scene } from "babylonjs/scene";
  21924. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21925. /**
  21926. * Base block used for the particle texture
  21927. */
  21928. export class ParticleTextureBlock extends NodeMaterialBlock {
  21929. private _samplerName;
  21930. private _linearDefineName;
  21931. private _gammaDefineName;
  21932. private _tempTextureRead;
  21933. /**
  21934. * Gets or sets the texture associated with the node
  21935. */
  21936. texture: Nullable<BaseTexture>;
  21937. /**
  21938. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21939. */
  21940. convertToGammaSpace: boolean;
  21941. /**
  21942. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21943. */
  21944. convertToLinearSpace: boolean;
  21945. /**
  21946. * Create a new ParticleTextureBlock
  21947. * @param name defines the block name
  21948. */
  21949. constructor(name: string);
  21950. /**
  21951. * Gets the current class name
  21952. * @returns the class name
  21953. */
  21954. getClassName(): string;
  21955. /**
  21956. * Gets the uv input component
  21957. */
  21958. get uv(): NodeMaterialConnectionPoint;
  21959. /**
  21960. * Gets the rgba output component
  21961. */
  21962. get rgba(): NodeMaterialConnectionPoint;
  21963. /**
  21964. * Gets the rgb output component
  21965. */
  21966. get rgb(): NodeMaterialConnectionPoint;
  21967. /**
  21968. * Gets the r output component
  21969. */
  21970. get r(): NodeMaterialConnectionPoint;
  21971. /**
  21972. * Gets the g output component
  21973. */
  21974. get g(): NodeMaterialConnectionPoint;
  21975. /**
  21976. * Gets the b output component
  21977. */
  21978. get b(): NodeMaterialConnectionPoint;
  21979. /**
  21980. * Gets the a output component
  21981. */
  21982. get a(): NodeMaterialConnectionPoint;
  21983. /**
  21984. * Initialize the block and prepare the context for build
  21985. * @param state defines the state that will be used for the build
  21986. */
  21987. initialize(state: NodeMaterialBuildState): void;
  21988. autoConfigure(material: NodeMaterial): void;
  21989. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21990. isReady(): boolean;
  21991. private _writeOutput;
  21992. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21993. serialize(): any;
  21994. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21995. }
  21996. }
  21997. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  21998. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21999. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22000. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22001. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22002. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22003. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22004. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22005. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22006. import { Scene } from "babylonjs/scene";
  22007. /**
  22008. * Class used to store shared data between 2 NodeMaterialBuildState
  22009. */
  22010. export class NodeMaterialBuildStateSharedData {
  22011. /**
  22012. * Gets the list of emitted varyings
  22013. */
  22014. temps: string[];
  22015. /**
  22016. * Gets the list of emitted varyings
  22017. */
  22018. varyings: string[];
  22019. /**
  22020. * Gets the varying declaration string
  22021. */
  22022. varyingDeclaration: string;
  22023. /**
  22024. * Input blocks
  22025. */
  22026. inputBlocks: InputBlock[];
  22027. /**
  22028. * Input blocks
  22029. */
  22030. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22031. /**
  22032. * Bindable blocks (Blocks that need to set data to the effect)
  22033. */
  22034. bindableBlocks: NodeMaterialBlock[];
  22035. /**
  22036. * List of blocks that can provide a compilation fallback
  22037. */
  22038. blocksWithFallbacks: NodeMaterialBlock[];
  22039. /**
  22040. * List of blocks that can provide a define update
  22041. */
  22042. blocksWithDefines: NodeMaterialBlock[];
  22043. /**
  22044. * List of blocks that can provide a repeatable content
  22045. */
  22046. repeatableContentBlocks: NodeMaterialBlock[];
  22047. /**
  22048. * List of blocks that can provide a dynamic list of uniforms
  22049. */
  22050. dynamicUniformBlocks: NodeMaterialBlock[];
  22051. /**
  22052. * List of blocks that can block the isReady function for the material
  22053. */
  22054. blockingBlocks: NodeMaterialBlock[];
  22055. /**
  22056. * Gets the list of animated inputs
  22057. */
  22058. animatedInputs: InputBlock[];
  22059. /**
  22060. * Build Id used to avoid multiple recompilations
  22061. */
  22062. buildId: number;
  22063. /** List of emitted variables */
  22064. variableNames: {
  22065. [key: string]: number;
  22066. };
  22067. /** List of emitted defines */
  22068. defineNames: {
  22069. [key: string]: number;
  22070. };
  22071. /** Should emit comments? */
  22072. emitComments: boolean;
  22073. /** Emit build activity */
  22074. verbose: boolean;
  22075. /** Gets or sets the hosting scene */
  22076. scene: Scene;
  22077. /**
  22078. * Gets the compilation hints emitted at compilation time
  22079. */
  22080. hints: {
  22081. needWorldViewMatrix: boolean;
  22082. needWorldViewProjectionMatrix: boolean;
  22083. needAlphaBlending: boolean;
  22084. needAlphaTesting: boolean;
  22085. };
  22086. /**
  22087. * List of compilation checks
  22088. */
  22089. checks: {
  22090. emitVertex: boolean;
  22091. emitFragment: boolean;
  22092. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22093. };
  22094. /**
  22095. * Is vertex program allowed to be empty?
  22096. */
  22097. allowEmptyVertexProgram: boolean;
  22098. /** Creates a new shared data */
  22099. constructor();
  22100. /**
  22101. * Emits console errors and exceptions if there is a failing check
  22102. */
  22103. emitErrors(): void;
  22104. }
  22105. }
  22106. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22107. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22108. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22109. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22110. /**
  22111. * Class used to store node based material build state
  22112. */
  22113. export class NodeMaterialBuildState {
  22114. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22115. supportUniformBuffers: boolean;
  22116. /**
  22117. * Gets the list of emitted attributes
  22118. */
  22119. attributes: string[];
  22120. /**
  22121. * Gets the list of emitted uniforms
  22122. */
  22123. uniforms: string[];
  22124. /**
  22125. * Gets the list of emitted constants
  22126. */
  22127. constants: string[];
  22128. /**
  22129. * Gets the list of emitted samplers
  22130. */
  22131. samplers: string[];
  22132. /**
  22133. * Gets the list of emitted functions
  22134. */
  22135. functions: {
  22136. [key: string]: string;
  22137. };
  22138. /**
  22139. * Gets the list of emitted extensions
  22140. */
  22141. extensions: {
  22142. [key: string]: string;
  22143. };
  22144. /**
  22145. * Gets the target of the compilation state
  22146. */
  22147. target: NodeMaterialBlockTargets;
  22148. /**
  22149. * Gets the list of emitted counters
  22150. */
  22151. counters: {
  22152. [key: string]: number;
  22153. };
  22154. /**
  22155. * Shared data between multiple NodeMaterialBuildState instances
  22156. */
  22157. sharedData: NodeMaterialBuildStateSharedData;
  22158. /** @hidden */
  22159. _vertexState: NodeMaterialBuildState;
  22160. /** @hidden */
  22161. _attributeDeclaration: string;
  22162. /** @hidden */
  22163. _uniformDeclaration: string;
  22164. /** @hidden */
  22165. _constantDeclaration: string;
  22166. /** @hidden */
  22167. _samplerDeclaration: string;
  22168. /** @hidden */
  22169. _varyingTransfer: string;
  22170. /** @hidden */
  22171. _injectAtEnd: string;
  22172. private _repeatableContentAnchorIndex;
  22173. /** @hidden */
  22174. _builtCompilationString: string;
  22175. /**
  22176. * Gets the emitted compilation strings
  22177. */
  22178. compilationString: string;
  22179. /**
  22180. * Finalize the compilation strings
  22181. * @param state defines the current compilation state
  22182. */
  22183. finalize(state: NodeMaterialBuildState): void;
  22184. /** @hidden */
  22185. get _repeatableContentAnchor(): string;
  22186. /** @hidden */
  22187. _getFreeVariableName(prefix: string): string;
  22188. /** @hidden */
  22189. _getFreeDefineName(prefix: string): string;
  22190. /** @hidden */
  22191. _excludeVariableName(name: string): void;
  22192. /** @hidden */
  22193. _emit2DSampler(name: string): void;
  22194. /** @hidden */
  22195. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22196. /** @hidden */
  22197. _emitExtension(name: string, extension: string, define?: string): void;
  22198. /** @hidden */
  22199. _emitFunction(name: string, code: string, comments: string): void;
  22200. /** @hidden */
  22201. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22202. replaceStrings?: {
  22203. search: RegExp;
  22204. replace: string;
  22205. }[];
  22206. repeatKey?: string;
  22207. }): string;
  22208. /** @hidden */
  22209. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22210. repeatKey?: string;
  22211. removeAttributes?: boolean;
  22212. removeUniforms?: boolean;
  22213. removeVaryings?: boolean;
  22214. removeIfDef?: boolean;
  22215. replaceStrings?: {
  22216. search: RegExp;
  22217. replace: string;
  22218. }[];
  22219. }, storeKey?: string): void;
  22220. /** @hidden */
  22221. _registerTempVariable(name: string): boolean;
  22222. /** @hidden */
  22223. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22224. /** @hidden */
  22225. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22226. /** @hidden */
  22227. _emitFloat(value: number): string;
  22228. }
  22229. }
  22230. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22231. /**
  22232. * Helper class used to generate session unique ID
  22233. */
  22234. export class UniqueIdGenerator {
  22235. private static _UniqueIdCounter;
  22236. /**
  22237. * Gets an unique (relatively to the current scene) Id
  22238. */
  22239. static get UniqueId(): number;
  22240. }
  22241. }
  22242. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22243. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22244. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22245. import { Nullable } from "babylonjs/types";
  22246. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22247. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22248. import { Effect } from "babylonjs/Materials/effect";
  22249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22250. import { Mesh } from "babylonjs/Meshes/mesh";
  22251. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22252. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22253. import { Scene } from "babylonjs/scene";
  22254. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22255. /**
  22256. * Defines a block that can be used inside a node based material
  22257. */
  22258. export class NodeMaterialBlock {
  22259. private _buildId;
  22260. private _buildTarget;
  22261. private _target;
  22262. private _isFinalMerger;
  22263. private _isInput;
  22264. private _name;
  22265. protected _isUnique: boolean;
  22266. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22267. inputsAreExclusive: boolean;
  22268. /** @hidden */
  22269. _codeVariableName: string;
  22270. /** @hidden */
  22271. _inputs: NodeMaterialConnectionPoint[];
  22272. /** @hidden */
  22273. _outputs: NodeMaterialConnectionPoint[];
  22274. /** @hidden */
  22275. _preparationId: number;
  22276. /**
  22277. * Gets the name of the block
  22278. */
  22279. get name(): string;
  22280. /**
  22281. * Sets the name of the block. Will check if the name is valid.
  22282. */
  22283. set name(newName: string);
  22284. /**
  22285. * Gets or sets the unique id of the node
  22286. */
  22287. uniqueId: number;
  22288. /**
  22289. * Gets or sets the comments associated with this block
  22290. */
  22291. comments: string;
  22292. /**
  22293. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22294. */
  22295. get isUnique(): boolean;
  22296. /**
  22297. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22298. */
  22299. get isFinalMerger(): boolean;
  22300. /**
  22301. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22302. */
  22303. get isInput(): boolean;
  22304. /**
  22305. * Gets or sets the build Id
  22306. */
  22307. get buildId(): number;
  22308. set buildId(value: number);
  22309. /**
  22310. * Gets or sets the target of the block
  22311. */
  22312. get target(): NodeMaterialBlockTargets;
  22313. set target(value: NodeMaterialBlockTargets);
  22314. /**
  22315. * Gets the list of input points
  22316. */
  22317. get inputs(): NodeMaterialConnectionPoint[];
  22318. /** Gets the list of output points */
  22319. get outputs(): NodeMaterialConnectionPoint[];
  22320. /**
  22321. * Find an input by its name
  22322. * @param name defines the name of the input to look for
  22323. * @returns the input or null if not found
  22324. */
  22325. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22326. /**
  22327. * Find an output by its name
  22328. * @param name defines the name of the outputto look for
  22329. * @returns the output or null if not found
  22330. */
  22331. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22332. /**
  22333. * Creates a new NodeMaterialBlock
  22334. * @param name defines the block name
  22335. * @param target defines the target of that block (Vertex by default)
  22336. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22337. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22338. */
  22339. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22340. /**
  22341. * Initialize the block and prepare the context for build
  22342. * @param state defines the state that will be used for the build
  22343. */
  22344. initialize(state: NodeMaterialBuildState): void;
  22345. /**
  22346. * Bind data to effect. Will only be called for blocks with isBindable === true
  22347. * @param effect defines the effect to bind data to
  22348. * @param nodeMaterial defines the hosting NodeMaterial
  22349. * @param mesh defines the mesh that will be rendered
  22350. * @param subMesh defines the submesh that will be rendered
  22351. */
  22352. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22353. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22354. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22355. protected _writeFloat(value: number): string;
  22356. /**
  22357. * Gets the current class name e.g. "NodeMaterialBlock"
  22358. * @returns the class name
  22359. */
  22360. getClassName(): string;
  22361. /**
  22362. * Register a new input. Must be called inside a block constructor
  22363. * @param name defines the connection point name
  22364. * @param type defines the connection point type
  22365. * @param isOptional defines a boolean indicating that this input can be omitted
  22366. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22367. * @param point an already created connection point. If not provided, create a new one
  22368. * @returns the current block
  22369. */
  22370. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22371. /**
  22372. * Register a new output. Must be called inside a block constructor
  22373. * @param name defines the connection point name
  22374. * @param type defines the connection point type
  22375. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22376. * @param point an already created connection point. If not provided, create a new one
  22377. * @returns the current block
  22378. */
  22379. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22380. /**
  22381. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22382. * @param forOutput defines an optional connection point to check compatibility with
  22383. * @returns the first available input or null
  22384. */
  22385. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22386. /**
  22387. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22388. * @param forBlock defines an optional block to check compatibility with
  22389. * @returns the first available input or null
  22390. */
  22391. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22392. /**
  22393. * Gets the sibling of the given output
  22394. * @param current defines the current output
  22395. * @returns the next output in the list or null
  22396. */
  22397. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22398. /**
  22399. * Connect current block with another block
  22400. * @param other defines the block to connect with
  22401. * @param options define the various options to help pick the right connections
  22402. * @returns the current block
  22403. */
  22404. connectTo(other: NodeMaterialBlock, options?: {
  22405. input?: string;
  22406. output?: string;
  22407. outputSwizzle?: string;
  22408. }): this | undefined;
  22409. protected _buildBlock(state: NodeMaterialBuildState): void;
  22410. /**
  22411. * Add uniforms, samplers and uniform buffers at compilation time
  22412. * @param state defines the state to update
  22413. * @param nodeMaterial defines the node material requesting the update
  22414. * @param defines defines the material defines to update
  22415. * @param uniformBuffers defines the list of uniform buffer names
  22416. */
  22417. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22418. /**
  22419. * Add potential fallbacks if shader compilation fails
  22420. * @param mesh defines the mesh to be rendered
  22421. * @param fallbacks defines the current prioritized list of fallbacks
  22422. */
  22423. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22424. /**
  22425. * Initialize defines for shader compilation
  22426. * @param mesh defines the mesh to be rendered
  22427. * @param nodeMaterial defines the node material requesting the update
  22428. * @param defines defines the material defines to update
  22429. * @param useInstances specifies that instances should be used
  22430. */
  22431. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22432. /**
  22433. * Update defines for shader compilation
  22434. * @param mesh defines the mesh to be rendered
  22435. * @param nodeMaterial defines the node material requesting the update
  22436. * @param defines defines the material defines to update
  22437. * @param useInstances specifies that instances should be used
  22438. * @param subMesh defines which submesh to render
  22439. */
  22440. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22441. /**
  22442. * Lets the block try to connect some inputs automatically
  22443. * @param material defines the hosting NodeMaterial
  22444. */
  22445. autoConfigure(material: NodeMaterial): void;
  22446. /**
  22447. * Function called when a block is declared as repeatable content generator
  22448. * @param vertexShaderState defines the current compilation state for the vertex shader
  22449. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22450. * @param mesh defines the mesh to be rendered
  22451. * @param defines defines the material defines to update
  22452. */
  22453. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22454. /**
  22455. * Checks if the block is ready
  22456. * @param mesh defines the mesh to be rendered
  22457. * @param nodeMaterial defines the node material requesting the update
  22458. * @param defines defines the material defines to update
  22459. * @param useInstances specifies that instances should be used
  22460. * @returns true if the block is ready
  22461. */
  22462. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22463. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22464. private _processBuild;
  22465. /**
  22466. * Validates the new name for the block node.
  22467. * @param newName the new name to be given to the node.
  22468. * @returns false if the name is a reserve word, else true.
  22469. */
  22470. validateBlockName(newName: string): boolean;
  22471. /**
  22472. * Compile the current node and generate the shader code
  22473. * @param state defines the current compilation state (uniforms, samplers, current string)
  22474. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22475. * @returns true if already built
  22476. */
  22477. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22478. protected _inputRename(name: string): string;
  22479. protected _outputRename(name: string): string;
  22480. protected _dumpPropertiesCode(): string;
  22481. /** @hidden */
  22482. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22483. /** @hidden */
  22484. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22485. /**
  22486. * Clone the current block to a new identical block
  22487. * @param scene defines the hosting scene
  22488. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22489. * @returns a copy of the current block
  22490. */
  22491. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22492. /**
  22493. * Serializes this block in a JSON representation
  22494. * @returns the serialized block object
  22495. */
  22496. serialize(): any;
  22497. /** @hidden */
  22498. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22499. private _deserializePortDisplayNamesAndExposedOnFrame;
  22500. /**
  22501. * Release resources
  22502. */
  22503. dispose(): void;
  22504. }
  22505. }
  22506. declare module "babylonjs/Materials/pushMaterial" {
  22507. import { Nullable } from "babylonjs/types";
  22508. import { Scene } from "babylonjs/scene";
  22509. import { Matrix } from "babylonjs/Maths/math.vector";
  22510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22511. import { Mesh } from "babylonjs/Meshes/mesh";
  22512. import { Material } from "babylonjs/Materials/material";
  22513. import { Effect } from "babylonjs/Materials/effect";
  22514. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22515. /**
  22516. * Base class of materials working in push mode in babylon JS
  22517. * @hidden
  22518. */
  22519. export class PushMaterial extends Material {
  22520. protected _activeEffect: Effect;
  22521. protected _normalMatrix: Matrix;
  22522. constructor(name: string, scene: Scene);
  22523. getEffect(): Effect;
  22524. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22525. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22526. /**
  22527. * Binds the given world matrix to the active effect
  22528. *
  22529. * @param world the matrix to bind
  22530. */
  22531. bindOnlyWorldMatrix(world: Matrix): void;
  22532. /**
  22533. * Binds the given normal matrix to the active effect
  22534. *
  22535. * @param normalMatrix the matrix to bind
  22536. */
  22537. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22538. bind(world: Matrix, mesh?: Mesh): void;
  22539. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22540. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22541. }
  22542. }
  22543. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22544. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22545. /**
  22546. * Root class for all node material optimizers
  22547. */
  22548. export class NodeMaterialOptimizer {
  22549. /**
  22550. * Function used to optimize a NodeMaterial graph
  22551. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22552. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22553. */
  22554. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22555. }
  22556. }
  22557. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22558. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22559. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22560. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22561. import { Scene } from "babylonjs/scene";
  22562. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22563. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22564. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22565. /**
  22566. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22567. */
  22568. export class TransformBlock extends NodeMaterialBlock {
  22569. /**
  22570. * Defines the value to use to complement W value to transform it to a Vector4
  22571. */
  22572. complementW: number;
  22573. /**
  22574. * Defines the value to use to complement z value to transform it to a Vector4
  22575. */
  22576. complementZ: number;
  22577. /**
  22578. * Creates a new TransformBlock
  22579. * @param name defines the block name
  22580. */
  22581. constructor(name: string);
  22582. /**
  22583. * Gets the current class name
  22584. * @returns the class name
  22585. */
  22586. getClassName(): string;
  22587. /**
  22588. * Gets the vector input
  22589. */
  22590. get vector(): NodeMaterialConnectionPoint;
  22591. /**
  22592. * Gets the output component
  22593. */
  22594. get output(): NodeMaterialConnectionPoint;
  22595. /**
  22596. * Gets the xyz output component
  22597. */
  22598. get xyz(): NodeMaterialConnectionPoint;
  22599. /**
  22600. * Gets the matrix transform input
  22601. */
  22602. get transform(): NodeMaterialConnectionPoint;
  22603. protected _buildBlock(state: NodeMaterialBuildState): this;
  22604. /**
  22605. * Update defines for shader compilation
  22606. * @param mesh defines the mesh to be rendered
  22607. * @param nodeMaterial defines the node material requesting the update
  22608. * @param defines defines the material defines to update
  22609. * @param useInstances specifies that instances should be used
  22610. * @param subMesh defines which submesh to render
  22611. */
  22612. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22613. serialize(): any;
  22614. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22615. protected _dumpPropertiesCode(): string;
  22616. }
  22617. }
  22618. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22619. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22620. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22621. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22622. /**
  22623. * Block used to output the vertex position
  22624. */
  22625. export class VertexOutputBlock extends NodeMaterialBlock {
  22626. /**
  22627. * Creates a new VertexOutputBlock
  22628. * @param name defines the block name
  22629. */
  22630. constructor(name: string);
  22631. /**
  22632. * Gets the current class name
  22633. * @returns the class name
  22634. */
  22635. getClassName(): string;
  22636. /**
  22637. * Gets the vector input component
  22638. */
  22639. get vector(): NodeMaterialConnectionPoint;
  22640. protected _buildBlock(state: NodeMaterialBuildState): this;
  22641. }
  22642. }
  22643. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22644. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22645. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22646. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22647. /**
  22648. * Block used to output the final color
  22649. */
  22650. export class FragmentOutputBlock extends NodeMaterialBlock {
  22651. /**
  22652. * Create a new FragmentOutputBlock
  22653. * @param name defines the block name
  22654. */
  22655. constructor(name: string);
  22656. /**
  22657. * Gets the current class name
  22658. * @returns the class name
  22659. */
  22660. getClassName(): string;
  22661. /**
  22662. * Gets the rgba input component
  22663. */
  22664. get rgba(): NodeMaterialConnectionPoint;
  22665. /**
  22666. * Gets the rgb input component
  22667. */
  22668. get rgb(): NodeMaterialConnectionPoint;
  22669. /**
  22670. * Gets the a input component
  22671. */
  22672. get a(): NodeMaterialConnectionPoint;
  22673. protected _buildBlock(state: NodeMaterialBuildState): this;
  22674. }
  22675. }
  22676. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22677. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22678. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22679. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22680. /**
  22681. * Block used for the particle ramp gradient section
  22682. */
  22683. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22684. /**
  22685. * Create a new ParticleRampGradientBlock
  22686. * @param name defines the block name
  22687. */
  22688. constructor(name: string);
  22689. /**
  22690. * Gets the current class name
  22691. * @returns the class name
  22692. */
  22693. getClassName(): string;
  22694. /**
  22695. * Gets the color input component
  22696. */
  22697. get color(): NodeMaterialConnectionPoint;
  22698. /**
  22699. * Gets the rampColor output component
  22700. */
  22701. get rampColor(): NodeMaterialConnectionPoint;
  22702. /**
  22703. * Initialize the block and prepare the context for build
  22704. * @param state defines the state that will be used for the build
  22705. */
  22706. initialize(state: NodeMaterialBuildState): void;
  22707. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22708. }
  22709. }
  22710. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22711. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22712. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22713. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22714. /**
  22715. * Block used for the particle blend multiply section
  22716. */
  22717. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22718. /**
  22719. * Create a new ParticleBlendMultiplyBlock
  22720. * @param name defines the block name
  22721. */
  22722. constructor(name: string);
  22723. /**
  22724. * Gets the current class name
  22725. * @returns the class name
  22726. */
  22727. getClassName(): string;
  22728. /**
  22729. * Gets the color input component
  22730. */
  22731. get color(): NodeMaterialConnectionPoint;
  22732. /**
  22733. * Gets the alphaTexture input component
  22734. */
  22735. get alphaTexture(): NodeMaterialConnectionPoint;
  22736. /**
  22737. * Gets the alphaColor input component
  22738. */
  22739. get alphaColor(): NodeMaterialConnectionPoint;
  22740. /**
  22741. * Gets the blendColor output component
  22742. */
  22743. get blendColor(): NodeMaterialConnectionPoint;
  22744. /**
  22745. * Initialize the block and prepare the context for build
  22746. * @param state defines the state that will be used for the build
  22747. */
  22748. initialize(state: NodeMaterialBuildState): void;
  22749. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22750. }
  22751. }
  22752. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22753. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22754. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22755. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22756. /**
  22757. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22758. */
  22759. export class VectorMergerBlock extends NodeMaterialBlock {
  22760. /**
  22761. * Create a new VectorMergerBlock
  22762. * @param name defines the block name
  22763. */
  22764. constructor(name: string);
  22765. /**
  22766. * Gets the current class name
  22767. * @returns the class name
  22768. */
  22769. getClassName(): string;
  22770. /**
  22771. * Gets the xyz component (input)
  22772. */
  22773. get xyzIn(): NodeMaterialConnectionPoint;
  22774. /**
  22775. * Gets the xy component (input)
  22776. */
  22777. get xyIn(): NodeMaterialConnectionPoint;
  22778. /**
  22779. * Gets the x component (input)
  22780. */
  22781. get x(): NodeMaterialConnectionPoint;
  22782. /**
  22783. * Gets the y component (input)
  22784. */
  22785. get y(): NodeMaterialConnectionPoint;
  22786. /**
  22787. * Gets the z component (input)
  22788. */
  22789. get z(): NodeMaterialConnectionPoint;
  22790. /**
  22791. * Gets the w component (input)
  22792. */
  22793. get w(): NodeMaterialConnectionPoint;
  22794. /**
  22795. * Gets the xyzw component (output)
  22796. */
  22797. get xyzw(): NodeMaterialConnectionPoint;
  22798. /**
  22799. * Gets the xyz component (output)
  22800. */
  22801. get xyzOut(): NodeMaterialConnectionPoint;
  22802. /**
  22803. * Gets the xy component (output)
  22804. */
  22805. get xyOut(): NodeMaterialConnectionPoint;
  22806. /**
  22807. * Gets the xy component (output)
  22808. * @deprecated Please use xyOut instead.
  22809. */
  22810. get xy(): NodeMaterialConnectionPoint;
  22811. /**
  22812. * Gets the xyz component (output)
  22813. * @deprecated Please use xyzOut instead.
  22814. */
  22815. get xyz(): NodeMaterialConnectionPoint;
  22816. protected _buildBlock(state: NodeMaterialBuildState): this;
  22817. }
  22818. }
  22819. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22820. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22821. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22822. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22823. import { Vector2 } from "babylonjs/Maths/math.vector";
  22824. import { Scene } from "babylonjs/scene";
  22825. /**
  22826. * Block used to remap a float from a range to a new one
  22827. */
  22828. export class RemapBlock extends NodeMaterialBlock {
  22829. /**
  22830. * Gets or sets the source range
  22831. */
  22832. sourceRange: Vector2;
  22833. /**
  22834. * Gets or sets the target range
  22835. */
  22836. targetRange: Vector2;
  22837. /**
  22838. * Creates a new RemapBlock
  22839. * @param name defines the block name
  22840. */
  22841. constructor(name: string);
  22842. /**
  22843. * Gets the current class name
  22844. * @returns the class name
  22845. */
  22846. getClassName(): string;
  22847. /**
  22848. * Gets the input component
  22849. */
  22850. get input(): NodeMaterialConnectionPoint;
  22851. /**
  22852. * Gets the source min input component
  22853. */
  22854. get sourceMin(): NodeMaterialConnectionPoint;
  22855. /**
  22856. * Gets the source max input component
  22857. */
  22858. get sourceMax(): NodeMaterialConnectionPoint;
  22859. /**
  22860. * Gets the target min input component
  22861. */
  22862. get targetMin(): NodeMaterialConnectionPoint;
  22863. /**
  22864. * Gets the target max input component
  22865. */
  22866. get targetMax(): NodeMaterialConnectionPoint;
  22867. /**
  22868. * Gets the output component
  22869. */
  22870. get output(): NodeMaterialConnectionPoint;
  22871. protected _buildBlock(state: NodeMaterialBuildState): this;
  22872. protected _dumpPropertiesCode(): string;
  22873. serialize(): any;
  22874. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22875. }
  22876. }
  22877. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22878. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22879. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22880. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22881. /**
  22882. * Block used to multiply 2 values
  22883. */
  22884. export class MultiplyBlock extends NodeMaterialBlock {
  22885. /**
  22886. * Creates a new MultiplyBlock
  22887. * @param name defines the block name
  22888. */
  22889. constructor(name: string);
  22890. /**
  22891. * Gets the current class name
  22892. * @returns the class name
  22893. */
  22894. getClassName(): string;
  22895. /**
  22896. * Gets the left operand input component
  22897. */
  22898. get left(): NodeMaterialConnectionPoint;
  22899. /**
  22900. * Gets the right operand input component
  22901. */
  22902. get right(): NodeMaterialConnectionPoint;
  22903. /**
  22904. * Gets the output component
  22905. */
  22906. get output(): NodeMaterialConnectionPoint;
  22907. protected _buildBlock(state: NodeMaterialBuildState): this;
  22908. }
  22909. }
  22910. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22911. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22912. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22913. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22914. /**
  22915. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22916. */
  22917. export class ColorSplitterBlock extends NodeMaterialBlock {
  22918. /**
  22919. * Create a new ColorSplitterBlock
  22920. * @param name defines the block name
  22921. */
  22922. constructor(name: string);
  22923. /**
  22924. * Gets the current class name
  22925. * @returns the class name
  22926. */
  22927. getClassName(): string;
  22928. /**
  22929. * Gets the rgba component (input)
  22930. */
  22931. get rgba(): NodeMaterialConnectionPoint;
  22932. /**
  22933. * Gets the rgb component (input)
  22934. */
  22935. get rgbIn(): NodeMaterialConnectionPoint;
  22936. /**
  22937. * Gets the rgb component (output)
  22938. */
  22939. get rgbOut(): NodeMaterialConnectionPoint;
  22940. /**
  22941. * Gets the r component (output)
  22942. */
  22943. get r(): NodeMaterialConnectionPoint;
  22944. /**
  22945. * Gets the g component (output)
  22946. */
  22947. get g(): NodeMaterialConnectionPoint;
  22948. /**
  22949. * Gets the b component (output)
  22950. */
  22951. get b(): NodeMaterialConnectionPoint;
  22952. /**
  22953. * Gets the a component (output)
  22954. */
  22955. get a(): NodeMaterialConnectionPoint;
  22956. protected _inputRename(name: string): string;
  22957. protected _outputRename(name: string): string;
  22958. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22959. }
  22960. }
  22961. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22962. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22963. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22964. import { Scene } from "babylonjs/scene";
  22965. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22966. import { Matrix } from "babylonjs/Maths/math.vector";
  22967. import { Mesh } from "babylonjs/Meshes/mesh";
  22968. import { Engine } from "babylonjs/Engines/engine";
  22969. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22970. import { Observable } from "babylonjs/Misc/observable";
  22971. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22972. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22973. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22974. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22975. import { Nullable } from "babylonjs/types";
  22976. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22977. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22978. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22979. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22980. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22981. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22982. import { Effect } from "babylonjs/Materials/effect";
  22983. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22984. import { Camera } from "babylonjs/Cameras/camera";
  22985. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22986. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22987. /**
  22988. * Interface used to configure the node material editor
  22989. */
  22990. export interface INodeMaterialEditorOptions {
  22991. /** Define the URl to load node editor script */
  22992. editorURL?: string;
  22993. }
  22994. /** @hidden */
  22995. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22996. NORMAL: boolean;
  22997. TANGENT: boolean;
  22998. UV1: boolean;
  22999. /** BONES */
  23000. NUM_BONE_INFLUENCERS: number;
  23001. BonesPerMesh: number;
  23002. BONETEXTURE: boolean;
  23003. /** MORPH TARGETS */
  23004. MORPHTARGETS: boolean;
  23005. MORPHTARGETS_NORMAL: boolean;
  23006. MORPHTARGETS_TANGENT: boolean;
  23007. MORPHTARGETS_UV: boolean;
  23008. NUM_MORPH_INFLUENCERS: number;
  23009. /** IMAGE PROCESSING */
  23010. IMAGEPROCESSING: boolean;
  23011. VIGNETTE: boolean;
  23012. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23013. VIGNETTEBLENDMODEOPAQUE: boolean;
  23014. TONEMAPPING: boolean;
  23015. TONEMAPPING_ACES: boolean;
  23016. CONTRAST: boolean;
  23017. EXPOSURE: boolean;
  23018. COLORCURVES: boolean;
  23019. COLORGRADING: boolean;
  23020. COLORGRADING3D: boolean;
  23021. SAMPLER3DGREENDEPTH: boolean;
  23022. SAMPLER3DBGRMAP: boolean;
  23023. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23024. /** MISC. */
  23025. BUMPDIRECTUV: number;
  23026. constructor();
  23027. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23028. }
  23029. /**
  23030. * Class used to configure NodeMaterial
  23031. */
  23032. export interface INodeMaterialOptions {
  23033. /**
  23034. * Defines if blocks should emit comments
  23035. */
  23036. emitComments: boolean;
  23037. }
  23038. /**
  23039. * Class used to create a node based material built by assembling shader blocks
  23040. */
  23041. export class NodeMaterial extends PushMaterial {
  23042. private static _BuildIdGenerator;
  23043. private _options;
  23044. private _vertexCompilationState;
  23045. private _fragmentCompilationState;
  23046. private _sharedData;
  23047. private _buildId;
  23048. private _buildWasSuccessful;
  23049. private _cachedWorldViewMatrix;
  23050. private _cachedWorldViewProjectionMatrix;
  23051. private _optimizers;
  23052. private _animationFrame;
  23053. /** Define the Url to load node editor script */
  23054. static EditorURL: string;
  23055. /** Define the Url to load snippets */
  23056. static SnippetUrl: string;
  23057. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23058. static IgnoreTexturesAtLoadTime: boolean;
  23059. private BJSNODEMATERIALEDITOR;
  23060. /** Get the inspector from bundle or global */
  23061. private _getGlobalNodeMaterialEditor;
  23062. /**
  23063. * Snippet ID if the material was created from the snippet server
  23064. */
  23065. snippetId: string;
  23066. /**
  23067. * Gets or sets data used by visual editor
  23068. * @see https://nme.babylonjs.com
  23069. */
  23070. editorData: any;
  23071. /**
  23072. * Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)
  23073. */
  23074. ignoreAlpha: boolean;
  23075. /**
  23076. * Defines the maximum number of lights that can be used in the material
  23077. */
  23078. maxSimultaneousLights: number;
  23079. /**
  23080. * Observable raised when the material is built
  23081. */
  23082. onBuildObservable: Observable<NodeMaterial>;
  23083. /**
  23084. * Gets or sets the root nodes of the material vertex shader
  23085. */
  23086. _vertexOutputNodes: NodeMaterialBlock[];
  23087. /**
  23088. * Gets or sets the root nodes of the material fragment (pixel) shader
  23089. */
  23090. _fragmentOutputNodes: NodeMaterialBlock[];
  23091. /** Gets or sets options to control the node material overall behavior */
  23092. get options(): INodeMaterialOptions;
  23093. set options(options: INodeMaterialOptions);
  23094. /**
  23095. * Default configuration related to image processing available in the standard Material.
  23096. */
  23097. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23098. /**
  23099. * Gets the image processing configuration used either in this material.
  23100. */
  23101. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23102. /**
  23103. * Sets the Default image processing configuration used either in the this material.
  23104. *
  23105. * If sets to null, the scene one is in use.
  23106. */
  23107. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23108. /**
  23109. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23110. */
  23111. attachedBlocks: NodeMaterialBlock[];
  23112. /**
  23113. * Specifies the mode of the node material
  23114. * @hidden
  23115. */
  23116. _mode: NodeMaterialModes;
  23117. /**
  23118. * Gets the mode property
  23119. */
  23120. get mode(): NodeMaterialModes;
  23121. /**
  23122. * Create a new node based material
  23123. * @param name defines the material name
  23124. * @param scene defines the hosting scene
  23125. * @param options defines creation option
  23126. */
  23127. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23128. /**
  23129. * Gets the current class name of the material e.g. "NodeMaterial"
  23130. * @returns the class name
  23131. */
  23132. getClassName(): string;
  23133. /**
  23134. * Keep track of the image processing observer to allow dispose and replace.
  23135. */
  23136. private _imageProcessingObserver;
  23137. /**
  23138. * Attaches a new image processing configuration to the Standard Material.
  23139. * @param configuration
  23140. */
  23141. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23142. /**
  23143. * Get a block by its name
  23144. * @param name defines the name of the block to retrieve
  23145. * @returns the required block or null if not found
  23146. */
  23147. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23148. /**
  23149. * Get a block by its name
  23150. * @param predicate defines the predicate used to find the good candidate
  23151. * @returns the required block or null if not found
  23152. */
  23153. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23154. /**
  23155. * Get an input block by its name
  23156. * @param predicate defines the predicate used to find the good candidate
  23157. * @returns the required input block or null if not found
  23158. */
  23159. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23160. /**
  23161. * Gets the list of input blocks attached to this material
  23162. * @returns an array of InputBlocks
  23163. */
  23164. getInputBlocks(): InputBlock[];
  23165. /**
  23166. * Adds a new optimizer to the list of optimizers
  23167. * @param optimizer defines the optimizers to add
  23168. * @returns the current material
  23169. */
  23170. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23171. /**
  23172. * Remove an optimizer from the list of optimizers
  23173. * @param optimizer defines the optimizers to remove
  23174. * @returns the current material
  23175. */
  23176. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23177. /**
  23178. * Add a new block to the list of output nodes
  23179. * @param node defines the node to add
  23180. * @returns the current material
  23181. */
  23182. addOutputNode(node: NodeMaterialBlock): this;
  23183. /**
  23184. * Remove a block from the list of root nodes
  23185. * @param node defines the node to remove
  23186. * @returns the current material
  23187. */
  23188. removeOutputNode(node: NodeMaterialBlock): this;
  23189. private _addVertexOutputNode;
  23190. private _removeVertexOutputNode;
  23191. private _addFragmentOutputNode;
  23192. private _removeFragmentOutputNode;
  23193. /**
  23194. * Specifies if the material will require alpha blending
  23195. * @returns a boolean specifying if alpha blending is needed
  23196. */
  23197. needAlphaBlending(): boolean;
  23198. /**
  23199. * Specifies if this material should be rendered in alpha test mode
  23200. * @returns a boolean specifying if an alpha test is needed.
  23201. */
  23202. needAlphaTesting(): boolean;
  23203. private _initializeBlock;
  23204. private _resetDualBlocks;
  23205. /**
  23206. * Remove a block from the current node material
  23207. * @param block defines the block to remove
  23208. */
  23209. removeBlock(block: NodeMaterialBlock): void;
  23210. /**
  23211. * Build the material and generates the inner effect
  23212. * @param verbose defines if the build should log activity
  23213. */
  23214. build(verbose?: boolean): void;
  23215. /**
  23216. * Runs an otpimization phase to try to improve the shader code
  23217. */
  23218. optimize(): void;
  23219. private _prepareDefinesForAttributes;
  23220. /**
  23221. * Create a post process from the material
  23222. * @param camera The camera to apply the render pass to.
  23223. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23224. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23225. * @param engine The engine which the post process will be applied. (default: current engine)
  23226. * @param reusable If the post process can be reused on the same frame. (default: false)
  23227. * @param textureType Type of textures used when performing the post process. (default: 0)
  23228. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23229. * @returns the post process created
  23230. */
  23231. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23232. /**
  23233. * Create the post process effect from the material
  23234. * @param postProcess The post process to create the effect for
  23235. */
  23236. createEffectForPostProcess(postProcess: PostProcess): void;
  23237. private _createEffectOrPostProcess;
  23238. private _createEffectForParticles;
  23239. /**
  23240. * Create the effect to be used as the custom effect for a particle system
  23241. * @param particleSystem Particle system to create the effect for
  23242. * @param onCompiled defines a function to call when the effect creation is successful
  23243. * @param onError defines a function to call when the effect creation has failed
  23244. */
  23245. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23246. private _processDefines;
  23247. /**
  23248. * Get if the submesh is ready to be used and all its information available.
  23249. * Child classes can use it to update shaders
  23250. * @param mesh defines the mesh to check
  23251. * @param subMesh defines which submesh to check
  23252. * @param useInstances specifies that instances should be used
  23253. * @returns a boolean indicating that the submesh is ready or not
  23254. */
  23255. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23256. /**
  23257. * Get a string representing the shaders built by the current node graph
  23258. */
  23259. get compiledShaders(): string;
  23260. /**
  23261. * Binds the world matrix to the material
  23262. * @param world defines the world transformation matrix
  23263. */
  23264. bindOnlyWorldMatrix(world: Matrix): void;
  23265. /**
  23266. * Binds the submesh to this material by preparing the effect and shader to draw
  23267. * @param world defines the world transformation matrix
  23268. * @param mesh defines the mesh containing the submesh
  23269. * @param subMesh defines the submesh to bind the material to
  23270. */
  23271. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23272. /**
  23273. * Gets the active textures from the material
  23274. * @returns an array of textures
  23275. */
  23276. getActiveTextures(): BaseTexture[];
  23277. /**
  23278. * Gets the list of texture blocks
  23279. * @returns an array of texture blocks
  23280. */
  23281. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23282. /**
  23283. * Specifies if the material uses a texture
  23284. * @param texture defines the texture to check against the material
  23285. * @returns a boolean specifying if the material uses the texture
  23286. */
  23287. hasTexture(texture: BaseTexture): boolean;
  23288. /**
  23289. * Disposes the material
  23290. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23291. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23292. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23293. */
  23294. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23295. /** Creates the node editor window. */
  23296. private _createNodeEditor;
  23297. /**
  23298. * Launch the node material editor
  23299. * @param config Define the configuration of the editor
  23300. * @return a promise fulfilled when the node editor is visible
  23301. */
  23302. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23303. /**
  23304. * Clear the current material
  23305. */
  23306. clear(): void;
  23307. /**
  23308. * Clear the current material and set it to a default state
  23309. */
  23310. setToDefault(): void;
  23311. /**
  23312. * Clear the current material and set it to a default state for post process
  23313. */
  23314. setToDefaultPostProcess(): void;
  23315. /**
  23316. * Clear the current material and set it to a default state for particle
  23317. */
  23318. setToDefaultParticle(): void;
  23319. /**
  23320. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23321. * @param url defines the url to load from
  23322. * @returns a promise that will fullfil when the material is fully loaded
  23323. */
  23324. loadAsync(url: string): Promise<void>;
  23325. private _gatherBlocks;
  23326. /**
  23327. * Generate a string containing the code declaration required to create an equivalent of this material
  23328. * @returns a string
  23329. */
  23330. generateCode(): string;
  23331. /**
  23332. * Serializes this material in a JSON representation
  23333. * @returns the serialized material object
  23334. */
  23335. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23336. private _restoreConnections;
  23337. /**
  23338. * Clear the current graph and load a new one from a serialization object
  23339. * @param source defines the JSON representation of the material
  23340. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23341. * @param merge defines whether or not the source must be merged or replace the current content
  23342. */
  23343. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23344. /**
  23345. * Makes a duplicate of the current material.
  23346. * @param name - name to use for the new material.
  23347. */
  23348. clone(name: string): NodeMaterial;
  23349. /**
  23350. * Creates a node material from parsed material data
  23351. * @param source defines the JSON representation of the material
  23352. * @param scene defines the hosting scene
  23353. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23354. * @returns a new node material
  23355. */
  23356. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23357. /**
  23358. * Creates a node material from a snippet saved in a remote file
  23359. * @param name defines the name of the material to create
  23360. * @param url defines the url to load from
  23361. * @param scene defines the hosting scene
  23362. * @returns a promise that will resolve to the new node material
  23363. */
  23364. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23365. /**
  23366. * Creates a node material from a snippet saved by the node material editor
  23367. * @param snippetId defines the snippet to load
  23368. * @param scene defines the hosting scene
  23369. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23370. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23371. * @returns a promise that will resolve to the new node material
  23372. */
  23373. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23374. /**
  23375. * Creates a new node material set to default basic configuration
  23376. * @param name defines the name of the material
  23377. * @param scene defines the hosting scene
  23378. * @returns a new NodeMaterial
  23379. */
  23380. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23381. }
  23382. }
  23383. declare module "babylonjs/PostProcesses/postProcess" {
  23384. import { Nullable } from "babylonjs/types";
  23385. import { SmartArray } from "babylonjs/Misc/smartArray";
  23386. import { Observable } from "babylonjs/Misc/observable";
  23387. import { Vector2 } from "babylonjs/Maths/math.vector";
  23388. import { Camera } from "babylonjs/Cameras/camera";
  23389. import { Effect } from "babylonjs/Materials/effect";
  23390. import "babylonjs/Shaders/postprocess.vertex";
  23391. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23392. import { Engine } from "babylonjs/Engines/engine";
  23393. import { Color4 } from "babylonjs/Maths/math.color";
  23394. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23395. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23396. import { Scene } from "babylonjs/scene";
  23397. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23398. /**
  23399. * Size options for a post process
  23400. */
  23401. export type PostProcessOptions = {
  23402. width: number;
  23403. height: number;
  23404. };
  23405. /**
  23406. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23407. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23408. */
  23409. export class PostProcess {
  23410. /**
  23411. * Gets or sets the unique id of the post process
  23412. */
  23413. uniqueId: number;
  23414. /** Name of the PostProcess. */
  23415. name: string;
  23416. /**
  23417. * Width of the texture to apply the post process on
  23418. */
  23419. width: number;
  23420. /**
  23421. * Height of the texture to apply the post process on
  23422. */
  23423. height: number;
  23424. /**
  23425. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23426. */
  23427. nodeMaterialSource: Nullable<NodeMaterial>;
  23428. /**
  23429. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23430. * @hidden
  23431. */
  23432. _outputTexture: Nullable<InternalTexture>;
  23433. /**
  23434. * Sampling mode used by the shader
  23435. * See https://doc.babylonjs.com/classes/3.1/texture
  23436. */
  23437. renderTargetSamplingMode: number;
  23438. /**
  23439. * Clear color to use when screen clearing
  23440. */
  23441. clearColor: Color4;
  23442. /**
  23443. * If the buffer needs to be cleared before applying the post process. (default: true)
  23444. * Should be set to false if shader will overwrite all previous pixels.
  23445. */
  23446. autoClear: boolean;
  23447. /**
  23448. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23449. */
  23450. alphaMode: number;
  23451. /**
  23452. * Sets the setAlphaBlendConstants of the babylon engine
  23453. */
  23454. alphaConstants: Color4;
  23455. /**
  23456. * Animations to be used for the post processing
  23457. */
  23458. animations: import("babylonjs/Animations/animation").Animation[];
  23459. /**
  23460. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23461. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23462. */
  23463. enablePixelPerfectMode: boolean;
  23464. /**
  23465. * Force the postprocess to be applied without taking in account viewport
  23466. */
  23467. forceFullscreenViewport: boolean;
  23468. /**
  23469. * List of inspectable custom properties (used by the Inspector)
  23470. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23471. */
  23472. inspectableCustomProperties: IInspectable[];
  23473. /**
  23474. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23475. *
  23476. * | Value | Type | Description |
  23477. * | ----- | ----------------------------------- | ----------- |
  23478. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23479. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23480. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23481. *
  23482. */
  23483. scaleMode: number;
  23484. /**
  23485. * Force textures to be a power of two (default: false)
  23486. */
  23487. alwaysForcePOT: boolean;
  23488. private _samples;
  23489. /**
  23490. * Number of sample textures (default: 1)
  23491. */
  23492. get samples(): number;
  23493. set samples(n: number);
  23494. /**
  23495. * Modify the scale of the post process to be the same as the viewport (default: false)
  23496. */
  23497. adaptScaleToCurrentViewport: boolean;
  23498. private _camera;
  23499. protected _scene: Scene;
  23500. private _engine;
  23501. private _options;
  23502. private _reusable;
  23503. private _textureType;
  23504. private _textureFormat;
  23505. /**
  23506. * Smart array of input and output textures for the post process.
  23507. * @hidden
  23508. */
  23509. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23510. /**
  23511. * The index in _textures that corresponds to the output texture.
  23512. * @hidden
  23513. */
  23514. _currentRenderTextureInd: number;
  23515. private _effect;
  23516. private _samplers;
  23517. private _fragmentUrl;
  23518. private _vertexUrl;
  23519. private _parameters;
  23520. private _scaleRatio;
  23521. protected _indexParameters: any;
  23522. private _shareOutputWithPostProcess;
  23523. private _texelSize;
  23524. private _forcedOutputTexture;
  23525. /**
  23526. * Returns the fragment url or shader name used in the post process.
  23527. * @returns the fragment url or name in the shader store.
  23528. */
  23529. getEffectName(): string;
  23530. /**
  23531. * An event triggered when the postprocess is activated.
  23532. */
  23533. onActivateObservable: Observable<Camera>;
  23534. private _onActivateObserver;
  23535. /**
  23536. * A function that is added to the onActivateObservable
  23537. */
  23538. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23539. /**
  23540. * An event triggered when the postprocess changes its size.
  23541. */
  23542. onSizeChangedObservable: Observable<PostProcess>;
  23543. private _onSizeChangedObserver;
  23544. /**
  23545. * A function that is added to the onSizeChangedObservable
  23546. */
  23547. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23548. /**
  23549. * An event triggered when the postprocess applies its effect.
  23550. */
  23551. onApplyObservable: Observable<Effect>;
  23552. private _onApplyObserver;
  23553. /**
  23554. * A function that is added to the onApplyObservable
  23555. */
  23556. set onApply(callback: (effect: Effect) => void);
  23557. /**
  23558. * An event triggered before rendering the postprocess
  23559. */
  23560. onBeforeRenderObservable: Observable<Effect>;
  23561. private _onBeforeRenderObserver;
  23562. /**
  23563. * A function that is added to the onBeforeRenderObservable
  23564. */
  23565. set onBeforeRender(callback: (effect: Effect) => void);
  23566. /**
  23567. * An event triggered after rendering the postprocess
  23568. */
  23569. onAfterRenderObservable: Observable<Effect>;
  23570. private _onAfterRenderObserver;
  23571. /**
  23572. * A function that is added to the onAfterRenderObservable
  23573. */
  23574. set onAfterRender(callback: (efect: Effect) => void);
  23575. /**
  23576. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  23577. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23578. */
  23579. get inputTexture(): InternalTexture;
  23580. set inputTexture(value: InternalTexture);
  23581. /**
  23582. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23583. * the only way to unset it is to use this function to restore its internal state
  23584. */
  23585. restoreDefaultInputTexture(): void;
  23586. /**
  23587. * Gets the camera which post process is applied to.
  23588. * @returns The camera the post process is applied to.
  23589. */
  23590. getCamera(): Camera;
  23591. /**
  23592. * Gets the texel size of the postprocess.
  23593. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23594. */
  23595. get texelSize(): Vector2;
  23596. /**
  23597. * Creates a new instance PostProcess
  23598. * @param name The name of the PostProcess.
  23599. * @param fragmentUrl The url of the fragment shader to be used.
  23600. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23601. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23602. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23603. * @param camera The camera to apply the render pass to.
  23604. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23605. * @param engine The engine which the post process will be applied. (default: current engine)
  23606. * @param reusable If the post process can be reused on the same frame. (default: false)
  23607. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23608. * @param textureType Type of textures used when performing the post process. (default: 0)
  23609. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23610. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23611. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23612. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23613. */
  23614. constructor(name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  23615. /**
  23616. * Gets a string identifying the name of the class
  23617. * @returns "PostProcess" string
  23618. */
  23619. getClassName(): string;
  23620. /**
  23621. * Gets the engine which this post process belongs to.
  23622. * @returns The engine the post process was enabled with.
  23623. */
  23624. getEngine(): Engine;
  23625. /**
  23626. * The effect that is created when initializing the post process.
  23627. * @returns The created effect corresponding the the postprocess.
  23628. */
  23629. getEffect(): Effect;
  23630. /**
  23631. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23632. * @param postProcess The post process to share the output with.
  23633. * @returns This post process.
  23634. */
  23635. shareOutputWith(postProcess: PostProcess): PostProcess;
  23636. /**
  23637. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23638. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23639. */
  23640. useOwnOutput(): void;
  23641. /**
  23642. * Updates the effect with the current post process compile time values and recompiles the shader.
  23643. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23644. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23645. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23646. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23647. * @param onCompiled Called when the shader has been compiled.
  23648. * @param onError Called if there is an error when compiling a shader.
  23649. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23650. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23651. */
  23652. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  23653. /**
  23654. * The post process is reusable if it can be used multiple times within one frame.
  23655. * @returns If the post process is reusable
  23656. */
  23657. isReusable(): boolean;
  23658. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23659. markTextureDirty(): void;
  23660. /**
  23661. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23662. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  23663. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23664. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23665. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23666. * @returns The target texture that was bound to be written to.
  23667. */
  23668. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23669. /**
  23670. * If the post process is supported.
  23671. */
  23672. get isSupported(): boolean;
  23673. /**
  23674. * The aspect ratio of the output texture.
  23675. */
  23676. get aspectRatio(): number;
  23677. /**
  23678. * Get a value indicating if the post-process is ready to be used
  23679. * @returns true if the post-process is ready (shader is compiled)
  23680. */
  23681. isReady(): boolean;
  23682. /**
  23683. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23684. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23685. */
  23686. apply(): Nullable<Effect>;
  23687. private _disposeTextures;
  23688. /**
  23689. * Disposes the post process.
  23690. * @param camera The camera to dispose the post process on.
  23691. */
  23692. dispose(camera?: Camera): void;
  23693. /**
  23694. * Serializes the particle system to a JSON object
  23695. * @returns the JSON object
  23696. */
  23697. serialize(): any;
  23698. /**
  23699. * Creates a material from parsed material data
  23700. * @param parsedPostProcess defines parsed post process data
  23701. * @param scene defines the hosting scene
  23702. * @param rootUrl defines the root URL to use to load textures
  23703. * @returns a new post process
  23704. */
  23705. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23706. }
  23707. }
  23708. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23709. /** @hidden */
  23710. export var kernelBlurVaryingDeclaration: {
  23711. name: string;
  23712. shader: string;
  23713. };
  23714. }
  23715. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23716. /** @hidden */
  23717. export var kernelBlurFragment: {
  23718. name: string;
  23719. shader: string;
  23720. };
  23721. }
  23722. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23723. /** @hidden */
  23724. export var kernelBlurFragment2: {
  23725. name: string;
  23726. shader: string;
  23727. };
  23728. }
  23729. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23730. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23731. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23732. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23733. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23734. /** @hidden */
  23735. export var kernelBlurPixelShader: {
  23736. name: string;
  23737. shader: string;
  23738. };
  23739. }
  23740. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23741. /** @hidden */
  23742. export var kernelBlurVertex: {
  23743. name: string;
  23744. shader: string;
  23745. };
  23746. }
  23747. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23748. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23749. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23750. /** @hidden */
  23751. export var kernelBlurVertexShader: {
  23752. name: string;
  23753. shader: string;
  23754. };
  23755. }
  23756. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23757. import { Vector2 } from "babylonjs/Maths/math.vector";
  23758. import { Nullable } from "babylonjs/types";
  23759. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23760. import { Camera } from "babylonjs/Cameras/camera";
  23761. import { Effect } from "babylonjs/Materials/effect";
  23762. import { Engine } from "babylonjs/Engines/engine";
  23763. import "babylonjs/Shaders/kernelBlur.fragment";
  23764. import "babylonjs/Shaders/kernelBlur.vertex";
  23765. import { Scene } from "babylonjs/scene";
  23766. /**
  23767. * The Blur Post Process which blurs an image based on a kernel and direction.
  23768. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23769. */
  23770. export class BlurPostProcess extends PostProcess {
  23771. private blockCompilation;
  23772. protected _kernel: number;
  23773. protected _idealKernel: number;
  23774. protected _packedFloat: boolean;
  23775. private _staticDefines;
  23776. /** The direction in which to blur the image. */
  23777. direction: Vector2;
  23778. /**
  23779. * Sets the length in pixels of the blur sample region
  23780. */
  23781. set kernel(v: number);
  23782. /**
  23783. * Gets the length in pixels of the blur sample region
  23784. */
  23785. get kernel(): number;
  23786. /**
  23787. * Sets wether or not the blur needs to unpack/repack floats
  23788. */
  23789. set packedFloat(v: boolean);
  23790. /**
  23791. * Gets wether or not the blur is unpacking/repacking floats
  23792. */
  23793. get packedFloat(): boolean;
  23794. /**
  23795. * Gets a string identifying the name of the class
  23796. * @returns "BlurPostProcess" string
  23797. */
  23798. getClassName(): string;
  23799. /**
  23800. * Creates a new instance BlurPostProcess
  23801. * @param name The name of the effect.
  23802. * @param direction The direction in which to blur the image.
  23803. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  23804. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23805. * @param camera The camera to apply the render pass to.
  23806. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23807. * @param engine The engine which the post process will be applied. (default: current engine)
  23808. * @param reusable If the post process can be reused on the same frame. (default: false)
  23809. * @param textureType Type of textures used when performing the post process. (default: 0)
  23810. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  23811. */
  23812. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23813. /**
  23814. * Updates the effect with the current post process compile time values and recompiles the shader.
  23815. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23816. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23817. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23818. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23819. * @param onCompiled Called when the shader has been compiled.
  23820. * @param onError Called if there is an error when compiling a shader.
  23821. */
  23822. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23823. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23824. /**
  23825. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23826. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23827. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23828. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23829. * The gaps between physical kernels are compensated for in the weighting of the samples
  23830. * @param idealKernel Ideal blur kernel.
  23831. * @return Nearest best kernel.
  23832. */
  23833. protected _nearestBestKernel(idealKernel: number): number;
  23834. /**
  23835. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23836. * @param x The point on the Gaussian distribution to sample.
  23837. * @return the value of the Gaussian function at x.
  23838. */
  23839. protected _gaussianWeight(x: number): number;
  23840. /**
  23841. * Generates a string that can be used as a floating point number in GLSL.
  23842. * @param x Value to print.
  23843. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23844. * @return GLSL float string.
  23845. */
  23846. protected _glslFloat(x: number, decimalFigures?: number): string;
  23847. /** @hidden */
  23848. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23849. }
  23850. }
  23851. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23852. import { Scene } from "babylonjs/scene";
  23853. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23854. import { Plane } from "babylonjs/Maths/math.plane";
  23855. /**
  23856. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23857. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23858. * You can then easily use it as a reflectionTexture on a flat surface.
  23859. * In case the surface is not a plane, please consider relying on reflection probes.
  23860. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23861. */
  23862. export class MirrorTexture extends RenderTargetTexture {
  23863. private scene;
  23864. /**
  23865. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23866. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  23867. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23868. */
  23869. mirrorPlane: Plane;
  23870. /**
  23871. * Define the blur ratio used to blur the reflection if needed.
  23872. */
  23873. set blurRatio(value: number);
  23874. get blurRatio(): number;
  23875. /**
  23876. * Define the adaptive blur kernel used to blur the reflection if needed.
  23877. * This will autocompute the closest best match for the `blurKernel`
  23878. */
  23879. set adaptiveBlurKernel(value: number);
  23880. /**
  23881. * Define the blur kernel used to blur the reflection if needed.
  23882. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23883. */
  23884. set blurKernel(value: number);
  23885. /**
  23886. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23887. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23888. */
  23889. set blurKernelX(value: number);
  23890. get blurKernelX(): number;
  23891. /**
  23892. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23893. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23894. */
  23895. set blurKernelY(value: number);
  23896. get blurKernelY(): number;
  23897. private _autoComputeBlurKernel;
  23898. protected _onRatioRescale(): void;
  23899. private _updateGammaSpace;
  23900. private _imageProcessingConfigChangeObserver;
  23901. private _transformMatrix;
  23902. private _mirrorMatrix;
  23903. private _savedViewMatrix;
  23904. private _blurX;
  23905. private _blurY;
  23906. private _adaptiveBlurKernel;
  23907. private _blurKernelX;
  23908. private _blurKernelY;
  23909. private _blurRatio;
  23910. /**
  23911. * Instantiates a Mirror Texture.
  23912. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23913. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23914. * You can then easily use it as a reflectionTexture on a flat surface.
  23915. * In case the surface is not a plane, please consider relying on reflection probes.
  23916. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23917. * @param name
  23918. * @param size
  23919. * @param scene
  23920. * @param generateMipMaps
  23921. * @param type
  23922. * @param samplingMode
  23923. * @param generateDepthBuffer
  23924. */
  23925. constructor(name: string, size: number | {
  23926. width: number;
  23927. height: number;
  23928. } | {
  23929. ratio: number;
  23930. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23931. private _preparePostProcesses;
  23932. /**
  23933. * Clone the mirror texture.
  23934. * @returns the cloned texture
  23935. */
  23936. clone(): MirrorTexture;
  23937. /**
  23938. * Serialize the texture to a JSON representation you could use in Parse later on
  23939. * @returns the serialized JSON representation
  23940. */
  23941. serialize(): any;
  23942. /**
  23943. * Dispose the texture and release its associated resources.
  23944. */
  23945. dispose(): void;
  23946. }
  23947. }
  23948. declare module "babylonjs/Materials/Textures/texture" {
  23949. import { Observable } from "babylonjs/Misc/observable";
  23950. import { Nullable } from "babylonjs/types";
  23951. import { Matrix } from "babylonjs/Maths/math.vector";
  23952. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23953. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23954. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23955. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23956. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23957. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23958. import { Scene } from "babylonjs/scene";
  23959. /**
  23960. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23961. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23962. */
  23963. export class Texture extends BaseTexture {
  23964. /**
  23965. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23966. */
  23967. static SerializeBuffers: boolean;
  23968. /** @hidden */
  23969. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23970. /** @hidden */
  23971. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23972. /** @hidden */
  23973. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23974. /** nearest is mag = nearest and min = nearest and mip = linear */
  23975. static readonly NEAREST_SAMPLINGMODE: number;
  23976. /** nearest is mag = nearest and min = nearest and mip = linear */
  23977. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23978. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23979. static readonly BILINEAR_SAMPLINGMODE: number;
  23980. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23981. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23982. /** Trilinear is mag = linear and min = linear and mip = linear */
  23983. static readonly TRILINEAR_SAMPLINGMODE: number;
  23984. /** Trilinear is mag = linear and min = linear and mip = linear */
  23985. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23986. /** mag = nearest and min = nearest and mip = nearest */
  23987. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23988. /** mag = nearest and min = linear and mip = nearest */
  23989. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23990. /** mag = nearest and min = linear and mip = linear */
  23991. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23992. /** mag = nearest and min = linear and mip = none */
  23993. static readonly NEAREST_LINEAR: number;
  23994. /** mag = nearest and min = nearest and mip = none */
  23995. static readonly NEAREST_NEAREST: number;
  23996. /** mag = linear and min = nearest and mip = nearest */
  23997. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  23998. /** mag = linear and min = nearest and mip = linear */
  23999. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24000. /** mag = linear and min = linear and mip = none */
  24001. static readonly LINEAR_LINEAR: number;
  24002. /** mag = linear and min = nearest and mip = none */
  24003. static readonly LINEAR_NEAREST: number;
  24004. /** Explicit coordinates mode */
  24005. static readonly EXPLICIT_MODE: number;
  24006. /** Spherical coordinates mode */
  24007. static readonly SPHERICAL_MODE: number;
  24008. /** Planar coordinates mode */
  24009. static readonly PLANAR_MODE: number;
  24010. /** Cubic coordinates mode */
  24011. static readonly CUBIC_MODE: number;
  24012. /** Projection coordinates mode */
  24013. static readonly PROJECTION_MODE: number;
  24014. /** Inverse Cubic coordinates mode */
  24015. static readonly SKYBOX_MODE: number;
  24016. /** Inverse Cubic coordinates mode */
  24017. static readonly INVCUBIC_MODE: number;
  24018. /** Equirectangular coordinates mode */
  24019. static readonly EQUIRECTANGULAR_MODE: number;
  24020. /** Equirectangular Fixed coordinates mode */
  24021. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24022. /** Equirectangular Fixed Mirrored coordinates mode */
  24023. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24024. /** Texture is not repeating outside of 0..1 UVs */
  24025. static readonly CLAMP_ADDRESSMODE: number;
  24026. /** Texture is repeating outside of 0..1 UVs */
  24027. static readonly WRAP_ADDRESSMODE: number;
  24028. /** Texture is repeating and mirrored */
  24029. static readonly MIRROR_ADDRESSMODE: number;
  24030. /**
  24031. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  24032. */
  24033. static UseSerializedUrlIfAny: boolean;
  24034. /**
  24035. * Define the url of the texture.
  24036. */
  24037. url: Nullable<string>;
  24038. /**
  24039. * Define an offset on the texture to offset the u coordinates of the UVs
  24040. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24041. */
  24042. uOffset: number;
  24043. /**
  24044. * Define an offset on the texture to offset the v coordinates of the UVs
  24045. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24046. */
  24047. vOffset: number;
  24048. /**
  24049. * Define an offset on the texture to scale the u coordinates of the UVs
  24050. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24051. */
  24052. uScale: number;
  24053. /**
  24054. * Define an offset on the texture to scale the v coordinates of the UVs
  24055. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24056. */
  24057. vScale: number;
  24058. /**
  24059. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24060. * @see https://doc.babylonjs.com/how_to/more_materials
  24061. */
  24062. uAng: number;
  24063. /**
  24064. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24065. * @see https://doc.babylonjs.com/how_to/more_materials
  24066. */
  24067. vAng: number;
  24068. /**
  24069. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24070. * @see https://doc.babylonjs.com/how_to/more_materials
  24071. */
  24072. wAng: number;
  24073. /**
  24074. * Defines the center of rotation (U)
  24075. */
  24076. uRotationCenter: number;
  24077. /**
  24078. * Defines the center of rotation (V)
  24079. */
  24080. vRotationCenter: number;
  24081. /**
  24082. * Defines the center of rotation (W)
  24083. */
  24084. wRotationCenter: number;
  24085. /**
  24086. * Are mip maps generated for this texture or not.
  24087. */
  24088. get noMipmap(): boolean;
  24089. /**
  24090. * List of inspectable custom properties (used by the Inspector)
  24091. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24092. */
  24093. inspectableCustomProperties: Nullable<IInspectable[]>;
  24094. private _noMipmap;
  24095. /** @hidden */
  24096. _invertY: boolean;
  24097. private _rowGenerationMatrix;
  24098. private _cachedTextureMatrix;
  24099. private _projectionModeMatrix;
  24100. private _t0;
  24101. private _t1;
  24102. private _t2;
  24103. private _cachedUOffset;
  24104. private _cachedVOffset;
  24105. private _cachedUScale;
  24106. private _cachedVScale;
  24107. private _cachedUAng;
  24108. private _cachedVAng;
  24109. private _cachedWAng;
  24110. private _cachedProjectionMatrixId;
  24111. private _cachedCoordinatesMode;
  24112. /** @hidden */
  24113. protected _initialSamplingMode: number;
  24114. /** @hidden */
  24115. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24116. private _deleteBuffer;
  24117. protected _format: Nullable<number>;
  24118. private _delayedOnLoad;
  24119. private _delayedOnError;
  24120. private _mimeType?;
  24121. /**
  24122. * Observable triggered once the texture has been loaded.
  24123. */
  24124. onLoadObservable: Observable<Texture>;
  24125. protected _isBlocking: boolean;
  24126. /**
  24127. * Is the texture preventing material to render while loading.
  24128. * If false, a default texture will be used instead of the loading one during the preparation step.
  24129. */
  24130. set isBlocking(value: boolean);
  24131. get isBlocking(): boolean;
  24132. /**
  24133. * Get the current sampling mode associated with the texture.
  24134. */
  24135. get samplingMode(): number;
  24136. /**
  24137. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24138. */
  24139. get invertY(): boolean;
  24140. /**
  24141. * Instantiates a new texture.
  24142. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24143. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24144. * @param url defines the url of the picture to load as a texture
  24145. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24146. * @param noMipmap defines if the texture will require mip maps or not
  24147. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24148. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24149. * @param onLoad defines a callback triggered when the texture has been loaded
  24150. * @param onError defines a callback triggered when an error occurred during the loading session
  24151. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24152. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24153. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24154. * @param mimeType defines an optional mime type information
  24155. */
  24156. 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);
  24157. /**
  24158. * Update the url (and optional buffer) of this texture if url was null during construction.
  24159. * @param url the url of the texture
  24160. * @param buffer the buffer of the texture (defaults to null)
  24161. * @param onLoad callback called when the texture is loaded (defaults to null)
  24162. */
  24163. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24164. /**
  24165. * Finish the loading sequence of a texture flagged as delayed load.
  24166. * @hidden
  24167. */
  24168. delayLoad(): void;
  24169. private _prepareRowForTextureGeneration;
  24170. /**
  24171. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24172. * @returns the transform matrix of the texture.
  24173. */
  24174. getTextureMatrix(uBase?: number): Matrix;
  24175. /**
  24176. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24177. * @returns The reflection texture transform
  24178. */
  24179. getReflectionTextureMatrix(): Matrix;
  24180. /**
  24181. * Clones the texture.
  24182. * @returns the cloned texture
  24183. */
  24184. clone(): Texture;
  24185. /**
  24186. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24187. * @returns The JSON representation of the texture
  24188. */
  24189. serialize(): any;
  24190. /**
  24191. * Get the current class name of the texture useful for serialization or dynamic coding.
  24192. * @returns "Texture"
  24193. */
  24194. getClassName(): string;
  24195. /**
  24196. * Dispose the texture and release its associated resources.
  24197. */
  24198. dispose(): void;
  24199. /**
  24200. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24201. * @param parsedTexture Define the JSON representation of the texture
  24202. * @param scene Define the scene the parsed texture should be instantiated in
  24203. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24204. * @returns The parsed texture if successful
  24205. */
  24206. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24207. /**
  24208. * Creates a texture from its base 64 representation.
  24209. * @param data Define the base64 payload without the data: prefix
  24210. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24211. * @param scene Define the scene the texture should belong to
  24212. * @param noMipmap Forces the texture to not create mip map information if true
  24213. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24214. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24215. * @param onLoad define a callback triggered when the texture has been loaded
  24216. * @param onError define a callback triggered when an error occurred during the loading session
  24217. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24218. * @returns the created texture
  24219. */
  24220. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24221. /**
  24222. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24223. * @param data Define the base64 payload without the data: prefix
  24224. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24225. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24226. * @param scene Define the scene the texture should belong to
  24227. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24228. * @param noMipmap Forces the texture to not create mip map information if true
  24229. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24230. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24231. * @param onLoad define a callback triggered when the texture has been loaded
  24232. * @param onError define a callback triggered when an error occurred during the loading session
  24233. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24234. * @returns the created texture
  24235. */
  24236. 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;
  24237. }
  24238. }
  24239. declare module "babylonjs/PostProcesses/postProcessManager" {
  24240. import { Nullable } from "babylonjs/types";
  24241. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24242. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24243. import { Scene } from "babylonjs/scene";
  24244. /**
  24245. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24246. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24247. */
  24248. export class PostProcessManager {
  24249. private _scene;
  24250. private _indexBuffer;
  24251. private _vertexBuffers;
  24252. /**
  24253. * Creates a new instance PostProcess
  24254. * @param scene The scene that the post process is associated with.
  24255. */
  24256. constructor(scene: Scene);
  24257. private _prepareBuffers;
  24258. private _buildIndexBuffer;
  24259. /**
  24260. * Rebuilds the vertex buffers of the manager.
  24261. * @hidden
  24262. */
  24263. _rebuild(): void;
  24264. /**
  24265. * Prepares a frame to be run through a post process.
  24266. * @param sourceTexture The input texture to the post procesess. (default: null)
  24267. * @param postProcesses An array of post processes to be run. (default: null)
  24268. * @returns True if the post processes were able to be run.
  24269. * @hidden
  24270. */
  24271. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24272. /**
  24273. * Manually render a set of post processes to a texture.
  24274. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24275. * @param postProcesses An array of post processes to be run.
  24276. * @param targetTexture The target texture to render to.
  24277. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24278. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24279. * @param lodLevel defines which lod of the texture to render to
  24280. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24281. */
  24282. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24283. /**
  24284. * Finalize the result of the output of the postprocesses.
  24285. * @param doNotPresent If true the result will not be displayed to the screen.
  24286. * @param targetTexture The target texture to render to.
  24287. * @param faceIndex The index of the face to bind the target texture to.
  24288. * @param postProcesses The array of post processes to render.
  24289. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24290. * @hidden
  24291. */
  24292. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24293. /**
  24294. * Disposes of the post process manager.
  24295. */
  24296. dispose(): void;
  24297. }
  24298. }
  24299. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24300. import { Observable } from "babylonjs/Misc/observable";
  24301. import { SmartArray } from "babylonjs/Misc/smartArray";
  24302. import { Nullable, Immutable } from "babylonjs/types";
  24303. import { Camera } from "babylonjs/Cameras/camera";
  24304. import { Scene } from "babylonjs/scene";
  24305. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24306. import { Color4 } from "babylonjs/Maths/math.color";
  24307. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24308. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24309. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24310. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24311. import { Texture } from "babylonjs/Materials/Textures/texture";
  24312. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24313. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24314. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24315. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24316. import { Engine } from "babylonjs/Engines/engine";
  24317. /**
  24318. * This Helps creating a texture that will be created from a camera in your scene.
  24319. * It is basically a dynamic texture that could be used to create special effects for instance.
  24320. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24321. */
  24322. export class RenderTargetTexture extends Texture {
  24323. isCube: boolean;
  24324. /**
  24325. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24326. */
  24327. static readonly REFRESHRATE_RENDER_ONCE: number;
  24328. /**
  24329. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24330. */
  24331. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24332. /**
  24333. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24334. * the central point of your effect and can save a lot of performances.
  24335. */
  24336. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24337. /**
  24338. * Use this predicate to dynamically define the list of mesh you want to render.
  24339. * If set, the renderList property will be overwritten.
  24340. */
  24341. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24342. private _renderList;
  24343. /**
  24344. * Use this list to define the list of mesh you want to render.
  24345. */
  24346. get renderList(): Nullable<Array<AbstractMesh>>;
  24347. set renderList(value: Nullable<Array<AbstractMesh>>);
  24348. /**
  24349. * Use this function to overload the renderList array at rendering time.
  24350. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24351. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24352. * the cube (if the RTT is a cube, else layerOrFace=0).
  24353. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24354. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24355. * hold dummy elements!
  24356. */
  24357. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24358. private _hookArray;
  24359. /**
  24360. * Define if particles should be rendered in your texture.
  24361. */
  24362. renderParticles: boolean;
  24363. /**
  24364. * Define if sprites should be rendered in your texture.
  24365. */
  24366. renderSprites: boolean;
  24367. /**
  24368. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  24369. */
  24370. coordinatesMode: number;
  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 or sets a boolean indicating that this mesh does not use index buffer
  29304. */
  29305. get isUnIndexed(): boolean;
  29306. set isUnIndexed(value: boolean);
  29307. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29308. get worldMatrixInstancedBuffer(): Float32Array;
  29309. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29310. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29311. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29312. /**
  29313. * @constructor
  29314. * @param name The value used by scene.getMeshByName() to do a lookup.
  29315. * @param scene The scene to add this mesh to.
  29316. * @param parent The parent of this mesh, if it has one
  29317. * @param source An optional Mesh from which geometry is shared, cloned.
  29318. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29319. * When false, achieved by calling a clone(), also passing False.
  29320. * This will make creation of children, recursive.
  29321. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29322. */
  29323. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29324. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29325. doNotInstantiate: boolean;
  29326. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29327. /**
  29328. * Gets the class name
  29329. * @returns the string "Mesh".
  29330. */
  29331. getClassName(): string;
  29332. /** @hidden */
  29333. get _isMesh(): boolean;
  29334. /**
  29335. * Returns a description of this mesh
  29336. * @param fullDetails define if full details about this mesh must be used
  29337. * @returns a descriptive string representing this mesh
  29338. */
  29339. toString(fullDetails?: boolean): string;
  29340. /** @hidden */
  29341. _unBindEffect(): void;
  29342. /**
  29343. * Gets a boolean indicating if this mesh has LOD
  29344. */
  29345. get hasLODLevels(): boolean;
  29346. /**
  29347. * Gets the list of MeshLODLevel associated with the current mesh
  29348. * @returns an array of MeshLODLevel
  29349. */
  29350. getLODLevels(): MeshLODLevel[];
  29351. private _sortLODLevels;
  29352. /**
  29353. * Add a mesh as LOD level triggered at the given distance.
  29354. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29355. * @param distance The distance from the center of the object to show this level
  29356. * @param mesh The mesh to be added as LOD level (can be null)
  29357. * @return This mesh (for chaining)
  29358. */
  29359. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29360. /**
  29361. * Returns the LOD level mesh at the passed distance or null if not found.
  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. * @returns a Mesh or `null`
  29365. */
  29366. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29367. /**
  29368. * Remove a mesh from the LOD array
  29369. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29370. * @param mesh defines the mesh to be removed
  29371. * @return This mesh (for chaining)
  29372. */
  29373. removeLODLevel(mesh: Mesh): Mesh;
  29374. /**
  29375. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29376. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29377. * @param camera defines the camera to use to compute distance
  29378. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29379. * @return This mesh (for chaining)
  29380. */
  29381. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29382. /**
  29383. * Gets the mesh internal Geometry object
  29384. */
  29385. get geometry(): Nullable<Geometry>;
  29386. /**
  29387. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29388. * @returns the total number of vertices
  29389. */
  29390. getTotalVertices(): number;
  29391. /**
  29392. * Returns the content of an associated vertex buffer
  29393. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29394. * - VertexBuffer.PositionKind
  29395. * - VertexBuffer.UVKind
  29396. * - VertexBuffer.UV2Kind
  29397. * - VertexBuffer.UV3Kind
  29398. * - VertexBuffer.UV4Kind
  29399. * - VertexBuffer.UV5Kind
  29400. * - VertexBuffer.UV6Kind
  29401. * - VertexBuffer.ColorKind
  29402. * - VertexBuffer.MatricesIndicesKind
  29403. * - VertexBuffer.MatricesIndicesExtraKind
  29404. * - VertexBuffer.MatricesWeightsKind
  29405. * - VertexBuffer.MatricesWeightsExtraKind
  29406. * @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
  29407. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29408. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29409. */
  29410. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29411. /**
  29412. * Returns the mesh VertexBuffer object from the requested `kind`
  29413. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29414. * - VertexBuffer.PositionKind
  29415. * - VertexBuffer.NormalKind
  29416. * - VertexBuffer.UVKind
  29417. * - VertexBuffer.UV2Kind
  29418. * - VertexBuffer.UV3Kind
  29419. * - VertexBuffer.UV4Kind
  29420. * - VertexBuffer.UV5Kind
  29421. * - VertexBuffer.UV6Kind
  29422. * - VertexBuffer.ColorKind
  29423. * - VertexBuffer.MatricesIndicesKind
  29424. * - VertexBuffer.MatricesIndicesExtraKind
  29425. * - VertexBuffer.MatricesWeightsKind
  29426. * - VertexBuffer.MatricesWeightsExtraKind
  29427. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29428. */
  29429. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29430. /**
  29431. * Tests if a specific vertex buffer is associated with this mesh
  29432. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29433. * - VertexBuffer.PositionKind
  29434. * - VertexBuffer.NormalKind
  29435. * - VertexBuffer.UVKind
  29436. * - VertexBuffer.UV2Kind
  29437. * - VertexBuffer.UV3Kind
  29438. * - VertexBuffer.UV4Kind
  29439. * - VertexBuffer.UV5Kind
  29440. * - VertexBuffer.UV6Kind
  29441. * - VertexBuffer.ColorKind
  29442. * - VertexBuffer.MatricesIndicesKind
  29443. * - VertexBuffer.MatricesIndicesExtraKind
  29444. * - VertexBuffer.MatricesWeightsKind
  29445. * - VertexBuffer.MatricesWeightsExtraKind
  29446. * @returns a boolean
  29447. */
  29448. isVerticesDataPresent(kind: string): boolean;
  29449. /**
  29450. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29451. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29452. * - VertexBuffer.PositionKind
  29453. * - VertexBuffer.UVKind
  29454. * - VertexBuffer.UV2Kind
  29455. * - VertexBuffer.UV3Kind
  29456. * - VertexBuffer.UV4Kind
  29457. * - VertexBuffer.UV5Kind
  29458. * - VertexBuffer.UV6Kind
  29459. * - VertexBuffer.ColorKind
  29460. * - VertexBuffer.MatricesIndicesKind
  29461. * - VertexBuffer.MatricesIndicesExtraKind
  29462. * - VertexBuffer.MatricesWeightsKind
  29463. * - VertexBuffer.MatricesWeightsExtraKind
  29464. * @returns a boolean
  29465. */
  29466. isVertexBufferUpdatable(kind: string): boolean;
  29467. /**
  29468. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29469. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29470. * - VertexBuffer.PositionKind
  29471. * - VertexBuffer.NormalKind
  29472. * - VertexBuffer.UVKind
  29473. * - VertexBuffer.UV2Kind
  29474. * - VertexBuffer.UV3Kind
  29475. * - VertexBuffer.UV4Kind
  29476. * - VertexBuffer.UV5Kind
  29477. * - VertexBuffer.UV6Kind
  29478. * - VertexBuffer.ColorKind
  29479. * - VertexBuffer.MatricesIndicesKind
  29480. * - VertexBuffer.MatricesIndicesExtraKind
  29481. * - VertexBuffer.MatricesWeightsKind
  29482. * - VertexBuffer.MatricesWeightsExtraKind
  29483. * @returns an array of strings
  29484. */
  29485. getVerticesDataKinds(): string[];
  29486. /**
  29487. * Returns a positive integer : the total number of indices in this mesh geometry.
  29488. * @returns the numner of indices or zero if the mesh has no geometry.
  29489. */
  29490. getTotalIndices(): number;
  29491. /**
  29492. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29493. * @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.
  29494. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29495. * @returns the indices array or an empty array if the mesh has no geometry
  29496. */
  29497. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29498. get isBlocked(): boolean;
  29499. /**
  29500. * Determine if the current mesh is ready to be rendered
  29501. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29502. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29503. * @returns true if all associated assets are ready (material, textures, shaders)
  29504. */
  29505. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29506. /**
  29507. * 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.
  29508. */
  29509. get areNormalsFrozen(): boolean;
  29510. /**
  29511. * 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.
  29512. * @returns the current mesh
  29513. */
  29514. freezeNormals(): Mesh;
  29515. /**
  29516. * 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
  29517. * @returns the current mesh
  29518. */
  29519. unfreezeNormals(): Mesh;
  29520. /**
  29521. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29522. */
  29523. set overridenInstanceCount(count: number);
  29524. /** @hidden */
  29525. _preActivate(): Mesh;
  29526. /** @hidden */
  29527. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29528. /** @hidden */
  29529. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29530. protected _afterComputeWorldMatrix(): void;
  29531. /** @hidden */
  29532. _postActivate(): void;
  29533. /**
  29534. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29535. * This means the mesh underlying bounding box and sphere are recomputed.
  29536. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29537. * @returns the current mesh
  29538. */
  29539. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29540. /** @hidden */
  29541. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29542. /**
  29543. * This function will subdivide the mesh into multiple submeshes
  29544. * @param count defines the expected number of submeshes
  29545. */
  29546. subdivide(count: number): void;
  29547. /**
  29548. * Copy a FloatArray into a specific associated vertex buffer
  29549. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29550. * - VertexBuffer.PositionKind
  29551. * - VertexBuffer.UVKind
  29552. * - VertexBuffer.UV2Kind
  29553. * - VertexBuffer.UV3Kind
  29554. * - VertexBuffer.UV4Kind
  29555. * - VertexBuffer.UV5Kind
  29556. * - VertexBuffer.UV6Kind
  29557. * - VertexBuffer.ColorKind
  29558. * - VertexBuffer.MatricesIndicesKind
  29559. * - VertexBuffer.MatricesIndicesExtraKind
  29560. * - VertexBuffer.MatricesWeightsKind
  29561. * - VertexBuffer.MatricesWeightsExtraKind
  29562. * @param data defines the data source
  29563. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29564. * @param stride defines the data stride size (can be null)
  29565. * @returns the current mesh
  29566. */
  29567. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29568. /**
  29569. * Delete a vertex buffer associated with this mesh
  29570. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29571. * - VertexBuffer.PositionKind
  29572. * - VertexBuffer.UVKind
  29573. * - VertexBuffer.UV2Kind
  29574. * - VertexBuffer.UV3Kind
  29575. * - VertexBuffer.UV4Kind
  29576. * - VertexBuffer.UV5Kind
  29577. * - VertexBuffer.UV6Kind
  29578. * - VertexBuffer.ColorKind
  29579. * - VertexBuffer.MatricesIndicesKind
  29580. * - VertexBuffer.MatricesIndicesExtraKind
  29581. * - VertexBuffer.MatricesWeightsKind
  29582. * - VertexBuffer.MatricesWeightsExtraKind
  29583. */
  29584. removeVerticesData(kind: string): void;
  29585. /**
  29586. * Flags an associated vertex buffer as updatable
  29587. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29588. * - VertexBuffer.PositionKind
  29589. * - VertexBuffer.UVKind
  29590. * - VertexBuffer.UV2Kind
  29591. * - VertexBuffer.UV3Kind
  29592. * - VertexBuffer.UV4Kind
  29593. * - VertexBuffer.UV5Kind
  29594. * - VertexBuffer.UV6Kind
  29595. * - VertexBuffer.ColorKind
  29596. * - VertexBuffer.MatricesIndicesKind
  29597. * - VertexBuffer.MatricesIndicesExtraKind
  29598. * - VertexBuffer.MatricesWeightsKind
  29599. * - VertexBuffer.MatricesWeightsExtraKind
  29600. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29601. */
  29602. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29603. /**
  29604. * Sets the mesh global Vertex Buffer
  29605. * @param buffer defines the buffer to use
  29606. * @returns the current mesh
  29607. */
  29608. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29609. /**
  29610. * Update a specific associated vertex buffer
  29611. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29612. * - VertexBuffer.PositionKind
  29613. * - VertexBuffer.UVKind
  29614. * - VertexBuffer.UV2Kind
  29615. * - VertexBuffer.UV3Kind
  29616. * - VertexBuffer.UV4Kind
  29617. * - VertexBuffer.UV5Kind
  29618. * - VertexBuffer.UV6Kind
  29619. * - VertexBuffer.ColorKind
  29620. * - VertexBuffer.MatricesIndicesKind
  29621. * - VertexBuffer.MatricesIndicesExtraKind
  29622. * - VertexBuffer.MatricesWeightsKind
  29623. * - VertexBuffer.MatricesWeightsExtraKind
  29624. * @param data defines the data source
  29625. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29626. * @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)
  29627. * @returns the current mesh
  29628. */
  29629. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29630. /**
  29631. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29632. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29633. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29634. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29635. * @returns the current mesh
  29636. */
  29637. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29638. /**
  29639. * Creates a un-shared specific occurence of the geometry for the mesh.
  29640. * @returns the current mesh
  29641. */
  29642. makeGeometryUnique(): Mesh;
  29643. /**
  29644. * Set the index buffer of this mesh
  29645. * @param indices defines the source data
  29646. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29647. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29648. * @returns the current mesh
  29649. */
  29650. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29651. /**
  29652. * Update the current index buffer
  29653. * @param indices defines the source data
  29654. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29655. * @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)
  29656. * @returns the current mesh
  29657. */
  29658. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29659. /**
  29660. * Invert the geometry to move from a right handed system to a left handed one.
  29661. * @returns the current mesh
  29662. */
  29663. toLeftHanded(): Mesh;
  29664. /** @hidden */
  29665. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29666. /** @hidden */
  29667. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29668. /**
  29669. * Registers for this mesh a javascript function called just before the rendering process
  29670. * @param func defines the function to call before rendering this mesh
  29671. * @returns the current mesh
  29672. */
  29673. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29674. /**
  29675. * Disposes a previously registered javascript function called before the rendering
  29676. * @param func defines the function to remove
  29677. * @returns the current mesh
  29678. */
  29679. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29680. /**
  29681. * Registers for this mesh a javascript function called just after the rendering is complete
  29682. * @param func defines the function to call after rendering this mesh
  29683. * @returns the current mesh
  29684. */
  29685. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29686. /**
  29687. * Disposes a previously registered javascript function called after the rendering.
  29688. * @param func defines the function to remove
  29689. * @returns the current mesh
  29690. */
  29691. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29692. /** @hidden */
  29693. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29694. /** @hidden */
  29695. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29696. /** @hidden */
  29697. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29698. /** @hidden */
  29699. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29700. /** @hidden */
  29701. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29702. /** @hidden */
  29703. _rebuild(): void;
  29704. /** @hidden */
  29705. _freeze(): void;
  29706. /** @hidden */
  29707. _unFreeze(): void;
  29708. /**
  29709. * 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
  29710. * @param subMesh defines the subMesh to render
  29711. * @param enableAlphaMode defines if alpha mode can be changed
  29712. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29713. * @returns the current mesh
  29714. */
  29715. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29716. private _onBeforeDraw;
  29717. /**
  29718. * Renormalize the mesh and patch it up if there are no weights
  29719. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29720. * However in the case of zero weights then we set just a single influence to 1.
  29721. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29722. */
  29723. cleanMatrixWeights(): void;
  29724. private normalizeSkinFourWeights;
  29725. private normalizeSkinWeightsAndExtra;
  29726. /**
  29727. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29728. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29729. * the user know there was an issue with importing the mesh
  29730. * @returns a validation object with skinned, valid and report string
  29731. */
  29732. validateSkinning(): {
  29733. skinned: boolean;
  29734. valid: boolean;
  29735. report: string;
  29736. };
  29737. /** @hidden */
  29738. _checkDelayState(): Mesh;
  29739. private _queueLoad;
  29740. /**
  29741. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29742. * A mesh is in the frustum if its bounding box intersects the frustum
  29743. * @param frustumPlanes defines the frustum to test
  29744. * @returns true if the mesh is in the frustum planes
  29745. */
  29746. isInFrustum(frustumPlanes: Plane[]): boolean;
  29747. /**
  29748. * Sets the mesh material by the material or multiMaterial `id` property
  29749. * @param id is a string identifying the material or the multiMaterial
  29750. * @returns the current mesh
  29751. */
  29752. setMaterialByID(id: string): Mesh;
  29753. /**
  29754. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29755. * @returns an array of IAnimatable
  29756. */
  29757. getAnimatables(): IAnimatable[];
  29758. /**
  29759. * Modifies the mesh geometry according to the passed transformation matrix.
  29760. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29761. * The mesh normals are modified using the same transformation.
  29762. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29763. * @param transform defines the transform matrix to use
  29764. * @see https://doc.babylonjs.com/resources/baking_transformations
  29765. * @returns the current mesh
  29766. */
  29767. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29768. /**
  29769. * Modifies the mesh geometry according to its own current World Matrix.
  29770. * The mesh World Matrix is then reset.
  29771. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29772. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29773. * @see https://doc.babylonjs.com/resources/baking_transformations
  29774. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29775. * @returns the current mesh
  29776. */
  29777. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29778. /** @hidden */
  29779. get _positions(): Nullable<Vector3[]>;
  29780. /** @hidden */
  29781. _resetPointsArrayCache(): Mesh;
  29782. /** @hidden */
  29783. _generatePointsArray(): boolean;
  29784. /**
  29785. * Returns a new Mesh object generated from the current mesh properties.
  29786. * This method must not get confused with createInstance()
  29787. * @param name is a string, the name given to the new mesh
  29788. * @param newParent can be any Node object (default `null`)
  29789. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29790. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29791. * @returns a new mesh
  29792. */
  29793. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29794. /**
  29795. * Releases resources associated with this mesh.
  29796. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29797. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29798. */
  29799. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29800. /** @hidden */
  29801. _disposeInstanceSpecificData(): void;
  29802. /** @hidden */
  29803. _disposeThinInstanceSpecificData(): void;
  29804. /**
  29805. * Modifies the mesh geometry according to a displacement map.
  29806. * 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.
  29807. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29808. * @param url is a string, the URL from the image file is to be downloaded.
  29809. * @param minHeight is the lower limit of the displacement.
  29810. * @param maxHeight is the upper limit of the displacement.
  29811. * @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.
  29812. * @param uvOffset is an optional vector2 used to offset UV.
  29813. * @param uvScale is an optional vector2 used to scale UV.
  29814. * @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.
  29815. * @returns the Mesh.
  29816. */
  29817. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29818. /**
  29819. * Modifies the mesh geometry according to a displacementMap buffer.
  29820. * 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.
  29821. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29822. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29823. * @param heightMapWidth is the width of the buffer image.
  29824. * @param heightMapHeight is the height of the buffer image.
  29825. * @param minHeight is the lower limit of the displacement.
  29826. * @param maxHeight is the upper limit of the displacement.
  29827. * @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.
  29828. * @param uvOffset is an optional vector2 used to offset UV.
  29829. * @param uvScale is an optional vector2 used to scale UV.
  29830. * @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.
  29831. * @returns the Mesh.
  29832. */
  29833. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29834. /**
  29835. * Modify the mesh to get a flat shading rendering.
  29836. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29837. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29838. * @returns current mesh
  29839. */
  29840. convertToFlatShadedMesh(): Mesh;
  29841. /**
  29842. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29843. * In other words, more vertices, no more indices and a single bigger VBO.
  29844. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29845. * @returns current mesh
  29846. */
  29847. convertToUnIndexedMesh(): Mesh;
  29848. /**
  29849. * Inverses facet orientations.
  29850. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29851. * @param flipNormals will also inverts the normals
  29852. * @returns current mesh
  29853. */
  29854. flipFaces(flipNormals?: boolean): Mesh;
  29855. /**
  29856. * Increase the number of facets and hence vertices in a mesh
  29857. * Vertex normals are interpolated from existing vertex normals
  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 numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29860. */
  29861. increaseVertices(numberPerEdge: number): void;
  29862. /**
  29863. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29864. * This will undo any application of covertToFlatShadedMesh
  29865. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29866. */
  29867. forceSharedVertices(): void;
  29868. /** @hidden */
  29869. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29870. /** @hidden */
  29871. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29872. /**
  29873. * Creates a new InstancedMesh object from the mesh model.
  29874. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29875. * @param name defines the name of the new instance
  29876. * @returns a new InstancedMesh
  29877. */
  29878. createInstance(name: string): InstancedMesh;
  29879. /**
  29880. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29881. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29882. * @returns the current mesh
  29883. */
  29884. synchronizeInstances(): Mesh;
  29885. /**
  29886. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29887. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29888. * This should be used together with the simplification to avoid disappearing triangles.
  29889. * @param successCallback an optional success callback to be called after the optimization finished.
  29890. * @returns the current mesh
  29891. */
  29892. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29893. /**
  29894. * Serialize current mesh
  29895. * @param serializationObject defines the object which will receive the serialization data
  29896. */
  29897. serialize(serializationObject: any): void;
  29898. /** @hidden */
  29899. _syncGeometryWithMorphTargetManager(): void;
  29900. /** @hidden */
  29901. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29902. /**
  29903. * Returns a new Mesh object parsed from the source provided.
  29904. * @param parsedMesh is the source
  29905. * @param scene defines the hosting scene
  29906. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29907. * @returns a new Mesh
  29908. */
  29909. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29910. /**
  29911. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29912. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29913. * @param name defines the name of the mesh to create
  29914. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29915. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29916. * @param closePath creates a seam between the first and the last points of each path of the path array
  29917. * @param offset is taken in account only if the `pathArray` is containing a single path
  29918. * @param scene defines the hosting scene
  29919. * @param updatable defines if the mesh must be flagged as updatable
  29920. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29921. * @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)
  29922. * @returns a new Mesh
  29923. */
  29924. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29925. /**
  29926. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29927. * @param name defines the name of the mesh to create
  29928. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29929. * @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
  29930. * @param scene defines the hosting scene
  29931. * @param updatable defines if the mesh must be flagged as updatable
  29932. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29933. * @returns a new Mesh
  29934. */
  29935. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29936. /**
  29937. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29938. * @param name defines the name of the mesh to create
  29939. * @param size sets the size (float) of each box side (default 1)
  29940. * @param scene defines the hosting scene
  29941. * @param updatable defines if the mesh must be flagged as updatable
  29942. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29943. * @returns a new Mesh
  29944. */
  29945. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29946. /**
  29947. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29948. * @param name defines the name of the mesh to create
  29949. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29950. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29951. * @param scene defines the hosting scene
  29952. * @param updatable defines if the mesh must be flagged as updatable
  29953. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29954. * @returns a new Mesh
  29955. */
  29956. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29957. /**
  29958. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29959. * @param name defines the name of the mesh to create
  29960. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29961. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29962. * @param scene defines the hosting scene
  29963. * @returns a new Mesh
  29964. */
  29965. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29966. /**
  29967. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29968. * @param name defines the name of the mesh to create
  29969. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29970. * @param diameterTop set the top cap diameter (floats, default 1)
  29971. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29972. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29973. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29974. * @param scene defines the hosting scene
  29975. * @param updatable defines if the mesh must be flagged as updatable
  29976. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29977. * @returns a new Mesh
  29978. */
  29979. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29980. /**
  29981. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29982. * @param name defines the name of the mesh to create
  29983. * @param diameter sets the diameter size (float) of the torus (default 1)
  29984. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29985. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29986. * @param scene defines the hosting scene
  29987. * @param updatable defines if the mesh must be flagged as updatable
  29988. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29989. * @returns a new Mesh
  29990. */
  29991. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29992. /**
  29993. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  29994. * @param name defines the name of the mesh to create
  29995. * @param radius sets the global radius size (float) of the torus knot (default 2)
  29996. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  29997. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  29998. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  29999. * @param p the number of windings on X axis (positive integers, default 2)
  30000. * @param q the number of windings on Y axis (positive integers, default 3)
  30001. * @param scene defines the hosting scene
  30002. * @param updatable defines if the mesh must be flagged as updatable
  30003. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30004. * @returns a new Mesh
  30005. */
  30006. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30007. /**
  30008. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30009. * @param name defines the name of the mesh to create
  30010. * @param points is an array successive Vector3
  30011. * @param scene defines the hosting scene
  30012. * @param updatable defines if the mesh must be flagged as updatable
  30013. * @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).
  30014. * @returns a new Mesh
  30015. */
  30016. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30017. /**
  30018. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30019. * @param name defines the name of the mesh to create
  30020. * @param points is an array successive Vector3
  30021. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30022. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30023. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30024. * @param scene defines the hosting scene
  30025. * @param updatable defines if the mesh must be flagged as updatable
  30026. * @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)
  30027. * @returns a new Mesh
  30028. */
  30029. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30030. /**
  30031. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30032. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30033. * 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.
  30034. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30035. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30036. * Remember you can only change the shape positions, not their number when updating a polygon.
  30037. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30038. * @param name defines the name of the mesh to create
  30039. * @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
  30040. * @param scene defines the hosting scene
  30041. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30042. * @param updatable defines if the mesh must be flagged as updatable
  30043. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30044. * @param earcutInjection can be used to inject your own earcut reference
  30045. * @returns a new Mesh
  30046. */
  30047. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30048. /**
  30049. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30050. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30051. * @param name defines the name of the mesh to create
  30052. * @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
  30053. * @param depth defines the height of extrusion
  30054. * @param scene defines the hosting scene
  30055. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30056. * @param updatable defines if the mesh must be flagged as updatable
  30057. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30058. * @param earcutInjection can be used to inject your own earcut reference
  30059. * @returns a new Mesh
  30060. */
  30061. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30062. /**
  30063. * Creates an extruded shape mesh.
  30064. * 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
  30065. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30066. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30067. * @param name defines the name of the mesh to create
  30068. * @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
  30069. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30070. * @param scale is the value to scale the shape
  30071. * @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
  30072. * @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
  30073. * @param scene defines the hosting scene
  30074. * @param updatable defines if the mesh must be flagged as updatable
  30075. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30076. * @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)
  30077. * @returns a new Mesh
  30078. */
  30079. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30080. /**
  30081. * Creates an custom extruded shape mesh.
  30082. * The custom extrusion is a parametric shape.
  30083. * It has no predefined shape. Its final shape will depend on the input parameters.
  30084. * Please consider using the same method from the MeshBuilder class instead
  30085. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30086. * @param name defines the name of the mesh to create
  30087. * @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
  30088. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30089. * @param scaleFunction is a custom Javascript function called on each path point
  30090. * @param rotationFunction is a custom Javascript function called on each path point
  30091. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30092. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30093. * @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
  30094. * @param scene defines the hosting scene
  30095. * @param updatable defines if the mesh must be flagged as updatable
  30096. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30097. * @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)
  30098. * @returns a new Mesh
  30099. */
  30100. 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;
  30101. /**
  30102. * Creates lathe mesh.
  30103. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30104. * Please consider using the same method from the MeshBuilder class instead
  30105. * @param name defines the name of the mesh to create
  30106. * @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
  30107. * @param radius is the radius value of the lathe
  30108. * @param tessellation is the side number of the lathe.
  30109. * @param scene defines the hosting scene
  30110. * @param updatable defines if the mesh must be flagged as updatable
  30111. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30112. * @returns a new Mesh
  30113. */
  30114. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30115. /**
  30116. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30117. * @param name defines the name of the mesh to create
  30118. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30119. * @param scene defines the hosting scene
  30120. * @param updatable defines if the mesh must be flagged as updatable
  30121. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30122. * @returns a new Mesh
  30123. */
  30124. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30125. /**
  30126. * Creates a ground mesh.
  30127. * Please consider using the same method from the MeshBuilder class instead
  30128. * @param name defines the name of the mesh to create
  30129. * @param width set the width of the ground
  30130. * @param height set the height of the ground
  30131. * @param subdivisions sets the number of subdivisions per side
  30132. * @param scene defines the hosting scene
  30133. * @param updatable defines if the mesh must be flagged as updatable
  30134. * @returns a new Mesh
  30135. */
  30136. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30137. /**
  30138. * Creates a tiled ground mesh.
  30139. * Please consider using the same method from the MeshBuilder class instead
  30140. * @param name defines the name of the mesh to create
  30141. * @param xmin set the ground minimum X coordinate
  30142. * @param zmin set the ground minimum Y coordinate
  30143. * @param xmax set the ground maximum X coordinate
  30144. * @param zmax set the ground maximum Z coordinate
  30145. * @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
  30146. * @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
  30147. * @param scene defines the hosting scene
  30148. * @param updatable defines if the mesh must be flagged as updatable
  30149. * @returns a new Mesh
  30150. */
  30151. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30152. w: number;
  30153. h: number;
  30154. }, precision: {
  30155. w: number;
  30156. h: number;
  30157. }, scene: Scene, updatable?: boolean): Mesh;
  30158. /**
  30159. * Creates a ground mesh from a height map.
  30160. * Please consider using the same method from the MeshBuilder class instead
  30161. * @see https://doc.babylonjs.com/babylon101/height_map
  30162. * @param name defines the name of the mesh to create
  30163. * @param url sets the URL of the height map image resource
  30164. * @param width set the ground width size
  30165. * @param height set the ground height size
  30166. * @param subdivisions sets the number of subdivision per side
  30167. * @param minHeight is the minimum altitude on the ground
  30168. * @param maxHeight is the maximum altitude on the ground
  30169. * @param scene defines the hosting scene
  30170. * @param updatable defines if the mesh must be flagged as updatable
  30171. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30172. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30173. * @returns a new Mesh
  30174. */
  30175. 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;
  30176. /**
  30177. * Creates a tube mesh.
  30178. * The tube is a parametric shape.
  30179. * It has no predefined shape. Its final shape will depend on the input parameters.
  30180. * Please consider using the same method from the MeshBuilder class instead
  30181. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30182. * @param name defines the name of the mesh to create
  30183. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30184. * @param radius sets the tube radius size
  30185. * @param tessellation is the number of sides on the tubular surface
  30186. * @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
  30187. * @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
  30188. * @param scene defines the hosting scene
  30189. * @param updatable defines if the mesh must be flagged as updatable
  30190. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30191. * @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)
  30192. * @returns a new Mesh
  30193. */
  30194. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30195. (i: number, distance: number): number;
  30196. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30197. /**
  30198. * Creates a polyhedron mesh.
  30199. * Please consider using the same method from the MeshBuilder class instead.
  30200. * * 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
  30201. * * The parameter `size` (positive float, default 1) sets the polygon size
  30202. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30203. * * 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`
  30204. * * 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
  30205. * * 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)`)
  30206. * * 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
  30207. * * 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
  30208. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30209. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30210. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30211. * @param name defines the name of the mesh to create
  30212. * @param options defines the options used to create the mesh
  30213. * @param scene defines the hosting scene
  30214. * @returns a new Mesh
  30215. */
  30216. static CreatePolyhedron(name: string, options: {
  30217. type?: number;
  30218. size?: number;
  30219. sizeX?: number;
  30220. sizeY?: number;
  30221. sizeZ?: number;
  30222. custom?: any;
  30223. faceUV?: Vector4[];
  30224. faceColors?: Color4[];
  30225. updatable?: boolean;
  30226. sideOrientation?: number;
  30227. }, scene: Scene): Mesh;
  30228. /**
  30229. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30230. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30231. * * 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`)
  30232. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30233. * * 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
  30234. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30235. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30236. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30237. * @param name defines the name of the mesh
  30238. * @param options defines the options used to create the mesh
  30239. * @param scene defines the hosting scene
  30240. * @returns a new Mesh
  30241. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30242. */
  30243. static CreateIcoSphere(name: string, options: {
  30244. radius?: number;
  30245. flat?: boolean;
  30246. subdivisions?: number;
  30247. sideOrientation?: number;
  30248. updatable?: boolean;
  30249. }, scene: Scene): Mesh;
  30250. /**
  30251. * Creates a decal mesh.
  30252. * Please consider using the same method from the MeshBuilder class instead.
  30253. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30254. * @param name defines the name of the mesh
  30255. * @param sourceMesh defines the mesh receiving the decal
  30256. * @param position sets the position of the decal in world coordinates
  30257. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30258. * @param size sets the decal scaling
  30259. * @param angle sets the angle to rotate the decal
  30260. * @returns a new Mesh
  30261. */
  30262. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30263. /**
  30264. * Prepare internal position array for software CPU skinning
  30265. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30266. */
  30267. setPositionsForCPUSkinning(): Float32Array;
  30268. /**
  30269. * Prepare internal normal array for software CPU skinning
  30270. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30271. */
  30272. setNormalsForCPUSkinning(): Float32Array;
  30273. /**
  30274. * Updates the vertex buffer by applying transformation from the bones
  30275. * @param skeleton defines the skeleton to apply to current mesh
  30276. * @returns the current mesh
  30277. */
  30278. applySkeleton(skeleton: Skeleton): Mesh;
  30279. /**
  30280. * 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
  30281. * @param meshes defines the list of meshes to scan
  30282. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30283. */
  30284. static MinMax(meshes: AbstractMesh[]): {
  30285. min: Vector3;
  30286. max: Vector3;
  30287. };
  30288. /**
  30289. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30290. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30291. * @returns a vector3
  30292. */
  30293. static Center(meshesOrMinMaxVector: {
  30294. min: Vector3;
  30295. max: Vector3;
  30296. } | AbstractMesh[]): Vector3;
  30297. /**
  30298. * Merge the array of meshes into a single mesh for performance reasons.
  30299. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30300. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30301. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30302. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30303. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30304. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30305. * @returns a new mesh
  30306. */
  30307. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30308. /** @hidden */
  30309. addInstance(instance: InstancedMesh): void;
  30310. /** @hidden */
  30311. removeInstance(instance: InstancedMesh): void;
  30312. }
  30313. }
  30314. declare module "babylonjs/Cameras/camera" {
  30315. import { SmartArray } from "babylonjs/Misc/smartArray";
  30316. import { Observable } from "babylonjs/Misc/observable";
  30317. import { Nullable } from "babylonjs/types";
  30318. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30319. import { Scene } from "babylonjs/scene";
  30320. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30321. import { Node } from "babylonjs/node";
  30322. import { Mesh } from "babylonjs/Meshes/mesh";
  30323. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30324. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30325. import { Viewport } from "babylonjs/Maths/math.viewport";
  30326. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30327. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30328. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30329. import { Ray } from "babylonjs/Culling/ray";
  30330. /**
  30331. * This is the base class of all the camera used in the application.
  30332. * @see https://doc.babylonjs.com/features/cameras
  30333. */
  30334. export class Camera extends Node {
  30335. /** @hidden */
  30336. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30337. /**
  30338. * This is the default projection mode used by the cameras.
  30339. * It helps recreating a feeling of perspective and better appreciate depth.
  30340. * This is the best way to simulate real life cameras.
  30341. */
  30342. static readonly PERSPECTIVE_CAMERA: number;
  30343. /**
  30344. * This helps creating camera with an orthographic mode.
  30345. * 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.
  30346. */
  30347. static readonly ORTHOGRAPHIC_CAMERA: number;
  30348. /**
  30349. * This is the default FOV mode for perspective cameras.
  30350. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30351. */
  30352. static readonly FOVMODE_VERTICAL_FIXED: number;
  30353. /**
  30354. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30355. */
  30356. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30357. /**
  30358. * This specifies ther is no need for a camera rig.
  30359. * Basically only one eye is rendered corresponding to the camera.
  30360. */
  30361. static readonly RIG_MODE_NONE: number;
  30362. /**
  30363. * Simulates a camera Rig with one blue eye and one red eye.
  30364. * This can be use with 3d blue and red glasses.
  30365. */
  30366. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30367. /**
  30368. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30369. */
  30370. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30371. /**
  30372. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30373. */
  30374. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30375. /**
  30376. * Defines that both eyes of the camera will be rendered over under each other.
  30377. */
  30378. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30379. /**
  30380. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30381. */
  30382. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30383. /**
  30384. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30385. */
  30386. static readonly RIG_MODE_VR: number;
  30387. /**
  30388. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30389. */
  30390. static readonly RIG_MODE_WEBVR: number;
  30391. /**
  30392. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30393. */
  30394. static readonly RIG_MODE_CUSTOM: number;
  30395. /**
  30396. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30397. */
  30398. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30399. /**
  30400. * Define the input manager associated with the camera.
  30401. */
  30402. inputs: CameraInputsManager<Camera>;
  30403. /** @hidden */
  30404. _position: Vector3;
  30405. /**
  30406. * Define the current local position of the camera in the scene
  30407. */
  30408. get position(): Vector3;
  30409. set position(newPosition: Vector3);
  30410. /**
  30411. * The vector the camera should consider as up.
  30412. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30413. */
  30414. upVector: Vector3;
  30415. /**
  30416. * Define the current limit on the left side for an orthographic camera
  30417. * In scene unit
  30418. */
  30419. orthoLeft: Nullable<number>;
  30420. /**
  30421. * Define the current limit on the right side for an orthographic camera
  30422. * In scene unit
  30423. */
  30424. orthoRight: Nullable<number>;
  30425. /**
  30426. * Define the current limit on the bottom side for an orthographic camera
  30427. * In scene unit
  30428. */
  30429. orthoBottom: Nullable<number>;
  30430. /**
  30431. * Define the current limit on the top side for an orthographic camera
  30432. * In scene unit
  30433. */
  30434. orthoTop: Nullable<number>;
  30435. /**
  30436. * Field Of View is set in Radians. (default is 0.8)
  30437. */
  30438. fov: number;
  30439. /**
  30440. * Define the minimum distance the camera can see from.
  30441. * This is important to note that the depth buffer are not infinite and the closer it starts
  30442. * the more your scene might encounter depth fighting issue.
  30443. */
  30444. minZ: number;
  30445. /**
  30446. * Define the maximum distance the camera can see to.
  30447. * This is important to note that the depth buffer are not infinite and the further it end
  30448. * the more your scene might encounter depth fighting issue.
  30449. */
  30450. maxZ: number;
  30451. /**
  30452. * Define the default inertia of the camera.
  30453. * This helps giving a smooth feeling to the camera movement.
  30454. */
  30455. inertia: number;
  30456. /**
  30457. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30458. */
  30459. mode: number;
  30460. /**
  30461. * Define whether the camera is intermediate.
  30462. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30463. */
  30464. isIntermediate: boolean;
  30465. /**
  30466. * Define the viewport of the camera.
  30467. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30468. */
  30469. viewport: Viewport;
  30470. /**
  30471. * Restricts the camera to viewing objects with the same layerMask.
  30472. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30473. */
  30474. layerMask: number;
  30475. /**
  30476. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30477. */
  30478. fovMode: number;
  30479. /**
  30480. * Rig mode of the camera.
  30481. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30482. * This is normally controlled byt the camera themselves as internal use.
  30483. */
  30484. cameraRigMode: number;
  30485. /**
  30486. * Defines the distance between both "eyes" in case of a RIG
  30487. */
  30488. interaxialDistance: number;
  30489. /**
  30490. * Defines if stereoscopic rendering is done side by side or over under.
  30491. */
  30492. isStereoscopicSideBySide: boolean;
  30493. /**
  30494. * 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
  30495. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30496. * else in the scene. (Eg. security camera)
  30497. *
  30498. * 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)
  30499. */
  30500. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30501. /**
  30502. * When set, the camera will render to this render target instead of the default canvas
  30503. *
  30504. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30505. */
  30506. outputRenderTarget: Nullable<RenderTargetTexture>;
  30507. /**
  30508. * Observable triggered when the camera view matrix has changed.
  30509. */
  30510. onViewMatrixChangedObservable: Observable<Camera>;
  30511. /**
  30512. * Observable triggered when the camera Projection matrix has changed.
  30513. */
  30514. onProjectionMatrixChangedObservable: Observable<Camera>;
  30515. /**
  30516. * Observable triggered when the inputs have been processed.
  30517. */
  30518. onAfterCheckInputsObservable: Observable<Camera>;
  30519. /**
  30520. * Observable triggered when reset has been called and applied to the camera.
  30521. */
  30522. onRestoreStateObservable: Observable<Camera>;
  30523. /**
  30524. * Is this camera a part of a rig system?
  30525. */
  30526. isRigCamera: boolean;
  30527. /**
  30528. * If isRigCamera set to true this will be set with the parent camera.
  30529. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30530. */
  30531. rigParent?: Camera;
  30532. /** @hidden */
  30533. _cameraRigParams: any;
  30534. /** @hidden */
  30535. _rigCameras: Camera[];
  30536. /** @hidden */
  30537. _rigPostProcess: Nullable<PostProcess>;
  30538. protected _webvrViewMatrix: Matrix;
  30539. /** @hidden */
  30540. _skipRendering: boolean;
  30541. /** @hidden */
  30542. _projectionMatrix: Matrix;
  30543. /** @hidden */
  30544. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30545. /** @hidden */
  30546. _activeMeshes: SmartArray<AbstractMesh>;
  30547. protected _globalPosition: Vector3;
  30548. /** @hidden */
  30549. _computedViewMatrix: Matrix;
  30550. private _doNotComputeProjectionMatrix;
  30551. private _transformMatrix;
  30552. private _frustumPlanes;
  30553. private _refreshFrustumPlanes;
  30554. private _storedFov;
  30555. private _stateStored;
  30556. /**
  30557. * Instantiates a new camera object.
  30558. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30559. * @see https://doc.babylonjs.com/features/cameras
  30560. * @param name Defines the name of the camera in the scene
  30561. * @param position Defines the position of the camera
  30562. * @param scene Defines the scene the camera belongs too
  30563. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30564. */
  30565. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30566. /**
  30567. * Store current camera state (fov, position, etc..)
  30568. * @returns the camera
  30569. */
  30570. storeState(): Camera;
  30571. /**
  30572. * Restores the camera state values if it has been stored. You must call storeState() first
  30573. */
  30574. protected _restoreStateValues(): boolean;
  30575. /**
  30576. * Restored camera state. You must call storeState() first.
  30577. * @returns true if restored and false otherwise
  30578. */
  30579. restoreState(): boolean;
  30580. /**
  30581. * Gets the class name of the camera.
  30582. * @returns the class name
  30583. */
  30584. getClassName(): string;
  30585. /** @hidden */
  30586. readonly _isCamera: boolean;
  30587. /**
  30588. * Gets a string representation of the camera useful for debug purpose.
  30589. * @param fullDetails Defines that a more verboe level of logging is required
  30590. * @returns the string representation
  30591. */
  30592. toString(fullDetails?: boolean): string;
  30593. /**
  30594. * Gets the current world space position of the camera.
  30595. */
  30596. get globalPosition(): Vector3;
  30597. /**
  30598. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30599. * @returns the active meshe list
  30600. */
  30601. getActiveMeshes(): SmartArray<AbstractMesh>;
  30602. /**
  30603. * Check whether a mesh is part of the current active mesh list of the camera
  30604. * @param mesh Defines the mesh to check
  30605. * @returns true if active, false otherwise
  30606. */
  30607. isActiveMesh(mesh: Mesh): boolean;
  30608. /**
  30609. * Is this camera ready to be used/rendered
  30610. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30611. * @return true if the camera is ready
  30612. */
  30613. isReady(completeCheck?: boolean): boolean;
  30614. /** @hidden */
  30615. _initCache(): void;
  30616. /** @hidden */
  30617. _updateCache(ignoreParentClass?: boolean): void;
  30618. /** @hidden */
  30619. _isSynchronized(): boolean;
  30620. /** @hidden */
  30621. _isSynchronizedViewMatrix(): boolean;
  30622. /** @hidden */
  30623. _isSynchronizedProjectionMatrix(): boolean;
  30624. /**
  30625. * Attach the input controls to a specific dom element to get the input from.
  30626. * @param element Defines the element the controls should be listened from
  30627. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30628. */
  30629. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30630. /**
  30631. * Detach the current controls from the specified dom element.
  30632. * @param element Defines the element to stop listening the inputs from
  30633. */
  30634. detachControl(element: HTMLElement): void;
  30635. /**
  30636. * Update the camera state according to the different inputs gathered during the frame.
  30637. */
  30638. update(): void;
  30639. /** @hidden */
  30640. _checkInputs(): void;
  30641. /** @hidden */
  30642. get rigCameras(): Camera[];
  30643. /**
  30644. * Gets the post process used by the rig cameras
  30645. */
  30646. get rigPostProcess(): Nullable<PostProcess>;
  30647. /**
  30648. * Internal, gets the first post proces.
  30649. * @returns the first post process to be run on this camera.
  30650. */
  30651. _getFirstPostProcess(): Nullable<PostProcess>;
  30652. private _cascadePostProcessesToRigCams;
  30653. /**
  30654. * Attach a post process to the camera.
  30655. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30656. * @param postProcess The post process to attach to the camera
  30657. * @param insertAt The position of the post process in case several of them are in use in the scene
  30658. * @returns the position the post process has been inserted at
  30659. */
  30660. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30661. /**
  30662. * Detach a post process to the camera.
  30663. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30664. * @param postProcess The post process to detach from the camera
  30665. */
  30666. detachPostProcess(postProcess: PostProcess): void;
  30667. /**
  30668. * Gets the current world matrix of the camera
  30669. */
  30670. getWorldMatrix(): Matrix;
  30671. /** @hidden */
  30672. _getViewMatrix(): Matrix;
  30673. /**
  30674. * Gets the current view matrix of the camera.
  30675. * @param force forces the camera to recompute the matrix without looking at the cached state
  30676. * @returns the view matrix
  30677. */
  30678. getViewMatrix(force?: boolean): Matrix;
  30679. /**
  30680. * Freeze the projection matrix.
  30681. * It will prevent the cache check of the camera projection compute and can speed up perf
  30682. * if no parameter of the camera are meant to change
  30683. * @param projection Defines manually a projection if necessary
  30684. */
  30685. freezeProjectionMatrix(projection?: Matrix): void;
  30686. /**
  30687. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30688. */
  30689. unfreezeProjectionMatrix(): void;
  30690. /**
  30691. * Gets the current projection matrix of the camera.
  30692. * @param force forces the camera to recompute the matrix without looking at the cached state
  30693. * @returns the projection matrix
  30694. */
  30695. getProjectionMatrix(force?: boolean): Matrix;
  30696. /**
  30697. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30698. * @returns a Matrix
  30699. */
  30700. getTransformationMatrix(): Matrix;
  30701. private _updateFrustumPlanes;
  30702. /**
  30703. * Checks if a cullable object (mesh...) is in the camera frustum
  30704. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30705. * @param target The object to check
  30706. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30707. * @returns true if the object is in frustum otherwise false
  30708. */
  30709. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30710. /**
  30711. * Checks if a cullable object (mesh...) is in the camera frustum
  30712. * Unlike isInFrustum this cheks the full bounding box
  30713. * @param target The object to check
  30714. * @returns true if the object is in frustum otherwise false
  30715. */
  30716. isCompletelyInFrustum(target: ICullable): boolean;
  30717. /**
  30718. * Gets a ray in the forward direction from the camera.
  30719. * @param length Defines the length of the ray to create
  30720. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30721. * @param origin Defines the start point of the ray which defaults to the camera position
  30722. * @returns the forward ray
  30723. */
  30724. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30725. /**
  30726. * Gets a ray in the forward direction from the camera.
  30727. * @param refRay the ray to (re)use when setting the values
  30728. * @param length Defines the length of the ray to create
  30729. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30730. * @param origin Defines the start point of the ray which defaults to the camera position
  30731. * @returns the forward ray
  30732. */
  30733. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30734. /**
  30735. * Releases resources associated with this node.
  30736. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30737. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30738. */
  30739. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30740. /** @hidden */
  30741. _isLeftCamera: boolean;
  30742. /**
  30743. * Gets the left camera of a rig setup in case of Rigged Camera
  30744. */
  30745. get isLeftCamera(): boolean;
  30746. /** @hidden */
  30747. _isRightCamera: boolean;
  30748. /**
  30749. * Gets the right camera of a rig setup in case of Rigged Camera
  30750. */
  30751. get isRightCamera(): boolean;
  30752. /**
  30753. * Gets the left camera of a rig setup in case of Rigged Camera
  30754. */
  30755. get leftCamera(): Nullable<FreeCamera>;
  30756. /**
  30757. * Gets the right camera of a rig setup in case of Rigged Camera
  30758. */
  30759. get rightCamera(): Nullable<FreeCamera>;
  30760. /**
  30761. * Gets the left camera target of a rig setup in case of Rigged Camera
  30762. * @returns the target position
  30763. */
  30764. getLeftTarget(): Nullable<Vector3>;
  30765. /**
  30766. * Gets the right camera target of a rig setup in case of Rigged Camera
  30767. * @returns the target position
  30768. */
  30769. getRightTarget(): Nullable<Vector3>;
  30770. /**
  30771. * @hidden
  30772. */
  30773. setCameraRigMode(mode: number, rigParams: any): void;
  30774. /** @hidden */
  30775. static _setStereoscopicRigMode(camera: Camera): void;
  30776. /** @hidden */
  30777. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30778. /** @hidden */
  30779. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30780. /** @hidden */
  30781. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30782. /** @hidden */
  30783. _getVRProjectionMatrix(): Matrix;
  30784. protected _updateCameraRotationMatrix(): void;
  30785. protected _updateWebVRCameraRotationMatrix(): void;
  30786. /**
  30787. * This function MUST be overwritten by the different WebVR cameras available.
  30788. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30789. * @hidden
  30790. */
  30791. _getWebVRProjectionMatrix(): Matrix;
  30792. /**
  30793. * This function MUST be overwritten by the different WebVR cameras available.
  30794. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30795. * @hidden
  30796. */
  30797. _getWebVRViewMatrix(): Matrix;
  30798. /** @hidden */
  30799. setCameraRigParameter(name: string, value: any): void;
  30800. /**
  30801. * needs to be overridden by children so sub has required properties to be copied
  30802. * @hidden
  30803. */
  30804. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30805. /**
  30806. * May need to be overridden by children
  30807. * @hidden
  30808. */
  30809. _updateRigCameras(): void;
  30810. /** @hidden */
  30811. _setupInputs(): void;
  30812. /**
  30813. * Serialiaze the camera setup to a json represention
  30814. * @returns the JSON representation
  30815. */
  30816. serialize(): any;
  30817. /**
  30818. * Clones the current camera.
  30819. * @param name The cloned camera name
  30820. * @returns the cloned camera
  30821. */
  30822. clone(name: string): Camera;
  30823. /**
  30824. * Gets the direction of the camera relative to a given local axis.
  30825. * @param localAxis Defines the reference axis to provide a relative direction.
  30826. * @return the direction
  30827. */
  30828. getDirection(localAxis: Vector3): Vector3;
  30829. /**
  30830. * Returns the current camera absolute rotation
  30831. */
  30832. get absoluteRotation(): Quaternion;
  30833. /**
  30834. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30835. * @param localAxis Defines the reference axis to provide a relative direction.
  30836. * @param result Defines the vector to store the result in
  30837. */
  30838. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30839. /**
  30840. * Gets a camera constructor for a given camera type
  30841. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30842. * @param name The name of the camera the result will be able to instantiate
  30843. * @param scene The scene the result will construct the camera in
  30844. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30845. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30846. * @returns a factory method to construc the camera
  30847. */
  30848. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30849. /**
  30850. * Compute the world matrix of the camera.
  30851. * @returns the camera world matrix
  30852. */
  30853. computeWorldMatrix(): Matrix;
  30854. /**
  30855. * Parse a JSON and creates the camera from the parsed information
  30856. * @param parsedCamera The JSON to parse
  30857. * @param scene The scene to instantiate the camera in
  30858. * @returns the newly constructed camera
  30859. */
  30860. static Parse(parsedCamera: any, scene: Scene): Camera;
  30861. }
  30862. }
  30863. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30864. import { Nullable } from "babylonjs/types";
  30865. import { Scene } from "babylonjs/scene";
  30866. import { Vector4 } from "babylonjs/Maths/math.vector";
  30867. import { Mesh } from "babylonjs/Meshes/mesh";
  30868. /**
  30869. * Class containing static functions to help procedurally build meshes
  30870. */
  30871. export class DiscBuilder {
  30872. /**
  30873. * Creates a plane polygonal mesh. By default, this is a disc
  30874. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30875. * * 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
  30876. * * 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
  30877. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30878. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30879. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30880. * @param name defines the name of the mesh
  30881. * @param options defines the options used to create the mesh
  30882. * @param scene defines the hosting scene
  30883. * @returns the plane polygonal mesh
  30884. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30885. */
  30886. static CreateDisc(name: string, options: {
  30887. radius?: number;
  30888. tessellation?: number;
  30889. arc?: number;
  30890. updatable?: boolean;
  30891. sideOrientation?: number;
  30892. frontUVs?: Vector4;
  30893. backUVs?: Vector4;
  30894. }, scene?: Nullable<Scene>): Mesh;
  30895. }
  30896. }
  30897. declare module "babylonjs/Materials/fresnelParameters" {
  30898. import { DeepImmutable } from "babylonjs/types";
  30899. import { Color3 } from "babylonjs/Maths/math.color";
  30900. /**
  30901. * Options to be used when creating a FresnelParameters.
  30902. */
  30903. export type IFresnelParametersCreationOptions = {
  30904. /**
  30905. * Define the color used on edges (grazing angle)
  30906. */
  30907. leftColor?: Color3;
  30908. /**
  30909. * Define the color used on center
  30910. */
  30911. rightColor?: Color3;
  30912. /**
  30913. * Define bias applied to computed fresnel term
  30914. */
  30915. bias?: number;
  30916. /**
  30917. * Defined the power exponent applied to fresnel term
  30918. */
  30919. power?: number;
  30920. /**
  30921. * Define if the fresnel effect is enable or not.
  30922. */
  30923. isEnabled?: boolean;
  30924. };
  30925. /**
  30926. * Serialized format for FresnelParameters.
  30927. */
  30928. export type IFresnelParametersSerialized = {
  30929. /**
  30930. * Define the color used on edges (grazing angle) [as an array]
  30931. */
  30932. leftColor: number[];
  30933. /**
  30934. * Define the color used on center [as an array]
  30935. */
  30936. rightColor: number[];
  30937. /**
  30938. * Define bias applied to computed fresnel term
  30939. */
  30940. bias: number;
  30941. /**
  30942. * Defined the power exponent applied to fresnel term
  30943. */
  30944. power?: number;
  30945. /**
  30946. * Define if the fresnel effect is enable or not.
  30947. */
  30948. isEnabled: boolean;
  30949. };
  30950. /**
  30951. * This represents all the required information to add a fresnel effect on a material:
  30952. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30953. */
  30954. export class FresnelParameters {
  30955. private _isEnabled;
  30956. /**
  30957. * Define if the fresnel effect is enable or not.
  30958. */
  30959. get isEnabled(): boolean;
  30960. set isEnabled(value: boolean);
  30961. /**
  30962. * Define the color used on edges (grazing angle)
  30963. */
  30964. leftColor: Color3;
  30965. /**
  30966. * Define the color used on center
  30967. */
  30968. rightColor: Color3;
  30969. /**
  30970. * Define bias applied to computed fresnel term
  30971. */
  30972. bias: number;
  30973. /**
  30974. * Defined the power exponent applied to fresnel term
  30975. */
  30976. power: number;
  30977. /**
  30978. * Creates a new FresnelParameters object.
  30979. *
  30980. * @param options provide your own settings to optionally to override defaults
  30981. */
  30982. constructor(options?: IFresnelParametersCreationOptions);
  30983. /**
  30984. * Clones the current fresnel and its valuues
  30985. * @returns a clone fresnel configuration
  30986. */
  30987. clone(): FresnelParameters;
  30988. /**
  30989. * Determines equality between FresnelParameters objects
  30990. * @param otherFresnelParameters defines the second operand
  30991. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  30992. */
  30993. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  30994. /**
  30995. * Serializes the current fresnel parameters to a JSON representation.
  30996. * @return the JSON serialization
  30997. */
  30998. serialize(): IFresnelParametersSerialized;
  30999. /**
  31000. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31001. * @param parsedFresnelParameters Define the JSON representation
  31002. * @returns the parsed parameters
  31003. */
  31004. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31005. }
  31006. }
  31007. declare module "babylonjs/Materials/materialFlags" {
  31008. /**
  31009. * This groups all the flags used to control the materials channel.
  31010. */
  31011. export class MaterialFlags {
  31012. private static _DiffuseTextureEnabled;
  31013. /**
  31014. * Are diffuse textures enabled in the application.
  31015. */
  31016. static get DiffuseTextureEnabled(): boolean;
  31017. static set DiffuseTextureEnabled(value: boolean);
  31018. private static _DetailTextureEnabled;
  31019. /**
  31020. * Are detail textures enabled in the application.
  31021. */
  31022. static get DetailTextureEnabled(): boolean;
  31023. static set DetailTextureEnabled(value: boolean);
  31024. private static _AmbientTextureEnabled;
  31025. /**
  31026. * Are ambient textures enabled in the application.
  31027. */
  31028. static get AmbientTextureEnabled(): boolean;
  31029. static set AmbientTextureEnabled(value: boolean);
  31030. private static _OpacityTextureEnabled;
  31031. /**
  31032. * Are opacity textures enabled in the application.
  31033. */
  31034. static get OpacityTextureEnabled(): boolean;
  31035. static set OpacityTextureEnabled(value: boolean);
  31036. private static _ReflectionTextureEnabled;
  31037. /**
  31038. * Are reflection textures enabled in the application.
  31039. */
  31040. static get ReflectionTextureEnabled(): boolean;
  31041. static set ReflectionTextureEnabled(value: boolean);
  31042. private static _EmissiveTextureEnabled;
  31043. /**
  31044. * Are emissive textures enabled in the application.
  31045. */
  31046. static get EmissiveTextureEnabled(): boolean;
  31047. static set EmissiveTextureEnabled(value: boolean);
  31048. private static _SpecularTextureEnabled;
  31049. /**
  31050. * Are specular textures enabled in the application.
  31051. */
  31052. static get SpecularTextureEnabled(): boolean;
  31053. static set SpecularTextureEnabled(value: boolean);
  31054. private static _BumpTextureEnabled;
  31055. /**
  31056. * Are bump textures enabled in the application.
  31057. */
  31058. static get BumpTextureEnabled(): boolean;
  31059. static set BumpTextureEnabled(value: boolean);
  31060. private static _LightmapTextureEnabled;
  31061. /**
  31062. * Are lightmap textures enabled in the application.
  31063. */
  31064. static get LightmapTextureEnabled(): boolean;
  31065. static set LightmapTextureEnabled(value: boolean);
  31066. private static _RefractionTextureEnabled;
  31067. /**
  31068. * Are refraction textures enabled in the application.
  31069. */
  31070. static get RefractionTextureEnabled(): boolean;
  31071. static set RefractionTextureEnabled(value: boolean);
  31072. private static _ColorGradingTextureEnabled;
  31073. /**
  31074. * Are color grading textures enabled in the application.
  31075. */
  31076. static get ColorGradingTextureEnabled(): boolean;
  31077. static set ColorGradingTextureEnabled(value: boolean);
  31078. private static _FresnelEnabled;
  31079. /**
  31080. * Are fresnels enabled in the application.
  31081. */
  31082. static get FresnelEnabled(): boolean;
  31083. static set FresnelEnabled(value: boolean);
  31084. private static _ClearCoatTextureEnabled;
  31085. /**
  31086. * Are clear coat textures enabled in the application.
  31087. */
  31088. static get ClearCoatTextureEnabled(): boolean;
  31089. static set ClearCoatTextureEnabled(value: boolean);
  31090. private static _ClearCoatBumpTextureEnabled;
  31091. /**
  31092. * Are clear coat bump textures enabled in the application.
  31093. */
  31094. static get ClearCoatBumpTextureEnabled(): boolean;
  31095. static set ClearCoatBumpTextureEnabled(value: boolean);
  31096. private static _ClearCoatTintTextureEnabled;
  31097. /**
  31098. * Are clear coat tint textures enabled in the application.
  31099. */
  31100. static get ClearCoatTintTextureEnabled(): boolean;
  31101. static set ClearCoatTintTextureEnabled(value: boolean);
  31102. private static _SheenTextureEnabled;
  31103. /**
  31104. * Are sheen textures enabled in the application.
  31105. */
  31106. static get SheenTextureEnabled(): boolean;
  31107. static set SheenTextureEnabled(value: boolean);
  31108. private static _AnisotropicTextureEnabled;
  31109. /**
  31110. * Are anisotropic textures enabled in the application.
  31111. */
  31112. static get AnisotropicTextureEnabled(): boolean;
  31113. static set AnisotropicTextureEnabled(value: boolean);
  31114. private static _ThicknessTextureEnabled;
  31115. /**
  31116. * Are thickness textures enabled in the application.
  31117. */
  31118. static get ThicknessTextureEnabled(): boolean;
  31119. static set ThicknessTextureEnabled(value: boolean);
  31120. }
  31121. }
  31122. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31123. /** @hidden */
  31124. export var defaultFragmentDeclaration: {
  31125. name: string;
  31126. shader: string;
  31127. };
  31128. }
  31129. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31130. /** @hidden */
  31131. export var defaultUboDeclaration: {
  31132. name: string;
  31133. shader: string;
  31134. };
  31135. }
  31136. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31137. /** @hidden */
  31138. export var prePassDeclaration: {
  31139. name: string;
  31140. shader: string;
  31141. };
  31142. }
  31143. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31144. /** @hidden */
  31145. export var lightFragmentDeclaration: {
  31146. name: string;
  31147. shader: string;
  31148. };
  31149. }
  31150. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31151. /** @hidden */
  31152. export var lightUboDeclaration: {
  31153. name: string;
  31154. shader: string;
  31155. };
  31156. }
  31157. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31158. /** @hidden */
  31159. export var lightsFragmentFunctions: {
  31160. name: string;
  31161. shader: string;
  31162. };
  31163. }
  31164. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31165. /** @hidden */
  31166. export var shadowsFragmentFunctions: {
  31167. name: string;
  31168. shader: string;
  31169. };
  31170. }
  31171. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31172. /** @hidden */
  31173. export var fresnelFunction: {
  31174. name: string;
  31175. shader: string;
  31176. };
  31177. }
  31178. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31179. /** @hidden */
  31180. export var bumpFragmentMainFunctions: {
  31181. name: string;
  31182. shader: string;
  31183. };
  31184. }
  31185. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31186. /** @hidden */
  31187. export var bumpFragmentFunctions: {
  31188. name: string;
  31189. shader: string;
  31190. };
  31191. }
  31192. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31193. /** @hidden */
  31194. export var logDepthDeclaration: {
  31195. name: string;
  31196. shader: string;
  31197. };
  31198. }
  31199. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31200. /** @hidden */
  31201. export var bumpFragment: {
  31202. name: string;
  31203. shader: string;
  31204. };
  31205. }
  31206. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31207. /** @hidden */
  31208. export var depthPrePass: {
  31209. name: string;
  31210. shader: string;
  31211. };
  31212. }
  31213. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31214. /** @hidden */
  31215. export var lightFragment: {
  31216. name: string;
  31217. shader: string;
  31218. };
  31219. }
  31220. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31221. /** @hidden */
  31222. export var logDepthFragment: {
  31223. name: string;
  31224. shader: string;
  31225. };
  31226. }
  31227. declare module "babylonjs/Shaders/default.fragment" {
  31228. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31229. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31230. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31231. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31232. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31233. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31234. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31235. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31236. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31237. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31238. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31239. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31240. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31241. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31242. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31243. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31244. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31245. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31246. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31247. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31248. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31249. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31250. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31251. /** @hidden */
  31252. export var defaultPixelShader: {
  31253. name: string;
  31254. shader: string;
  31255. };
  31256. }
  31257. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31258. /** @hidden */
  31259. export var defaultVertexDeclaration: {
  31260. name: string;
  31261. shader: string;
  31262. };
  31263. }
  31264. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31265. /** @hidden */
  31266. export var bumpVertexDeclaration: {
  31267. name: string;
  31268. shader: string;
  31269. };
  31270. }
  31271. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31272. /** @hidden */
  31273. export var bumpVertex: {
  31274. name: string;
  31275. shader: string;
  31276. };
  31277. }
  31278. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31279. /** @hidden */
  31280. export var fogVertex: {
  31281. name: string;
  31282. shader: string;
  31283. };
  31284. }
  31285. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31286. /** @hidden */
  31287. export var shadowsVertex: {
  31288. name: string;
  31289. shader: string;
  31290. };
  31291. }
  31292. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31293. /** @hidden */
  31294. export var pointCloudVertex: {
  31295. name: string;
  31296. shader: string;
  31297. };
  31298. }
  31299. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31300. /** @hidden */
  31301. export var logDepthVertex: {
  31302. name: string;
  31303. shader: string;
  31304. };
  31305. }
  31306. declare module "babylonjs/Shaders/default.vertex" {
  31307. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31308. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31309. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31310. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31311. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31312. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31313. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31314. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31315. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31316. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31317. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31319. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31320. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31321. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31322. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31323. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31324. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31325. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31326. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31327. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31328. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31329. /** @hidden */
  31330. export var defaultVertexShader: {
  31331. name: string;
  31332. shader: string;
  31333. };
  31334. }
  31335. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31336. import { Nullable } from "babylonjs/types";
  31337. import { Scene } from "babylonjs/scene";
  31338. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31339. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31340. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31341. /**
  31342. * @hidden
  31343. */
  31344. export interface IMaterialDetailMapDefines {
  31345. DETAIL: boolean;
  31346. DETAILDIRECTUV: number;
  31347. DETAIL_NORMALBLENDMETHOD: number;
  31348. /** @hidden */
  31349. _areTexturesDirty: boolean;
  31350. }
  31351. /**
  31352. * Define the code related to the detail map parameters of a material
  31353. *
  31354. * Inspired from:
  31355. * 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
  31356. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31357. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31358. */
  31359. export class DetailMapConfiguration {
  31360. private _texture;
  31361. /**
  31362. * The detail texture of the material.
  31363. */
  31364. texture: Nullable<BaseTexture>;
  31365. /**
  31366. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31367. * Bigger values mean stronger blending
  31368. */
  31369. diffuseBlendLevel: number;
  31370. /**
  31371. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31372. * Bigger values mean stronger blending. Only used with PBR materials
  31373. */
  31374. roughnessBlendLevel: number;
  31375. /**
  31376. * Defines how strong the bump effect from the detail map is
  31377. * Bigger values mean stronger effect
  31378. */
  31379. bumpLevel: number;
  31380. private _normalBlendMethod;
  31381. /**
  31382. * The method used to blend the bump and detail normals together
  31383. */
  31384. normalBlendMethod: number;
  31385. private _isEnabled;
  31386. /**
  31387. * Enable or disable the detail map on this material
  31388. */
  31389. isEnabled: boolean;
  31390. /** @hidden */
  31391. private _internalMarkAllSubMeshesAsTexturesDirty;
  31392. /** @hidden */
  31393. _markAllSubMeshesAsTexturesDirty(): void;
  31394. /**
  31395. * Instantiate a new detail map
  31396. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31397. */
  31398. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31399. /**
  31400. * Gets whether the submesh is ready to be used or not.
  31401. * @param defines the list of "defines" to update.
  31402. * @param scene defines the scene the material belongs to.
  31403. * @returns - boolean indicating that the submesh is ready or not.
  31404. */
  31405. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31406. /**
  31407. * Update the defines for detail map usage
  31408. * @param defines the list of "defines" to update.
  31409. * @param scene defines the scene the material belongs to.
  31410. */
  31411. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31412. /**
  31413. * Binds the material data.
  31414. * @param uniformBuffer defines the Uniform buffer to fill in.
  31415. * @param scene defines the scene the material belongs to.
  31416. * @param isFrozen defines whether the material is frozen or not.
  31417. */
  31418. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31419. /**
  31420. * Checks to see if a texture is used in the material.
  31421. * @param texture - Base texture to use.
  31422. * @returns - Boolean specifying if a texture is used in the material.
  31423. */
  31424. hasTexture(texture: BaseTexture): boolean;
  31425. /**
  31426. * Returns an array of the actively used textures.
  31427. * @param activeTextures Array of BaseTextures
  31428. */
  31429. getActiveTextures(activeTextures: BaseTexture[]): void;
  31430. /**
  31431. * Returns the animatable textures.
  31432. * @param animatables Array of animatable textures.
  31433. */
  31434. getAnimatables(animatables: IAnimatable[]): void;
  31435. /**
  31436. * Disposes the resources of the material.
  31437. * @param forceDisposeTextures - Forces the disposal of all textures.
  31438. */
  31439. dispose(forceDisposeTextures?: boolean): void;
  31440. /**
  31441. * Get the current class name useful for serialization or dynamic coding.
  31442. * @returns "DetailMap"
  31443. */
  31444. getClassName(): string;
  31445. /**
  31446. * Add the required uniforms to the current list.
  31447. * @param uniforms defines the current uniform list.
  31448. */
  31449. static AddUniforms(uniforms: string[]): void;
  31450. /**
  31451. * Add the required samplers to the current list.
  31452. * @param samplers defines the current sampler list.
  31453. */
  31454. static AddSamplers(samplers: string[]): void;
  31455. /**
  31456. * Add the required uniforms to the current buffer.
  31457. * @param uniformBuffer defines the current uniform buffer.
  31458. */
  31459. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31460. /**
  31461. * Makes a duplicate of the current instance into another one.
  31462. * @param detailMap define the instance where to copy the info
  31463. */
  31464. copyTo(detailMap: DetailMapConfiguration): void;
  31465. /**
  31466. * Serializes this detail map instance
  31467. * @returns - An object with the serialized instance.
  31468. */
  31469. serialize(): any;
  31470. /**
  31471. * Parses a detail map setting from a serialized object.
  31472. * @param source - Serialized object.
  31473. * @param scene Defines the scene we are parsing for
  31474. * @param rootUrl Defines the rootUrl to load from
  31475. */
  31476. parse(source: any, scene: Scene, rootUrl: string): void;
  31477. }
  31478. }
  31479. declare module "babylonjs/Materials/standardMaterial" {
  31480. import { SmartArray } from "babylonjs/Misc/smartArray";
  31481. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31482. import { Nullable } from "babylonjs/types";
  31483. import { Scene } from "babylonjs/scene";
  31484. import { Matrix } from "babylonjs/Maths/math.vector";
  31485. import { Color3 } from "babylonjs/Maths/math.color";
  31486. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31487. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31488. import { Mesh } from "babylonjs/Meshes/mesh";
  31489. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31490. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31491. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31492. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31493. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31494. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31495. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31496. import "babylonjs/Shaders/default.fragment";
  31497. import "babylonjs/Shaders/default.vertex";
  31498. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31499. /** @hidden */
  31500. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31501. MAINUV1: boolean;
  31502. MAINUV2: boolean;
  31503. DIFFUSE: boolean;
  31504. DIFFUSEDIRECTUV: number;
  31505. DETAIL: boolean;
  31506. DETAILDIRECTUV: number;
  31507. DETAIL_NORMALBLENDMETHOD: number;
  31508. AMBIENT: boolean;
  31509. AMBIENTDIRECTUV: number;
  31510. OPACITY: boolean;
  31511. OPACITYDIRECTUV: number;
  31512. OPACITYRGB: boolean;
  31513. REFLECTION: boolean;
  31514. EMISSIVE: boolean;
  31515. EMISSIVEDIRECTUV: number;
  31516. SPECULAR: boolean;
  31517. SPECULARDIRECTUV: number;
  31518. BUMP: boolean;
  31519. BUMPDIRECTUV: number;
  31520. PARALLAX: boolean;
  31521. PARALLAXOCCLUSION: boolean;
  31522. SPECULAROVERALPHA: boolean;
  31523. CLIPPLANE: boolean;
  31524. CLIPPLANE2: boolean;
  31525. CLIPPLANE3: boolean;
  31526. CLIPPLANE4: boolean;
  31527. CLIPPLANE5: boolean;
  31528. CLIPPLANE6: boolean;
  31529. ALPHATEST: boolean;
  31530. DEPTHPREPASS: boolean;
  31531. ALPHAFROMDIFFUSE: boolean;
  31532. POINTSIZE: boolean;
  31533. FOG: boolean;
  31534. SPECULARTERM: boolean;
  31535. DIFFUSEFRESNEL: boolean;
  31536. OPACITYFRESNEL: boolean;
  31537. REFLECTIONFRESNEL: boolean;
  31538. REFRACTIONFRESNEL: boolean;
  31539. EMISSIVEFRESNEL: boolean;
  31540. FRESNEL: boolean;
  31541. NORMAL: boolean;
  31542. UV1: boolean;
  31543. UV2: boolean;
  31544. VERTEXCOLOR: boolean;
  31545. VERTEXALPHA: boolean;
  31546. NUM_BONE_INFLUENCERS: number;
  31547. BonesPerMesh: number;
  31548. BONETEXTURE: boolean;
  31549. INSTANCES: boolean;
  31550. THIN_INSTANCES: boolean;
  31551. GLOSSINESS: boolean;
  31552. ROUGHNESS: boolean;
  31553. EMISSIVEASILLUMINATION: boolean;
  31554. LINKEMISSIVEWITHDIFFUSE: boolean;
  31555. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31556. LIGHTMAP: boolean;
  31557. LIGHTMAPDIRECTUV: number;
  31558. OBJECTSPACE_NORMALMAP: boolean;
  31559. USELIGHTMAPASSHADOWMAP: boolean;
  31560. REFLECTIONMAP_3D: boolean;
  31561. REFLECTIONMAP_SPHERICAL: boolean;
  31562. REFLECTIONMAP_PLANAR: boolean;
  31563. REFLECTIONMAP_CUBIC: boolean;
  31564. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31565. REFLECTIONMAP_PROJECTION: boolean;
  31566. REFLECTIONMAP_SKYBOX: boolean;
  31567. REFLECTIONMAP_EXPLICIT: boolean;
  31568. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31569. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31570. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31571. INVERTCUBICMAP: boolean;
  31572. LOGARITHMICDEPTH: boolean;
  31573. REFRACTION: boolean;
  31574. REFRACTIONMAP_3D: boolean;
  31575. REFLECTIONOVERALPHA: boolean;
  31576. TWOSIDEDLIGHTING: boolean;
  31577. SHADOWFLOAT: boolean;
  31578. MORPHTARGETS: boolean;
  31579. MORPHTARGETS_NORMAL: boolean;
  31580. MORPHTARGETS_TANGENT: boolean;
  31581. MORPHTARGETS_UV: boolean;
  31582. NUM_MORPH_INFLUENCERS: number;
  31583. NONUNIFORMSCALING: boolean;
  31584. PREMULTIPLYALPHA: boolean;
  31585. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31586. ALPHABLEND: boolean;
  31587. PREPASS: boolean;
  31588. SCENE_MRT_COUNT: number;
  31589. RGBDLIGHTMAP: boolean;
  31590. RGBDREFLECTION: boolean;
  31591. RGBDREFRACTION: boolean;
  31592. IMAGEPROCESSING: boolean;
  31593. VIGNETTE: boolean;
  31594. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31595. VIGNETTEBLENDMODEOPAQUE: boolean;
  31596. TONEMAPPING: boolean;
  31597. TONEMAPPING_ACES: boolean;
  31598. CONTRAST: boolean;
  31599. COLORCURVES: boolean;
  31600. COLORGRADING: boolean;
  31601. COLORGRADING3D: boolean;
  31602. SAMPLER3DGREENDEPTH: boolean;
  31603. SAMPLER3DBGRMAP: boolean;
  31604. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31605. MULTIVIEW: boolean;
  31606. /**
  31607. * If the reflection texture on this material is in linear color space
  31608. * @hidden
  31609. */
  31610. IS_REFLECTION_LINEAR: boolean;
  31611. /**
  31612. * If the refraction texture on this material is in linear color space
  31613. * @hidden
  31614. */
  31615. IS_REFRACTION_LINEAR: boolean;
  31616. EXPOSURE: boolean;
  31617. constructor();
  31618. setReflectionMode(modeToEnable: string): void;
  31619. }
  31620. /**
  31621. * This is the default material used in Babylon. It is the best trade off between quality
  31622. * and performances.
  31623. * @see https://doc.babylonjs.com/babylon101/materials
  31624. */
  31625. export class StandardMaterial extends PushMaterial {
  31626. private _diffuseTexture;
  31627. /**
  31628. * The basic texture of the material as viewed under a light.
  31629. */
  31630. diffuseTexture: Nullable<BaseTexture>;
  31631. private _ambientTexture;
  31632. /**
  31633. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31634. */
  31635. ambientTexture: Nullable<BaseTexture>;
  31636. private _opacityTexture;
  31637. /**
  31638. * Define the transparency of the material from a texture.
  31639. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31640. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31641. */
  31642. opacityTexture: Nullable<BaseTexture>;
  31643. private _reflectionTexture;
  31644. /**
  31645. * Define the texture used to display the reflection.
  31646. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31647. */
  31648. reflectionTexture: Nullable<BaseTexture>;
  31649. private _emissiveTexture;
  31650. /**
  31651. * Define texture of the material as if self lit.
  31652. * This will be mixed in the final result even in the absence of light.
  31653. */
  31654. emissiveTexture: Nullable<BaseTexture>;
  31655. private _specularTexture;
  31656. /**
  31657. * Define how the color and intensity of the highlight given by the light in the material.
  31658. */
  31659. specularTexture: Nullable<BaseTexture>;
  31660. private _bumpTexture;
  31661. /**
  31662. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31663. * 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.
  31664. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31665. */
  31666. bumpTexture: Nullable<BaseTexture>;
  31667. private _lightmapTexture;
  31668. /**
  31669. * Complex lighting can be computationally expensive to compute at runtime.
  31670. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31671. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31672. */
  31673. lightmapTexture: Nullable<BaseTexture>;
  31674. private _refractionTexture;
  31675. /**
  31676. * Define the texture used to display the refraction.
  31677. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31678. */
  31679. refractionTexture: Nullable<BaseTexture>;
  31680. /**
  31681. * The color of the material lit by the environmental background lighting.
  31682. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31683. */
  31684. ambientColor: Color3;
  31685. /**
  31686. * The basic color of the material as viewed under a light.
  31687. */
  31688. diffuseColor: Color3;
  31689. /**
  31690. * Define how the color and intensity of the highlight given by the light in the material.
  31691. */
  31692. specularColor: Color3;
  31693. /**
  31694. * Define the color of the material as if self lit.
  31695. * This will be mixed in the final result even in the absence of light.
  31696. */
  31697. emissiveColor: Color3;
  31698. /**
  31699. * Defines how sharp are the highlights in the material.
  31700. * The bigger the value the sharper giving a more glossy feeling to the result.
  31701. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31702. */
  31703. specularPower: number;
  31704. private _useAlphaFromDiffuseTexture;
  31705. /**
  31706. * Does the transparency come from the diffuse texture alpha channel.
  31707. */
  31708. useAlphaFromDiffuseTexture: boolean;
  31709. private _useEmissiveAsIllumination;
  31710. /**
  31711. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31712. */
  31713. useEmissiveAsIllumination: boolean;
  31714. private _linkEmissiveWithDiffuse;
  31715. /**
  31716. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31717. * the emissive level when the final color is close to one.
  31718. */
  31719. linkEmissiveWithDiffuse: boolean;
  31720. private _useSpecularOverAlpha;
  31721. /**
  31722. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31723. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31724. */
  31725. useSpecularOverAlpha: boolean;
  31726. private _useReflectionOverAlpha;
  31727. /**
  31728. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31729. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31730. */
  31731. useReflectionOverAlpha: boolean;
  31732. private _disableLighting;
  31733. /**
  31734. * Does lights from the scene impacts this material.
  31735. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31736. */
  31737. disableLighting: boolean;
  31738. private _useObjectSpaceNormalMap;
  31739. /**
  31740. * Allows using an object space normal map (instead of tangent space).
  31741. */
  31742. useObjectSpaceNormalMap: boolean;
  31743. private _useParallax;
  31744. /**
  31745. * Is parallax enabled or not.
  31746. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31747. */
  31748. useParallax: boolean;
  31749. private _useParallaxOcclusion;
  31750. /**
  31751. * Is parallax occlusion enabled or not.
  31752. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31753. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31754. */
  31755. useParallaxOcclusion: boolean;
  31756. /**
  31757. * 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.
  31758. */
  31759. parallaxScaleBias: number;
  31760. private _roughness;
  31761. /**
  31762. * Helps to define how blurry the reflections should appears in the material.
  31763. */
  31764. roughness: number;
  31765. /**
  31766. * In case of refraction, define the value of the index of refraction.
  31767. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31768. */
  31769. indexOfRefraction: number;
  31770. /**
  31771. * Invert the refraction texture alongside the y axis.
  31772. * It can be useful with procedural textures or probe for instance.
  31773. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31774. */
  31775. invertRefractionY: boolean;
  31776. /**
  31777. * Defines the alpha limits in alpha test mode.
  31778. */
  31779. alphaCutOff: number;
  31780. private _useLightmapAsShadowmap;
  31781. /**
  31782. * In case of light mapping, define whether the map contains light or shadow informations.
  31783. */
  31784. useLightmapAsShadowmap: boolean;
  31785. private _diffuseFresnelParameters;
  31786. /**
  31787. * Define the diffuse fresnel parameters of the material.
  31788. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31789. */
  31790. diffuseFresnelParameters: FresnelParameters;
  31791. private _opacityFresnelParameters;
  31792. /**
  31793. * Define the opacity fresnel parameters of the material.
  31794. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31795. */
  31796. opacityFresnelParameters: FresnelParameters;
  31797. private _reflectionFresnelParameters;
  31798. /**
  31799. * Define the reflection fresnel parameters of the material.
  31800. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31801. */
  31802. reflectionFresnelParameters: FresnelParameters;
  31803. private _refractionFresnelParameters;
  31804. /**
  31805. * Define the refraction fresnel parameters of the material.
  31806. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31807. */
  31808. refractionFresnelParameters: FresnelParameters;
  31809. private _emissiveFresnelParameters;
  31810. /**
  31811. * Define the emissive fresnel parameters of the material.
  31812. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31813. */
  31814. emissiveFresnelParameters: FresnelParameters;
  31815. private _useReflectionFresnelFromSpecular;
  31816. /**
  31817. * If true automatically deducts the fresnels values from the material specularity.
  31818. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31819. */
  31820. useReflectionFresnelFromSpecular: boolean;
  31821. private _useGlossinessFromSpecularMapAlpha;
  31822. /**
  31823. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31824. */
  31825. useGlossinessFromSpecularMapAlpha: boolean;
  31826. private _maxSimultaneousLights;
  31827. /**
  31828. * Defines the maximum number of lights that can be used in the material
  31829. */
  31830. maxSimultaneousLights: number;
  31831. private _invertNormalMapX;
  31832. /**
  31833. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31834. */
  31835. invertNormalMapX: boolean;
  31836. private _invertNormalMapY;
  31837. /**
  31838. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31839. */
  31840. invertNormalMapY: boolean;
  31841. private _twoSidedLighting;
  31842. /**
  31843. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31844. */
  31845. twoSidedLighting: boolean;
  31846. /**
  31847. * Default configuration related to image processing available in the standard Material.
  31848. */
  31849. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31850. /**
  31851. * Gets the image processing configuration used either in this material.
  31852. */
  31853. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31854. /**
  31855. * Sets the Default image processing configuration used either in the this material.
  31856. *
  31857. * If sets to null, the scene one is in use.
  31858. */
  31859. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31860. /**
  31861. * Keep track of the image processing observer to allow dispose and replace.
  31862. */
  31863. private _imageProcessingObserver;
  31864. /**
  31865. * Attaches a new image processing configuration to the Standard Material.
  31866. * @param configuration
  31867. */
  31868. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31869. /**
  31870. * Gets wether the color curves effect is enabled.
  31871. */
  31872. get cameraColorCurvesEnabled(): boolean;
  31873. /**
  31874. * Sets wether the color curves effect is enabled.
  31875. */
  31876. set cameraColorCurvesEnabled(value: boolean);
  31877. /**
  31878. * Gets wether the color grading effect is enabled.
  31879. */
  31880. get cameraColorGradingEnabled(): boolean;
  31881. /**
  31882. * Gets wether the color grading effect is enabled.
  31883. */
  31884. set cameraColorGradingEnabled(value: boolean);
  31885. /**
  31886. * Gets wether tonemapping is enabled or not.
  31887. */
  31888. get cameraToneMappingEnabled(): boolean;
  31889. /**
  31890. * Sets wether tonemapping is enabled or not
  31891. */
  31892. set cameraToneMappingEnabled(value: boolean);
  31893. /**
  31894. * The camera exposure used on this material.
  31895. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31896. * This corresponds to a photographic exposure.
  31897. */
  31898. get cameraExposure(): number;
  31899. /**
  31900. * The camera exposure used on this material.
  31901. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31902. * This corresponds to a photographic exposure.
  31903. */
  31904. set cameraExposure(value: number);
  31905. /**
  31906. * Gets The camera contrast used on this material.
  31907. */
  31908. get cameraContrast(): number;
  31909. /**
  31910. * Sets The camera contrast used on this material.
  31911. */
  31912. set cameraContrast(value: number);
  31913. /**
  31914. * Gets the Color Grading 2D Lookup Texture.
  31915. */
  31916. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31917. /**
  31918. * Sets the Color Grading 2D Lookup Texture.
  31919. */
  31920. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31921. /**
  31922. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31923. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31924. * 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;
  31925. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31926. */
  31927. get cameraColorCurves(): Nullable<ColorCurves>;
  31928. /**
  31929. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31930. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31931. * 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;
  31932. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31933. */
  31934. set cameraColorCurves(value: Nullable<ColorCurves>);
  31935. /**
  31936. * Can this material render to several textures at once
  31937. */
  31938. get canRenderToMRT(): boolean;
  31939. /**
  31940. * Defines the detail map parameters for the material.
  31941. */
  31942. readonly detailMap: DetailMapConfiguration;
  31943. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31944. protected _worldViewProjectionMatrix: Matrix;
  31945. protected _globalAmbientColor: Color3;
  31946. protected _useLogarithmicDepth: boolean;
  31947. protected _rebuildInParallel: boolean;
  31948. /**
  31949. * Instantiates a new standard material.
  31950. * This is the default material used in Babylon. It is the best trade off between quality
  31951. * and performances.
  31952. * @see https://doc.babylonjs.com/babylon101/materials
  31953. * @param name Define the name of the material in the scene
  31954. * @param scene Define the scene the material belong to
  31955. */
  31956. constructor(name: string, scene: Scene);
  31957. /**
  31958. * Gets a boolean indicating that current material needs to register RTT
  31959. */
  31960. get hasRenderTargetTextures(): boolean;
  31961. /**
  31962. * Gets the current class name of the material e.g. "StandardMaterial"
  31963. * Mainly use in serialization.
  31964. * @returns the class name
  31965. */
  31966. getClassName(): string;
  31967. /**
  31968. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31969. * You can try switching to logarithmic depth.
  31970. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31971. */
  31972. get useLogarithmicDepth(): boolean;
  31973. set useLogarithmicDepth(value: boolean);
  31974. /**
  31975. * Specifies if the material will require alpha blending
  31976. * @returns a boolean specifying if alpha blending is needed
  31977. */
  31978. needAlphaBlending(): boolean;
  31979. /**
  31980. * Specifies if this material should be rendered in alpha test mode
  31981. * @returns a boolean specifying if an alpha test is needed.
  31982. */
  31983. needAlphaTesting(): boolean;
  31984. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31985. /**
  31986. * Get the texture used for alpha test purpose.
  31987. * @returns the diffuse texture in case of the standard material.
  31988. */
  31989. getAlphaTestTexture(): Nullable<BaseTexture>;
  31990. /**
  31991. * Get if the submesh is ready to be used and all its information available.
  31992. * Child classes can use it to update shaders
  31993. * @param mesh defines the mesh to check
  31994. * @param subMesh defines which submesh to check
  31995. * @param useInstances specifies that instances should be used
  31996. * @returns a boolean indicating that the submesh is ready or not
  31997. */
  31998. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  31999. /**
  32000. * Builds the material UBO layouts.
  32001. * Used internally during the effect preparation.
  32002. */
  32003. buildUniformLayout(): void;
  32004. /**
  32005. * Unbinds the material from the mesh
  32006. */
  32007. unbind(): void;
  32008. /**
  32009. * Binds the submesh to this material by preparing the effect and shader to draw
  32010. * @param world defines the world transformation matrix
  32011. * @param mesh defines the mesh containing the submesh
  32012. * @param subMesh defines the submesh to bind the material to
  32013. */
  32014. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32015. /**
  32016. * Get the list of animatables in the material.
  32017. * @returns the list of animatables object used in the material
  32018. */
  32019. getAnimatables(): IAnimatable[];
  32020. /**
  32021. * Gets the active textures from the material
  32022. * @returns an array of textures
  32023. */
  32024. getActiveTextures(): BaseTexture[];
  32025. /**
  32026. * Specifies if the material uses a texture
  32027. * @param texture defines the texture to check against the material
  32028. * @returns a boolean specifying if the material uses the texture
  32029. */
  32030. hasTexture(texture: BaseTexture): boolean;
  32031. /**
  32032. * Disposes the material
  32033. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32034. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32035. */
  32036. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32037. /**
  32038. * Makes a duplicate of the material, and gives it a new name
  32039. * @param name defines the new name for the duplicated material
  32040. * @returns the cloned material
  32041. */
  32042. clone(name: string): StandardMaterial;
  32043. /**
  32044. * Serializes this material in a JSON representation
  32045. * @returns the serialized material object
  32046. */
  32047. serialize(): any;
  32048. /**
  32049. * Creates a standard material from parsed material data
  32050. * @param source defines the JSON representation of the material
  32051. * @param scene defines the hosting scene
  32052. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32053. * @returns a new standard material
  32054. */
  32055. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32056. /**
  32057. * Are diffuse textures enabled in the application.
  32058. */
  32059. static get DiffuseTextureEnabled(): boolean;
  32060. static set DiffuseTextureEnabled(value: boolean);
  32061. /**
  32062. * Are detail textures enabled in the application.
  32063. */
  32064. static get DetailTextureEnabled(): boolean;
  32065. static set DetailTextureEnabled(value: boolean);
  32066. /**
  32067. * Are ambient textures enabled in the application.
  32068. */
  32069. static get AmbientTextureEnabled(): boolean;
  32070. static set AmbientTextureEnabled(value: boolean);
  32071. /**
  32072. * Are opacity textures enabled in the application.
  32073. */
  32074. static get OpacityTextureEnabled(): boolean;
  32075. static set OpacityTextureEnabled(value: boolean);
  32076. /**
  32077. * Are reflection textures enabled in the application.
  32078. */
  32079. static get ReflectionTextureEnabled(): boolean;
  32080. static set ReflectionTextureEnabled(value: boolean);
  32081. /**
  32082. * Are emissive textures enabled in the application.
  32083. */
  32084. static get EmissiveTextureEnabled(): boolean;
  32085. static set EmissiveTextureEnabled(value: boolean);
  32086. /**
  32087. * Are specular textures enabled in the application.
  32088. */
  32089. static get SpecularTextureEnabled(): boolean;
  32090. static set SpecularTextureEnabled(value: boolean);
  32091. /**
  32092. * Are bump textures enabled in the application.
  32093. */
  32094. static get BumpTextureEnabled(): boolean;
  32095. static set BumpTextureEnabled(value: boolean);
  32096. /**
  32097. * Are lightmap textures enabled in the application.
  32098. */
  32099. static get LightmapTextureEnabled(): boolean;
  32100. static set LightmapTextureEnabled(value: boolean);
  32101. /**
  32102. * Are refraction textures enabled in the application.
  32103. */
  32104. static get RefractionTextureEnabled(): boolean;
  32105. static set RefractionTextureEnabled(value: boolean);
  32106. /**
  32107. * Are color grading textures enabled in the application.
  32108. */
  32109. static get ColorGradingTextureEnabled(): boolean;
  32110. static set ColorGradingTextureEnabled(value: boolean);
  32111. /**
  32112. * Are fresnels enabled in the application.
  32113. */
  32114. static get FresnelEnabled(): boolean;
  32115. static set FresnelEnabled(value: boolean);
  32116. }
  32117. }
  32118. declare module "babylonjs/Particles/solidParticleSystem" {
  32119. import { Nullable } from "babylonjs/types";
  32120. import { Mesh } from "babylonjs/Meshes/mesh";
  32121. import { Scene, IDisposable } from "babylonjs/scene";
  32122. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32123. import { Material } from "babylonjs/Materials/material";
  32124. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32125. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32126. /**
  32127. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32128. *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.
  32129. * The SPS is also a particle system. It provides some methods to manage the particles.
  32130. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32131. *
  32132. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32133. */
  32134. export class SolidParticleSystem implements IDisposable {
  32135. /**
  32136. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32137. * Example : var p = SPS.particles[i];
  32138. */
  32139. particles: SolidParticle[];
  32140. /**
  32141. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32142. */
  32143. nbParticles: number;
  32144. /**
  32145. * If the particles must ever face the camera (default false). Useful for planar particles.
  32146. */
  32147. billboard: boolean;
  32148. /**
  32149. * Recompute normals when adding a shape
  32150. */
  32151. recomputeNormals: boolean;
  32152. /**
  32153. * This a counter ofr your own usage. It's not set by any SPS functions.
  32154. */
  32155. counter: number;
  32156. /**
  32157. * The SPS name. This name is also given to the underlying mesh.
  32158. */
  32159. name: string;
  32160. /**
  32161. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32162. */
  32163. mesh: Mesh;
  32164. /**
  32165. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32166. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32167. */
  32168. vars: any;
  32169. /**
  32170. * This array is populated when the SPS is set as 'pickable'.
  32171. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32172. * Each element of this array is an object `{idx: int, faceId: int}`.
  32173. * `idx` is the picked particle index in the `SPS.particles` array
  32174. * `faceId` is the picked face index counted within this particle.
  32175. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32176. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32177. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32178. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32179. */
  32180. pickedParticles: {
  32181. idx: number;
  32182. faceId: number;
  32183. }[];
  32184. /**
  32185. * This array is populated when the SPS is set as 'pickable'
  32186. * Each key of this array is a submesh index.
  32187. * Each element of this array is a second array defined like this :
  32188. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32189. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32190. * `idx` is the picked particle index in the `SPS.particles` array
  32191. * `faceId` is the picked face index counted within this particle.
  32192. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32193. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32194. */
  32195. pickedBySubMesh: {
  32196. idx: number;
  32197. faceId: number;
  32198. }[][];
  32199. /**
  32200. * This array is populated when `enableDepthSort` is set to true.
  32201. * Each element of this array is an instance of the class DepthSortedParticle.
  32202. */
  32203. depthSortedParticles: DepthSortedParticle[];
  32204. /**
  32205. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32206. * @hidden
  32207. */
  32208. _bSphereOnly: boolean;
  32209. /**
  32210. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32211. * @hidden
  32212. */
  32213. _bSphereRadiusFactor: number;
  32214. private _scene;
  32215. private _positions;
  32216. private _indices;
  32217. private _normals;
  32218. private _colors;
  32219. private _uvs;
  32220. private _indices32;
  32221. private _positions32;
  32222. private _normals32;
  32223. private _fixedNormal32;
  32224. private _colors32;
  32225. private _uvs32;
  32226. private _index;
  32227. private _updatable;
  32228. private _pickable;
  32229. private _isVisibilityBoxLocked;
  32230. private _alwaysVisible;
  32231. private _depthSort;
  32232. private _expandable;
  32233. private _shapeCounter;
  32234. private _copy;
  32235. private _color;
  32236. private _computeParticleColor;
  32237. private _computeParticleTexture;
  32238. private _computeParticleRotation;
  32239. private _computeParticleVertex;
  32240. private _computeBoundingBox;
  32241. private _depthSortParticles;
  32242. private _camera;
  32243. private _mustUnrotateFixedNormals;
  32244. private _particlesIntersect;
  32245. private _needs32Bits;
  32246. private _isNotBuilt;
  32247. private _lastParticleId;
  32248. private _idxOfId;
  32249. private _multimaterialEnabled;
  32250. private _useModelMaterial;
  32251. private _indicesByMaterial;
  32252. private _materialIndexes;
  32253. private _depthSortFunction;
  32254. private _materialSortFunction;
  32255. private _materials;
  32256. private _multimaterial;
  32257. private _materialIndexesById;
  32258. private _defaultMaterial;
  32259. private _autoUpdateSubMeshes;
  32260. private _tmpVertex;
  32261. /**
  32262. * Creates a SPS (Solid Particle System) object.
  32263. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32264. * @param scene (Scene) is the scene in which the SPS is added.
  32265. * @param options defines the options of the sps e.g.
  32266. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32267. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32268. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32269. * * 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.
  32270. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32271. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32272. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32273. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32274. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32275. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32276. */
  32277. constructor(name: string, scene: Scene, options?: {
  32278. updatable?: boolean;
  32279. isPickable?: boolean;
  32280. enableDepthSort?: boolean;
  32281. particleIntersection?: boolean;
  32282. boundingSphereOnly?: boolean;
  32283. bSphereRadiusFactor?: number;
  32284. expandable?: boolean;
  32285. useModelMaterial?: boolean;
  32286. enableMultiMaterial?: boolean;
  32287. });
  32288. /**
  32289. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32290. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32291. * @returns the created mesh
  32292. */
  32293. buildMesh(): Mesh;
  32294. /**
  32295. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32296. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32297. * Thus the particles generated from `digest()` have their property `position` set yet.
  32298. * @param mesh ( Mesh ) is the mesh to be digested
  32299. * @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
  32300. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32301. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32302. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32303. * @returns the current SPS
  32304. */
  32305. digest(mesh: Mesh, options?: {
  32306. facetNb?: number;
  32307. number?: number;
  32308. delta?: number;
  32309. storage?: [];
  32310. }): SolidParticleSystem;
  32311. /**
  32312. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32313. * @hidden
  32314. */
  32315. private _unrotateFixedNormals;
  32316. /**
  32317. * Resets the temporary working copy particle
  32318. * @hidden
  32319. */
  32320. private _resetCopy;
  32321. /**
  32322. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32323. * @param p the current index in the positions array to be updated
  32324. * @param ind the current index in the indices array
  32325. * @param shape a Vector3 array, the shape geometry
  32326. * @param positions the positions array to be updated
  32327. * @param meshInd the shape indices array
  32328. * @param indices the indices array to be updated
  32329. * @param meshUV the shape uv array
  32330. * @param uvs the uv array to be updated
  32331. * @param meshCol the shape color array
  32332. * @param colors the color array to be updated
  32333. * @param meshNor the shape normals array
  32334. * @param normals the normals array to be updated
  32335. * @param idx the particle index
  32336. * @param idxInShape the particle index in its shape
  32337. * @param options the addShape() method passed options
  32338. * @model the particle model
  32339. * @hidden
  32340. */
  32341. private _meshBuilder;
  32342. /**
  32343. * Returns a shape Vector3 array from positions float array
  32344. * @param positions float array
  32345. * @returns a vector3 array
  32346. * @hidden
  32347. */
  32348. private _posToShape;
  32349. /**
  32350. * Returns a shapeUV array from a float uvs (array deep copy)
  32351. * @param uvs as a float array
  32352. * @returns a shapeUV array
  32353. * @hidden
  32354. */
  32355. private _uvsToShapeUV;
  32356. /**
  32357. * Adds a new particle object in the particles array
  32358. * @param idx particle index in particles array
  32359. * @param id particle id
  32360. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32361. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32362. * @param model particle ModelShape object
  32363. * @param shapeId model shape identifier
  32364. * @param idxInShape index of the particle in the current model
  32365. * @param bInfo model bounding info object
  32366. * @param storage target storage array, if any
  32367. * @hidden
  32368. */
  32369. private _addParticle;
  32370. /**
  32371. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32372. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32373. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32374. * @param nb (positive integer) the number of particles to be created from this model
  32375. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32376. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32377. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32378. * @returns the number of shapes in the system
  32379. */
  32380. addShape(mesh: Mesh, nb: number, options?: {
  32381. positionFunction?: any;
  32382. vertexFunction?: any;
  32383. storage?: [];
  32384. }): number;
  32385. /**
  32386. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32387. * @hidden
  32388. */
  32389. private _rebuildParticle;
  32390. /**
  32391. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32392. * @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.
  32393. * @returns the SPS.
  32394. */
  32395. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32396. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32397. * Returns an array with the removed particles.
  32398. * 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.
  32399. * The SPS can't be empty so at least one particle needs to remain in place.
  32400. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32401. * @param start index of the first particle to remove
  32402. * @param end index of the last particle to remove (included)
  32403. * @returns an array populated with the removed particles
  32404. */
  32405. removeParticles(start: number, end: number): SolidParticle[];
  32406. /**
  32407. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32408. * @param solidParticleArray an array populated with Solid Particles objects
  32409. * @returns the SPS
  32410. */
  32411. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32412. /**
  32413. * Creates a new particle and modifies the SPS mesh geometry :
  32414. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32415. * - calls _addParticle() to populate the particle array
  32416. * factorized code from addShape() and insertParticlesFromArray()
  32417. * @param idx particle index in the particles array
  32418. * @param i particle index in its shape
  32419. * @param modelShape particle ModelShape object
  32420. * @param shape shape vertex array
  32421. * @param meshInd shape indices array
  32422. * @param meshUV shape uv array
  32423. * @param meshCol shape color array
  32424. * @param meshNor shape normals array
  32425. * @param bbInfo shape bounding info
  32426. * @param storage target particle storage
  32427. * @options addShape() passed options
  32428. * @hidden
  32429. */
  32430. private _insertNewParticle;
  32431. /**
  32432. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32433. * This method calls `updateParticle()` for each particle of the SPS.
  32434. * For an animated SPS, it is usually called within the render loop.
  32435. * 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.
  32436. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32437. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32438. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32439. * @returns the SPS.
  32440. */
  32441. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32442. /**
  32443. * Disposes the SPS.
  32444. */
  32445. dispose(): void;
  32446. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32447. * idx is the particle index in the SPS
  32448. * faceId is the picked face index counted within this particle.
  32449. * Returns null if the pickInfo can't identify a picked particle.
  32450. * @param pickingInfo (PickingInfo object)
  32451. * @returns {idx: number, faceId: number} or null
  32452. */
  32453. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32454. idx: number;
  32455. faceId: number;
  32456. }>;
  32457. /**
  32458. * Returns a SolidParticle object from its identifier : particle.id
  32459. * @param id (integer) the particle Id
  32460. * @returns the searched particle or null if not found in the SPS.
  32461. */
  32462. getParticleById(id: number): Nullable<SolidParticle>;
  32463. /**
  32464. * Returns a new array populated with the particles having the passed shapeId.
  32465. * @param shapeId (integer) the shape identifier
  32466. * @returns a new solid particle array
  32467. */
  32468. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32469. /**
  32470. * Populates the passed array "ref" with the particles having the passed shapeId.
  32471. * @param shapeId the shape identifier
  32472. * @returns the SPS
  32473. * @param ref
  32474. */
  32475. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32476. /**
  32477. * Computes the required SubMeshes according the materials assigned to the particles.
  32478. * @returns the solid particle system.
  32479. * Does nothing if called before the SPS mesh is built.
  32480. */
  32481. computeSubMeshes(): SolidParticleSystem;
  32482. /**
  32483. * Sorts the solid particles by material when MultiMaterial is enabled.
  32484. * Updates the indices32 array.
  32485. * Updates the indicesByMaterial array.
  32486. * Updates the mesh indices array.
  32487. * @returns the SPS
  32488. * @hidden
  32489. */
  32490. private _sortParticlesByMaterial;
  32491. /**
  32492. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32493. * @hidden
  32494. */
  32495. private _setMaterialIndexesById;
  32496. /**
  32497. * Returns an array with unique values of Materials from the passed array
  32498. * @param array the material array to be checked and filtered
  32499. * @hidden
  32500. */
  32501. private _filterUniqueMaterialId;
  32502. /**
  32503. * Sets a new Standard Material as _defaultMaterial if not already set.
  32504. * @hidden
  32505. */
  32506. private _setDefaultMaterial;
  32507. /**
  32508. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32509. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32510. * @returns the SPS.
  32511. */
  32512. refreshVisibleSize(): SolidParticleSystem;
  32513. /**
  32514. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32515. * @param size the size (float) of the visibility box
  32516. * note : this doesn't lock the SPS mesh bounding box.
  32517. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32518. */
  32519. setVisibilityBox(size: number): void;
  32520. /**
  32521. * Gets whether the SPS as always visible or not
  32522. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32523. */
  32524. get isAlwaysVisible(): boolean;
  32525. /**
  32526. * Sets the SPS as always visible or not
  32527. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32528. */
  32529. set isAlwaysVisible(val: boolean);
  32530. /**
  32531. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32532. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32533. */
  32534. set isVisibilityBoxLocked(val: boolean);
  32535. /**
  32536. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32537. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32538. */
  32539. get isVisibilityBoxLocked(): boolean;
  32540. /**
  32541. * Tells to `setParticles()` to compute the particle rotations or not.
  32542. * Default value : true. The SPS is faster when it's set to false.
  32543. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32544. */
  32545. set computeParticleRotation(val: boolean);
  32546. /**
  32547. * Tells to `setParticles()` to compute the particle colors or not.
  32548. * Default value : true. The SPS is faster when it's set to false.
  32549. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32550. */
  32551. set computeParticleColor(val: boolean);
  32552. set computeParticleTexture(val: boolean);
  32553. /**
  32554. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32555. * Default value : false. The SPS is faster when it's set to false.
  32556. * Note : the particle custom vertex positions aren't stored values.
  32557. */
  32558. set computeParticleVertex(val: boolean);
  32559. /**
  32560. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32561. */
  32562. set computeBoundingBox(val: boolean);
  32563. /**
  32564. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32565. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32566. * Default : `true`
  32567. */
  32568. set depthSortParticles(val: boolean);
  32569. /**
  32570. * Gets if `setParticles()` computes the particle rotations or not.
  32571. * Default value : true. The SPS is faster when it's set to false.
  32572. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32573. */
  32574. get computeParticleRotation(): boolean;
  32575. /**
  32576. * Gets if `setParticles()` computes the particle colors or not.
  32577. * Default value : true. The SPS is faster when it's set to false.
  32578. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32579. */
  32580. get computeParticleColor(): boolean;
  32581. /**
  32582. * Gets if `setParticles()` computes the particle textures or not.
  32583. * Default value : true. The SPS is faster when it's set to false.
  32584. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32585. */
  32586. get computeParticleTexture(): boolean;
  32587. /**
  32588. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32589. * Default value : false. The SPS is faster when it's set to false.
  32590. * Note : the particle custom vertex positions aren't stored values.
  32591. */
  32592. get computeParticleVertex(): boolean;
  32593. /**
  32594. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32595. */
  32596. get computeBoundingBox(): boolean;
  32597. /**
  32598. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32599. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32600. * Default : `true`
  32601. */
  32602. get depthSortParticles(): boolean;
  32603. /**
  32604. * Gets if the SPS is created as expandable at construction time.
  32605. * Default : `false`
  32606. */
  32607. get expandable(): boolean;
  32608. /**
  32609. * Gets if the SPS supports the Multi Materials
  32610. */
  32611. get multimaterialEnabled(): boolean;
  32612. /**
  32613. * Gets if the SPS uses the model materials for its own multimaterial.
  32614. */
  32615. get useModelMaterial(): boolean;
  32616. /**
  32617. * The SPS used material array.
  32618. */
  32619. get materials(): Material[];
  32620. /**
  32621. * Sets the SPS MultiMaterial from the passed materials.
  32622. * Note : the passed array is internally copied and not used then by reference.
  32623. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32624. */
  32625. setMultiMaterial(materials: Material[]): void;
  32626. /**
  32627. * The SPS computed multimaterial object
  32628. */
  32629. get multimaterial(): MultiMaterial;
  32630. set multimaterial(mm: MultiMaterial);
  32631. /**
  32632. * If the subMeshes must be updated on the next call to setParticles()
  32633. */
  32634. get autoUpdateSubMeshes(): boolean;
  32635. set autoUpdateSubMeshes(val: boolean);
  32636. /**
  32637. * This function does nothing. It may be overwritten to set all the particle first values.
  32638. * The SPS doesn't call this function, you may have to call it by your own.
  32639. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32640. */
  32641. initParticles(): void;
  32642. /**
  32643. * This function does nothing. It may be overwritten to recycle a particle.
  32644. * The SPS doesn't call this function, you may have to call it by your own.
  32645. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32646. * @param particle The particle to recycle
  32647. * @returns the recycled particle
  32648. */
  32649. recycleParticle(particle: SolidParticle): SolidParticle;
  32650. /**
  32651. * Updates a particle : this function should be overwritten by the user.
  32652. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32653. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32654. * @example : just set a particle position or velocity and recycle conditions
  32655. * @param particle The particle to update
  32656. * @returns the updated particle
  32657. */
  32658. updateParticle(particle: SolidParticle): SolidParticle;
  32659. /**
  32660. * Updates a vertex of a particle : it can be overwritten by the user.
  32661. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32662. * @param particle the current particle
  32663. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32664. * @param pt the index of the current vertex in the particle shape
  32665. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32666. * @example : just set a vertex particle position or color
  32667. * @returns the sps
  32668. */
  32669. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32670. /**
  32671. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32672. * This does nothing and may be overwritten by the user.
  32673. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32674. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32675. * @param update the boolean update value actually passed to setParticles()
  32676. */
  32677. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32678. /**
  32679. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32680. * This will be passed three parameters.
  32681. * This does nothing and may be overwritten by the user.
  32682. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32683. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32684. * @param update the boolean update value actually passed to setParticles()
  32685. */
  32686. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32687. }
  32688. }
  32689. declare module "babylonjs/Particles/solidParticle" {
  32690. import { Nullable } from "babylonjs/types";
  32691. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32692. import { Color4 } from "babylonjs/Maths/math.color";
  32693. import { Mesh } from "babylonjs/Meshes/mesh";
  32694. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32695. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32696. import { Plane } from "babylonjs/Maths/math.plane";
  32697. import { Material } from "babylonjs/Materials/material";
  32698. /**
  32699. * Represents one particle of a solid particle system.
  32700. */
  32701. export class SolidParticle {
  32702. /**
  32703. * particle global index
  32704. */
  32705. idx: number;
  32706. /**
  32707. * particle identifier
  32708. */
  32709. id: number;
  32710. /**
  32711. * The color of the particle
  32712. */
  32713. color: Nullable<Color4>;
  32714. /**
  32715. * The world space position of the particle.
  32716. */
  32717. position: Vector3;
  32718. /**
  32719. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32720. */
  32721. rotation: Vector3;
  32722. /**
  32723. * The world space rotation quaternion of the particle.
  32724. */
  32725. rotationQuaternion: Nullable<Quaternion>;
  32726. /**
  32727. * The scaling of the particle.
  32728. */
  32729. scaling: Vector3;
  32730. /**
  32731. * The uvs of the particle.
  32732. */
  32733. uvs: Vector4;
  32734. /**
  32735. * The current speed of the particle.
  32736. */
  32737. velocity: Vector3;
  32738. /**
  32739. * The pivot point in the particle local space.
  32740. */
  32741. pivot: Vector3;
  32742. /**
  32743. * Must the particle be translated from its pivot point in its local space ?
  32744. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32745. * Default : false
  32746. */
  32747. translateFromPivot: boolean;
  32748. /**
  32749. * Is the particle active or not ?
  32750. */
  32751. alive: boolean;
  32752. /**
  32753. * Is the particle visible or not ?
  32754. */
  32755. isVisible: boolean;
  32756. /**
  32757. * Index of this particle in the global "positions" array (Internal use)
  32758. * @hidden
  32759. */
  32760. _pos: number;
  32761. /**
  32762. * @hidden Index of this particle in the global "indices" array (Internal use)
  32763. */
  32764. _ind: number;
  32765. /**
  32766. * @hidden ModelShape of this particle (Internal use)
  32767. */
  32768. _model: ModelShape;
  32769. /**
  32770. * ModelShape id of this particle
  32771. */
  32772. shapeId: number;
  32773. /**
  32774. * Index of the particle in its shape id
  32775. */
  32776. idxInShape: number;
  32777. /**
  32778. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32779. */
  32780. _modelBoundingInfo: BoundingInfo;
  32781. /**
  32782. * @hidden Particle BoundingInfo object (Internal use)
  32783. */
  32784. _boundingInfo: BoundingInfo;
  32785. /**
  32786. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32787. */
  32788. _sps: SolidParticleSystem;
  32789. /**
  32790. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32791. */
  32792. _stillInvisible: boolean;
  32793. /**
  32794. * @hidden Last computed particle rotation matrix
  32795. */
  32796. _rotationMatrix: number[];
  32797. /**
  32798. * Parent particle Id, if any.
  32799. * Default null.
  32800. */
  32801. parentId: Nullable<number>;
  32802. /**
  32803. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32804. */
  32805. materialIndex: Nullable<number>;
  32806. /**
  32807. * Custom object or properties.
  32808. */
  32809. props: Nullable<any>;
  32810. /**
  32811. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32812. * The possible values are :
  32813. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32814. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32815. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32816. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32817. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32818. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32819. * */
  32820. cullingStrategy: number;
  32821. /**
  32822. * @hidden Internal global position in the SPS.
  32823. */
  32824. _globalPosition: Vector3;
  32825. /**
  32826. * Creates a Solid Particle object.
  32827. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32828. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32829. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32830. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32831. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32832. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32833. * @param shapeId (integer) is the model shape identifier in the SPS.
  32834. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32835. * @param sps defines the sps it is associated to
  32836. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32837. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32838. */
  32839. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32840. /**
  32841. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32842. * @param target the particle target
  32843. * @returns the current particle
  32844. */
  32845. copyToRef(target: SolidParticle): SolidParticle;
  32846. /**
  32847. * Legacy support, changed scale to scaling
  32848. */
  32849. get scale(): Vector3;
  32850. /**
  32851. * Legacy support, changed scale to scaling
  32852. */
  32853. set scale(scale: Vector3);
  32854. /**
  32855. * Legacy support, changed quaternion to rotationQuaternion
  32856. */
  32857. get quaternion(): Nullable<Quaternion>;
  32858. /**
  32859. * Legacy support, changed quaternion to rotationQuaternion
  32860. */
  32861. set quaternion(q: Nullable<Quaternion>);
  32862. /**
  32863. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32864. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32865. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32866. * @returns true if it intersects
  32867. */
  32868. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32869. /**
  32870. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32871. * A particle is in the frustum if its bounding box intersects the frustum
  32872. * @param frustumPlanes defines the frustum to test
  32873. * @returns true if the particle is in the frustum planes
  32874. */
  32875. isInFrustum(frustumPlanes: Plane[]): boolean;
  32876. /**
  32877. * get the rotation matrix of the particle
  32878. * @hidden
  32879. */
  32880. getRotationMatrix(m: Matrix): void;
  32881. }
  32882. /**
  32883. * Represents the shape of the model used by one particle of a solid particle system.
  32884. * SPS internal tool, don't use it manually.
  32885. */
  32886. export class ModelShape {
  32887. /**
  32888. * The shape id
  32889. * @hidden
  32890. */
  32891. shapeID: number;
  32892. /**
  32893. * flat array of model positions (internal use)
  32894. * @hidden
  32895. */
  32896. _shape: Vector3[];
  32897. /**
  32898. * flat array of model UVs (internal use)
  32899. * @hidden
  32900. */
  32901. _shapeUV: number[];
  32902. /**
  32903. * color array of the model
  32904. * @hidden
  32905. */
  32906. _shapeColors: number[];
  32907. /**
  32908. * indices array of the model
  32909. * @hidden
  32910. */
  32911. _indices: number[];
  32912. /**
  32913. * normals array of the model
  32914. * @hidden
  32915. */
  32916. _normals: number[];
  32917. /**
  32918. * length of the shape in the model indices array (internal use)
  32919. * @hidden
  32920. */
  32921. _indicesLength: number;
  32922. /**
  32923. * Custom position function (internal use)
  32924. * @hidden
  32925. */
  32926. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32927. /**
  32928. * Custom vertex function (internal use)
  32929. * @hidden
  32930. */
  32931. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32932. /**
  32933. * Model material (internal use)
  32934. * @hidden
  32935. */
  32936. _material: Nullable<Material>;
  32937. /**
  32938. * 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.
  32939. * SPS internal tool, don't use it manually.
  32940. * @hidden
  32941. */
  32942. 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>);
  32943. }
  32944. /**
  32945. * Represents a Depth Sorted Particle in the solid particle system.
  32946. * @hidden
  32947. */
  32948. export class DepthSortedParticle {
  32949. /**
  32950. * Particle index
  32951. */
  32952. idx: number;
  32953. /**
  32954. * Index of the particle in the "indices" array
  32955. */
  32956. ind: number;
  32957. /**
  32958. * Length of the particle shape in the "indices" array
  32959. */
  32960. indicesLength: number;
  32961. /**
  32962. * Squared distance from the particle to the camera
  32963. */
  32964. sqDistance: number;
  32965. /**
  32966. * Material index when used with MultiMaterials
  32967. */
  32968. materialIndex: number;
  32969. /**
  32970. * Creates a new sorted particle
  32971. * @param materialIndex
  32972. */
  32973. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32974. }
  32975. /**
  32976. * Represents a solid particle vertex
  32977. */
  32978. export class SolidParticleVertex {
  32979. /**
  32980. * Vertex position
  32981. */
  32982. position: Vector3;
  32983. /**
  32984. * Vertex color
  32985. */
  32986. color: Color4;
  32987. /**
  32988. * Vertex UV
  32989. */
  32990. uv: Vector2;
  32991. /**
  32992. * Creates a new solid particle vertex
  32993. */
  32994. constructor();
  32995. /** Vertex x coordinate */
  32996. get x(): number;
  32997. set x(val: number);
  32998. /** Vertex y coordinate */
  32999. get y(): number;
  33000. set y(val: number);
  33001. /** Vertex z coordinate */
  33002. get z(): number;
  33003. set z(val: number);
  33004. }
  33005. }
  33006. declare module "babylonjs/Collisions/meshCollisionData" {
  33007. import { Collider } from "babylonjs/Collisions/collider";
  33008. import { Vector3 } from "babylonjs/Maths/math.vector";
  33009. import { Nullable } from "babylonjs/types";
  33010. import { Observer } from "babylonjs/Misc/observable";
  33011. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33012. /**
  33013. * @hidden
  33014. */
  33015. export class _MeshCollisionData {
  33016. _checkCollisions: boolean;
  33017. _collisionMask: number;
  33018. _collisionGroup: number;
  33019. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33020. _collider: Nullable<Collider>;
  33021. _oldPositionForCollisions: Vector3;
  33022. _diffPositionForCollisions: Vector3;
  33023. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33024. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33025. }
  33026. }
  33027. declare module "babylonjs/Meshes/abstractMesh" {
  33028. import { Observable } from "babylonjs/Misc/observable";
  33029. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33030. import { Camera } from "babylonjs/Cameras/camera";
  33031. import { Scene, IDisposable } from "babylonjs/scene";
  33032. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33033. import { Node } from "babylonjs/node";
  33034. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33035. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33036. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33037. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33038. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33039. import { Material } from "babylonjs/Materials/material";
  33040. import { Light } from "babylonjs/Lights/light";
  33041. import { Skeleton } from "babylonjs/Bones/skeleton";
  33042. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33043. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33044. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33045. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33046. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33047. import { Plane } from "babylonjs/Maths/math.plane";
  33048. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33049. import { Ray } from "babylonjs/Culling/ray";
  33050. import { Collider } from "babylonjs/Collisions/collider";
  33051. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33052. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33053. /** @hidden */
  33054. class _FacetDataStorage {
  33055. facetPositions: Vector3[];
  33056. facetNormals: Vector3[];
  33057. facetPartitioning: number[][];
  33058. facetNb: number;
  33059. partitioningSubdivisions: number;
  33060. partitioningBBoxRatio: number;
  33061. facetDataEnabled: boolean;
  33062. facetParameters: any;
  33063. bbSize: Vector3;
  33064. subDiv: {
  33065. max: number;
  33066. X: number;
  33067. Y: number;
  33068. Z: number;
  33069. };
  33070. facetDepthSort: boolean;
  33071. facetDepthSortEnabled: boolean;
  33072. depthSortedIndices: IndicesArray;
  33073. depthSortedFacets: {
  33074. ind: number;
  33075. sqDistance: number;
  33076. }[];
  33077. facetDepthSortFunction: (f1: {
  33078. ind: number;
  33079. sqDistance: number;
  33080. }, f2: {
  33081. ind: number;
  33082. sqDistance: number;
  33083. }) => number;
  33084. facetDepthSortFrom: Vector3;
  33085. facetDepthSortOrigin: Vector3;
  33086. invertedMatrix: Matrix;
  33087. }
  33088. /**
  33089. * @hidden
  33090. **/
  33091. class _InternalAbstractMeshDataInfo {
  33092. _hasVertexAlpha: boolean;
  33093. _useVertexColors: boolean;
  33094. _numBoneInfluencers: number;
  33095. _applyFog: boolean;
  33096. _receiveShadows: boolean;
  33097. _facetData: _FacetDataStorage;
  33098. _visibility: number;
  33099. _skeleton: Nullable<Skeleton>;
  33100. _layerMask: number;
  33101. _computeBonesUsingShaders: boolean;
  33102. _isActive: boolean;
  33103. _onlyForInstances: boolean;
  33104. _isActiveIntermediate: boolean;
  33105. _onlyForInstancesIntermediate: boolean;
  33106. _actAsRegularMesh: boolean;
  33107. }
  33108. /**
  33109. * Class used to store all common mesh properties
  33110. */
  33111. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33112. /** No occlusion */
  33113. static OCCLUSION_TYPE_NONE: number;
  33114. /** Occlusion set to optimisitic */
  33115. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33116. /** Occlusion set to strict */
  33117. static OCCLUSION_TYPE_STRICT: number;
  33118. /** Use an accurante occlusion algorithm */
  33119. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33120. /** Use a conservative occlusion algorithm */
  33121. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33122. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33123. * Test order :
  33124. * Is the bounding sphere outside the frustum ?
  33125. * If not, are the bounding box vertices outside the frustum ?
  33126. * It not, then the cullable object is in the frustum.
  33127. */
  33128. static readonly CULLINGSTRATEGY_STANDARD: number;
  33129. /** Culling strategy : Bounding Sphere Only.
  33130. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33131. * It's also less accurate than the standard because some not visible objects can still be selected.
  33132. * Test : is the bounding sphere outside the frustum ?
  33133. * If not, then the cullable object is in the frustum.
  33134. */
  33135. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33136. /** Culling strategy : Optimistic Inclusion.
  33137. * This in an inclusion test first, then the standard exclusion test.
  33138. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33139. * 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.
  33140. * Anyway, it's as accurate as the standard strategy.
  33141. * Test :
  33142. * Is the cullable object bounding sphere center in the frustum ?
  33143. * If not, apply the default culling strategy.
  33144. */
  33145. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33146. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33147. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33148. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33149. * 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.
  33150. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33151. * Test :
  33152. * Is the cullable object bounding sphere center in the frustum ?
  33153. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33154. */
  33155. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33156. /**
  33157. * No billboard
  33158. */
  33159. static get BILLBOARDMODE_NONE(): number;
  33160. /** Billboard on X axis */
  33161. static get BILLBOARDMODE_X(): number;
  33162. /** Billboard on Y axis */
  33163. static get BILLBOARDMODE_Y(): number;
  33164. /** Billboard on Z axis */
  33165. static get BILLBOARDMODE_Z(): number;
  33166. /** Billboard on all axes */
  33167. static get BILLBOARDMODE_ALL(): number;
  33168. /** Billboard on using position instead of orientation */
  33169. static get BILLBOARDMODE_USE_POSITION(): number;
  33170. /** @hidden */
  33171. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33172. /**
  33173. * The culling strategy to use to check whether the mesh must be rendered or not.
  33174. * This value can be changed at any time and will be used on the next render mesh selection.
  33175. * The possible values are :
  33176. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33177. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33178. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33179. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33180. * Please read each static variable documentation to get details about the culling process.
  33181. * */
  33182. cullingStrategy: number;
  33183. /**
  33184. * Gets the number of facets in the mesh
  33185. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33186. */
  33187. get facetNb(): number;
  33188. /**
  33189. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33190. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33191. */
  33192. get partitioningSubdivisions(): number;
  33193. set partitioningSubdivisions(nb: number);
  33194. /**
  33195. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33196. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33197. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33198. */
  33199. get partitioningBBoxRatio(): number;
  33200. set partitioningBBoxRatio(ratio: number);
  33201. /**
  33202. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33203. * Works only for updatable meshes.
  33204. * Doesn't work with multi-materials
  33205. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33206. */
  33207. get mustDepthSortFacets(): boolean;
  33208. set mustDepthSortFacets(sort: boolean);
  33209. /**
  33210. * The location (Vector3) where the facet depth sort must be computed from.
  33211. * By default, the active camera position.
  33212. * Used only when facet depth sort is enabled
  33213. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33214. */
  33215. get facetDepthSortFrom(): Vector3;
  33216. set facetDepthSortFrom(location: Vector3);
  33217. /**
  33218. * gets a boolean indicating if facetData is enabled
  33219. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33220. */
  33221. get isFacetDataEnabled(): boolean;
  33222. /** @hidden */
  33223. _updateNonUniformScalingState(value: boolean): boolean;
  33224. /**
  33225. * An event triggered when this mesh collides with another one
  33226. */
  33227. onCollideObservable: Observable<AbstractMesh>;
  33228. /** Set a function to call when this mesh collides with another one */
  33229. set onCollide(callback: () => void);
  33230. /**
  33231. * An event triggered when the collision's position changes
  33232. */
  33233. onCollisionPositionChangeObservable: Observable<Vector3>;
  33234. /** Set a function to call when the collision's position changes */
  33235. set onCollisionPositionChange(callback: () => void);
  33236. /**
  33237. * An event triggered when material is changed
  33238. */
  33239. onMaterialChangedObservable: Observable<AbstractMesh>;
  33240. /**
  33241. * Gets or sets the orientation for POV movement & rotation
  33242. */
  33243. definedFacingForward: boolean;
  33244. /** @hidden */
  33245. _occlusionQuery: Nullable<WebGLQuery>;
  33246. /** @hidden */
  33247. _renderingGroup: Nullable<RenderingGroup>;
  33248. /**
  33249. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33250. */
  33251. get visibility(): number;
  33252. /**
  33253. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33254. */
  33255. set visibility(value: number);
  33256. /** Gets or sets the alpha index used to sort transparent meshes
  33257. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33258. */
  33259. alphaIndex: number;
  33260. /**
  33261. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33262. */
  33263. isVisible: boolean;
  33264. /**
  33265. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33266. */
  33267. isPickable: boolean;
  33268. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33269. showSubMeshesBoundingBox: boolean;
  33270. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33271. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33272. */
  33273. isBlocker: boolean;
  33274. /**
  33275. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33276. */
  33277. enablePointerMoveEvents: boolean;
  33278. /**
  33279. * Specifies the rendering group id for this mesh (0 by default)
  33280. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33281. */
  33282. renderingGroupId: number;
  33283. private _material;
  33284. /** Gets or sets current material */
  33285. get material(): Nullable<Material>;
  33286. set material(value: Nullable<Material>);
  33287. /**
  33288. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33289. * @see https://doc.babylonjs.com/babylon101/shadows
  33290. */
  33291. get receiveShadows(): boolean;
  33292. set receiveShadows(value: boolean);
  33293. /** Defines color to use when rendering outline */
  33294. outlineColor: Color3;
  33295. /** Define width to use when rendering outline */
  33296. outlineWidth: number;
  33297. /** Defines color to use when rendering overlay */
  33298. overlayColor: Color3;
  33299. /** Defines alpha to use when rendering overlay */
  33300. overlayAlpha: number;
  33301. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33302. get hasVertexAlpha(): boolean;
  33303. set hasVertexAlpha(value: boolean);
  33304. /** 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) */
  33305. get useVertexColors(): boolean;
  33306. set useVertexColors(value: boolean);
  33307. /**
  33308. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33309. */
  33310. get computeBonesUsingShaders(): boolean;
  33311. set computeBonesUsingShaders(value: boolean);
  33312. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33313. get numBoneInfluencers(): number;
  33314. set numBoneInfluencers(value: number);
  33315. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33316. get applyFog(): boolean;
  33317. set applyFog(value: boolean);
  33318. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33319. useOctreeForRenderingSelection: boolean;
  33320. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33321. useOctreeForPicking: boolean;
  33322. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33323. useOctreeForCollisions: boolean;
  33324. /**
  33325. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33326. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33327. */
  33328. get layerMask(): number;
  33329. set layerMask(value: number);
  33330. /**
  33331. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33332. */
  33333. alwaysSelectAsActiveMesh: boolean;
  33334. /**
  33335. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33336. */
  33337. doNotSyncBoundingInfo: boolean;
  33338. /**
  33339. * Gets or sets the current action manager
  33340. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33341. */
  33342. actionManager: Nullable<AbstractActionManager>;
  33343. private _meshCollisionData;
  33344. /**
  33345. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33346. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33347. */
  33348. ellipsoid: Vector3;
  33349. /**
  33350. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33351. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33352. */
  33353. ellipsoidOffset: Vector3;
  33354. /**
  33355. * Gets or sets a collision mask used to mask collisions (default is -1).
  33356. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33357. */
  33358. get collisionMask(): number;
  33359. set collisionMask(mask: number);
  33360. /**
  33361. * Gets or sets the current collision group mask (-1 by default).
  33362. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33363. */
  33364. get collisionGroup(): number;
  33365. set collisionGroup(mask: number);
  33366. /**
  33367. * Gets or sets current surrounding meshes (null by default).
  33368. *
  33369. * By default collision detection is tested against every mesh in the scene.
  33370. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33371. * meshes will be tested for the collision.
  33372. *
  33373. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33374. */
  33375. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33376. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33377. /**
  33378. * Defines edge width used when edgesRenderer is enabled
  33379. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33380. */
  33381. edgesWidth: number;
  33382. /**
  33383. * Defines edge color used when edgesRenderer is enabled
  33384. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33385. */
  33386. edgesColor: Color4;
  33387. /** @hidden */
  33388. _edgesRenderer: Nullable<IEdgesRenderer>;
  33389. /** @hidden */
  33390. _masterMesh: Nullable<AbstractMesh>;
  33391. /** @hidden */
  33392. _boundingInfo: Nullable<BoundingInfo>;
  33393. /** @hidden */
  33394. _renderId: number;
  33395. /**
  33396. * Gets or sets the list of subMeshes
  33397. * @see https://doc.babylonjs.com/how_to/multi_materials
  33398. */
  33399. subMeshes: SubMesh[];
  33400. /** @hidden */
  33401. _intersectionsInProgress: AbstractMesh[];
  33402. /** @hidden */
  33403. _unIndexed: boolean;
  33404. /** @hidden */
  33405. _lightSources: Light[];
  33406. /** Gets the list of lights affecting that mesh */
  33407. get lightSources(): Light[];
  33408. /** @hidden */
  33409. get _positions(): Nullable<Vector3[]>;
  33410. /** @hidden */
  33411. _waitingData: {
  33412. lods: Nullable<any>;
  33413. actions: Nullable<any>;
  33414. freezeWorldMatrix: Nullable<boolean>;
  33415. };
  33416. /** @hidden */
  33417. _bonesTransformMatrices: Nullable<Float32Array>;
  33418. /** @hidden */
  33419. _transformMatrixTexture: Nullable<RawTexture>;
  33420. /**
  33421. * Gets or sets a skeleton to apply skining transformations
  33422. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33423. */
  33424. set skeleton(value: Nullable<Skeleton>);
  33425. get skeleton(): Nullable<Skeleton>;
  33426. /**
  33427. * An event triggered when the mesh is rebuilt.
  33428. */
  33429. onRebuildObservable: Observable<AbstractMesh>;
  33430. /**
  33431. * Creates a new AbstractMesh
  33432. * @param name defines the name of the mesh
  33433. * @param scene defines the hosting scene
  33434. */
  33435. constructor(name: string, scene?: Nullable<Scene>);
  33436. /**
  33437. * Returns the string "AbstractMesh"
  33438. * @returns "AbstractMesh"
  33439. */
  33440. getClassName(): string;
  33441. /**
  33442. * Gets a string representation of the current mesh
  33443. * @param fullDetails defines a boolean indicating if full details must be included
  33444. * @returns a string representation of the current mesh
  33445. */
  33446. toString(fullDetails?: boolean): string;
  33447. /**
  33448. * @hidden
  33449. */
  33450. protected _getEffectiveParent(): Nullable<Node>;
  33451. /** @hidden */
  33452. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33453. /** @hidden */
  33454. _rebuild(): void;
  33455. /** @hidden */
  33456. _resyncLightSources(): void;
  33457. /** @hidden */
  33458. _resyncLightSource(light: Light): void;
  33459. /** @hidden */
  33460. _unBindEffect(): void;
  33461. /** @hidden */
  33462. _removeLightSource(light: Light, dispose: boolean): void;
  33463. private _markSubMeshesAsDirty;
  33464. /** @hidden */
  33465. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33466. /** @hidden */
  33467. _markSubMeshesAsAttributesDirty(): void;
  33468. /** @hidden */
  33469. _markSubMeshesAsMiscDirty(): void;
  33470. /**
  33471. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33472. */
  33473. get scaling(): Vector3;
  33474. set scaling(newScaling: Vector3);
  33475. /**
  33476. * Returns true if the mesh is blocked. Implemented by child classes
  33477. */
  33478. get isBlocked(): boolean;
  33479. /**
  33480. * Returns the mesh itself by default. Implemented by child classes
  33481. * @param camera defines the camera to use to pick the right LOD level
  33482. * @returns the currentAbstractMesh
  33483. */
  33484. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33485. /**
  33486. * Returns 0 by default. Implemented by child classes
  33487. * @returns an integer
  33488. */
  33489. getTotalVertices(): number;
  33490. /**
  33491. * Returns a positive integer : the total number of indices in this mesh geometry.
  33492. * @returns the numner of indices or zero if the mesh has no geometry.
  33493. */
  33494. getTotalIndices(): number;
  33495. /**
  33496. * Returns null by default. Implemented by child classes
  33497. * @returns null
  33498. */
  33499. getIndices(): Nullable<IndicesArray>;
  33500. /**
  33501. * Returns the array of the requested vertex data kind. Implemented by child classes
  33502. * @param kind defines the vertex data kind to use
  33503. * @returns null
  33504. */
  33505. getVerticesData(kind: string): Nullable<FloatArray>;
  33506. /**
  33507. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33508. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33509. * Note that a new underlying VertexBuffer object is created each call.
  33510. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33511. * @param kind defines vertex data kind:
  33512. * * VertexBuffer.PositionKind
  33513. * * VertexBuffer.UVKind
  33514. * * VertexBuffer.UV2Kind
  33515. * * VertexBuffer.UV3Kind
  33516. * * VertexBuffer.UV4Kind
  33517. * * VertexBuffer.UV5Kind
  33518. * * VertexBuffer.UV6Kind
  33519. * * VertexBuffer.ColorKind
  33520. * * VertexBuffer.MatricesIndicesKind
  33521. * * VertexBuffer.MatricesIndicesExtraKind
  33522. * * VertexBuffer.MatricesWeightsKind
  33523. * * VertexBuffer.MatricesWeightsExtraKind
  33524. * @param data defines the data source
  33525. * @param updatable defines if the data must be flagged as updatable (or static)
  33526. * @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
  33527. * @returns the current mesh
  33528. */
  33529. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33530. /**
  33531. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33532. * If the mesh has no geometry, it is simply returned as it is.
  33533. * @param kind defines vertex data kind:
  33534. * * VertexBuffer.PositionKind
  33535. * * VertexBuffer.UVKind
  33536. * * VertexBuffer.UV2Kind
  33537. * * VertexBuffer.UV3Kind
  33538. * * VertexBuffer.UV4Kind
  33539. * * VertexBuffer.UV5Kind
  33540. * * VertexBuffer.UV6Kind
  33541. * * VertexBuffer.ColorKind
  33542. * * VertexBuffer.MatricesIndicesKind
  33543. * * VertexBuffer.MatricesIndicesExtraKind
  33544. * * VertexBuffer.MatricesWeightsKind
  33545. * * VertexBuffer.MatricesWeightsExtraKind
  33546. * @param data defines the data source
  33547. * @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
  33548. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33549. * @returns the current mesh
  33550. */
  33551. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33552. /**
  33553. * Sets the mesh indices,
  33554. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33555. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33556. * @param totalVertices Defines the total number of vertices
  33557. * @returns the current mesh
  33558. */
  33559. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33560. /**
  33561. * Gets a boolean indicating if specific vertex data is present
  33562. * @param kind defines the vertex data kind to use
  33563. * @returns true is data kind is present
  33564. */
  33565. isVerticesDataPresent(kind: string): boolean;
  33566. /**
  33567. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33568. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33569. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33570. * @returns a BoundingInfo
  33571. */
  33572. getBoundingInfo(): BoundingInfo;
  33573. /**
  33574. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33575. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33576. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33577. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33578. * @returns the current mesh
  33579. */
  33580. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33581. /**
  33582. * Overwrite the current bounding info
  33583. * @param boundingInfo defines the new bounding info
  33584. * @returns the current mesh
  33585. */
  33586. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33587. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33588. get useBones(): boolean;
  33589. /** @hidden */
  33590. _preActivate(): void;
  33591. /** @hidden */
  33592. _preActivateForIntermediateRendering(renderId: number): void;
  33593. /** @hidden */
  33594. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33595. /** @hidden */
  33596. _postActivate(): void;
  33597. /** @hidden */
  33598. _freeze(): void;
  33599. /** @hidden */
  33600. _unFreeze(): void;
  33601. /**
  33602. * Gets the current world matrix
  33603. * @returns a Matrix
  33604. */
  33605. getWorldMatrix(): Matrix;
  33606. /** @hidden */
  33607. _getWorldMatrixDeterminant(): number;
  33608. /**
  33609. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33610. */
  33611. get isAnInstance(): boolean;
  33612. /**
  33613. * Gets a boolean indicating if this mesh has instances
  33614. */
  33615. get hasInstances(): boolean;
  33616. /**
  33617. * Gets a boolean indicating if this mesh has thin instances
  33618. */
  33619. get hasThinInstances(): boolean;
  33620. /**
  33621. * Perform relative position change from the point of view of behind the front of the mesh.
  33622. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33623. * Supports definition of mesh facing forward or backward
  33624. * @param amountRight defines the distance on the right axis
  33625. * @param amountUp defines the distance on the up axis
  33626. * @param amountForward defines the distance on the forward axis
  33627. * @returns the current mesh
  33628. */
  33629. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33630. /**
  33631. * Calculate relative position change from the point of view of behind the front of the mesh.
  33632. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33633. * Supports definition of mesh facing forward or backward
  33634. * @param amountRight defines the distance on the right axis
  33635. * @param amountUp defines the distance on the up axis
  33636. * @param amountForward defines the distance on the forward axis
  33637. * @returns the new displacement vector
  33638. */
  33639. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33640. /**
  33641. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33642. * Supports definition of mesh facing forward or backward
  33643. * @param flipBack defines the flip
  33644. * @param twirlClockwise defines the twirl
  33645. * @param tiltRight defines the tilt
  33646. * @returns the current mesh
  33647. */
  33648. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33649. /**
  33650. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33651. * Supports definition of mesh facing forward or backward.
  33652. * @param flipBack defines the flip
  33653. * @param twirlClockwise defines the twirl
  33654. * @param tiltRight defines the tilt
  33655. * @returns the new rotation vector
  33656. */
  33657. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33658. /**
  33659. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33660. * This means the mesh underlying bounding box and sphere are recomputed.
  33661. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33662. * @returns the current mesh
  33663. */
  33664. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33665. /** @hidden */
  33666. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33667. /** @hidden */
  33668. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33669. /** @hidden */
  33670. _updateBoundingInfo(): AbstractMesh;
  33671. /** @hidden */
  33672. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33673. /** @hidden */
  33674. protected _afterComputeWorldMatrix(): void;
  33675. /** @hidden */
  33676. get _effectiveMesh(): AbstractMesh;
  33677. /**
  33678. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33679. * A mesh is in the frustum if its bounding box intersects the frustum
  33680. * @param frustumPlanes defines the frustum to test
  33681. * @returns true if the mesh is in the frustum planes
  33682. */
  33683. isInFrustum(frustumPlanes: Plane[]): boolean;
  33684. /**
  33685. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33686. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33687. * @param frustumPlanes defines the frustum to test
  33688. * @returns true if the mesh is completely in the frustum planes
  33689. */
  33690. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33691. /**
  33692. * True if the mesh intersects another mesh or a SolidParticle object
  33693. * @param mesh defines a target mesh or SolidParticle to test
  33694. * @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)
  33695. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33696. * @returns true if there is an intersection
  33697. */
  33698. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33699. /**
  33700. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33701. * @param point defines the point to test
  33702. * @returns true if there is an intersection
  33703. */
  33704. intersectsPoint(point: Vector3): boolean;
  33705. /**
  33706. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33707. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33708. */
  33709. get checkCollisions(): boolean;
  33710. set checkCollisions(collisionEnabled: boolean);
  33711. /**
  33712. * Gets Collider object used to compute collisions (not physics)
  33713. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33714. */
  33715. get collider(): Nullable<Collider>;
  33716. /**
  33717. * Move the mesh using collision engine
  33718. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33719. * @param displacement defines the requested displacement vector
  33720. * @returns the current mesh
  33721. */
  33722. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33723. private _onCollisionPositionChange;
  33724. /** @hidden */
  33725. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33726. /** @hidden */
  33727. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33728. /** @hidden */
  33729. _checkCollision(collider: Collider): AbstractMesh;
  33730. /** @hidden */
  33731. _generatePointsArray(): boolean;
  33732. /**
  33733. * Checks if the passed Ray intersects with the mesh
  33734. * @param ray defines the ray to use
  33735. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33736. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33737. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33738. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33739. * @returns the picking info
  33740. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33741. */
  33742. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33743. /**
  33744. * Clones the current mesh
  33745. * @param name defines the mesh name
  33746. * @param newParent defines the new mesh parent
  33747. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33748. * @returns the new mesh
  33749. */
  33750. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33751. /**
  33752. * Disposes all the submeshes of the current meshnp
  33753. * @returns the current mesh
  33754. */
  33755. releaseSubMeshes(): AbstractMesh;
  33756. /**
  33757. * Releases resources associated with this abstract mesh.
  33758. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33759. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33760. */
  33761. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33762. /**
  33763. * Adds the passed mesh as a child to the current mesh
  33764. * @param mesh defines the child mesh
  33765. * @returns the current mesh
  33766. */
  33767. addChild(mesh: AbstractMesh): AbstractMesh;
  33768. /**
  33769. * Removes the passed mesh from the current mesh children list
  33770. * @param mesh defines the child mesh
  33771. * @returns the current mesh
  33772. */
  33773. removeChild(mesh: AbstractMesh): AbstractMesh;
  33774. /** @hidden */
  33775. private _initFacetData;
  33776. /**
  33777. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33778. * This method can be called within the render loop.
  33779. * 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
  33780. * @returns the current mesh
  33781. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33782. */
  33783. updateFacetData(): AbstractMesh;
  33784. /**
  33785. * Returns the facetLocalNormals array.
  33786. * The normals are expressed in the mesh local spac
  33787. * @returns an array of Vector3
  33788. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33789. */
  33790. getFacetLocalNormals(): Vector3[];
  33791. /**
  33792. * Returns the facetLocalPositions array.
  33793. * The facet positions are expressed in the mesh local space
  33794. * @returns an array of Vector3
  33795. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33796. */
  33797. getFacetLocalPositions(): Vector3[];
  33798. /**
  33799. * Returns the facetLocalPartioning array
  33800. * @returns an array of array of numbers
  33801. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33802. */
  33803. getFacetLocalPartitioning(): number[][];
  33804. /**
  33805. * Returns the i-th facet position in the world system.
  33806. * This method allocates a new Vector3 per call
  33807. * @param i defines the facet index
  33808. * @returns a new Vector3
  33809. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33810. */
  33811. getFacetPosition(i: number): Vector3;
  33812. /**
  33813. * Sets the reference Vector3 with the i-th facet position in the world system
  33814. * @param i defines the facet index
  33815. * @param ref defines the target vector
  33816. * @returns the current mesh
  33817. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33818. */
  33819. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33820. /**
  33821. * Returns the i-th facet normal in the world system.
  33822. * This method allocates a new Vector3 per call
  33823. * @param i defines the facet index
  33824. * @returns a new Vector3
  33825. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33826. */
  33827. getFacetNormal(i: number): Vector3;
  33828. /**
  33829. * Sets the reference Vector3 with the i-th facet normal in the world system
  33830. * @param i defines the facet index
  33831. * @param ref defines the target vector
  33832. * @returns the current mesh
  33833. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33834. */
  33835. getFacetNormalToRef(i: number, ref: Vector3): this;
  33836. /**
  33837. * 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)
  33838. * @param x defines x coordinate
  33839. * @param y defines y coordinate
  33840. * @param z defines z coordinate
  33841. * @returns the array of facet indexes
  33842. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33843. */
  33844. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33845. /**
  33846. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33847. * @param projected sets as the (x,y,z) world projection on the facet
  33848. * @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
  33849. * @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
  33850. * @param x defines x coordinate
  33851. * @param y defines y coordinate
  33852. * @param z defines z coordinate
  33853. * @returns the face index if found (or null instead)
  33854. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33855. */
  33856. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33857. /**
  33858. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33859. * @param projected sets as the (x,y,z) local 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. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33869. /**
  33870. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33871. * @returns the parameters
  33872. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33873. */
  33874. getFacetDataParameters(): any;
  33875. /**
  33876. * Disables the feature FacetData and frees the related memory
  33877. * @returns the current mesh
  33878. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33879. */
  33880. disableFacetData(): AbstractMesh;
  33881. /**
  33882. * Updates the AbstractMesh indices array
  33883. * @param indices defines the data source
  33884. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33885. * @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)
  33886. * @returns the current mesh
  33887. */
  33888. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33889. /**
  33890. * Creates new normals data for the mesh
  33891. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33892. * @returns the current mesh
  33893. */
  33894. createNormals(updatable: boolean): AbstractMesh;
  33895. /**
  33896. * Align the mesh with a normal
  33897. * @param normal defines the normal to use
  33898. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33899. * @returns the current mesh
  33900. */
  33901. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33902. /** @hidden */
  33903. _checkOcclusionQuery(): boolean;
  33904. /**
  33905. * Disables the mesh edge rendering mode
  33906. * @returns the currentAbstractMesh
  33907. */
  33908. disableEdgesRendering(): AbstractMesh;
  33909. /**
  33910. * Enables the edge rendering mode on the mesh.
  33911. * This mode makes the mesh edges visible
  33912. * @param epsilon defines the maximal distance between two angles to detect a face
  33913. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33914. * @returns the currentAbstractMesh
  33915. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33916. */
  33917. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33918. /**
  33919. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33920. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33921. */
  33922. getConnectedParticleSystems(): IParticleSystem[];
  33923. }
  33924. }
  33925. declare module "babylonjs/Actions/actionEvent" {
  33926. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33927. import { Nullable } from "babylonjs/types";
  33928. import { Sprite } from "babylonjs/Sprites/sprite";
  33929. import { Scene } from "babylonjs/scene";
  33930. import { Vector2 } from "babylonjs/Maths/math.vector";
  33931. /**
  33932. * Interface used to define ActionEvent
  33933. */
  33934. export interface IActionEvent {
  33935. /** The mesh or sprite that triggered the action */
  33936. source: any;
  33937. /** The X mouse cursor position at the time of the event */
  33938. pointerX: number;
  33939. /** The Y mouse cursor position at the time of the event */
  33940. pointerY: number;
  33941. /** The mesh that is currently pointed at (can be null) */
  33942. meshUnderPointer: Nullable<AbstractMesh>;
  33943. /** the original (browser) event that triggered the ActionEvent */
  33944. sourceEvent?: any;
  33945. /** additional data for the event */
  33946. additionalData?: any;
  33947. }
  33948. /**
  33949. * ActionEvent is the event being sent when an action is triggered.
  33950. */
  33951. export class ActionEvent implements IActionEvent {
  33952. /** The mesh or sprite that triggered the action */
  33953. source: any;
  33954. /** The X mouse cursor position at the time of the event */
  33955. pointerX: number;
  33956. /** The Y mouse cursor position at the time of the event */
  33957. pointerY: number;
  33958. /** The mesh that is currently pointed at (can be null) */
  33959. meshUnderPointer: Nullable<AbstractMesh>;
  33960. /** the original (browser) event that triggered the ActionEvent */
  33961. sourceEvent?: any;
  33962. /** additional data for the event */
  33963. additionalData?: any;
  33964. /**
  33965. * Creates a new ActionEvent
  33966. * @param source The mesh or sprite that triggered the action
  33967. * @param pointerX The X mouse cursor position at the time of the event
  33968. * @param pointerY The Y mouse cursor position at the time of the event
  33969. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33970. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33971. * @param additionalData additional data for the event
  33972. */
  33973. constructor(
  33974. /** The mesh or sprite that triggered the action */
  33975. source: any,
  33976. /** The X mouse cursor position at the time of the event */
  33977. pointerX: number,
  33978. /** The Y mouse cursor position at the time of the event */
  33979. pointerY: number,
  33980. /** The mesh that is currently pointed at (can be null) */
  33981. meshUnderPointer: Nullable<AbstractMesh>,
  33982. /** the original (browser) event that triggered the ActionEvent */
  33983. sourceEvent?: any,
  33984. /** additional data for the event */
  33985. additionalData?: any);
  33986. /**
  33987. * Helper function to auto-create an ActionEvent from a source mesh.
  33988. * @param source The source mesh that triggered the event
  33989. * @param evt The original (browser) event
  33990. * @param additionalData additional data for the event
  33991. * @returns the new ActionEvent
  33992. */
  33993. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  33994. /**
  33995. * Helper function to auto-create an ActionEvent from a source sprite
  33996. * @param source The source sprite that triggered the event
  33997. * @param scene Scene associated with the sprite
  33998. * @param evt The original (browser) event
  33999. * @param additionalData additional data for the event
  34000. * @returns the new ActionEvent
  34001. */
  34002. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34003. /**
  34004. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34005. * @param scene the scene where the event occurred
  34006. * @param evt The original (browser) event
  34007. * @returns the new ActionEvent
  34008. */
  34009. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34010. /**
  34011. * Helper function to auto-create an ActionEvent from a primitive
  34012. * @param prim defines the target primitive
  34013. * @param pointerPos defines the pointer position
  34014. * @param evt The original (browser) event
  34015. * @param additionalData additional data for the event
  34016. * @returns the new ActionEvent
  34017. */
  34018. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34019. }
  34020. }
  34021. declare module "babylonjs/Actions/abstractActionManager" {
  34022. import { IDisposable } from "babylonjs/scene";
  34023. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34024. import { IAction } from "babylonjs/Actions/action";
  34025. import { Nullable } from "babylonjs/types";
  34026. /**
  34027. * Abstract class used to decouple action Manager from scene and meshes.
  34028. * Do not instantiate.
  34029. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34030. */
  34031. export abstract class AbstractActionManager implements IDisposable {
  34032. /** Gets the list of active triggers */
  34033. static Triggers: {
  34034. [key: string]: number;
  34035. };
  34036. /** Gets the cursor to use when hovering items */
  34037. hoverCursor: string;
  34038. /** Gets the list of actions */
  34039. actions: IAction[];
  34040. /**
  34041. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34042. */
  34043. isRecursive: boolean;
  34044. /**
  34045. * Releases all associated resources
  34046. */
  34047. abstract dispose(): void;
  34048. /**
  34049. * Does this action manager has pointer triggers
  34050. */
  34051. abstract get hasPointerTriggers(): boolean;
  34052. /**
  34053. * Does this action manager has pick triggers
  34054. */
  34055. abstract get hasPickTriggers(): boolean;
  34056. /**
  34057. * Process a specific trigger
  34058. * @param trigger defines the trigger to process
  34059. * @param evt defines the event details to be processed
  34060. */
  34061. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34062. /**
  34063. * Does this action manager handles actions of any of the given triggers
  34064. * @param triggers defines the triggers to be tested
  34065. * @return a boolean indicating whether one (or more) of the triggers is handled
  34066. */
  34067. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34068. /**
  34069. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34070. * speed.
  34071. * @param triggerA defines the trigger to be tested
  34072. * @param triggerB defines the trigger to be tested
  34073. * @return a boolean indicating whether one (or more) of the triggers is handled
  34074. */
  34075. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34076. /**
  34077. * Does this action manager handles actions of a given trigger
  34078. * @param trigger defines the trigger to be tested
  34079. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34080. * @return whether the trigger is handled
  34081. */
  34082. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34083. /**
  34084. * Serialize this manager to a JSON object
  34085. * @param name defines the property name to store this manager
  34086. * @returns a JSON representation of this manager
  34087. */
  34088. abstract serialize(name: string): any;
  34089. /**
  34090. * Registers an action to this action manager
  34091. * @param action defines the action to be registered
  34092. * @return the action amended (prepared) after registration
  34093. */
  34094. abstract registerAction(action: IAction): Nullable<IAction>;
  34095. /**
  34096. * Unregisters an action to this action manager
  34097. * @param action defines the action to be unregistered
  34098. * @return a boolean indicating whether the action has been unregistered
  34099. */
  34100. abstract unregisterAction(action: IAction): Boolean;
  34101. /**
  34102. * Does exist one action manager with at least one trigger
  34103. **/
  34104. static get HasTriggers(): boolean;
  34105. /**
  34106. * Does exist one action manager with at least one pick trigger
  34107. **/
  34108. static get HasPickTriggers(): boolean;
  34109. /**
  34110. * Does exist one action manager that handles actions of a given trigger
  34111. * @param trigger defines the trigger to be tested
  34112. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34113. **/
  34114. static HasSpecificTrigger(trigger: number): boolean;
  34115. }
  34116. }
  34117. declare module "babylonjs/node" {
  34118. import { Scene } from "babylonjs/scene";
  34119. import { Nullable } from "babylonjs/types";
  34120. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34121. import { Engine } from "babylonjs/Engines/engine";
  34122. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34123. import { Observable } from "babylonjs/Misc/observable";
  34124. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34125. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34126. import { Animatable } from "babylonjs/Animations/animatable";
  34127. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34128. import { Animation } from "babylonjs/Animations/animation";
  34129. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34130. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34131. /**
  34132. * Defines how a node can be built from a string name.
  34133. */
  34134. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34135. /**
  34136. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34137. */
  34138. export class Node implements IBehaviorAware<Node> {
  34139. /** @hidden */
  34140. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34141. private static _NodeConstructors;
  34142. /**
  34143. * Add a new node constructor
  34144. * @param type defines the type name of the node to construct
  34145. * @param constructorFunc defines the constructor function
  34146. */
  34147. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34148. /**
  34149. * Returns a node constructor based on type name
  34150. * @param type defines the type name
  34151. * @param name defines the new node name
  34152. * @param scene defines the hosting scene
  34153. * @param options defines optional options to transmit to constructors
  34154. * @returns the new constructor or null
  34155. */
  34156. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34157. /**
  34158. * Gets or sets the name of the node
  34159. */
  34160. name: string;
  34161. /**
  34162. * Gets or sets the id of the node
  34163. */
  34164. id: string;
  34165. /**
  34166. * Gets or sets the unique id of the node
  34167. */
  34168. uniqueId: number;
  34169. /**
  34170. * Gets or sets a string used to store user defined state for the node
  34171. */
  34172. state: string;
  34173. /**
  34174. * Gets or sets an object used to store user defined information for the node
  34175. */
  34176. metadata: any;
  34177. /**
  34178. * For internal use only. Please do not use.
  34179. */
  34180. reservedDataStore: any;
  34181. /**
  34182. * List of inspectable custom properties (used by the Inspector)
  34183. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34184. */
  34185. inspectableCustomProperties: IInspectable[];
  34186. private _doNotSerialize;
  34187. /**
  34188. * Gets or sets a boolean used to define if the node must be serialized
  34189. */
  34190. get doNotSerialize(): boolean;
  34191. set doNotSerialize(value: boolean);
  34192. /** @hidden */
  34193. _isDisposed: boolean;
  34194. /**
  34195. * Gets a list of Animations associated with the node
  34196. */
  34197. animations: import("babylonjs/Animations/animation").Animation[];
  34198. protected _ranges: {
  34199. [name: string]: Nullable<AnimationRange>;
  34200. };
  34201. /**
  34202. * Callback raised when the node is ready to be used
  34203. */
  34204. onReady: Nullable<(node: Node) => void>;
  34205. private _isEnabled;
  34206. private _isParentEnabled;
  34207. private _isReady;
  34208. /** @hidden */
  34209. _currentRenderId: number;
  34210. private _parentUpdateId;
  34211. /** @hidden */
  34212. _childUpdateId: number;
  34213. /** @hidden */
  34214. _waitingParentId: Nullable<string>;
  34215. /** @hidden */
  34216. _scene: Scene;
  34217. /** @hidden */
  34218. _cache: any;
  34219. private _parentNode;
  34220. private _children;
  34221. /** @hidden */
  34222. _worldMatrix: Matrix;
  34223. /** @hidden */
  34224. _worldMatrixDeterminant: number;
  34225. /** @hidden */
  34226. _worldMatrixDeterminantIsDirty: boolean;
  34227. /** @hidden */
  34228. private _sceneRootNodesIndex;
  34229. /**
  34230. * Gets a boolean indicating if the node has been disposed
  34231. * @returns true if the node was disposed
  34232. */
  34233. isDisposed(): boolean;
  34234. /**
  34235. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34236. * @see https://doc.babylonjs.com/how_to/parenting
  34237. */
  34238. set parent(parent: Nullable<Node>);
  34239. get parent(): Nullable<Node>;
  34240. /** @hidden */
  34241. _addToSceneRootNodes(): void;
  34242. /** @hidden */
  34243. _removeFromSceneRootNodes(): void;
  34244. private _animationPropertiesOverride;
  34245. /**
  34246. * Gets or sets the animation properties override
  34247. */
  34248. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34249. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34250. /**
  34251. * Gets a string identifying the name of the class
  34252. * @returns "Node" string
  34253. */
  34254. getClassName(): string;
  34255. /** @hidden */
  34256. readonly _isNode: boolean;
  34257. /**
  34258. * An event triggered when the mesh is disposed
  34259. */
  34260. onDisposeObservable: Observable<Node>;
  34261. private _onDisposeObserver;
  34262. /**
  34263. * Sets a callback that will be raised when the node will be disposed
  34264. */
  34265. set onDispose(callback: () => void);
  34266. /**
  34267. * Creates a new Node
  34268. * @param name the name and id to be given to this node
  34269. * @param scene the scene this node will be added to
  34270. */
  34271. constructor(name: string, scene?: Nullable<Scene>);
  34272. /**
  34273. * Gets the scene of the node
  34274. * @returns a scene
  34275. */
  34276. getScene(): Scene;
  34277. /**
  34278. * Gets the engine of the node
  34279. * @returns a Engine
  34280. */
  34281. getEngine(): Engine;
  34282. private _behaviors;
  34283. /**
  34284. * Attach a behavior to the node
  34285. * @see https://doc.babylonjs.com/features/behaviour
  34286. * @param behavior defines the behavior to attach
  34287. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34288. * @returns the current Node
  34289. */
  34290. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34291. /**
  34292. * Remove an attached behavior
  34293. * @see https://doc.babylonjs.com/features/behaviour
  34294. * @param behavior defines the behavior to attach
  34295. * @returns the current Node
  34296. */
  34297. removeBehavior(behavior: Behavior<Node>): Node;
  34298. /**
  34299. * Gets the list of attached behaviors
  34300. * @see https://doc.babylonjs.com/features/behaviour
  34301. */
  34302. get behaviors(): Behavior<Node>[];
  34303. /**
  34304. * Gets an attached behavior by name
  34305. * @param name defines the name of the behavior to look for
  34306. * @see https://doc.babylonjs.com/features/behaviour
  34307. * @returns null if behavior was not found else the requested behavior
  34308. */
  34309. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34310. /**
  34311. * Returns the latest update of the World matrix
  34312. * @returns a Matrix
  34313. */
  34314. getWorldMatrix(): Matrix;
  34315. /** @hidden */
  34316. _getWorldMatrixDeterminant(): number;
  34317. /**
  34318. * Returns directly the latest state of the mesh World matrix.
  34319. * A Matrix is returned.
  34320. */
  34321. get worldMatrixFromCache(): Matrix;
  34322. /** @hidden */
  34323. _initCache(): void;
  34324. /** @hidden */
  34325. updateCache(force?: boolean): void;
  34326. /** @hidden */
  34327. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34328. /** @hidden */
  34329. _updateCache(ignoreParentClass?: boolean): void;
  34330. /** @hidden */
  34331. _isSynchronized(): boolean;
  34332. /** @hidden */
  34333. _markSyncedWithParent(): void;
  34334. /** @hidden */
  34335. isSynchronizedWithParent(): boolean;
  34336. /** @hidden */
  34337. isSynchronized(): boolean;
  34338. /**
  34339. * Is this node ready to be used/rendered
  34340. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34341. * @return true if the node is ready
  34342. */
  34343. isReady(completeCheck?: boolean): boolean;
  34344. /**
  34345. * Is this node enabled?
  34346. * 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
  34347. * @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
  34348. * @return whether this node (and its parent) is enabled
  34349. */
  34350. isEnabled(checkAncestors?: boolean): boolean;
  34351. /** @hidden */
  34352. protected _syncParentEnabledState(): void;
  34353. /**
  34354. * Set the enabled state of this node
  34355. * @param value defines the new enabled state
  34356. */
  34357. setEnabled(value: boolean): void;
  34358. /**
  34359. * Is this node a descendant of the given node?
  34360. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34361. * @param ancestor defines the parent node to inspect
  34362. * @returns a boolean indicating if this node is a descendant of the given node
  34363. */
  34364. isDescendantOf(ancestor: Node): boolean;
  34365. /** @hidden */
  34366. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34367. /**
  34368. * Will return all nodes that have this node as ascendant
  34369. * @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
  34370. * @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
  34371. * @return all children nodes of all types
  34372. */
  34373. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34374. /**
  34375. * Get all child-meshes of this node
  34376. * @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)
  34377. * @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
  34378. * @returns an array of AbstractMesh
  34379. */
  34380. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34381. /**
  34382. * Get all direct children of this node
  34383. * @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
  34384. * @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)
  34385. * @returns an array of Node
  34386. */
  34387. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34388. /** @hidden */
  34389. _setReady(state: boolean): void;
  34390. /**
  34391. * Get an animation by name
  34392. * @param name defines the name of the animation to look for
  34393. * @returns null if not found else the requested animation
  34394. */
  34395. getAnimationByName(name: string): Nullable<Animation>;
  34396. /**
  34397. * Creates an animation range for this node
  34398. * @param name defines the name of the range
  34399. * @param from defines the starting key
  34400. * @param to defines the end key
  34401. */
  34402. createAnimationRange(name: string, from: number, to: number): void;
  34403. /**
  34404. * Delete a specific animation range
  34405. * @param name defines the name of the range to delete
  34406. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34407. */
  34408. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34409. /**
  34410. * Get an animation range by name
  34411. * @param name defines the name of the animation range to look for
  34412. * @returns null if not found else the requested animation range
  34413. */
  34414. getAnimationRange(name: string): Nullable<AnimationRange>;
  34415. /**
  34416. * Gets the list of all animation ranges defined on this node
  34417. * @returns an array
  34418. */
  34419. getAnimationRanges(): Nullable<AnimationRange>[];
  34420. /**
  34421. * Will start the animation sequence
  34422. * @param name defines the range frames for animation sequence
  34423. * @param loop defines if the animation should loop (false by default)
  34424. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34425. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34426. * @returns the object created for this animation. If range does not exist, it will return null
  34427. */
  34428. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34429. /**
  34430. * Serialize animation ranges into a JSON compatible object
  34431. * @returns serialization object
  34432. */
  34433. serializeAnimationRanges(): any;
  34434. /**
  34435. * Computes the world matrix of the node
  34436. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34437. * @returns the world matrix
  34438. */
  34439. computeWorldMatrix(force?: boolean): Matrix;
  34440. /**
  34441. * Releases resources associated with this node.
  34442. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34443. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34444. */
  34445. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34446. /**
  34447. * Parse animation range data from a serialization object and store them into a given node
  34448. * @param node defines where to store the animation ranges
  34449. * @param parsedNode defines the serialization object to read data from
  34450. * @param scene defines the hosting scene
  34451. */
  34452. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34453. /**
  34454. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34455. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34456. * @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
  34457. * @returns the new bounding vectors
  34458. */
  34459. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34460. min: Vector3;
  34461. max: Vector3;
  34462. };
  34463. }
  34464. }
  34465. declare module "babylonjs/Animations/animation" {
  34466. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34467. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34468. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34469. import { Nullable } from "babylonjs/types";
  34470. import { Scene } from "babylonjs/scene";
  34471. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34472. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34473. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34474. import { Node } from "babylonjs/node";
  34475. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34476. import { Size } from "babylonjs/Maths/math.size";
  34477. import { Animatable } from "babylonjs/Animations/animatable";
  34478. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34479. /**
  34480. * @hidden
  34481. */
  34482. export class _IAnimationState {
  34483. key: number;
  34484. repeatCount: number;
  34485. workValue?: any;
  34486. loopMode?: number;
  34487. offsetValue?: any;
  34488. highLimitValue?: any;
  34489. }
  34490. /**
  34491. * Class used to store any kind of animation
  34492. */
  34493. export class Animation {
  34494. /**Name of the animation */
  34495. name: string;
  34496. /**Property to animate */
  34497. targetProperty: string;
  34498. /**The frames per second of the animation */
  34499. framePerSecond: number;
  34500. /**The data type of the animation */
  34501. dataType: number;
  34502. /**The loop mode of the animation */
  34503. loopMode?: number | undefined;
  34504. /**Specifies if blending should be enabled */
  34505. enableBlending?: boolean | undefined;
  34506. /**
  34507. * Use matrix interpolation instead of using direct key value when animating matrices
  34508. */
  34509. static AllowMatricesInterpolation: boolean;
  34510. /**
  34511. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34512. */
  34513. static AllowMatrixDecomposeForInterpolation: boolean;
  34514. /** Define the Url to load snippets */
  34515. static SnippetUrl: string;
  34516. /** Snippet ID if the animation was created from the snippet server */
  34517. snippetId: string;
  34518. /**
  34519. * Stores the key frames of the animation
  34520. */
  34521. private _keys;
  34522. /**
  34523. * Stores the easing function of the animation
  34524. */
  34525. private _easingFunction;
  34526. /**
  34527. * @hidden Internal use only
  34528. */
  34529. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34530. /**
  34531. * The set of event that will be linked to this animation
  34532. */
  34533. private _events;
  34534. /**
  34535. * Stores an array of target property paths
  34536. */
  34537. targetPropertyPath: string[];
  34538. /**
  34539. * Stores the blending speed of the animation
  34540. */
  34541. blendingSpeed: number;
  34542. /**
  34543. * Stores the animation ranges for the animation
  34544. */
  34545. private _ranges;
  34546. /**
  34547. * @hidden Internal use
  34548. */
  34549. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34550. /**
  34551. * Sets up an animation
  34552. * @param property The property to animate
  34553. * @param animationType The animation type to apply
  34554. * @param framePerSecond The frames per second of the animation
  34555. * @param easingFunction The easing function used in the animation
  34556. * @returns The created animation
  34557. */
  34558. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34559. /**
  34560. * Create and start an animation on a node
  34561. * @param name defines the name of the global animation that will be run on all nodes
  34562. * @param node defines the root node where the animation will take place
  34563. * @param targetProperty defines property to animate
  34564. * @param framePerSecond defines the number of frame per second yo use
  34565. * @param totalFrame defines the number of frames in total
  34566. * @param from defines the initial value
  34567. * @param to defines the final value
  34568. * @param loopMode defines which loop mode you want to use (off by default)
  34569. * @param easingFunction defines the easing function to use (linear by default)
  34570. * @param onAnimationEnd defines the callback to call when animation end
  34571. * @returns the animatable created for this animation
  34572. */
  34573. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34574. /**
  34575. * Create and start an animation on a node and its descendants
  34576. * @param name defines the name of the global animation that will be run on all nodes
  34577. * @param node defines the root node where the animation will take place
  34578. * @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
  34579. * @param targetProperty defines property to animate
  34580. * @param framePerSecond defines the number of frame per second to use
  34581. * @param totalFrame defines the number of frames in total
  34582. * @param from defines the initial value
  34583. * @param to defines the final value
  34584. * @param loopMode defines which loop mode you want to use (off by default)
  34585. * @param easingFunction defines the easing function to use (linear by default)
  34586. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34587. * @returns the list of animatables created for all nodes
  34588. * @example https://www.babylonjs-playground.com/#MH0VLI
  34589. */
  34590. 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[]>;
  34591. /**
  34592. * Creates a new animation, merges it with the existing animations and starts it
  34593. * @param name Name of the animation
  34594. * @param node Node which contains the scene that begins the animations
  34595. * @param targetProperty Specifies which property to animate
  34596. * @param framePerSecond The frames per second of the animation
  34597. * @param totalFrame The total number of frames
  34598. * @param from The frame at the beginning of the animation
  34599. * @param to The frame at the end of the animation
  34600. * @param loopMode Specifies the loop mode of the animation
  34601. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34602. * @param onAnimationEnd Callback to run once the animation is complete
  34603. * @returns Nullable animation
  34604. */
  34605. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34606. /**
  34607. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34608. * @param sourceAnimation defines the Animation containing keyframes to convert
  34609. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34610. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34611. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34612. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34613. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34614. */
  34615. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34616. /**
  34617. * Transition property of an host to the target Value
  34618. * @param property The property to transition
  34619. * @param targetValue The target Value of the property
  34620. * @param host The object where the property to animate belongs
  34621. * @param scene Scene used to run the animation
  34622. * @param frameRate Framerate (in frame/s) to use
  34623. * @param transition The transition type we want to use
  34624. * @param duration The duration of the animation, in milliseconds
  34625. * @param onAnimationEnd Callback trigger at the end of the animation
  34626. * @returns Nullable animation
  34627. */
  34628. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34629. /**
  34630. * Return the array of runtime animations currently using this animation
  34631. */
  34632. get runtimeAnimations(): RuntimeAnimation[];
  34633. /**
  34634. * Specifies if any of the runtime animations are currently running
  34635. */
  34636. get hasRunningRuntimeAnimations(): boolean;
  34637. /**
  34638. * Initializes the animation
  34639. * @param name Name of the animation
  34640. * @param targetProperty Property to animate
  34641. * @param framePerSecond The frames per second of the animation
  34642. * @param dataType The data type of the animation
  34643. * @param loopMode The loop mode of the animation
  34644. * @param enableBlending Specifies if blending should be enabled
  34645. */
  34646. constructor(
  34647. /**Name of the animation */
  34648. name: string,
  34649. /**Property to animate */
  34650. targetProperty: string,
  34651. /**The frames per second of the animation */
  34652. framePerSecond: number,
  34653. /**The data type of the animation */
  34654. dataType: number,
  34655. /**The loop mode of the animation */
  34656. loopMode?: number | undefined,
  34657. /**Specifies if blending should be enabled */
  34658. enableBlending?: boolean | undefined);
  34659. /**
  34660. * Converts the animation to a string
  34661. * @param fullDetails support for multiple levels of logging within scene loading
  34662. * @returns String form of the animation
  34663. */
  34664. toString(fullDetails?: boolean): string;
  34665. /**
  34666. * Add an event to this animation
  34667. * @param event Event to add
  34668. */
  34669. addEvent(event: AnimationEvent): void;
  34670. /**
  34671. * Remove all events found at the given frame
  34672. * @param frame The frame to remove events from
  34673. */
  34674. removeEvents(frame: number): void;
  34675. /**
  34676. * Retrieves all the events from the animation
  34677. * @returns Events from the animation
  34678. */
  34679. getEvents(): AnimationEvent[];
  34680. /**
  34681. * Creates an animation range
  34682. * @param name Name of the animation range
  34683. * @param from Starting frame of the animation range
  34684. * @param to Ending frame of the animation
  34685. */
  34686. createRange(name: string, from: number, to: number): void;
  34687. /**
  34688. * Deletes an animation range by name
  34689. * @param name Name of the animation range to delete
  34690. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34691. */
  34692. deleteRange(name: string, deleteFrames?: boolean): void;
  34693. /**
  34694. * Gets the animation range by name, or null if not defined
  34695. * @param name Name of the animation range
  34696. * @returns Nullable animation range
  34697. */
  34698. getRange(name: string): Nullable<AnimationRange>;
  34699. /**
  34700. * Gets the key frames from the animation
  34701. * @returns The key frames of the animation
  34702. */
  34703. getKeys(): Array<IAnimationKey>;
  34704. /**
  34705. * Gets the highest frame rate of the animation
  34706. * @returns Highest frame rate of the animation
  34707. */
  34708. getHighestFrame(): number;
  34709. /**
  34710. * Gets the easing function of the animation
  34711. * @returns Easing function of the animation
  34712. */
  34713. getEasingFunction(): IEasingFunction;
  34714. /**
  34715. * Sets the easing function of the animation
  34716. * @param easingFunction A custom mathematical formula for animation
  34717. */
  34718. setEasingFunction(easingFunction: EasingFunction): void;
  34719. /**
  34720. * Interpolates a scalar linearly
  34721. * @param startValue Start value of the animation curve
  34722. * @param endValue End value of the animation curve
  34723. * @param gradient Scalar amount to interpolate
  34724. * @returns Interpolated scalar value
  34725. */
  34726. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34727. /**
  34728. * Interpolates a scalar cubically
  34729. * @param startValue Start value of the animation curve
  34730. * @param outTangent End tangent of the animation
  34731. * @param endValue End value of the animation curve
  34732. * @param inTangent Start tangent of the animation curve
  34733. * @param gradient Scalar amount to interpolate
  34734. * @returns Interpolated scalar value
  34735. */
  34736. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34737. /**
  34738. * Interpolates a quaternion using a spherical linear interpolation
  34739. * @param startValue Start value of the animation curve
  34740. * @param endValue End value of the animation curve
  34741. * @param gradient Scalar amount to interpolate
  34742. * @returns Interpolated quaternion value
  34743. */
  34744. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34745. /**
  34746. * Interpolates a quaternion cubically
  34747. * @param startValue Start value of the animation curve
  34748. * @param outTangent End tangent of the animation curve
  34749. * @param endValue End value of the animation curve
  34750. * @param inTangent Start tangent of the animation curve
  34751. * @param gradient Scalar amount to interpolate
  34752. * @returns Interpolated quaternion value
  34753. */
  34754. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34755. /**
  34756. * Interpolates a Vector3 linearl
  34757. * @param startValue Start value of the animation curve
  34758. * @param endValue End value of the animation curve
  34759. * @param gradient Scalar amount to interpolate
  34760. * @returns Interpolated scalar value
  34761. */
  34762. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34763. /**
  34764. * Interpolates a Vector3 cubically
  34765. * @param startValue Start value of the animation curve
  34766. * @param outTangent End tangent of the animation
  34767. * @param endValue End value of the animation curve
  34768. * @param inTangent Start tangent of the animation curve
  34769. * @param gradient Scalar amount to interpolate
  34770. * @returns InterpolatedVector3 value
  34771. */
  34772. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34773. /**
  34774. * Interpolates a Vector2 linearly
  34775. * @param startValue Start value of the animation curve
  34776. * @param endValue End value of the animation curve
  34777. * @param gradient Scalar amount to interpolate
  34778. * @returns Interpolated Vector2 value
  34779. */
  34780. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34781. /**
  34782. * Interpolates a Vector2 cubically
  34783. * @param startValue Start value of the animation curve
  34784. * @param outTangent End tangent of the animation
  34785. * @param endValue End value of the animation curve
  34786. * @param inTangent Start tangent of the animation curve
  34787. * @param gradient Scalar amount to interpolate
  34788. * @returns Interpolated Vector2 value
  34789. */
  34790. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34791. /**
  34792. * Interpolates a size linearly
  34793. * @param startValue Start value of the animation curve
  34794. * @param endValue End value of the animation curve
  34795. * @param gradient Scalar amount to interpolate
  34796. * @returns Interpolated Size value
  34797. */
  34798. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34799. /**
  34800. * Interpolates a Color3 linearly
  34801. * @param startValue Start value of the animation curve
  34802. * @param endValue End value of the animation curve
  34803. * @param gradient Scalar amount to interpolate
  34804. * @returns Interpolated Color3 value
  34805. */
  34806. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34807. /**
  34808. * Interpolates a Color4 linearly
  34809. * @param startValue Start value of the animation curve
  34810. * @param endValue End value of the animation curve
  34811. * @param gradient Scalar amount to interpolate
  34812. * @returns Interpolated Color3 value
  34813. */
  34814. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34815. /**
  34816. * @hidden Internal use only
  34817. */
  34818. _getKeyValue(value: any): any;
  34819. /**
  34820. * @hidden Internal use only
  34821. */
  34822. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34823. /**
  34824. * Defines the function to use to interpolate matrices
  34825. * @param startValue defines the start matrix
  34826. * @param endValue defines the end matrix
  34827. * @param gradient defines the gradient between both matrices
  34828. * @param result defines an optional target matrix where to store the interpolation
  34829. * @returns the interpolated matrix
  34830. */
  34831. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34832. /**
  34833. * Makes a copy of the animation
  34834. * @returns Cloned animation
  34835. */
  34836. clone(): Animation;
  34837. /**
  34838. * Sets the key frames of the animation
  34839. * @param values The animation key frames to set
  34840. */
  34841. setKeys(values: Array<IAnimationKey>): void;
  34842. /**
  34843. * Serializes the animation to an object
  34844. * @returns Serialized object
  34845. */
  34846. serialize(): any;
  34847. /**
  34848. * Float animation type
  34849. */
  34850. static readonly ANIMATIONTYPE_FLOAT: number;
  34851. /**
  34852. * Vector3 animation type
  34853. */
  34854. static readonly ANIMATIONTYPE_VECTOR3: number;
  34855. /**
  34856. * Quaternion animation type
  34857. */
  34858. static readonly ANIMATIONTYPE_QUATERNION: number;
  34859. /**
  34860. * Matrix animation type
  34861. */
  34862. static readonly ANIMATIONTYPE_MATRIX: number;
  34863. /**
  34864. * Color3 animation type
  34865. */
  34866. static readonly ANIMATIONTYPE_COLOR3: number;
  34867. /**
  34868. * Color3 animation type
  34869. */
  34870. static readonly ANIMATIONTYPE_COLOR4: number;
  34871. /**
  34872. * Vector2 animation type
  34873. */
  34874. static readonly ANIMATIONTYPE_VECTOR2: number;
  34875. /**
  34876. * Size animation type
  34877. */
  34878. static readonly ANIMATIONTYPE_SIZE: number;
  34879. /**
  34880. * Relative Loop Mode
  34881. */
  34882. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34883. /**
  34884. * Cycle Loop Mode
  34885. */
  34886. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34887. /**
  34888. * Constant Loop Mode
  34889. */
  34890. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34891. /** @hidden */
  34892. static _UniversalLerp(left: any, right: any, amount: number): any;
  34893. /**
  34894. * Parses an animation object and creates an animation
  34895. * @param parsedAnimation Parsed animation object
  34896. * @returns Animation object
  34897. */
  34898. static Parse(parsedAnimation: any): Animation;
  34899. /**
  34900. * Appends the serialized animations from the source animations
  34901. * @param source Source containing the animations
  34902. * @param destination Target to store the animations
  34903. */
  34904. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34905. /**
  34906. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34907. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34908. * @param url defines the url to load from
  34909. * @returns a promise that will resolve to the new animation or an array of animations
  34910. */
  34911. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34912. /**
  34913. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34914. * @param snippetId defines the snippet to load
  34915. * @returns a promise that will resolve to the new animation or a new array of animations
  34916. */
  34917. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34918. }
  34919. }
  34920. declare module "babylonjs/Animations/animatable.interface" {
  34921. import { Nullable } from "babylonjs/types";
  34922. import { Animation } from "babylonjs/Animations/animation";
  34923. /**
  34924. * Interface containing an array of animations
  34925. */
  34926. export interface IAnimatable {
  34927. /**
  34928. * Array of animations
  34929. */
  34930. animations: Nullable<Array<Animation>>;
  34931. }
  34932. }
  34933. declare module "babylonjs/Misc/decorators" {
  34934. import { Nullable } from "babylonjs/types";
  34935. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34936. import { Scene } from "babylonjs/scene";
  34937. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34938. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34939. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34940. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34941. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34942. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34943. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34944. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34945. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34946. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34947. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34948. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34949. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34950. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34951. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34952. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34953. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34954. /**
  34955. * Decorator used to define property that can be serialized as reference to a camera
  34956. * @param sourceName defines the name of the property to decorate
  34957. */
  34958. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34959. /**
  34960. * Class used to help serialization objects
  34961. */
  34962. export class SerializationHelper {
  34963. /** @hidden */
  34964. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34965. /** @hidden */
  34966. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34967. /** @hidden */
  34968. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34969. /** @hidden */
  34970. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34971. /**
  34972. * Appends the serialized animations from the source animations
  34973. * @param source Source containing the animations
  34974. * @param destination Target to store the animations
  34975. */
  34976. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34977. /**
  34978. * Static function used to serialized a specific entity
  34979. * @param entity defines the entity to serialize
  34980. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34981. * @returns a JSON compatible object representing the serialization of the entity
  34982. */
  34983. static Serialize<T>(entity: T, serializationObject?: any): any;
  34984. /**
  34985. * Creates a new entity from a serialization data object
  34986. * @param creationFunction defines a function used to instanciated the new entity
  34987. * @param source defines the source serialization data
  34988. * @param scene defines the hosting scene
  34989. * @param rootUrl defines the root url for resources
  34990. * @returns a new entity
  34991. */
  34992. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  34993. /**
  34994. * Clones an object
  34995. * @param creationFunction defines the function used to instanciate the new object
  34996. * @param source defines the source object
  34997. * @returns the cloned object
  34998. */
  34999. static Clone<T>(creationFunction: () => T, source: T): T;
  35000. /**
  35001. * Instanciates a new object based on a source one (some data will be shared between both object)
  35002. * @param creationFunction defines the function used to instanciate the new object
  35003. * @param source defines the source object
  35004. * @returns the new object
  35005. */
  35006. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35007. }
  35008. }
  35009. declare module "babylonjs/Materials/Textures/baseTexture" {
  35010. import { Observable } from "babylonjs/Misc/observable";
  35011. import { Nullable } from "babylonjs/types";
  35012. import { Scene } from "babylonjs/scene";
  35013. import { Matrix } from "babylonjs/Maths/math.vector";
  35014. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35015. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35016. import { ISize } from "babylonjs/Maths/math.size";
  35017. import "babylonjs/Misc/fileTools";
  35018. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35019. /**
  35020. * Base class of all the textures in babylon.
  35021. * It groups all the common properties the materials, post process, lights... might need
  35022. * in order to make a correct use of the texture.
  35023. */
  35024. export class BaseTexture implements IAnimatable {
  35025. /**
  35026. * Default anisotropic filtering level for the application.
  35027. * It is set to 4 as a good tradeoff between perf and quality.
  35028. */
  35029. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35030. /**
  35031. * Gets or sets the unique id of the texture
  35032. */
  35033. uniqueId: number;
  35034. /**
  35035. * Define the name of the texture.
  35036. */
  35037. name: string;
  35038. /**
  35039. * Gets or sets an object used to store user defined information.
  35040. */
  35041. metadata: any;
  35042. /**
  35043. * For internal use only. Please do not use.
  35044. */
  35045. reservedDataStore: any;
  35046. private _hasAlpha;
  35047. /**
  35048. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35049. */
  35050. set hasAlpha(value: boolean);
  35051. get hasAlpha(): boolean;
  35052. /**
  35053. * Defines if the alpha value should be determined via the rgb values.
  35054. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35055. */
  35056. getAlphaFromRGB: boolean;
  35057. /**
  35058. * Intensity or strength of the texture.
  35059. * It is commonly used by materials to fine tune the intensity of the texture
  35060. */
  35061. level: number;
  35062. /**
  35063. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35064. * This is part of the texture as textures usually maps to one uv set.
  35065. */
  35066. coordinatesIndex: number;
  35067. private _coordinatesMode;
  35068. /**
  35069. * How a texture is mapped.
  35070. *
  35071. * | Value | Type | Description |
  35072. * | ----- | ----------------------------------- | ----------- |
  35073. * | 0 | EXPLICIT_MODE | |
  35074. * | 1 | SPHERICAL_MODE | |
  35075. * | 2 | PLANAR_MODE | |
  35076. * | 3 | CUBIC_MODE | |
  35077. * | 4 | PROJECTION_MODE | |
  35078. * | 5 | SKYBOX_MODE | |
  35079. * | 6 | INVCUBIC_MODE | |
  35080. * | 7 | EQUIRECTANGULAR_MODE | |
  35081. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35082. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35083. */
  35084. set coordinatesMode(value: number);
  35085. get coordinatesMode(): number;
  35086. /**
  35087. * | Value | Type | Description |
  35088. * | ----- | ------------------ | ----------- |
  35089. * | 0 | CLAMP_ADDRESSMODE | |
  35090. * | 1 | WRAP_ADDRESSMODE | |
  35091. * | 2 | MIRROR_ADDRESSMODE | |
  35092. */
  35093. wrapU: number;
  35094. /**
  35095. * | Value | Type | Description |
  35096. * | ----- | ------------------ | ----------- |
  35097. * | 0 | CLAMP_ADDRESSMODE | |
  35098. * | 1 | WRAP_ADDRESSMODE | |
  35099. * | 2 | MIRROR_ADDRESSMODE | |
  35100. */
  35101. wrapV: number;
  35102. /**
  35103. * | Value | Type | Description |
  35104. * | ----- | ------------------ | ----------- |
  35105. * | 0 | CLAMP_ADDRESSMODE | |
  35106. * | 1 | WRAP_ADDRESSMODE | |
  35107. * | 2 | MIRROR_ADDRESSMODE | |
  35108. */
  35109. wrapR: number;
  35110. /**
  35111. * With compliant hardware and browser (supporting anisotropic filtering)
  35112. * this defines the level of anisotropic filtering in the texture.
  35113. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35114. */
  35115. anisotropicFilteringLevel: number;
  35116. /**
  35117. * Define if the texture is a cube texture or if false a 2d texture.
  35118. */
  35119. get isCube(): boolean;
  35120. set isCube(value: boolean);
  35121. /**
  35122. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35123. */
  35124. get is3D(): boolean;
  35125. set is3D(value: boolean);
  35126. /**
  35127. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35128. */
  35129. get is2DArray(): boolean;
  35130. set is2DArray(value: boolean);
  35131. /**
  35132. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35133. * HDR texture are usually stored in linear space.
  35134. * This only impacts the PBR and Background materials
  35135. */
  35136. gammaSpace: boolean;
  35137. /**
  35138. * Gets or sets whether or not the texture contains RGBD data.
  35139. */
  35140. get isRGBD(): boolean;
  35141. set isRGBD(value: boolean);
  35142. /**
  35143. * Is Z inverted in the texture (useful in a cube texture).
  35144. */
  35145. invertZ: boolean;
  35146. /**
  35147. * Are mip maps generated for this texture or not.
  35148. */
  35149. get noMipmap(): boolean;
  35150. /**
  35151. * @hidden
  35152. */
  35153. lodLevelInAlpha: boolean;
  35154. /**
  35155. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35156. */
  35157. get lodGenerationOffset(): number;
  35158. set lodGenerationOffset(value: number);
  35159. /**
  35160. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35161. */
  35162. get lodGenerationScale(): number;
  35163. set lodGenerationScale(value: number);
  35164. /**
  35165. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35166. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35167. * average roughness values.
  35168. */
  35169. get linearSpecularLOD(): boolean;
  35170. set linearSpecularLOD(value: boolean);
  35171. /**
  35172. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35173. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35174. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35175. */
  35176. get irradianceTexture(): Nullable<BaseTexture>;
  35177. set irradianceTexture(value: Nullable<BaseTexture>);
  35178. /**
  35179. * Define if the texture is a render target.
  35180. */
  35181. isRenderTarget: boolean;
  35182. /**
  35183. * Define the unique id of the texture in the scene.
  35184. */
  35185. get uid(): string;
  35186. /** @hidden */
  35187. _prefiltered: boolean;
  35188. /**
  35189. * Return a string representation of the texture.
  35190. * @returns the texture as a string
  35191. */
  35192. toString(): string;
  35193. /**
  35194. * Get the class name of the texture.
  35195. * @returns "BaseTexture"
  35196. */
  35197. getClassName(): string;
  35198. /**
  35199. * Define the list of animation attached to the texture.
  35200. */
  35201. animations: import("babylonjs/Animations/animation").Animation[];
  35202. /**
  35203. * An event triggered when the texture is disposed.
  35204. */
  35205. onDisposeObservable: Observable<BaseTexture>;
  35206. private _onDisposeObserver;
  35207. /**
  35208. * Callback triggered when the texture has been disposed.
  35209. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35210. */
  35211. set onDispose(callback: () => void);
  35212. /**
  35213. * Define the current state of the loading sequence when in delayed load mode.
  35214. */
  35215. delayLoadState: number;
  35216. protected _scene: Nullable<Scene>;
  35217. protected _engine: Nullable<ThinEngine>;
  35218. /** @hidden */
  35219. _texture: Nullable<InternalTexture>;
  35220. private _uid;
  35221. /**
  35222. * Define if the texture is preventinga material to render or not.
  35223. * If not and the texture is not ready, the engine will use a default black texture instead.
  35224. */
  35225. get isBlocking(): boolean;
  35226. /**
  35227. * Instantiates a new BaseTexture.
  35228. * Base class of all the textures in babylon.
  35229. * It groups all the common properties the materials, post process, lights... might need
  35230. * in order to make a correct use of the texture.
  35231. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35232. */
  35233. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35234. /**
  35235. * Get the scene the texture belongs to.
  35236. * @returns the scene or null if undefined
  35237. */
  35238. getScene(): Nullable<Scene>;
  35239. /** @hidden */
  35240. protected _getEngine(): Nullable<ThinEngine>;
  35241. /**
  35242. * Get the texture transform matrix used to offset tile the texture for istance.
  35243. * @returns the transformation matrix
  35244. */
  35245. getTextureMatrix(): Matrix;
  35246. /**
  35247. * Get the texture reflection matrix used to rotate/transform the reflection.
  35248. * @returns the reflection matrix
  35249. */
  35250. getReflectionTextureMatrix(): Matrix;
  35251. /**
  35252. * Get the underlying lower level texture from Babylon.
  35253. * @returns the insternal texture
  35254. */
  35255. getInternalTexture(): Nullable<InternalTexture>;
  35256. /**
  35257. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35258. * @returns true if ready or not blocking
  35259. */
  35260. isReadyOrNotBlocking(): boolean;
  35261. /**
  35262. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35263. * @returns true if fully ready
  35264. */
  35265. isReady(): boolean;
  35266. private _cachedSize;
  35267. /**
  35268. * Get the size of the texture.
  35269. * @returns the texture size.
  35270. */
  35271. getSize(): ISize;
  35272. /**
  35273. * Get the base size of the texture.
  35274. * It can be different from the size if the texture has been resized for POT for instance
  35275. * @returns the base size
  35276. */
  35277. getBaseSize(): ISize;
  35278. /**
  35279. * Update the sampling mode of the texture.
  35280. * Default is Trilinear mode.
  35281. *
  35282. * | Value | Type | Description |
  35283. * | ----- | ------------------ | ----------- |
  35284. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35285. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35286. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35287. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35288. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35289. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35290. * | 7 | NEAREST_LINEAR | |
  35291. * | 8 | NEAREST_NEAREST | |
  35292. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35293. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35294. * | 11 | LINEAR_LINEAR | |
  35295. * | 12 | LINEAR_NEAREST | |
  35296. *
  35297. * > _mag_: magnification filter (close to the viewer)
  35298. * > _min_: minification filter (far from the viewer)
  35299. * > _mip_: filter used between mip map levels
  35300. *@param samplingMode Define the new sampling mode of the texture
  35301. */
  35302. updateSamplingMode(samplingMode: number): void;
  35303. /**
  35304. * Scales the texture if is `canRescale()`
  35305. * @param ratio the resize factor we want to use to rescale
  35306. */
  35307. scale(ratio: number): void;
  35308. /**
  35309. * Get if the texture can rescale.
  35310. */
  35311. get canRescale(): boolean;
  35312. /** @hidden */
  35313. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35314. /** @hidden */
  35315. _rebuild(): void;
  35316. /**
  35317. * Triggers the load sequence in delayed load mode.
  35318. */
  35319. delayLoad(): void;
  35320. /**
  35321. * Clones the texture.
  35322. * @returns the cloned texture
  35323. */
  35324. clone(): Nullable<BaseTexture>;
  35325. /**
  35326. * Get the texture underlying type (INT, FLOAT...)
  35327. */
  35328. get textureType(): number;
  35329. /**
  35330. * Get the texture underlying format (RGB, RGBA...)
  35331. */
  35332. get textureFormat(): number;
  35333. /**
  35334. * Indicates that textures need to be re-calculated for all materials
  35335. */
  35336. protected _markAllSubMeshesAsTexturesDirty(): void;
  35337. /**
  35338. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35339. * This will returns an RGBA array buffer containing either in values (0-255) or
  35340. * float values (0-1) depending of the underlying buffer type.
  35341. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35342. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35343. * @param buffer defines a user defined buffer to fill with data (can be null)
  35344. * @returns The Array buffer containing the pixels data.
  35345. */
  35346. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35347. /**
  35348. * Release and destroy the underlying lower level texture aka internalTexture.
  35349. */
  35350. releaseInternalTexture(): void;
  35351. /** @hidden */
  35352. get _lodTextureHigh(): Nullable<BaseTexture>;
  35353. /** @hidden */
  35354. get _lodTextureMid(): Nullable<BaseTexture>;
  35355. /** @hidden */
  35356. get _lodTextureLow(): Nullable<BaseTexture>;
  35357. /**
  35358. * Dispose the texture and release its associated resources.
  35359. */
  35360. dispose(): void;
  35361. /**
  35362. * Serialize the texture into a JSON representation that can be parsed later on.
  35363. * @returns the JSON representation of the texture
  35364. */
  35365. serialize(): any;
  35366. /**
  35367. * Helper function to be called back once a list of texture contains only ready textures.
  35368. * @param textures Define the list of textures to wait for
  35369. * @param callback Define the callback triggered once the entire list will be ready
  35370. */
  35371. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35372. private static _isScene;
  35373. }
  35374. }
  35375. declare module "babylonjs/Materials/effect" {
  35376. import { Observable } from "babylonjs/Misc/observable";
  35377. import { Nullable } from "babylonjs/types";
  35378. import { IDisposable } from "babylonjs/scene";
  35379. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35380. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35381. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35382. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35383. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35384. import { Engine } from "babylonjs/Engines/engine";
  35385. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35386. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35387. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35388. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35389. /**
  35390. * Options to be used when creating an effect.
  35391. */
  35392. export interface IEffectCreationOptions {
  35393. /**
  35394. * Atrributes that will be used in the shader.
  35395. */
  35396. attributes: string[];
  35397. /**
  35398. * Uniform varible names that will be set in the shader.
  35399. */
  35400. uniformsNames: string[];
  35401. /**
  35402. * Uniform buffer variable names that will be set in the shader.
  35403. */
  35404. uniformBuffersNames: string[];
  35405. /**
  35406. * Sampler texture variable names that will be set in the shader.
  35407. */
  35408. samplers: string[];
  35409. /**
  35410. * Define statements that will be set in the shader.
  35411. */
  35412. defines: any;
  35413. /**
  35414. * Possible fallbacks for this effect to improve performance when needed.
  35415. */
  35416. fallbacks: Nullable<IEffectFallbacks>;
  35417. /**
  35418. * Callback that will be called when the shader is compiled.
  35419. */
  35420. onCompiled: Nullable<(effect: Effect) => void>;
  35421. /**
  35422. * Callback that will be called if an error occurs during shader compilation.
  35423. */
  35424. onError: Nullable<(effect: Effect, errors: string) => void>;
  35425. /**
  35426. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35427. */
  35428. indexParameters?: any;
  35429. /**
  35430. * Max number of lights that can be used in the shader.
  35431. */
  35432. maxSimultaneousLights?: number;
  35433. /**
  35434. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35435. */
  35436. transformFeedbackVaryings?: Nullable<string[]>;
  35437. /**
  35438. * 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
  35439. */
  35440. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35441. /**
  35442. * Is this effect rendering to several color attachments ?
  35443. */
  35444. multiTarget?: boolean;
  35445. }
  35446. /**
  35447. * Effect containing vertex and fragment shader that can be executed on an object.
  35448. */
  35449. export class Effect implements IDisposable {
  35450. /**
  35451. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35452. */
  35453. static ShadersRepository: string;
  35454. /**
  35455. * Enable logging of the shader code when a compilation error occurs
  35456. */
  35457. static LogShaderCodeOnCompilationError: boolean;
  35458. /**
  35459. * Name of the effect.
  35460. */
  35461. name: any;
  35462. /**
  35463. * String container all the define statements that should be set on the shader.
  35464. */
  35465. defines: string;
  35466. /**
  35467. * Callback that will be called when the shader is compiled.
  35468. */
  35469. onCompiled: Nullable<(effect: Effect) => void>;
  35470. /**
  35471. * Callback that will be called if an error occurs during shader compilation.
  35472. */
  35473. onError: Nullable<(effect: Effect, errors: string) => void>;
  35474. /**
  35475. * Callback that will be called when effect is bound.
  35476. */
  35477. onBind: Nullable<(effect: Effect) => void>;
  35478. /**
  35479. * Unique ID of the effect.
  35480. */
  35481. uniqueId: number;
  35482. /**
  35483. * Observable that will be called when the shader is compiled.
  35484. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35485. */
  35486. onCompileObservable: Observable<Effect>;
  35487. /**
  35488. * Observable that will be called if an error occurs during shader compilation.
  35489. */
  35490. onErrorObservable: Observable<Effect>;
  35491. /** @hidden */
  35492. _onBindObservable: Nullable<Observable<Effect>>;
  35493. /**
  35494. * @hidden
  35495. * Specifies if the effect was previously ready
  35496. */
  35497. _wasPreviouslyReady: boolean;
  35498. /**
  35499. * Observable that will be called when effect is bound.
  35500. */
  35501. get onBindObservable(): Observable<Effect>;
  35502. /** @hidden */
  35503. _bonesComputationForcedToCPU: boolean;
  35504. /** @hidden */
  35505. _multiTarget: boolean;
  35506. private static _uniqueIdSeed;
  35507. private _engine;
  35508. private _uniformBuffersNames;
  35509. private _uniformBuffersNamesList;
  35510. private _uniformsNames;
  35511. private _samplerList;
  35512. private _samplers;
  35513. private _isReady;
  35514. private _compilationError;
  35515. private _allFallbacksProcessed;
  35516. private _attributesNames;
  35517. private _attributes;
  35518. private _attributeLocationByName;
  35519. private _uniforms;
  35520. /**
  35521. * Key for the effect.
  35522. * @hidden
  35523. */
  35524. _key: string;
  35525. private _indexParameters;
  35526. private _fallbacks;
  35527. private _vertexSourceCode;
  35528. private _fragmentSourceCode;
  35529. private _vertexSourceCodeOverride;
  35530. private _fragmentSourceCodeOverride;
  35531. private _transformFeedbackVaryings;
  35532. /**
  35533. * Compiled shader to webGL program.
  35534. * @hidden
  35535. */
  35536. _pipelineContext: Nullable<IPipelineContext>;
  35537. private _valueCache;
  35538. private static _baseCache;
  35539. /**
  35540. * Instantiates an effect.
  35541. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35542. * @param baseName Name of the effect.
  35543. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35544. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35545. * @param samplers List of sampler variables that will be passed to the shader.
  35546. * @param engine Engine to be used to render the effect
  35547. * @param defines Define statements to be added to the shader.
  35548. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35549. * @param onCompiled Callback that will be called when the shader is compiled.
  35550. * @param onError Callback that will be called if an error occurs during shader compilation.
  35551. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35552. */
  35553. 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);
  35554. private _useFinalCode;
  35555. /**
  35556. * Unique key for this effect
  35557. */
  35558. get key(): string;
  35559. /**
  35560. * If the effect has been compiled and prepared.
  35561. * @returns if the effect is compiled and prepared.
  35562. */
  35563. isReady(): boolean;
  35564. private _isReadyInternal;
  35565. /**
  35566. * The engine the effect was initialized with.
  35567. * @returns the engine.
  35568. */
  35569. getEngine(): Engine;
  35570. /**
  35571. * The pipeline context for this effect
  35572. * @returns the associated pipeline context
  35573. */
  35574. getPipelineContext(): Nullable<IPipelineContext>;
  35575. /**
  35576. * The set of names of attribute variables for the shader.
  35577. * @returns An array of attribute names.
  35578. */
  35579. getAttributesNames(): string[];
  35580. /**
  35581. * Returns the attribute at the given index.
  35582. * @param index The index of the attribute.
  35583. * @returns The location of the attribute.
  35584. */
  35585. getAttributeLocation(index: number): number;
  35586. /**
  35587. * Returns the attribute based on the name of the variable.
  35588. * @param name of the attribute to look up.
  35589. * @returns the attribute location.
  35590. */
  35591. getAttributeLocationByName(name: string): number;
  35592. /**
  35593. * The number of attributes.
  35594. * @returns the numnber of attributes.
  35595. */
  35596. getAttributesCount(): number;
  35597. /**
  35598. * Gets the index of a uniform variable.
  35599. * @param uniformName of the uniform to look up.
  35600. * @returns the index.
  35601. */
  35602. getUniformIndex(uniformName: string): number;
  35603. /**
  35604. * Returns the attribute based on the name of the variable.
  35605. * @param uniformName of the uniform to look up.
  35606. * @returns the location of the uniform.
  35607. */
  35608. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35609. /**
  35610. * Returns an array of sampler variable names
  35611. * @returns The array of sampler variable names.
  35612. */
  35613. getSamplers(): string[];
  35614. /**
  35615. * Returns an array of uniform variable names
  35616. * @returns The array of uniform variable names.
  35617. */
  35618. getUniformNames(): string[];
  35619. /**
  35620. * Returns an array of uniform buffer variable names
  35621. * @returns The array of uniform buffer variable names.
  35622. */
  35623. getUniformBuffersNames(): string[];
  35624. /**
  35625. * Returns the index parameters used to create the effect
  35626. * @returns The index parameters object
  35627. */
  35628. getIndexParameters(): any;
  35629. /**
  35630. * The error from the last compilation.
  35631. * @returns the error string.
  35632. */
  35633. getCompilationError(): string;
  35634. /**
  35635. * Gets a boolean indicating that all fallbacks were used during compilation
  35636. * @returns true if all fallbacks were used
  35637. */
  35638. allFallbacksProcessed(): boolean;
  35639. /**
  35640. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35641. * @param func The callback to be used.
  35642. */
  35643. executeWhenCompiled(func: (effect: Effect) => void): void;
  35644. private _checkIsReady;
  35645. private _loadShader;
  35646. /**
  35647. * Gets the vertex shader source code of this effect
  35648. */
  35649. get vertexSourceCode(): string;
  35650. /**
  35651. * Gets the fragment shader source code of this effect
  35652. */
  35653. get fragmentSourceCode(): string;
  35654. /**
  35655. * Recompiles the webGL program
  35656. * @param vertexSourceCode The source code for the vertex shader.
  35657. * @param fragmentSourceCode The source code for the fragment shader.
  35658. * @param onCompiled Callback called when completed.
  35659. * @param onError Callback called on error.
  35660. * @hidden
  35661. */
  35662. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35663. /**
  35664. * Prepares the effect
  35665. * @hidden
  35666. */
  35667. _prepareEffect(): void;
  35668. private _getShaderCodeAndErrorLine;
  35669. private _processCompilationErrors;
  35670. /**
  35671. * Checks if the effect is supported. (Must be called after compilation)
  35672. */
  35673. get isSupported(): boolean;
  35674. /**
  35675. * Binds a texture to the engine to be used as output of the shader.
  35676. * @param channel Name of the output variable.
  35677. * @param texture Texture to bind.
  35678. * @hidden
  35679. */
  35680. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35681. /**
  35682. * Sets a texture on the engine to be used in the shader.
  35683. * @param channel Name of the sampler variable.
  35684. * @param texture Texture to set.
  35685. */
  35686. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35687. /**
  35688. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35689. * @param channel Name of the sampler variable.
  35690. * @param texture Texture to set.
  35691. */
  35692. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35693. /**
  35694. * Sets an array of textures on the engine to be used in the shader.
  35695. * @param channel Name of the variable.
  35696. * @param textures Textures to set.
  35697. */
  35698. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35699. /**
  35700. * 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)
  35701. * @param channel Name of the sampler variable.
  35702. * @param postProcess Post process to get the input texture from.
  35703. */
  35704. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35705. /**
  35706. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35707. * 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)
  35708. * @param channel Name of the sampler variable.
  35709. * @param postProcess Post process to get the output texture from.
  35710. */
  35711. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35712. /** @hidden */
  35713. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35714. /** @hidden */
  35715. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35716. /** @hidden */
  35717. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35718. /** @hidden */
  35719. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35720. /**
  35721. * Binds a buffer to a uniform.
  35722. * @param buffer Buffer to bind.
  35723. * @param name Name of the uniform variable to bind to.
  35724. */
  35725. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35726. /**
  35727. * Binds block to a uniform.
  35728. * @param blockName Name of the block to bind.
  35729. * @param index Index to bind.
  35730. */
  35731. bindUniformBlock(blockName: string, index: number): void;
  35732. /**
  35733. * Sets an interger value on a uniform variable.
  35734. * @param uniformName Name of the variable.
  35735. * @param value Value to be set.
  35736. * @returns this effect.
  35737. */
  35738. setInt(uniformName: string, value: number): Effect;
  35739. /**
  35740. * Sets an int array on a uniform variable.
  35741. * @param uniformName Name of the variable.
  35742. * @param array array to be set.
  35743. * @returns this effect.
  35744. */
  35745. setIntArray(uniformName: string, array: Int32Array): Effect;
  35746. /**
  35747. * 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)
  35748. * @param uniformName Name of the variable.
  35749. * @param array array to be set.
  35750. * @returns this effect.
  35751. */
  35752. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35753. /**
  35754. * 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)
  35755. * @param uniformName Name of the variable.
  35756. * @param array array to be set.
  35757. * @returns this effect.
  35758. */
  35759. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35760. /**
  35761. * 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)
  35762. * @param uniformName Name of the variable.
  35763. * @param array array to be set.
  35764. * @returns this effect.
  35765. */
  35766. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35767. /**
  35768. * Sets an float array on a uniform variable.
  35769. * @param uniformName Name of the variable.
  35770. * @param array array to be set.
  35771. * @returns this effect.
  35772. */
  35773. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35774. /**
  35775. * 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)
  35776. * @param uniformName Name of the variable.
  35777. * @param array array to be set.
  35778. * @returns this effect.
  35779. */
  35780. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35781. /**
  35782. * 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)
  35783. * @param uniformName Name of the variable.
  35784. * @param array array to be set.
  35785. * @returns this effect.
  35786. */
  35787. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35788. /**
  35789. * 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)
  35790. * @param uniformName Name of the variable.
  35791. * @param array array to be set.
  35792. * @returns this effect.
  35793. */
  35794. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35795. /**
  35796. * Sets an array on a uniform variable.
  35797. * @param uniformName Name of the variable.
  35798. * @param array array to be set.
  35799. * @returns this effect.
  35800. */
  35801. setArray(uniformName: string, array: number[]): Effect;
  35802. /**
  35803. * 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)
  35804. * @param uniformName Name of the variable.
  35805. * @param array array to be set.
  35806. * @returns this effect.
  35807. */
  35808. setArray2(uniformName: string, array: number[]): Effect;
  35809. /**
  35810. * 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)
  35811. * @param uniformName Name of the variable.
  35812. * @param array array to be set.
  35813. * @returns this effect.
  35814. */
  35815. setArray3(uniformName: string, array: number[]): Effect;
  35816. /**
  35817. * 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)
  35818. * @param uniformName Name of the variable.
  35819. * @param array array to be set.
  35820. * @returns this effect.
  35821. */
  35822. setArray4(uniformName: string, array: number[]): Effect;
  35823. /**
  35824. * Sets matrices on a uniform variable.
  35825. * @param uniformName Name of the variable.
  35826. * @param matrices matrices to be set.
  35827. * @returns this effect.
  35828. */
  35829. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35830. /**
  35831. * Sets matrix on a uniform variable.
  35832. * @param uniformName Name of the variable.
  35833. * @param matrix matrix to be set.
  35834. * @returns this effect.
  35835. */
  35836. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35837. /**
  35838. * 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)
  35839. * @param uniformName Name of the variable.
  35840. * @param matrix matrix to be set.
  35841. * @returns this effect.
  35842. */
  35843. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35844. /**
  35845. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35846. * @param uniformName Name of the variable.
  35847. * @param matrix matrix to be set.
  35848. * @returns this effect.
  35849. */
  35850. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35851. /**
  35852. * Sets a float on a uniform variable.
  35853. * @param uniformName Name of the variable.
  35854. * @param value value to be set.
  35855. * @returns this effect.
  35856. */
  35857. setFloat(uniformName: string, value: number): Effect;
  35858. /**
  35859. * Sets a boolean on a uniform variable.
  35860. * @param uniformName Name of the variable.
  35861. * @param bool value to be set.
  35862. * @returns this effect.
  35863. */
  35864. setBool(uniformName: string, bool: boolean): Effect;
  35865. /**
  35866. * Sets a Vector2 on a uniform variable.
  35867. * @param uniformName Name of the variable.
  35868. * @param vector2 vector2 to be set.
  35869. * @returns this effect.
  35870. */
  35871. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35872. /**
  35873. * Sets a float2 on a uniform variable.
  35874. * @param uniformName Name of the variable.
  35875. * @param x First float in float2.
  35876. * @param y Second float in float2.
  35877. * @returns this effect.
  35878. */
  35879. setFloat2(uniformName: string, x: number, y: number): Effect;
  35880. /**
  35881. * Sets a Vector3 on a uniform variable.
  35882. * @param uniformName Name of the variable.
  35883. * @param vector3 Value to be set.
  35884. * @returns this effect.
  35885. */
  35886. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35887. /**
  35888. * Sets a float3 on a uniform variable.
  35889. * @param uniformName Name of the variable.
  35890. * @param x First float in float3.
  35891. * @param y Second float in float3.
  35892. * @param z Third float in float3.
  35893. * @returns this effect.
  35894. */
  35895. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35896. /**
  35897. * Sets a Vector4 on a uniform variable.
  35898. * @param uniformName Name of the variable.
  35899. * @param vector4 Value to be set.
  35900. * @returns this effect.
  35901. */
  35902. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35903. /**
  35904. * Sets a float4 on a uniform variable.
  35905. * @param uniformName Name of the variable.
  35906. * @param x First float in float4.
  35907. * @param y Second float in float4.
  35908. * @param z Third float in float4.
  35909. * @param w Fourth float in float4.
  35910. * @returns this effect.
  35911. */
  35912. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35913. /**
  35914. * Sets a Color3 on a uniform variable.
  35915. * @param uniformName Name of the variable.
  35916. * @param color3 Value to be set.
  35917. * @returns this effect.
  35918. */
  35919. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35920. /**
  35921. * Sets a Color4 on a uniform variable.
  35922. * @param uniformName Name of the variable.
  35923. * @param color3 Value to be set.
  35924. * @param alpha Alpha value to be set.
  35925. * @returns this effect.
  35926. */
  35927. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35928. /**
  35929. * Sets a Color4 on a uniform variable
  35930. * @param uniformName defines the name of the variable
  35931. * @param color4 defines the value to be set
  35932. * @returns this effect.
  35933. */
  35934. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35935. /** Release all associated resources */
  35936. dispose(): void;
  35937. /**
  35938. * This function will add a new shader to the shader store
  35939. * @param name the name of the shader
  35940. * @param pixelShader optional pixel shader content
  35941. * @param vertexShader optional vertex shader content
  35942. */
  35943. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35944. /**
  35945. * Store of each shader (The can be looked up using effect.key)
  35946. */
  35947. static ShadersStore: {
  35948. [key: string]: string;
  35949. };
  35950. /**
  35951. * Store of each included file for a shader (The can be looked up using effect.key)
  35952. */
  35953. static IncludesShadersStore: {
  35954. [key: string]: string;
  35955. };
  35956. /**
  35957. * Resets the cache of effects.
  35958. */
  35959. static ResetCache(): void;
  35960. }
  35961. }
  35962. declare module "babylonjs/Engines/engineCapabilities" {
  35963. /**
  35964. * Interface used to describe the capabilities of the engine relatively to the current browser
  35965. */
  35966. export interface EngineCapabilities {
  35967. /** Maximum textures units per fragment shader */
  35968. maxTexturesImageUnits: number;
  35969. /** Maximum texture units per vertex shader */
  35970. maxVertexTextureImageUnits: number;
  35971. /** Maximum textures units in the entire pipeline */
  35972. maxCombinedTexturesImageUnits: number;
  35973. /** Maximum texture size */
  35974. maxTextureSize: number;
  35975. /** Maximum texture samples */
  35976. maxSamples?: number;
  35977. /** Maximum cube texture size */
  35978. maxCubemapTextureSize: number;
  35979. /** Maximum render texture size */
  35980. maxRenderTextureSize: number;
  35981. /** Maximum number of vertex attributes */
  35982. maxVertexAttribs: number;
  35983. /** Maximum number of varyings */
  35984. maxVaryingVectors: number;
  35985. /** Maximum number of uniforms per vertex shader */
  35986. maxVertexUniformVectors: number;
  35987. /** Maximum number of uniforms per fragment shader */
  35988. maxFragmentUniformVectors: number;
  35989. /** Defines if standard derivates (dx/dy) are supported */
  35990. standardDerivatives: boolean;
  35991. /** Defines if s3tc texture compression is supported */
  35992. s3tc?: WEBGL_compressed_texture_s3tc;
  35993. /** Defines if pvrtc texture compression is supported */
  35994. pvrtc: any;
  35995. /** Defines if etc1 texture compression is supported */
  35996. etc1: any;
  35997. /** Defines if etc2 texture compression is supported */
  35998. etc2: any;
  35999. /** Defines if astc texture compression is supported */
  36000. astc: any;
  36001. /** Defines if float textures are supported */
  36002. textureFloat: boolean;
  36003. /** Defines if vertex array objects are supported */
  36004. vertexArrayObject: boolean;
  36005. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36006. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36007. /** Gets the maximum level of anisotropy supported */
  36008. maxAnisotropy: number;
  36009. /** Defines if instancing is supported */
  36010. instancedArrays: boolean;
  36011. /** Defines if 32 bits indices are supported */
  36012. uintIndices: boolean;
  36013. /** Defines if high precision shaders are supported */
  36014. highPrecisionShaderSupported: boolean;
  36015. /** Defines if depth reading in the fragment shader is supported */
  36016. fragmentDepthSupported: boolean;
  36017. /** Defines if float texture linear filtering is supported*/
  36018. textureFloatLinearFiltering: boolean;
  36019. /** Defines if rendering to float textures is supported */
  36020. textureFloatRender: boolean;
  36021. /** Defines if half float textures are supported*/
  36022. textureHalfFloat: boolean;
  36023. /** Defines if half float texture linear filtering is supported*/
  36024. textureHalfFloatLinearFiltering: boolean;
  36025. /** Defines if rendering to half float textures is supported */
  36026. textureHalfFloatRender: boolean;
  36027. /** Defines if textureLOD shader command is supported */
  36028. textureLOD: boolean;
  36029. /** Defines if draw buffers extension is supported */
  36030. drawBuffersExtension: boolean;
  36031. /** Defines if depth textures are supported */
  36032. depthTextureExtension: boolean;
  36033. /** Defines if float color buffer are supported */
  36034. colorBufferFloat: boolean;
  36035. /** Gets disjoint timer query extension (null if not supported) */
  36036. timerQuery?: EXT_disjoint_timer_query;
  36037. /** Defines if timestamp can be used with timer query */
  36038. canUseTimestampForTimerQuery: boolean;
  36039. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36040. multiview?: any;
  36041. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36042. oculusMultiview?: any;
  36043. /** Function used to let the system compiles shaders in background */
  36044. parallelShaderCompile?: {
  36045. COMPLETION_STATUS_KHR: number;
  36046. };
  36047. /** Max number of texture samples for MSAA */
  36048. maxMSAASamples: number;
  36049. /** Defines if the blend min max extension is supported */
  36050. blendMinMax: boolean;
  36051. }
  36052. }
  36053. declare module "babylonjs/States/depthCullingState" {
  36054. import { Nullable } from "babylonjs/types";
  36055. /**
  36056. * @hidden
  36057. **/
  36058. export class DepthCullingState {
  36059. private _isDepthTestDirty;
  36060. private _isDepthMaskDirty;
  36061. private _isDepthFuncDirty;
  36062. private _isCullFaceDirty;
  36063. private _isCullDirty;
  36064. private _isZOffsetDirty;
  36065. private _isFrontFaceDirty;
  36066. private _depthTest;
  36067. private _depthMask;
  36068. private _depthFunc;
  36069. private _cull;
  36070. private _cullFace;
  36071. private _zOffset;
  36072. private _frontFace;
  36073. /**
  36074. * Initializes the state.
  36075. */
  36076. constructor();
  36077. get isDirty(): boolean;
  36078. get zOffset(): number;
  36079. set zOffset(value: number);
  36080. get cullFace(): Nullable<number>;
  36081. set cullFace(value: Nullable<number>);
  36082. get cull(): Nullable<boolean>;
  36083. set cull(value: Nullable<boolean>);
  36084. get depthFunc(): Nullable<number>;
  36085. set depthFunc(value: Nullable<number>);
  36086. get depthMask(): boolean;
  36087. set depthMask(value: boolean);
  36088. get depthTest(): boolean;
  36089. set depthTest(value: boolean);
  36090. get frontFace(): Nullable<number>;
  36091. set frontFace(value: Nullable<number>);
  36092. reset(): void;
  36093. apply(gl: WebGLRenderingContext): void;
  36094. }
  36095. }
  36096. declare module "babylonjs/States/stencilState" {
  36097. /**
  36098. * @hidden
  36099. **/
  36100. export class StencilState {
  36101. /** 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 */
  36102. static readonly ALWAYS: number;
  36103. /** Passed to stencilOperation to specify that stencil value must be kept */
  36104. static readonly KEEP: number;
  36105. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36106. static readonly REPLACE: number;
  36107. private _isStencilTestDirty;
  36108. private _isStencilMaskDirty;
  36109. private _isStencilFuncDirty;
  36110. private _isStencilOpDirty;
  36111. private _stencilTest;
  36112. private _stencilMask;
  36113. private _stencilFunc;
  36114. private _stencilFuncRef;
  36115. private _stencilFuncMask;
  36116. private _stencilOpStencilFail;
  36117. private _stencilOpDepthFail;
  36118. private _stencilOpStencilDepthPass;
  36119. get isDirty(): boolean;
  36120. get stencilFunc(): number;
  36121. set stencilFunc(value: number);
  36122. get stencilFuncRef(): number;
  36123. set stencilFuncRef(value: number);
  36124. get stencilFuncMask(): number;
  36125. set stencilFuncMask(value: number);
  36126. get stencilOpStencilFail(): number;
  36127. set stencilOpStencilFail(value: number);
  36128. get stencilOpDepthFail(): number;
  36129. set stencilOpDepthFail(value: number);
  36130. get stencilOpStencilDepthPass(): number;
  36131. set stencilOpStencilDepthPass(value: number);
  36132. get stencilMask(): number;
  36133. set stencilMask(value: number);
  36134. get stencilTest(): boolean;
  36135. set stencilTest(value: boolean);
  36136. constructor();
  36137. reset(): void;
  36138. apply(gl: WebGLRenderingContext): void;
  36139. }
  36140. }
  36141. declare module "babylonjs/States/alphaCullingState" {
  36142. /**
  36143. * @hidden
  36144. **/
  36145. export class AlphaState {
  36146. private _isAlphaBlendDirty;
  36147. private _isBlendFunctionParametersDirty;
  36148. private _isBlendEquationParametersDirty;
  36149. private _isBlendConstantsDirty;
  36150. private _alphaBlend;
  36151. private _blendFunctionParameters;
  36152. private _blendEquationParameters;
  36153. private _blendConstants;
  36154. /**
  36155. * Initializes the state.
  36156. */
  36157. constructor();
  36158. get isDirty(): boolean;
  36159. get alphaBlend(): boolean;
  36160. set alphaBlend(value: boolean);
  36161. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36162. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36163. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36164. reset(): void;
  36165. apply(gl: WebGLRenderingContext): void;
  36166. }
  36167. }
  36168. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36169. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36170. /** @hidden */
  36171. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36172. attributeProcessor(attribute: string): string;
  36173. varyingProcessor(varying: string, isFragment: boolean): string;
  36174. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36175. }
  36176. }
  36177. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36178. /**
  36179. * Interface for attribute information associated with buffer instanciation
  36180. */
  36181. export interface InstancingAttributeInfo {
  36182. /**
  36183. * Name of the GLSL attribute
  36184. * if attribute index is not specified, this is used to retrieve the index from the effect
  36185. */
  36186. attributeName: string;
  36187. /**
  36188. * Index/offset of the attribute in the vertex shader
  36189. * if not specified, this will be computes from the name.
  36190. */
  36191. index?: number;
  36192. /**
  36193. * size of the attribute, 1, 2, 3 or 4
  36194. */
  36195. attributeSize: number;
  36196. /**
  36197. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36198. */
  36199. offset: number;
  36200. /**
  36201. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36202. * default to 1
  36203. */
  36204. divisor?: number;
  36205. /**
  36206. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36207. * default is FLOAT
  36208. */
  36209. attributeType?: number;
  36210. /**
  36211. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36212. */
  36213. normalized?: boolean;
  36214. }
  36215. }
  36216. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36217. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36218. import { Nullable } from "babylonjs/types";
  36219. module "babylonjs/Engines/thinEngine" {
  36220. interface ThinEngine {
  36221. /**
  36222. * Update a video texture
  36223. * @param texture defines the texture to update
  36224. * @param video defines the video element to use
  36225. * @param invertY defines if data must be stored with Y axis inverted
  36226. */
  36227. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36228. }
  36229. }
  36230. }
  36231. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36232. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36233. import { Nullable } from "babylonjs/types";
  36234. module "babylonjs/Engines/thinEngine" {
  36235. interface ThinEngine {
  36236. /**
  36237. * Creates a dynamic texture
  36238. * @param width defines the width of the texture
  36239. * @param height defines the height of the texture
  36240. * @param generateMipMaps defines if the engine should generate the mip levels
  36241. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36242. * @returns the dynamic texture inside an InternalTexture
  36243. */
  36244. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36245. /**
  36246. * Update the content of a dynamic texture
  36247. * @param texture defines the texture to update
  36248. * @param canvas defines the canvas containing the source
  36249. * @param invertY defines if data must be stored with Y axis inverted
  36250. * @param premulAlpha defines if alpha is stored as premultiplied
  36251. * @param format defines the format of the data
  36252. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36253. */
  36254. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36255. }
  36256. }
  36257. }
  36258. declare module "babylonjs/Materials/Textures/videoTexture" {
  36259. import { Observable } from "babylonjs/Misc/observable";
  36260. import { Nullable } from "babylonjs/types";
  36261. import { Scene } from "babylonjs/scene";
  36262. import { Texture } from "babylonjs/Materials/Textures/texture";
  36263. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36264. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36265. /**
  36266. * Settings for finer control over video usage
  36267. */
  36268. export interface VideoTextureSettings {
  36269. /**
  36270. * Applies `autoplay` to video, if specified
  36271. */
  36272. autoPlay?: boolean;
  36273. /**
  36274. * Applies `loop` to video, if specified
  36275. */
  36276. loop?: boolean;
  36277. /**
  36278. * Automatically updates internal texture from video at every frame in the render loop
  36279. */
  36280. autoUpdateTexture: boolean;
  36281. /**
  36282. * Image src displayed during the video loading or until the user interacts with the video.
  36283. */
  36284. poster?: string;
  36285. }
  36286. /**
  36287. * If you want to display a video in your scene, this is the special texture for that.
  36288. * This special texture works similar to other textures, with the exception of a few parameters.
  36289. * @see https://doc.babylonjs.com/how_to/video_texture
  36290. */
  36291. export class VideoTexture extends Texture {
  36292. /**
  36293. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36294. */
  36295. readonly autoUpdateTexture: boolean;
  36296. /**
  36297. * The video instance used by the texture internally
  36298. */
  36299. readonly video: HTMLVideoElement;
  36300. private _onUserActionRequestedObservable;
  36301. /**
  36302. * Event triggerd when a dom action is required by the user to play the video.
  36303. * This happens due to recent changes in browser policies preventing video to auto start.
  36304. */
  36305. get onUserActionRequestedObservable(): Observable<Texture>;
  36306. private _generateMipMaps;
  36307. private _stillImageCaptured;
  36308. private _displayingPosterTexture;
  36309. private _settings;
  36310. private _createInternalTextureOnEvent;
  36311. private _frameId;
  36312. private _currentSrc;
  36313. /**
  36314. * Creates a video texture.
  36315. * If you want to display a video in your scene, this is the special texture for that.
  36316. * This special texture works similar to other textures, with the exception of a few parameters.
  36317. * @see https://doc.babylonjs.com/how_to/video_texture
  36318. * @param name optional name, will detect from video source, if not defined
  36319. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36320. * @param scene is obviously the current scene.
  36321. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36322. * @param invertY is false by default but can be used to invert video on Y axis
  36323. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36324. * @param settings allows finer control over video usage
  36325. */
  36326. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36327. private _getName;
  36328. private _getVideo;
  36329. private _createInternalTexture;
  36330. private reset;
  36331. /**
  36332. * @hidden Internal method to initiate `update`.
  36333. */
  36334. _rebuild(): void;
  36335. /**
  36336. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36337. */
  36338. update(): void;
  36339. /**
  36340. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36341. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36342. */
  36343. updateTexture(isVisible: boolean): void;
  36344. protected _updateInternalTexture: () => void;
  36345. /**
  36346. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36347. * @param url New url.
  36348. */
  36349. updateURL(url: string): void;
  36350. /**
  36351. * Clones the texture.
  36352. * @returns the cloned texture
  36353. */
  36354. clone(): VideoTexture;
  36355. /**
  36356. * Dispose the texture and release its associated resources.
  36357. */
  36358. dispose(): void;
  36359. /**
  36360. * Creates a video texture straight from a stream.
  36361. * @param scene Define the scene the texture should be created in
  36362. * @param stream Define the stream the texture should be created from
  36363. * @returns The created video texture as a promise
  36364. */
  36365. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36366. /**
  36367. * Creates a video texture straight from your WebCam video feed.
  36368. * @param scene Define the scene the texture should be created in
  36369. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36370. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36371. * @returns The created video texture as a promise
  36372. */
  36373. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36374. minWidth: number;
  36375. maxWidth: number;
  36376. minHeight: number;
  36377. maxHeight: number;
  36378. deviceId: string;
  36379. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36380. /**
  36381. * Creates a video texture straight from your WebCam video feed.
  36382. * @param scene Define the scene the texture should be created in
  36383. * @param onReady Define a callback to triggered once the texture will be ready
  36384. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36385. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36386. */
  36387. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36388. minWidth: number;
  36389. maxWidth: number;
  36390. minHeight: number;
  36391. maxHeight: number;
  36392. deviceId: string;
  36393. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36394. }
  36395. }
  36396. declare module "babylonjs/Engines/thinEngine" {
  36397. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36398. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36399. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36400. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36401. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36402. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36403. import { Observable } from "babylonjs/Misc/observable";
  36404. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36405. import { StencilState } from "babylonjs/States/stencilState";
  36406. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36407. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36408. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36409. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36410. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36411. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36412. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36413. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36414. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36415. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36416. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36417. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36418. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36419. import { WebRequest } from "babylonjs/Misc/webRequest";
  36420. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36421. /**
  36422. * Defines the interface used by objects working like Scene
  36423. * @hidden
  36424. */
  36425. export interface ISceneLike {
  36426. _addPendingData(data: any): void;
  36427. _removePendingData(data: any): void;
  36428. offlineProvider: IOfflineProvider;
  36429. }
  36430. /**
  36431. * Information about the current host
  36432. */
  36433. export interface HostInformation {
  36434. /**
  36435. * Defines if the current host is a mobile
  36436. */
  36437. isMobile: boolean;
  36438. }
  36439. /** Interface defining initialization parameters for Engine class */
  36440. export interface EngineOptions extends WebGLContextAttributes {
  36441. /**
  36442. * Defines if the engine should no exceed a specified device ratio
  36443. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36444. */
  36445. limitDeviceRatio?: number;
  36446. /**
  36447. * Defines if webvr should be enabled automatically
  36448. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36449. */
  36450. autoEnableWebVR?: boolean;
  36451. /**
  36452. * Defines if webgl2 should be turned off even if supported
  36453. * @see https://doc.babylonjs.com/features/webgl2
  36454. */
  36455. disableWebGL2Support?: boolean;
  36456. /**
  36457. * Defines if webaudio should be initialized as well
  36458. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36459. */
  36460. audioEngine?: boolean;
  36461. /**
  36462. * Defines if animations should run using a deterministic lock step
  36463. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36464. */
  36465. deterministicLockstep?: boolean;
  36466. /** Defines the maximum steps to use with deterministic lock step mode */
  36467. lockstepMaxSteps?: number;
  36468. /** Defines the seconds between each deterministic lock step */
  36469. timeStep?: number;
  36470. /**
  36471. * Defines that engine should ignore context lost events
  36472. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36473. */
  36474. doNotHandleContextLost?: boolean;
  36475. /**
  36476. * Defines that engine should ignore modifying touch action attribute and style
  36477. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36478. */
  36479. doNotHandleTouchAction?: boolean;
  36480. /**
  36481. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36482. */
  36483. useHighPrecisionFloats?: boolean;
  36484. /**
  36485. * Make the canvas XR Compatible for XR sessions
  36486. */
  36487. xrCompatible?: boolean;
  36488. /**
  36489. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36490. */
  36491. useHighPrecisionMatrix?: boolean;
  36492. }
  36493. /**
  36494. * The base engine class (root of all engines)
  36495. */
  36496. export class ThinEngine {
  36497. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36498. static ExceptionList: ({
  36499. key: string;
  36500. capture: string;
  36501. captureConstraint: number;
  36502. targets: string[];
  36503. } | {
  36504. key: string;
  36505. capture: null;
  36506. captureConstraint: null;
  36507. targets: string[];
  36508. })[];
  36509. /** @hidden */
  36510. static _TextureLoaders: IInternalTextureLoader[];
  36511. /**
  36512. * Returns the current npm package of the sdk
  36513. */
  36514. static get NpmPackage(): string;
  36515. /**
  36516. * Returns the current version of the framework
  36517. */
  36518. static get Version(): string;
  36519. /**
  36520. * Returns a string describing the current engine
  36521. */
  36522. get description(): string;
  36523. /**
  36524. * Gets or sets the epsilon value used by collision engine
  36525. */
  36526. static CollisionsEpsilon: number;
  36527. /**
  36528. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36529. */
  36530. static get ShadersRepository(): string;
  36531. static set ShadersRepository(value: string);
  36532. /** @hidden */
  36533. _shaderProcessor: IShaderProcessor;
  36534. /**
  36535. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36536. */
  36537. forcePOTTextures: boolean;
  36538. /**
  36539. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36540. */
  36541. isFullscreen: boolean;
  36542. /**
  36543. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36544. */
  36545. cullBackFaces: boolean;
  36546. /**
  36547. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36548. */
  36549. renderEvenInBackground: boolean;
  36550. /**
  36551. * Gets or sets a boolean indicating that cache can be kept between frames
  36552. */
  36553. preventCacheWipeBetweenFrames: boolean;
  36554. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36555. validateShaderPrograms: boolean;
  36556. /**
  36557. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36558. * This can provide greater z depth for distant objects.
  36559. */
  36560. useReverseDepthBuffer: boolean;
  36561. /**
  36562. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36563. */
  36564. disableUniformBuffers: boolean;
  36565. /** @hidden */
  36566. _uniformBuffers: UniformBuffer[];
  36567. /**
  36568. * Gets a boolean indicating that the engine supports uniform buffers
  36569. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36570. */
  36571. get supportsUniformBuffers(): boolean;
  36572. /** @hidden */
  36573. _gl: WebGLRenderingContext;
  36574. /** @hidden */
  36575. _webGLVersion: number;
  36576. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36577. protected _windowIsBackground: boolean;
  36578. protected _creationOptions: EngineOptions;
  36579. protected _highPrecisionShadersAllowed: boolean;
  36580. /** @hidden */
  36581. get _shouldUseHighPrecisionShader(): boolean;
  36582. /**
  36583. * Gets a boolean indicating that only power of 2 textures are supported
  36584. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36585. */
  36586. get needPOTTextures(): boolean;
  36587. /** @hidden */
  36588. _badOS: boolean;
  36589. /** @hidden */
  36590. _badDesktopOS: boolean;
  36591. private _hardwareScalingLevel;
  36592. /** @hidden */
  36593. _caps: EngineCapabilities;
  36594. private _isStencilEnable;
  36595. private _glVersion;
  36596. private _glRenderer;
  36597. private _glVendor;
  36598. /** @hidden */
  36599. _videoTextureSupported: boolean;
  36600. protected _renderingQueueLaunched: boolean;
  36601. protected _activeRenderLoops: (() => void)[];
  36602. /**
  36603. * Observable signaled when a context lost event is raised
  36604. */
  36605. onContextLostObservable: Observable<ThinEngine>;
  36606. /**
  36607. * Observable signaled when a context restored event is raised
  36608. */
  36609. onContextRestoredObservable: Observable<ThinEngine>;
  36610. private _onContextLost;
  36611. private _onContextRestored;
  36612. protected _contextWasLost: boolean;
  36613. /** @hidden */
  36614. _doNotHandleContextLost: boolean;
  36615. /**
  36616. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36617. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36618. */
  36619. get doNotHandleContextLost(): boolean;
  36620. set doNotHandleContextLost(value: boolean);
  36621. /**
  36622. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36623. */
  36624. disableVertexArrayObjects: boolean;
  36625. /** @hidden */
  36626. protected _colorWrite: boolean;
  36627. /** @hidden */
  36628. protected _colorWriteChanged: boolean;
  36629. /** @hidden */
  36630. protected _depthCullingState: DepthCullingState;
  36631. /** @hidden */
  36632. protected _stencilState: StencilState;
  36633. /** @hidden */
  36634. _alphaState: AlphaState;
  36635. /** @hidden */
  36636. _alphaMode: number;
  36637. /** @hidden */
  36638. _alphaEquation: number;
  36639. /** @hidden */
  36640. _internalTexturesCache: InternalTexture[];
  36641. /** @hidden */
  36642. protected _activeChannel: number;
  36643. private _currentTextureChannel;
  36644. /** @hidden */
  36645. protected _boundTexturesCache: {
  36646. [key: string]: Nullable<InternalTexture>;
  36647. };
  36648. /** @hidden */
  36649. protected _currentEffect: Nullable<Effect>;
  36650. /** @hidden */
  36651. protected _currentProgram: Nullable<WebGLProgram>;
  36652. private _compiledEffects;
  36653. private _vertexAttribArraysEnabled;
  36654. /** @hidden */
  36655. protected _cachedViewport: Nullable<IViewportLike>;
  36656. private _cachedVertexArrayObject;
  36657. /** @hidden */
  36658. protected _cachedVertexBuffers: any;
  36659. /** @hidden */
  36660. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36661. /** @hidden */
  36662. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36663. /** @hidden */
  36664. _currentRenderTarget: Nullable<InternalTexture>;
  36665. private _uintIndicesCurrentlySet;
  36666. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36667. /** @hidden */
  36668. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36669. /** @hidden */
  36670. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36671. private _currentBufferPointers;
  36672. private _currentInstanceLocations;
  36673. private _currentInstanceBuffers;
  36674. private _textureUnits;
  36675. /** @hidden */
  36676. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36677. /** @hidden */
  36678. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36679. /** @hidden */
  36680. _boundRenderFunction: any;
  36681. private _vaoRecordInProgress;
  36682. private _mustWipeVertexAttributes;
  36683. private _emptyTexture;
  36684. private _emptyCubeTexture;
  36685. private _emptyTexture3D;
  36686. private _emptyTexture2DArray;
  36687. /** @hidden */
  36688. _frameHandler: number;
  36689. private _nextFreeTextureSlots;
  36690. private _maxSimultaneousTextures;
  36691. private _activeRequests;
  36692. /** @hidden */
  36693. _transformTextureUrl: Nullable<(url: string) => string>;
  36694. /**
  36695. * Gets information about the current host
  36696. */
  36697. hostInformation: HostInformation;
  36698. protected get _supportsHardwareTextureRescaling(): boolean;
  36699. private _framebufferDimensionsObject;
  36700. /**
  36701. * sets the object from which width and height will be taken from when getting render width and height
  36702. * Will fallback to the gl object
  36703. * @param dimensions the framebuffer width and height that will be used.
  36704. */
  36705. set framebufferDimensionsObject(dimensions: Nullable<{
  36706. framebufferWidth: number;
  36707. framebufferHeight: number;
  36708. }>);
  36709. /**
  36710. * Gets the current viewport
  36711. */
  36712. get currentViewport(): Nullable<IViewportLike>;
  36713. /**
  36714. * Gets the default empty texture
  36715. */
  36716. get emptyTexture(): InternalTexture;
  36717. /**
  36718. * Gets the default empty 3D texture
  36719. */
  36720. get emptyTexture3D(): InternalTexture;
  36721. /**
  36722. * Gets the default empty 2D array texture
  36723. */
  36724. get emptyTexture2DArray(): InternalTexture;
  36725. /**
  36726. * Gets the default empty cube texture
  36727. */
  36728. get emptyCubeTexture(): InternalTexture;
  36729. /**
  36730. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36731. */
  36732. readonly premultipliedAlpha: boolean;
  36733. /**
  36734. * Observable event triggered before each texture is initialized
  36735. */
  36736. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36737. /**
  36738. * Creates a new engine
  36739. * @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
  36740. * @param antialias defines enable antialiasing (default: false)
  36741. * @param options defines further options to be sent to the getContext() function
  36742. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36743. */
  36744. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36745. private _rebuildInternalTextures;
  36746. private _rebuildEffects;
  36747. /**
  36748. * Gets a boolean indicating if all created effects are ready
  36749. * @returns true if all effects are ready
  36750. */
  36751. areAllEffectsReady(): boolean;
  36752. protected _rebuildBuffers(): void;
  36753. protected _initGLContext(): void;
  36754. /**
  36755. * Gets version of the current webGL context
  36756. */
  36757. get webGLVersion(): number;
  36758. /**
  36759. * Gets a string identifying the name of the class
  36760. * @returns "Engine" string
  36761. */
  36762. getClassName(): string;
  36763. /**
  36764. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36765. */
  36766. get isStencilEnable(): boolean;
  36767. /** @hidden */
  36768. _prepareWorkingCanvas(): void;
  36769. /**
  36770. * Reset the texture cache to empty state
  36771. */
  36772. resetTextureCache(): void;
  36773. /**
  36774. * Gets an object containing information about the current webGL context
  36775. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36776. */
  36777. getGlInfo(): {
  36778. vendor: string;
  36779. renderer: string;
  36780. version: string;
  36781. };
  36782. /**
  36783. * Defines the hardware scaling level.
  36784. * By default the hardware scaling level is computed from the window device ratio.
  36785. * 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.
  36786. * @param level defines the level to use
  36787. */
  36788. setHardwareScalingLevel(level: number): void;
  36789. /**
  36790. * Gets the current hardware scaling level.
  36791. * By default the hardware scaling level is computed from the window device ratio.
  36792. * 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.
  36793. * @returns a number indicating the current hardware scaling level
  36794. */
  36795. getHardwareScalingLevel(): number;
  36796. /**
  36797. * Gets the list of loaded textures
  36798. * @returns an array containing all loaded textures
  36799. */
  36800. getLoadedTexturesCache(): InternalTexture[];
  36801. /**
  36802. * Gets the object containing all engine capabilities
  36803. * @returns the EngineCapabilities object
  36804. */
  36805. getCaps(): EngineCapabilities;
  36806. /**
  36807. * stop executing a render loop function and remove it from the execution array
  36808. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36809. */
  36810. stopRenderLoop(renderFunction?: () => void): void;
  36811. /** @hidden */
  36812. _renderLoop(): void;
  36813. /**
  36814. * Gets the HTML canvas attached with the current webGL context
  36815. * @returns a HTML canvas
  36816. */
  36817. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36818. /**
  36819. * Gets host window
  36820. * @returns the host window object
  36821. */
  36822. getHostWindow(): Nullable<Window>;
  36823. /**
  36824. * Gets the current render width
  36825. * @param useScreen defines if screen size must be used (or the current render target if any)
  36826. * @returns a number defining the current render width
  36827. */
  36828. getRenderWidth(useScreen?: boolean): number;
  36829. /**
  36830. * Gets the current render height
  36831. * @param useScreen defines if screen size must be used (or the current render target if any)
  36832. * @returns a number defining the current render height
  36833. */
  36834. getRenderHeight(useScreen?: boolean): number;
  36835. /**
  36836. * Can be used to override the current requestAnimationFrame requester.
  36837. * @hidden
  36838. */
  36839. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36840. /**
  36841. * Register and execute a render loop. The engine can have more than one render function
  36842. * @param renderFunction defines the function to continuously execute
  36843. */
  36844. runRenderLoop(renderFunction: () => void): void;
  36845. /**
  36846. * Clear the current render buffer or the current render target (if any is set up)
  36847. * @param color defines the color to use
  36848. * @param backBuffer defines if the back buffer must be cleared
  36849. * @param depth defines if the depth buffer must be cleared
  36850. * @param stencil defines if the stencil buffer must be cleared
  36851. */
  36852. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36853. private _viewportCached;
  36854. /** @hidden */
  36855. _viewport(x: number, y: number, width: number, height: number): void;
  36856. /**
  36857. * Set the WebGL's viewport
  36858. * @param viewport defines the viewport element to be used
  36859. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36860. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36861. */
  36862. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36863. /**
  36864. * Begin a new frame
  36865. */
  36866. beginFrame(): void;
  36867. /**
  36868. * Enf the current frame
  36869. */
  36870. endFrame(): void;
  36871. /**
  36872. * Resize the view according to the canvas' size
  36873. */
  36874. resize(): void;
  36875. /**
  36876. * Force a specific size of the canvas
  36877. * @param width defines the new canvas' width
  36878. * @param height defines the new canvas' height
  36879. * @returns true if the size was changed
  36880. */
  36881. setSize(width: number, height: number): boolean;
  36882. /**
  36883. * Binds the frame buffer to the specified texture.
  36884. * @param texture The texture to render to or null for the default canvas
  36885. * @param faceIndex The face of the texture to render to in case of cube texture
  36886. * @param requiredWidth The width of the target to render to
  36887. * @param requiredHeight The height of the target to render to
  36888. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36889. * @param lodLevel defines the lod level to bind to the frame buffer
  36890. * @param layer defines the 2d array index to bind to frame buffer to
  36891. */
  36892. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36893. /** @hidden */
  36894. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36895. /**
  36896. * Unbind the current render target texture from the webGL context
  36897. * @param texture defines the render target texture to unbind
  36898. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36899. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36900. */
  36901. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36902. /**
  36903. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36904. */
  36905. flushFramebuffer(): void;
  36906. /**
  36907. * Unbind the current render target and bind the default framebuffer
  36908. */
  36909. restoreDefaultFramebuffer(): void;
  36910. /** @hidden */
  36911. protected _resetVertexBufferBinding(): void;
  36912. /**
  36913. * Creates a vertex buffer
  36914. * @param data the data for the vertex buffer
  36915. * @returns the new WebGL static buffer
  36916. */
  36917. createVertexBuffer(data: DataArray): DataBuffer;
  36918. private _createVertexBuffer;
  36919. /**
  36920. * Creates a dynamic vertex buffer
  36921. * @param data the data for the dynamic vertex buffer
  36922. * @returns the new WebGL dynamic buffer
  36923. */
  36924. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36925. protected _resetIndexBufferBinding(): void;
  36926. /**
  36927. * Creates a new index buffer
  36928. * @param indices defines the content of the index buffer
  36929. * @param updatable defines if the index buffer must be updatable
  36930. * @returns a new webGL buffer
  36931. */
  36932. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36933. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36934. /**
  36935. * Bind a webGL buffer to the webGL context
  36936. * @param buffer defines the buffer to bind
  36937. */
  36938. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36939. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36940. private bindBuffer;
  36941. /**
  36942. * update the bound buffer with the given data
  36943. * @param data defines the data to update
  36944. */
  36945. updateArrayBuffer(data: Float32Array): void;
  36946. private _vertexAttribPointer;
  36947. /** @hidden */
  36948. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36949. private _bindVertexBuffersAttributes;
  36950. /**
  36951. * Records a vertex array object
  36952. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36953. * @param vertexBuffers defines the list of vertex buffers to store
  36954. * @param indexBuffer defines the index buffer to store
  36955. * @param effect defines the effect to store
  36956. * @returns the new vertex array object
  36957. */
  36958. recordVertexArrayObject(vertexBuffers: {
  36959. [key: string]: VertexBuffer;
  36960. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36961. /**
  36962. * Bind a specific vertex array object
  36963. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36964. * @param vertexArrayObject defines the vertex array object to bind
  36965. * @param indexBuffer defines the index buffer to bind
  36966. */
  36967. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36968. /**
  36969. * Bind webGl buffers directly to the webGL context
  36970. * @param vertexBuffer defines the vertex buffer to bind
  36971. * @param indexBuffer defines the index buffer to bind
  36972. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36973. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36974. * @param effect defines the effect associated with the vertex buffer
  36975. */
  36976. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36977. private _unbindVertexArrayObject;
  36978. /**
  36979. * Bind a list of vertex buffers to the webGL context
  36980. * @param vertexBuffers defines the list of vertex buffers to bind
  36981. * @param indexBuffer defines the index buffer to bind
  36982. * @param effect defines the effect associated with the vertex buffers
  36983. */
  36984. bindBuffers(vertexBuffers: {
  36985. [key: string]: Nullable<VertexBuffer>;
  36986. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  36987. /**
  36988. * Unbind all instance attributes
  36989. */
  36990. unbindInstanceAttributes(): void;
  36991. /**
  36992. * Release and free the memory of a vertex array object
  36993. * @param vao defines the vertex array object to delete
  36994. */
  36995. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  36996. /** @hidden */
  36997. _releaseBuffer(buffer: DataBuffer): boolean;
  36998. protected _deleteBuffer(buffer: DataBuffer): void;
  36999. /**
  37000. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37001. * @param instancesBuffer defines the webGL buffer to update and bind
  37002. * @param data defines the data to store in the buffer
  37003. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37004. */
  37005. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37006. /**
  37007. * Bind the content of a webGL buffer used with instantiation
  37008. * @param instancesBuffer defines the webGL buffer to bind
  37009. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37010. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37011. */
  37012. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37013. /**
  37014. * Disable the instance attribute corresponding to the name in parameter
  37015. * @param name defines the name of the attribute to disable
  37016. */
  37017. disableInstanceAttributeByName(name: string): void;
  37018. /**
  37019. * Disable the instance attribute corresponding to the location in parameter
  37020. * @param attributeLocation defines the attribute location of the attribute to disable
  37021. */
  37022. disableInstanceAttribute(attributeLocation: number): void;
  37023. /**
  37024. * Disable the attribute corresponding to the location in parameter
  37025. * @param attributeLocation defines the attribute location of the attribute to disable
  37026. */
  37027. disableAttributeByIndex(attributeLocation: number): void;
  37028. /**
  37029. * Send a draw order
  37030. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37031. * @param indexStart defines the starting index
  37032. * @param indexCount defines the number of index to draw
  37033. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37034. */
  37035. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37036. /**
  37037. * Draw a list of points
  37038. * @param verticesStart defines the index of first vertex to draw
  37039. * @param verticesCount defines the count of vertices to draw
  37040. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37041. */
  37042. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37043. /**
  37044. * Draw a list of unindexed primitives
  37045. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37046. * @param verticesStart defines the index of first vertex to draw
  37047. * @param verticesCount defines the count of vertices to draw
  37048. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37049. */
  37050. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37051. /**
  37052. * Draw a list of indexed primitives
  37053. * @param fillMode defines the primitive to use
  37054. * @param indexStart defines the starting index
  37055. * @param indexCount defines the number of index to draw
  37056. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37057. */
  37058. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37059. /**
  37060. * Draw a list of unindexed primitives
  37061. * @param fillMode defines the primitive to use
  37062. * @param verticesStart defines the index of first vertex to draw
  37063. * @param verticesCount defines the count of vertices to draw
  37064. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37065. */
  37066. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37067. private _drawMode;
  37068. /** @hidden */
  37069. protected _reportDrawCall(): void;
  37070. /** @hidden */
  37071. _releaseEffect(effect: Effect): void;
  37072. /** @hidden */
  37073. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37074. /**
  37075. * Create a new effect (used to store vertex/fragment shaders)
  37076. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37077. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37078. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37079. * @param samplers defines an array of string used to represent textures
  37080. * @param defines defines the string containing the defines to use to compile the shaders
  37081. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37082. * @param onCompiled defines a function to call when the effect creation is successful
  37083. * @param onError defines a function to call when the effect creation has failed
  37084. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37085. * @returns the new Effect
  37086. */
  37087. 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;
  37088. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37089. private _compileShader;
  37090. private _compileRawShader;
  37091. /** @hidden */
  37092. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37093. /**
  37094. * Directly creates a webGL program
  37095. * @param pipelineContext defines the pipeline context to attach to
  37096. * @param vertexCode defines the vertex shader code to use
  37097. * @param fragmentCode defines the fragment shader code to use
  37098. * @param context defines the webGL context to use (if not set, the current one will be used)
  37099. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37100. * @returns the new webGL program
  37101. */
  37102. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37103. /**
  37104. * Creates a webGL program
  37105. * @param pipelineContext defines the pipeline context to attach to
  37106. * @param vertexCode defines the vertex shader code to use
  37107. * @param fragmentCode defines the fragment shader code to use
  37108. * @param defines defines the string containing the defines to use to compile the shaders
  37109. * @param context defines the webGL context to use (if not set, the current one will be used)
  37110. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37111. * @returns the new webGL program
  37112. */
  37113. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37114. /**
  37115. * Creates a new pipeline context
  37116. * @returns the new pipeline
  37117. */
  37118. createPipelineContext(): IPipelineContext;
  37119. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37120. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37121. /** @hidden */
  37122. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37123. /** @hidden */
  37124. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37125. /** @hidden */
  37126. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37127. /**
  37128. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37129. * @param pipelineContext defines the pipeline context to use
  37130. * @param uniformsNames defines the list of uniform names
  37131. * @returns an array of webGL uniform locations
  37132. */
  37133. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37134. /**
  37135. * Gets the lsit of active attributes for a given webGL program
  37136. * @param pipelineContext defines the pipeline context to use
  37137. * @param attributesNames defines the list of attribute names to get
  37138. * @returns an array of indices indicating the offset of each attribute
  37139. */
  37140. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37141. /**
  37142. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37143. * @param effect defines the effect to activate
  37144. */
  37145. enableEffect(effect: Nullable<Effect>): void;
  37146. /**
  37147. * Set the value of an uniform to a number (int)
  37148. * @param uniform defines the webGL uniform location where to store the value
  37149. * @param value defines the int number to store
  37150. */
  37151. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37152. /**
  37153. * Set the value of an uniform to an array of int32
  37154. * @param uniform defines the webGL uniform location where to store the value
  37155. * @param array defines the array of int32 to store
  37156. */
  37157. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37158. /**
  37159. * Set the value of an uniform to an array of int32 (stored as vec2)
  37160. * @param uniform defines the webGL uniform location where to store the value
  37161. * @param array defines the array of int32 to store
  37162. */
  37163. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37164. /**
  37165. * Set the value of an uniform to an array of int32 (stored as vec3)
  37166. * @param uniform defines the webGL uniform location where to store the value
  37167. * @param array defines the array of int32 to store
  37168. */
  37169. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37170. /**
  37171. * Set the value of an uniform to an array of int32 (stored as vec4)
  37172. * @param uniform defines the webGL uniform location where to store the value
  37173. * @param array defines the array of int32 to store
  37174. */
  37175. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37176. /**
  37177. * Set the value of an uniform to an array of number
  37178. * @param uniform defines the webGL uniform location where to store the value
  37179. * @param array defines the array of number to store
  37180. */
  37181. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37182. /**
  37183. * Set the value of an uniform to an array of number (stored as vec2)
  37184. * @param uniform defines the webGL uniform location where to store the value
  37185. * @param array defines the array of number to store
  37186. */
  37187. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37188. /**
  37189. * Set the value of an uniform to an array of number (stored as vec3)
  37190. * @param uniform defines the webGL uniform location where to store the value
  37191. * @param array defines the array of number to store
  37192. */
  37193. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37194. /**
  37195. * Set the value of an uniform to an array of number (stored as vec4)
  37196. * @param uniform defines the webGL uniform location where to store the value
  37197. * @param array defines the array of number to store
  37198. */
  37199. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37200. /**
  37201. * Set the value of an uniform to an array of float32 (stored as matrices)
  37202. * @param uniform defines the webGL uniform location where to store the value
  37203. * @param matrices defines the array of float32 to store
  37204. */
  37205. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37206. /**
  37207. * Set the value of an uniform to a matrix (3x3)
  37208. * @param uniform defines the webGL uniform location where to store the value
  37209. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37210. */
  37211. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37212. /**
  37213. * Set the value of an uniform to a matrix (2x2)
  37214. * @param uniform defines the webGL uniform location where to store the value
  37215. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37216. */
  37217. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37218. /**
  37219. * Set the value of an uniform to a number (float)
  37220. * @param uniform defines the webGL uniform location where to store the value
  37221. * @param value defines the float number to store
  37222. */
  37223. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37224. /**
  37225. * Set the value of an uniform to a vec2
  37226. * @param uniform defines the webGL uniform location where to store the value
  37227. * @param x defines the 1st component of the value
  37228. * @param y defines the 2nd component of the value
  37229. */
  37230. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37231. /**
  37232. * Set the value of an uniform to a vec3
  37233. * @param uniform defines the webGL uniform location where to store the value
  37234. * @param x defines the 1st component of the value
  37235. * @param y defines the 2nd component of the value
  37236. * @param z defines the 3rd component of the value
  37237. */
  37238. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37239. /**
  37240. * Set the value of an uniform to a vec4
  37241. * @param uniform defines the webGL uniform location where to store the value
  37242. * @param x defines the 1st component of the value
  37243. * @param y defines the 2nd component of the value
  37244. * @param z defines the 3rd component of the value
  37245. * @param w defines the 4th component of the value
  37246. */
  37247. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37248. /**
  37249. * Apply all cached states (depth, culling, stencil and alpha)
  37250. */
  37251. applyStates(): void;
  37252. /**
  37253. * Enable or disable color writing
  37254. * @param enable defines the state to set
  37255. */
  37256. setColorWrite(enable: boolean): void;
  37257. /**
  37258. * Gets a boolean indicating if color writing is enabled
  37259. * @returns the current color writing state
  37260. */
  37261. getColorWrite(): boolean;
  37262. /**
  37263. * Gets the depth culling state manager
  37264. */
  37265. get depthCullingState(): DepthCullingState;
  37266. /**
  37267. * Gets the alpha state manager
  37268. */
  37269. get alphaState(): AlphaState;
  37270. /**
  37271. * Gets the stencil state manager
  37272. */
  37273. get stencilState(): StencilState;
  37274. /**
  37275. * Clears the list of texture accessible through engine.
  37276. * This can help preventing texture load conflict due to name collision.
  37277. */
  37278. clearInternalTexturesCache(): void;
  37279. /**
  37280. * Force the entire cache to be cleared
  37281. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37282. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37283. */
  37284. wipeCaches(bruteForce?: boolean): void;
  37285. /** @hidden */
  37286. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37287. min: number;
  37288. mag: number;
  37289. };
  37290. /** @hidden */
  37291. _createTexture(): WebGLTexture;
  37292. /**
  37293. * Usually called from Texture.ts.
  37294. * Passed information to create a WebGLTexture
  37295. * @param url defines a value which contains one of the following:
  37296. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37297. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37298. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37299. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37300. * @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)
  37301. * @param scene needed for loading to the correct scene
  37302. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37303. * @param onLoad optional callback to be called upon successful completion
  37304. * @param onError optional callback to be called upon failure
  37305. * @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
  37306. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37307. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37308. * @param forcedExtension defines the extension to use to pick the right loader
  37309. * @param mimeType defines an optional mime type
  37310. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37311. */
  37312. 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;
  37313. /**
  37314. * Loads an image as an HTMLImageElement.
  37315. * @param input url string, ArrayBuffer, or Blob to load
  37316. * @param onLoad callback called when the image successfully loads
  37317. * @param onError callback called when the image fails to load
  37318. * @param offlineProvider offline provider for caching
  37319. * @param mimeType optional mime type
  37320. * @returns the HTMLImageElement of the loaded image
  37321. * @hidden
  37322. */
  37323. 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>;
  37324. /**
  37325. * @hidden
  37326. */
  37327. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37328. private _unpackFlipYCached;
  37329. /**
  37330. * In case you are sharing the context with other applications, it might
  37331. * be interested to not cache the unpack flip y state to ensure a consistent
  37332. * value would be set.
  37333. */
  37334. enableUnpackFlipYCached: boolean;
  37335. /** @hidden */
  37336. _unpackFlipY(value: boolean): void;
  37337. /** @hidden */
  37338. _getUnpackAlignement(): number;
  37339. private _getTextureTarget;
  37340. /**
  37341. * Update the sampling mode of a given texture
  37342. * @param samplingMode defines the required sampling mode
  37343. * @param texture defines the texture to update
  37344. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37345. */
  37346. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37347. /**
  37348. * Update the sampling mode of a given texture
  37349. * @param texture defines the texture to update
  37350. * @param wrapU defines the texture wrap mode of the u coordinates
  37351. * @param wrapV defines the texture wrap mode of the v coordinates
  37352. * @param wrapR defines the texture wrap mode of the r coordinates
  37353. */
  37354. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37355. /** @hidden */
  37356. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37357. width: number;
  37358. height: number;
  37359. layers?: number;
  37360. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37361. /** @hidden */
  37362. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37363. /** @hidden */
  37364. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37365. /**
  37366. * Update a portion of an internal texture
  37367. * @param texture defines the texture to update
  37368. * @param imageData defines the data to store into the texture
  37369. * @param xOffset defines the x coordinates of the update rectangle
  37370. * @param yOffset defines the y coordinates of the update rectangle
  37371. * @param width defines the width of the update rectangle
  37372. * @param height defines the height of the update rectangle
  37373. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37374. * @param lod defines the lod level to update (0 by default)
  37375. */
  37376. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37377. /** @hidden */
  37378. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37379. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37380. private _prepareWebGLTexture;
  37381. /** @hidden */
  37382. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37383. private _getDepthStencilBuffer;
  37384. /** @hidden */
  37385. _releaseFramebufferObjects(texture: InternalTexture): void;
  37386. /** @hidden */
  37387. _releaseTexture(texture: InternalTexture): void;
  37388. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37389. protected _setProgram(program: WebGLProgram): void;
  37390. protected _boundUniforms: {
  37391. [key: number]: WebGLUniformLocation;
  37392. };
  37393. /**
  37394. * Binds an effect to the webGL context
  37395. * @param effect defines the effect to bind
  37396. */
  37397. bindSamplers(effect: Effect): void;
  37398. private _activateCurrentTexture;
  37399. /** @hidden */
  37400. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37401. /** @hidden */
  37402. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37403. /**
  37404. * Unbind all textures from the webGL context
  37405. */
  37406. unbindAllTextures(): void;
  37407. /**
  37408. * Sets a texture to the according uniform.
  37409. * @param channel The texture channel
  37410. * @param uniform The uniform to set
  37411. * @param texture The texture to apply
  37412. */
  37413. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37414. private _bindSamplerUniformToChannel;
  37415. private _getTextureWrapMode;
  37416. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37417. /**
  37418. * Sets an array of texture to the webGL context
  37419. * @param channel defines the channel where the texture array must be set
  37420. * @param uniform defines the associated uniform location
  37421. * @param textures defines the array of textures to bind
  37422. */
  37423. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37424. /** @hidden */
  37425. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37426. private _setTextureParameterFloat;
  37427. private _setTextureParameterInteger;
  37428. /**
  37429. * Unbind all vertex attributes from the webGL context
  37430. */
  37431. unbindAllAttributes(): void;
  37432. /**
  37433. * 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
  37434. */
  37435. releaseEffects(): void;
  37436. /**
  37437. * Dispose and release all associated resources
  37438. */
  37439. dispose(): void;
  37440. /**
  37441. * Attach a new callback raised when context lost event is fired
  37442. * @param callback defines the callback to call
  37443. */
  37444. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37445. /**
  37446. * Attach a new callback raised when context restored event is fired
  37447. * @param callback defines the callback to call
  37448. */
  37449. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37450. /**
  37451. * Get the current error code of the webGL context
  37452. * @returns the error code
  37453. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37454. */
  37455. getError(): number;
  37456. private _canRenderToFloatFramebuffer;
  37457. private _canRenderToHalfFloatFramebuffer;
  37458. private _canRenderToFramebuffer;
  37459. /** @hidden */
  37460. _getWebGLTextureType(type: number): number;
  37461. /** @hidden */
  37462. _getInternalFormat(format: number): number;
  37463. /** @hidden */
  37464. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37465. /** @hidden */
  37466. _getRGBAMultiSampleBufferFormat(type: number): number;
  37467. /** @hidden */
  37468. _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;
  37469. /**
  37470. * Loads a file from a url
  37471. * @param url url to load
  37472. * @param onSuccess callback called when the file successfully loads
  37473. * @param onProgress callback called while file is loading (if the server supports this mode)
  37474. * @param offlineProvider defines the offline provider for caching
  37475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37476. * @param onError callback called when the file fails to load
  37477. * @returns a file request object
  37478. * @hidden
  37479. */
  37480. 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;
  37481. /**
  37482. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37483. * @param x defines the x coordinate of the rectangle where pixels must be read
  37484. * @param y defines the y coordinate of the rectangle where pixels must be read
  37485. * @param width defines the width of the rectangle where pixels must be read
  37486. * @param height defines the height of the rectangle where pixels must be read
  37487. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37488. * @returns a Uint8Array containing RGBA colors
  37489. */
  37490. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37491. private static _isSupported;
  37492. /**
  37493. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37494. * @returns true if the engine can be created
  37495. * @ignorenaming
  37496. */
  37497. static isSupported(): boolean;
  37498. /**
  37499. * Find the next highest power of two.
  37500. * @param x Number to start search from.
  37501. * @return Next highest power of two.
  37502. */
  37503. static CeilingPOT(x: number): number;
  37504. /**
  37505. * Find the next lowest power of two.
  37506. * @param x Number to start search from.
  37507. * @return Next lowest power of two.
  37508. */
  37509. static FloorPOT(x: number): number;
  37510. /**
  37511. * Find the nearest power of two.
  37512. * @param x Number to start search from.
  37513. * @return Next nearest power of two.
  37514. */
  37515. static NearestPOT(x: number): number;
  37516. /**
  37517. * Get the closest exponent of two
  37518. * @param value defines the value to approximate
  37519. * @param max defines the maximum value to return
  37520. * @param mode defines how to define the closest value
  37521. * @returns closest exponent of two of the given value
  37522. */
  37523. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37524. /**
  37525. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37526. * @param func - the function to be called
  37527. * @param requester - the object that will request the next frame. Falls back to window.
  37528. * @returns frame number
  37529. */
  37530. static QueueNewFrame(func: () => void, requester?: any): number;
  37531. /**
  37532. * Gets host document
  37533. * @returns the host document object
  37534. */
  37535. getHostDocument(): Nullable<Document>;
  37536. }
  37537. }
  37538. declare module "babylonjs/Maths/sphericalPolynomial" {
  37539. import { Vector3 } from "babylonjs/Maths/math.vector";
  37540. import { Color3 } from "babylonjs/Maths/math.color";
  37541. /**
  37542. * Class representing spherical harmonics coefficients to the 3rd degree
  37543. */
  37544. export class SphericalHarmonics {
  37545. /**
  37546. * Defines whether or not the harmonics have been prescaled for rendering.
  37547. */
  37548. preScaled: boolean;
  37549. /**
  37550. * The l0,0 coefficients of the spherical harmonics
  37551. */
  37552. l00: Vector3;
  37553. /**
  37554. * The l1,-1 coefficients of the spherical harmonics
  37555. */
  37556. l1_1: Vector3;
  37557. /**
  37558. * The l1,0 coefficients of the spherical harmonics
  37559. */
  37560. l10: Vector3;
  37561. /**
  37562. * The l1,1 coefficients of the spherical harmonics
  37563. */
  37564. l11: Vector3;
  37565. /**
  37566. * The l2,-2 coefficients of the spherical harmonics
  37567. */
  37568. l2_2: Vector3;
  37569. /**
  37570. * The l2,-1 coefficients of the spherical harmonics
  37571. */
  37572. l2_1: Vector3;
  37573. /**
  37574. * The l2,0 coefficients of the spherical harmonics
  37575. */
  37576. l20: Vector3;
  37577. /**
  37578. * The l2,1 coefficients of the spherical harmonics
  37579. */
  37580. l21: Vector3;
  37581. /**
  37582. * The l2,2 coefficients of the spherical harmonics
  37583. */
  37584. l22: Vector3;
  37585. /**
  37586. * Adds a light to the spherical harmonics
  37587. * @param direction the direction of the light
  37588. * @param color the color of the light
  37589. * @param deltaSolidAngle the delta solid angle of the light
  37590. */
  37591. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37592. /**
  37593. * Scales the spherical harmonics by the given amount
  37594. * @param scale the amount to scale
  37595. */
  37596. scaleInPlace(scale: number): void;
  37597. /**
  37598. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37599. *
  37600. * ```
  37601. * E_lm = A_l * L_lm
  37602. * ```
  37603. *
  37604. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37605. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37606. * the scaling factors are given in equation 9.
  37607. */
  37608. convertIncidentRadianceToIrradiance(): void;
  37609. /**
  37610. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37611. *
  37612. * ```
  37613. * L = (1/pi) * E * rho
  37614. * ```
  37615. *
  37616. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37617. */
  37618. convertIrradianceToLambertianRadiance(): void;
  37619. /**
  37620. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37621. * required operations at run time.
  37622. *
  37623. * This is simply done by scaling back the SH with Ylm constants parameter.
  37624. * The trigonometric part being applied by the shader at run time.
  37625. */
  37626. preScaleForRendering(): void;
  37627. /**
  37628. * Constructs a spherical harmonics from an array.
  37629. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37630. * @returns the spherical harmonics
  37631. */
  37632. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37633. /**
  37634. * Gets the spherical harmonics from polynomial
  37635. * @param polynomial the spherical polynomial
  37636. * @returns the spherical harmonics
  37637. */
  37638. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37639. }
  37640. /**
  37641. * Class representing spherical polynomial coefficients to the 3rd degree
  37642. */
  37643. export class SphericalPolynomial {
  37644. private _harmonics;
  37645. /**
  37646. * The spherical harmonics used to create the polynomials.
  37647. */
  37648. get preScaledHarmonics(): SphericalHarmonics;
  37649. /**
  37650. * The x coefficients of the spherical polynomial
  37651. */
  37652. x: Vector3;
  37653. /**
  37654. * The y coefficients of the spherical polynomial
  37655. */
  37656. y: Vector3;
  37657. /**
  37658. * The z coefficients of the spherical polynomial
  37659. */
  37660. z: Vector3;
  37661. /**
  37662. * The xx coefficients of the spherical polynomial
  37663. */
  37664. xx: Vector3;
  37665. /**
  37666. * The yy coefficients of the spherical polynomial
  37667. */
  37668. yy: Vector3;
  37669. /**
  37670. * The zz coefficients of the spherical polynomial
  37671. */
  37672. zz: Vector3;
  37673. /**
  37674. * The xy coefficients of the spherical polynomial
  37675. */
  37676. xy: Vector3;
  37677. /**
  37678. * The yz coefficients of the spherical polynomial
  37679. */
  37680. yz: Vector3;
  37681. /**
  37682. * The zx coefficients of the spherical polynomial
  37683. */
  37684. zx: Vector3;
  37685. /**
  37686. * Adds an ambient color to the spherical polynomial
  37687. * @param color the color to add
  37688. */
  37689. addAmbient(color: Color3): void;
  37690. /**
  37691. * Scales the spherical polynomial by the given amount
  37692. * @param scale the amount to scale
  37693. */
  37694. scaleInPlace(scale: number): void;
  37695. /**
  37696. * Gets the spherical polynomial from harmonics
  37697. * @param harmonics the spherical harmonics
  37698. * @returns the spherical polynomial
  37699. */
  37700. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37701. /**
  37702. * Constructs a spherical polynomial from an array.
  37703. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37704. * @returns the spherical polynomial
  37705. */
  37706. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37707. }
  37708. }
  37709. declare module "babylonjs/Materials/Textures/internalTexture" {
  37710. import { Observable } from "babylonjs/Misc/observable";
  37711. import { Nullable, int } from "babylonjs/types";
  37712. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37713. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37714. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37715. /**
  37716. * Defines the source of the internal texture
  37717. */
  37718. export enum InternalTextureSource {
  37719. /**
  37720. * The source of the texture data is unknown
  37721. */
  37722. Unknown = 0,
  37723. /**
  37724. * Texture data comes from an URL
  37725. */
  37726. Url = 1,
  37727. /**
  37728. * Texture data is only used for temporary storage
  37729. */
  37730. Temp = 2,
  37731. /**
  37732. * Texture data comes from raw data (ArrayBuffer)
  37733. */
  37734. Raw = 3,
  37735. /**
  37736. * Texture content is dynamic (video or dynamic texture)
  37737. */
  37738. Dynamic = 4,
  37739. /**
  37740. * Texture content is generated by rendering to it
  37741. */
  37742. RenderTarget = 5,
  37743. /**
  37744. * Texture content is part of a multi render target process
  37745. */
  37746. MultiRenderTarget = 6,
  37747. /**
  37748. * Texture data comes from a cube data file
  37749. */
  37750. Cube = 7,
  37751. /**
  37752. * Texture data comes from a raw cube data
  37753. */
  37754. CubeRaw = 8,
  37755. /**
  37756. * Texture data come from a prefiltered cube data file
  37757. */
  37758. CubePrefiltered = 9,
  37759. /**
  37760. * Texture content is raw 3D data
  37761. */
  37762. Raw3D = 10,
  37763. /**
  37764. * Texture content is raw 2D array data
  37765. */
  37766. Raw2DArray = 11,
  37767. /**
  37768. * Texture content is a depth texture
  37769. */
  37770. Depth = 12,
  37771. /**
  37772. * Texture data comes from a raw cube data encoded with RGBD
  37773. */
  37774. CubeRawRGBD = 13
  37775. }
  37776. /**
  37777. * Class used to store data associated with WebGL texture data for the engine
  37778. * This class should not be used directly
  37779. */
  37780. export class InternalTexture {
  37781. /** @hidden */
  37782. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37783. /**
  37784. * Defines if the texture is ready
  37785. */
  37786. isReady: boolean;
  37787. /**
  37788. * Defines if the texture is a cube texture
  37789. */
  37790. isCube: boolean;
  37791. /**
  37792. * Defines if the texture contains 3D data
  37793. */
  37794. is3D: boolean;
  37795. /**
  37796. * Defines if the texture contains 2D array data
  37797. */
  37798. is2DArray: boolean;
  37799. /**
  37800. * Defines if the texture contains multiview data
  37801. */
  37802. isMultiview: boolean;
  37803. /**
  37804. * Gets the URL used to load this texture
  37805. */
  37806. url: string;
  37807. /**
  37808. * Gets the sampling mode of the texture
  37809. */
  37810. samplingMode: number;
  37811. /**
  37812. * Gets a boolean indicating if the texture needs mipmaps generation
  37813. */
  37814. generateMipMaps: boolean;
  37815. /**
  37816. * Gets the number of samples used by the texture (WebGL2+ only)
  37817. */
  37818. samples: number;
  37819. /**
  37820. * Gets the type of the texture (int, float...)
  37821. */
  37822. type: number;
  37823. /**
  37824. * Gets the format of the texture (RGB, RGBA...)
  37825. */
  37826. format: number;
  37827. /**
  37828. * Observable called when the texture is loaded
  37829. */
  37830. onLoadedObservable: Observable<InternalTexture>;
  37831. /**
  37832. * Gets the width of the texture
  37833. */
  37834. width: number;
  37835. /**
  37836. * Gets the height of the texture
  37837. */
  37838. height: number;
  37839. /**
  37840. * Gets the depth of the texture
  37841. */
  37842. depth: number;
  37843. /**
  37844. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37845. */
  37846. baseWidth: number;
  37847. /**
  37848. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37849. */
  37850. baseHeight: number;
  37851. /**
  37852. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37853. */
  37854. baseDepth: number;
  37855. /**
  37856. * Gets a boolean indicating if the texture is inverted on Y axis
  37857. */
  37858. invertY: boolean;
  37859. /** @hidden */
  37860. _invertVScale: boolean;
  37861. /** @hidden */
  37862. _associatedChannel: number;
  37863. /** @hidden */
  37864. _source: InternalTextureSource;
  37865. /** @hidden */
  37866. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37867. /** @hidden */
  37868. _bufferView: Nullable<ArrayBufferView>;
  37869. /** @hidden */
  37870. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37871. /** @hidden */
  37872. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37873. /** @hidden */
  37874. _size: number;
  37875. /** @hidden */
  37876. _extension: string;
  37877. /** @hidden */
  37878. _files: Nullable<string[]>;
  37879. /** @hidden */
  37880. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37881. /** @hidden */
  37882. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37883. /** @hidden */
  37884. _framebuffer: Nullable<WebGLFramebuffer>;
  37885. /** @hidden */
  37886. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37887. /** @hidden */
  37888. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37889. /** @hidden */
  37890. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37891. /** @hidden */
  37892. _attachments: Nullable<number[]>;
  37893. /** @hidden */
  37894. _textureArray: Nullable<InternalTexture[]>;
  37895. /** @hidden */
  37896. _cachedCoordinatesMode: Nullable<number>;
  37897. /** @hidden */
  37898. _cachedWrapU: Nullable<number>;
  37899. /** @hidden */
  37900. _cachedWrapV: Nullable<number>;
  37901. /** @hidden */
  37902. _cachedWrapR: Nullable<number>;
  37903. /** @hidden */
  37904. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37905. /** @hidden */
  37906. _isDisabled: boolean;
  37907. /** @hidden */
  37908. _compression: Nullable<string>;
  37909. /** @hidden */
  37910. _generateStencilBuffer: boolean;
  37911. /** @hidden */
  37912. _generateDepthBuffer: boolean;
  37913. /** @hidden */
  37914. _comparisonFunction: number;
  37915. /** @hidden */
  37916. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37917. /** @hidden */
  37918. _lodGenerationScale: number;
  37919. /** @hidden */
  37920. _lodGenerationOffset: number;
  37921. /** @hidden */
  37922. _depthStencilTexture: Nullable<InternalTexture>;
  37923. /** @hidden */
  37924. _colorTextureArray: Nullable<WebGLTexture>;
  37925. /** @hidden */
  37926. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37927. /** @hidden */
  37928. _lodTextureHigh: Nullable<BaseTexture>;
  37929. /** @hidden */
  37930. _lodTextureMid: Nullable<BaseTexture>;
  37931. /** @hidden */
  37932. _lodTextureLow: Nullable<BaseTexture>;
  37933. /** @hidden */
  37934. _isRGBD: boolean;
  37935. /** @hidden */
  37936. _linearSpecularLOD: boolean;
  37937. /** @hidden */
  37938. _irradianceTexture: Nullable<BaseTexture>;
  37939. /** @hidden */
  37940. _webGLTexture: Nullable<WebGLTexture>;
  37941. /** @hidden */
  37942. _references: number;
  37943. private _engine;
  37944. /**
  37945. * Gets the Engine the texture belongs to.
  37946. * @returns The babylon engine
  37947. */
  37948. getEngine(): ThinEngine;
  37949. /**
  37950. * Gets the data source type of the texture
  37951. */
  37952. get source(): InternalTextureSource;
  37953. /**
  37954. * Creates a new InternalTexture
  37955. * @param engine defines the engine to use
  37956. * @param source defines the type of data that will be used
  37957. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37958. */
  37959. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37960. /**
  37961. * Increments the number of references (ie. the number of Texture that point to it)
  37962. */
  37963. incrementReferences(): void;
  37964. /**
  37965. * Change the size of the texture (not the size of the content)
  37966. * @param width defines the new width
  37967. * @param height defines the new height
  37968. * @param depth defines the new depth (1 by default)
  37969. */
  37970. updateSize(width: int, height: int, depth?: int): void;
  37971. /** @hidden */
  37972. _rebuild(): void;
  37973. /** @hidden */
  37974. _swapAndDie(target: InternalTexture): void;
  37975. /**
  37976. * Dispose the current allocated resources
  37977. */
  37978. dispose(): void;
  37979. }
  37980. }
  37981. declare module "babylonjs/Audio/analyser" {
  37982. import { Scene } from "babylonjs/scene";
  37983. /**
  37984. * Class used to work with sound analyzer using fast fourier transform (FFT)
  37985. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37986. */
  37987. export class Analyser {
  37988. /**
  37989. * Gets or sets the smoothing
  37990. * @ignorenaming
  37991. */
  37992. SMOOTHING: number;
  37993. /**
  37994. * Gets or sets the FFT table size
  37995. * @ignorenaming
  37996. */
  37997. FFT_SIZE: number;
  37998. /**
  37999. * Gets or sets the bar graph amplitude
  38000. * @ignorenaming
  38001. */
  38002. BARGRAPHAMPLITUDE: number;
  38003. /**
  38004. * Gets or sets the position of the debug canvas
  38005. * @ignorenaming
  38006. */
  38007. DEBUGCANVASPOS: {
  38008. x: number;
  38009. y: number;
  38010. };
  38011. /**
  38012. * Gets or sets the debug canvas size
  38013. * @ignorenaming
  38014. */
  38015. DEBUGCANVASSIZE: {
  38016. width: number;
  38017. height: number;
  38018. };
  38019. private _byteFreqs;
  38020. private _byteTime;
  38021. private _floatFreqs;
  38022. private _webAudioAnalyser;
  38023. private _debugCanvas;
  38024. private _debugCanvasContext;
  38025. private _scene;
  38026. private _registerFunc;
  38027. private _audioEngine;
  38028. /**
  38029. * Creates a new analyser
  38030. * @param scene defines hosting scene
  38031. */
  38032. constructor(scene: Scene);
  38033. /**
  38034. * Get the number of data values you will have to play with for the visualization
  38035. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38036. * @returns a number
  38037. */
  38038. getFrequencyBinCount(): number;
  38039. /**
  38040. * Gets the current frequency data as a byte array
  38041. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38042. * @returns a Uint8Array
  38043. */
  38044. getByteFrequencyData(): Uint8Array;
  38045. /**
  38046. * Gets the current waveform as a byte array
  38047. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38048. * @returns a Uint8Array
  38049. */
  38050. getByteTimeDomainData(): Uint8Array;
  38051. /**
  38052. * Gets the current frequency data as a float array
  38053. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38054. * @returns a Float32Array
  38055. */
  38056. getFloatFrequencyData(): Float32Array;
  38057. /**
  38058. * Renders the debug canvas
  38059. */
  38060. drawDebugCanvas(): void;
  38061. /**
  38062. * Stops rendering the debug canvas and removes it
  38063. */
  38064. stopDebugCanvas(): void;
  38065. /**
  38066. * Connects two audio nodes
  38067. * @param inputAudioNode defines first node to connect
  38068. * @param outputAudioNode defines second node to connect
  38069. */
  38070. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38071. /**
  38072. * Releases all associated resources
  38073. */
  38074. dispose(): void;
  38075. }
  38076. }
  38077. declare module "babylonjs/Audio/audioEngine" {
  38078. import { IDisposable } from "babylonjs/scene";
  38079. import { Analyser } from "babylonjs/Audio/analyser";
  38080. import { Nullable } from "babylonjs/types";
  38081. import { Observable } from "babylonjs/Misc/observable";
  38082. /**
  38083. * This represents an audio engine and it is responsible
  38084. * to play, synchronize and analyse sounds throughout the application.
  38085. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38086. */
  38087. export interface IAudioEngine extends IDisposable {
  38088. /**
  38089. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38090. */
  38091. readonly canUseWebAudio: boolean;
  38092. /**
  38093. * Gets the current AudioContext if available.
  38094. */
  38095. readonly audioContext: Nullable<AudioContext>;
  38096. /**
  38097. * The master gain node defines the global audio volume of your audio engine.
  38098. */
  38099. readonly masterGain: GainNode;
  38100. /**
  38101. * Gets whether or not mp3 are supported by your browser.
  38102. */
  38103. readonly isMP3supported: boolean;
  38104. /**
  38105. * Gets whether or not ogg are supported by your browser.
  38106. */
  38107. readonly isOGGsupported: boolean;
  38108. /**
  38109. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38110. * @ignoreNaming
  38111. */
  38112. WarnedWebAudioUnsupported: boolean;
  38113. /**
  38114. * Defines if the audio engine relies on a custom unlocked button.
  38115. * In this case, the embedded button will not be displayed.
  38116. */
  38117. useCustomUnlockedButton: boolean;
  38118. /**
  38119. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38120. */
  38121. readonly unlocked: boolean;
  38122. /**
  38123. * Event raised when audio has been unlocked on the browser.
  38124. */
  38125. onAudioUnlockedObservable: Observable<AudioEngine>;
  38126. /**
  38127. * Event raised when audio has been locked on the browser.
  38128. */
  38129. onAudioLockedObservable: Observable<AudioEngine>;
  38130. /**
  38131. * Flags the audio engine in Locked state.
  38132. * This happens due to new browser policies preventing audio to autoplay.
  38133. */
  38134. lock(): void;
  38135. /**
  38136. * Unlocks the audio engine once a user action has been done on the dom.
  38137. * This is helpful to resume play once browser policies have been satisfied.
  38138. */
  38139. unlock(): void;
  38140. /**
  38141. * Gets the global volume sets on the master gain.
  38142. * @returns the global volume if set or -1 otherwise
  38143. */
  38144. getGlobalVolume(): number;
  38145. /**
  38146. * Sets the global volume of your experience (sets on the master gain).
  38147. * @param newVolume Defines the new global volume of the application
  38148. */
  38149. setGlobalVolume(newVolume: number): void;
  38150. /**
  38151. * Connect the audio engine to an audio analyser allowing some amazing
  38152. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38153. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38154. * @param analyser The analyser to connect to the engine
  38155. */
  38156. connectToAnalyser(analyser: Analyser): void;
  38157. }
  38158. /**
  38159. * This represents the default audio engine used in babylon.
  38160. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38161. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38162. */
  38163. export class AudioEngine implements IAudioEngine {
  38164. private _audioContext;
  38165. private _audioContextInitialized;
  38166. private _muteButton;
  38167. private _hostElement;
  38168. /**
  38169. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38170. */
  38171. canUseWebAudio: boolean;
  38172. /**
  38173. * The master gain node defines the global audio volume of your audio engine.
  38174. */
  38175. masterGain: GainNode;
  38176. /**
  38177. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38178. * @ignoreNaming
  38179. */
  38180. WarnedWebAudioUnsupported: boolean;
  38181. /**
  38182. * Gets whether or not mp3 are supported by your browser.
  38183. */
  38184. isMP3supported: boolean;
  38185. /**
  38186. * Gets whether or not ogg are supported by your browser.
  38187. */
  38188. isOGGsupported: boolean;
  38189. /**
  38190. * Gets whether audio has been unlocked on the device.
  38191. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38192. * a user interaction has happened.
  38193. */
  38194. unlocked: boolean;
  38195. /**
  38196. * Defines if the audio engine relies on a custom unlocked button.
  38197. * In this case, the embedded button will not be displayed.
  38198. */
  38199. useCustomUnlockedButton: boolean;
  38200. /**
  38201. * Event raised when audio has been unlocked on the browser.
  38202. */
  38203. onAudioUnlockedObservable: Observable<AudioEngine>;
  38204. /**
  38205. * Event raised when audio has been locked on the browser.
  38206. */
  38207. onAudioLockedObservable: Observable<AudioEngine>;
  38208. /**
  38209. * Gets the current AudioContext if available.
  38210. */
  38211. get audioContext(): Nullable<AudioContext>;
  38212. private _connectedAnalyser;
  38213. /**
  38214. * Instantiates a new audio engine.
  38215. *
  38216. * There should be only one per page as some browsers restrict the number
  38217. * of audio contexts you can create.
  38218. * @param hostElement defines the host element where to display the mute icon if necessary
  38219. */
  38220. constructor(hostElement?: Nullable<HTMLElement>);
  38221. /**
  38222. * Flags the audio engine in Locked state.
  38223. * This happens due to new browser policies preventing audio to autoplay.
  38224. */
  38225. lock(): void;
  38226. /**
  38227. * Unlocks the audio engine once a user action has been done on the dom.
  38228. * This is helpful to resume play once browser policies have been satisfied.
  38229. */
  38230. unlock(): void;
  38231. private _resumeAudioContext;
  38232. private _initializeAudioContext;
  38233. private _tryToRun;
  38234. private _triggerRunningState;
  38235. private _triggerSuspendedState;
  38236. private _displayMuteButton;
  38237. private _moveButtonToTopLeft;
  38238. private _onResize;
  38239. private _hideMuteButton;
  38240. /**
  38241. * Destroy and release the resources associated with the audio ccontext.
  38242. */
  38243. dispose(): void;
  38244. /**
  38245. * Gets the global volume sets on the master gain.
  38246. * @returns the global volume if set or -1 otherwise
  38247. */
  38248. getGlobalVolume(): number;
  38249. /**
  38250. * Sets the global volume of your experience (sets on the master gain).
  38251. * @param newVolume Defines the new global volume of the application
  38252. */
  38253. setGlobalVolume(newVolume: number): void;
  38254. /**
  38255. * Connect the audio engine to an audio analyser allowing some amazing
  38256. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38257. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38258. * @param analyser The analyser to connect to the engine
  38259. */
  38260. connectToAnalyser(analyser: Analyser): void;
  38261. }
  38262. }
  38263. declare module "babylonjs/Loading/loadingScreen" {
  38264. /**
  38265. * Interface used to present a loading screen while loading a scene
  38266. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38267. */
  38268. export interface ILoadingScreen {
  38269. /**
  38270. * Function called to display the loading screen
  38271. */
  38272. displayLoadingUI: () => void;
  38273. /**
  38274. * Function called to hide the loading screen
  38275. */
  38276. hideLoadingUI: () => void;
  38277. /**
  38278. * Gets or sets the color to use for the background
  38279. */
  38280. loadingUIBackgroundColor: string;
  38281. /**
  38282. * Gets or sets the text to display while loading
  38283. */
  38284. loadingUIText: string;
  38285. }
  38286. /**
  38287. * Class used for the default loading screen
  38288. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38289. */
  38290. export class DefaultLoadingScreen implements ILoadingScreen {
  38291. private _renderingCanvas;
  38292. private _loadingText;
  38293. private _loadingDivBackgroundColor;
  38294. private _loadingDiv;
  38295. private _loadingTextDiv;
  38296. /** Gets or sets the logo url to use for the default loading screen */
  38297. static DefaultLogoUrl: string;
  38298. /** Gets or sets the spinner url to use for the default loading screen */
  38299. static DefaultSpinnerUrl: string;
  38300. /**
  38301. * Creates a new default loading screen
  38302. * @param _renderingCanvas defines the canvas used to render the scene
  38303. * @param _loadingText defines the default text to display
  38304. * @param _loadingDivBackgroundColor defines the default background color
  38305. */
  38306. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38307. /**
  38308. * Function called to display the loading screen
  38309. */
  38310. displayLoadingUI(): void;
  38311. /**
  38312. * Function called to hide the loading screen
  38313. */
  38314. hideLoadingUI(): void;
  38315. /**
  38316. * Gets or sets the text to display while loading
  38317. */
  38318. set loadingUIText(text: string);
  38319. get loadingUIText(): string;
  38320. /**
  38321. * Gets or sets the color to use for the background
  38322. */
  38323. get loadingUIBackgroundColor(): string;
  38324. set loadingUIBackgroundColor(color: string);
  38325. private _resizeLoadingUI;
  38326. }
  38327. }
  38328. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38329. /**
  38330. * Interface for any object that can request an animation frame
  38331. */
  38332. export interface ICustomAnimationFrameRequester {
  38333. /**
  38334. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38335. */
  38336. renderFunction?: Function;
  38337. /**
  38338. * Called to request the next frame to render to
  38339. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38340. */
  38341. requestAnimationFrame: Function;
  38342. /**
  38343. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38344. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38345. */
  38346. requestID?: number;
  38347. }
  38348. }
  38349. declare module "babylonjs/Misc/performanceMonitor" {
  38350. /**
  38351. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38352. */
  38353. export class PerformanceMonitor {
  38354. private _enabled;
  38355. private _rollingFrameTime;
  38356. private _lastFrameTimeMs;
  38357. /**
  38358. * constructor
  38359. * @param frameSampleSize The number of samples required to saturate the sliding window
  38360. */
  38361. constructor(frameSampleSize?: number);
  38362. /**
  38363. * Samples current frame
  38364. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38365. */
  38366. sampleFrame(timeMs?: number): void;
  38367. /**
  38368. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38369. */
  38370. get averageFrameTime(): number;
  38371. /**
  38372. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38373. */
  38374. get averageFrameTimeVariance(): number;
  38375. /**
  38376. * Returns the frame time of the most recent frame
  38377. */
  38378. get instantaneousFrameTime(): number;
  38379. /**
  38380. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38381. */
  38382. get averageFPS(): number;
  38383. /**
  38384. * Returns the average framerate in frames per second using the most recent frame time
  38385. */
  38386. get instantaneousFPS(): number;
  38387. /**
  38388. * Returns true if enough samples have been taken to completely fill the sliding window
  38389. */
  38390. get isSaturated(): boolean;
  38391. /**
  38392. * Enables contributions to the sliding window sample set
  38393. */
  38394. enable(): void;
  38395. /**
  38396. * Disables contributions to the sliding window sample set
  38397. * Samples will not be interpolated over the disabled period
  38398. */
  38399. disable(): void;
  38400. /**
  38401. * Returns true if sampling is enabled
  38402. */
  38403. get isEnabled(): boolean;
  38404. /**
  38405. * Resets performance monitor
  38406. */
  38407. reset(): void;
  38408. }
  38409. /**
  38410. * RollingAverage
  38411. *
  38412. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38413. */
  38414. export class RollingAverage {
  38415. /**
  38416. * Current average
  38417. */
  38418. average: number;
  38419. /**
  38420. * Current variance
  38421. */
  38422. variance: number;
  38423. protected _samples: Array<number>;
  38424. protected _sampleCount: number;
  38425. protected _pos: number;
  38426. protected _m2: number;
  38427. /**
  38428. * constructor
  38429. * @param length The number of samples required to saturate the sliding window
  38430. */
  38431. constructor(length: number);
  38432. /**
  38433. * Adds a sample to the sample set
  38434. * @param v The sample value
  38435. */
  38436. add(v: number): void;
  38437. /**
  38438. * Returns previously added values or null if outside of history or outside the sliding window domain
  38439. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38440. * @return Value previously recorded with add() or null if outside of range
  38441. */
  38442. history(i: number): number;
  38443. /**
  38444. * Returns true if enough samples have been taken to completely fill the sliding window
  38445. * @return true if sample-set saturated
  38446. */
  38447. isSaturated(): boolean;
  38448. /**
  38449. * Resets the rolling average (equivalent to 0 samples taken so far)
  38450. */
  38451. reset(): void;
  38452. /**
  38453. * Wraps a value around the sample range boundaries
  38454. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38455. * @return Wrapped position in sample range
  38456. */
  38457. protected _wrapPosition(i: number): number;
  38458. }
  38459. }
  38460. declare module "babylonjs/Misc/perfCounter" {
  38461. /**
  38462. * This class is used to track a performance counter which is number based.
  38463. * The user has access to many properties which give statistics of different nature.
  38464. *
  38465. * The implementer can track two kinds of Performance Counter: time and count.
  38466. * 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.
  38467. * 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.
  38468. */
  38469. export class PerfCounter {
  38470. /**
  38471. * Gets or sets a global boolean to turn on and off all the counters
  38472. */
  38473. static Enabled: boolean;
  38474. /**
  38475. * Returns the smallest value ever
  38476. */
  38477. get min(): number;
  38478. /**
  38479. * Returns the biggest value ever
  38480. */
  38481. get max(): number;
  38482. /**
  38483. * Returns the average value since the performance counter is running
  38484. */
  38485. get average(): number;
  38486. /**
  38487. * Returns the average value of the last second the counter was monitored
  38488. */
  38489. get lastSecAverage(): number;
  38490. /**
  38491. * Returns the current value
  38492. */
  38493. get current(): number;
  38494. /**
  38495. * Gets the accumulated total
  38496. */
  38497. get total(): number;
  38498. /**
  38499. * Gets the total value count
  38500. */
  38501. get count(): number;
  38502. /**
  38503. * Creates a new counter
  38504. */
  38505. constructor();
  38506. /**
  38507. * Call this method to start monitoring a new frame.
  38508. * 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.
  38509. */
  38510. fetchNewFrame(): void;
  38511. /**
  38512. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38513. * @param newCount the count value to add to the monitored count
  38514. * @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.
  38515. */
  38516. addCount(newCount: number, fetchResult: boolean): void;
  38517. /**
  38518. * Start monitoring this performance counter
  38519. */
  38520. beginMonitoring(): void;
  38521. /**
  38522. * Compute the time lapsed since the previous beginMonitoring() call.
  38523. * @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
  38524. */
  38525. endMonitoring(newFrame?: boolean): void;
  38526. private _fetchResult;
  38527. private _startMonitoringTime;
  38528. private _min;
  38529. private _max;
  38530. private _average;
  38531. private _current;
  38532. private _totalValueCount;
  38533. private _totalAccumulated;
  38534. private _lastSecAverage;
  38535. private _lastSecAccumulated;
  38536. private _lastSecTime;
  38537. private _lastSecValueCount;
  38538. }
  38539. }
  38540. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38541. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38542. import { Nullable } from "babylonjs/types";
  38543. module "babylonjs/Engines/thinEngine" {
  38544. interface ThinEngine {
  38545. /** @hidden */
  38546. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38547. }
  38548. }
  38549. }
  38550. declare module "babylonjs/Engines/engine" {
  38551. import { Observable } from "babylonjs/Misc/observable";
  38552. import { Nullable } from "babylonjs/types";
  38553. import { Scene } from "babylonjs/scene";
  38554. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38555. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38556. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38557. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38558. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38559. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38560. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38561. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38562. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38563. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38564. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38565. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38566. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38567. import "babylonjs/Engines/Extensions/engine.alpha";
  38568. import "babylonjs/Engines/Extensions/engine.readTexture";
  38569. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38570. import { Material } from "babylonjs/Materials/material";
  38571. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38572. /**
  38573. * Defines the interface used by display changed events
  38574. */
  38575. export interface IDisplayChangedEventArgs {
  38576. /** Gets the vrDisplay object (if any) */
  38577. vrDisplay: Nullable<any>;
  38578. /** Gets a boolean indicating if webVR is supported */
  38579. vrSupported: boolean;
  38580. }
  38581. /**
  38582. * Defines the interface used by objects containing a viewport (like a camera)
  38583. */
  38584. interface IViewportOwnerLike {
  38585. /**
  38586. * Gets or sets the viewport
  38587. */
  38588. viewport: IViewportLike;
  38589. }
  38590. /**
  38591. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38592. */
  38593. export class Engine extends ThinEngine {
  38594. /** Defines that alpha blending is disabled */
  38595. static readonly ALPHA_DISABLE: number;
  38596. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38597. static readonly ALPHA_ADD: number;
  38598. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38599. static readonly ALPHA_COMBINE: number;
  38600. /** Defines that alpha blending to DEST - SRC * DEST */
  38601. static readonly ALPHA_SUBTRACT: number;
  38602. /** Defines that alpha blending to SRC * DEST */
  38603. static readonly ALPHA_MULTIPLY: number;
  38604. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38605. static readonly ALPHA_MAXIMIZED: number;
  38606. /** Defines that alpha blending to SRC + DEST */
  38607. static readonly ALPHA_ONEONE: number;
  38608. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38609. static readonly ALPHA_PREMULTIPLIED: number;
  38610. /**
  38611. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38612. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38613. */
  38614. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38615. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38616. static readonly ALPHA_INTERPOLATE: number;
  38617. /**
  38618. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38619. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38620. */
  38621. static readonly ALPHA_SCREENMODE: number;
  38622. /** Defines that the ressource is not delayed*/
  38623. static readonly DELAYLOADSTATE_NONE: number;
  38624. /** Defines that the ressource was successfully delay loaded */
  38625. static readonly DELAYLOADSTATE_LOADED: number;
  38626. /** Defines that the ressource is currently delay loading */
  38627. static readonly DELAYLOADSTATE_LOADING: number;
  38628. /** Defines that the ressource is delayed and has not started loading */
  38629. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38630. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38631. static readonly NEVER: number;
  38632. /** 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 */
  38633. static readonly ALWAYS: number;
  38634. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38635. static readonly LESS: number;
  38636. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38637. static readonly EQUAL: number;
  38638. /** 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 */
  38639. static readonly LEQUAL: number;
  38640. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38641. static readonly GREATER: number;
  38642. /** 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 */
  38643. static readonly GEQUAL: number;
  38644. /** 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 */
  38645. static readonly NOTEQUAL: number;
  38646. /** Passed to stencilOperation to specify that stencil value must be kept */
  38647. static readonly KEEP: number;
  38648. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38649. static readonly REPLACE: number;
  38650. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38651. static readonly INCR: number;
  38652. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38653. static readonly DECR: number;
  38654. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38655. static readonly INVERT: number;
  38656. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38657. static readonly INCR_WRAP: number;
  38658. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38659. static readonly DECR_WRAP: number;
  38660. /** Texture is not repeating outside of 0..1 UVs */
  38661. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38662. /** Texture is repeating outside of 0..1 UVs */
  38663. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38664. /** Texture is repeating and mirrored */
  38665. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38666. /** ALPHA */
  38667. static readonly TEXTUREFORMAT_ALPHA: number;
  38668. /** LUMINANCE */
  38669. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38670. /** LUMINANCE_ALPHA */
  38671. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38672. /** RGB */
  38673. static readonly TEXTUREFORMAT_RGB: number;
  38674. /** RGBA */
  38675. static readonly TEXTUREFORMAT_RGBA: number;
  38676. /** RED */
  38677. static readonly TEXTUREFORMAT_RED: number;
  38678. /** RED (2nd reference) */
  38679. static readonly TEXTUREFORMAT_R: number;
  38680. /** RG */
  38681. static readonly TEXTUREFORMAT_RG: number;
  38682. /** RED_INTEGER */
  38683. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38684. /** RED_INTEGER (2nd reference) */
  38685. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38686. /** RG_INTEGER */
  38687. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38688. /** RGB_INTEGER */
  38689. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38690. /** RGBA_INTEGER */
  38691. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38692. /** UNSIGNED_BYTE */
  38693. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38694. /** UNSIGNED_BYTE (2nd reference) */
  38695. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38696. /** FLOAT */
  38697. static readonly TEXTURETYPE_FLOAT: number;
  38698. /** HALF_FLOAT */
  38699. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38700. /** BYTE */
  38701. static readonly TEXTURETYPE_BYTE: number;
  38702. /** SHORT */
  38703. static readonly TEXTURETYPE_SHORT: number;
  38704. /** UNSIGNED_SHORT */
  38705. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38706. /** INT */
  38707. static readonly TEXTURETYPE_INT: number;
  38708. /** UNSIGNED_INT */
  38709. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38710. /** UNSIGNED_SHORT_4_4_4_4 */
  38711. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38712. /** UNSIGNED_SHORT_5_5_5_1 */
  38713. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38714. /** UNSIGNED_SHORT_5_6_5 */
  38715. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38716. /** UNSIGNED_INT_2_10_10_10_REV */
  38717. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38718. /** UNSIGNED_INT_24_8 */
  38719. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38720. /** UNSIGNED_INT_10F_11F_11F_REV */
  38721. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38722. /** UNSIGNED_INT_5_9_9_9_REV */
  38723. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38724. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38725. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38726. /** nearest is mag = nearest and min = nearest and mip = linear */
  38727. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38728. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38729. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38730. /** Trilinear is mag = linear and min = linear and mip = linear */
  38731. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38732. /** nearest is mag = nearest and min = nearest and mip = linear */
  38733. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38734. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38735. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38736. /** Trilinear is mag = linear and min = linear and mip = linear */
  38737. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38738. /** mag = nearest and min = nearest and mip = nearest */
  38739. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38740. /** mag = nearest and min = linear and mip = nearest */
  38741. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38742. /** mag = nearest and min = linear and mip = linear */
  38743. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38744. /** mag = nearest and min = linear and mip = none */
  38745. static readonly TEXTURE_NEAREST_LINEAR: number;
  38746. /** mag = nearest and min = nearest and mip = none */
  38747. static readonly TEXTURE_NEAREST_NEAREST: number;
  38748. /** mag = linear and min = nearest and mip = nearest */
  38749. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38750. /** mag = linear and min = nearest and mip = linear */
  38751. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38752. /** mag = linear and min = linear and mip = none */
  38753. static readonly TEXTURE_LINEAR_LINEAR: number;
  38754. /** mag = linear and min = nearest and mip = none */
  38755. static readonly TEXTURE_LINEAR_NEAREST: number;
  38756. /** Explicit coordinates mode */
  38757. static readonly TEXTURE_EXPLICIT_MODE: number;
  38758. /** Spherical coordinates mode */
  38759. static readonly TEXTURE_SPHERICAL_MODE: number;
  38760. /** Planar coordinates mode */
  38761. static readonly TEXTURE_PLANAR_MODE: number;
  38762. /** Cubic coordinates mode */
  38763. static readonly TEXTURE_CUBIC_MODE: number;
  38764. /** Projection coordinates mode */
  38765. static readonly TEXTURE_PROJECTION_MODE: number;
  38766. /** Skybox coordinates mode */
  38767. static readonly TEXTURE_SKYBOX_MODE: number;
  38768. /** Inverse Cubic coordinates mode */
  38769. static readonly TEXTURE_INVCUBIC_MODE: number;
  38770. /** Equirectangular coordinates mode */
  38771. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38772. /** Equirectangular Fixed coordinates mode */
  38773. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38774. /** Equirectangular Fixed Mirrored coordinates mode */
  38775. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38776. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38777. static readonly SCALEMODE_FLOOR: number;
  38778. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38779. static readonly SCALEMODE_NEAREST: number;
  38780. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38781. static readonly SCALEMODE_CEILING: number;
  38782. /**
  38783. * Returns the current npm package of the sdk
  38784. */
  38785. static get NpmPackage(): string;
  38786. /**
  38787. * Returns the current version of the framework
  38788. */
  38789. static get Version(): string;
  38790. /** Gets the list of created engines */
  38791. static get Instances(): Engine[];
  38792. /**
  38793. * Gets the latest created engine
  38794. */
  38795. static get LastCreatedEngine(): Nullable<Engine>;
  38796. /**
  38797. * Gets the latest created scene
  38798. */
  38799. static get LastCreatedScene(): Nullable<Scene>;
  38800. /**
  38801. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38802. * @param flag defines which part of the materials must be marked as dirty
  38803. * @param predicate defines a predicate used to filter which materials should be affected
  38804. */
  38805. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38806. /**
  38807. * Method called to create the default loading screen.
  38808. * This can be overriden in your own app.
  38809. * @param canvas The rendering canvas element
  38810. * @returns The loading screen
  38811. */
  38812. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38813. /**
  38814. * Method called to create the default rescale post process on each engine.
  38815. */
  38816. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38817. /**
  38818. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38819. **/
  38820. enableOfflineSupport: boolean;
  38821. /**
  38822. * 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)
  38823. **/
  38824. disableManifestCheck: boolean;
  38825. /**
  38826. * Gets the list of created scenes
  38827. */
  38828. scenes: Scene[];
  38829. /**
  38830. * Event raised when a new scene is created
  38831. */
  38832. onNewSceneAddedObservable: Observable<Scene>;
  38833. /**
  38834. * Gets the list of created postprocesses
  38835. */
  38836. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38837. /**
  38838. * Gets a boolean indicating if the pointer is currently locked
  38839. */
  38840. isPointerLock: boolean;
  38841. /**
  38842. * Observable event triggered each time the rendering canvas is resized
  38843. */
  38844. onResizeObservable: Observable<Engine>;
  38845. /**
  38846. * Observable event triggered each time the canvas loses focus
  38847. */
  38848. onCanvasBlurObservable: Observable<Engine>;
  38849. /**
  38850. * Observable event triggered each time the canvas gains focus
  38851. */
  38852. onCanvasFocusObservable: Observable<Engine>;
  38853. /**
  38854. * Observable event triggered each time the canvas receives pointerout event
  38855. */
  38856. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38857. /**
  38858. * Observable raised when the engine begins a new frame
  38859. */
  38860. onBeginFrameObservable: Observable<Engine>;
  38861. /**
  38862. * If set, will be used to request the next animation frame for the render loop
  38863. */
  38864. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38865. /**
  38866. * Observable raised when the engine ends the current frame
  38867. */
  38868. onEndFrameObservable: Observable<Engine>;
  38869. /**
  38870. * Observable raised when the engine is about to compile a shader
  38871. */
  38872. onBeforeShaderCompilationObservable: Observable<Engine>;
  38873. /**
  38874. * Observable raised when the engine has jsut compiled a shader
  38875. */
  38876. onAfterShaderCompilationObservable: Observable<Engine>;
  38877. /**
  38878. * Gets the audio engine
  38879. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38880. * @ignorenaming
  38881. */
  38882. static audioEngine: IAudioEngine;
  38883. /**
  38884. * Default AudioEngine factory responsible of creating the Audio Engine.
  38885. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38886. */
  38887. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38888. /**
  38889. * Default offline support factory responsible of creating a tool used to store data locally.
  38890. * By default, this will create a Database object if the workload has been embedded.
  38891. */
  38892. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38893. private _loadingScreen;
  38894. private _pointerLockRequested;
  38895. private _rescalePostProcess;
  38896. private _deterministicLockstep;
  38897. private _lockstepMaxSteps;
  38898. private _timeStep;
  38899. protected get _supportsHardwareTextureRescaling(): boolean;
  38900. private _fps;
  38901. private _deltaTime;
  38902. /** @hidden */
  38903. _drawCalls: PerfCounter;
  38904. /** 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 */
  38905. canvasTabIndex: number;
  38906. /**
  38907. * Turn this value on if you want to pause FPS computation when in background
  38908. */
  38909. disablePerformanceMonitorInBackground: boolean;
  38910. private _performanceMonitor;
  38911. /**
  38912. * Gets the performance monitor attached to this engine
  38913. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38914. */
  38915. get performanceMonitor(): PerformanceMonitor;
  38916. private _onFocus;
  38917. private _onBlur;
  38918. private _onCanvasPointerOut;
  38919. private _onCanvasBlur;
  38920. private _onCanvasFocus;
  38921. private _onFullscreenChange;
  38922. private _onPointerLockChange;
  38923. /**
  38924. * Gets the HTML element used to attach event listeners
  38925. * @returns a HTML element
  38926. */
  38927. getInputElement(): Nullable<HTMLElement>;
  38928. /**
  38929. * Creates a new engine
  38930. * @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
  38931. * @param antialias defines enable antialiasing (default: false)
  38932. * @param options defines further options to be sent to the getContext() function
  38933. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38934. */
  38935. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38936. /**
  38937. * Gets current aspect ratio
  38938. * @param viewportOwner defines the camera to use to get the aspect ratio
  38939. * @param useScreen defines if screen size must be used (or the current render target if any)
  38940. * @returns a number defining the aspect ratio
  38941. */
  38942. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38943. /**
  38944. * Gets current screen aspect ratio
  38945. * @returns a number defining the aspect ratio
  38946. */
  38947. getScreenAspectRatio(): number;
  38948. /**
  38949. * Gets the client rect of the HTML canvas attached with the current webGL context
  38950. * @returns a client rectanglee
  38951. */
  38952. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38953. /**
  38954. * Gets the client rect of the HTML element used for events
  38955. * @returns a client rectanglee
  38956. */
  38957. getInputElementClientRect(): Nullable<ClientRect>;
  38958. /**
  38959. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38960. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38961. * @returns true if engine is in deterministic lock step mode
  38962. */
  38963. isDeterministicLockStep(): boolean;
  38964. /**
  38965. * Gets the max steps when engine is running in deterministic lock step
  38966. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38967. * @returns the max steps
  38968. */
  38969. getLockstepMaxSteps(): number;
  38970. /**
  38971. * Returns the time in ms between steps when using deterministic lock step.
  38972. * @returns time step in (ms)
  38973. */
  38974. getTimeStep(): number;
  38975. /**
  38976. * Force the mipmap generation for the given render target texture
  38977. * @param texture defines the render target texture to use
  38978. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38979. */
  38980. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38981. /** States */
  38982. /**
  38983. * Set various states to the webGL context
  38984. * @param culling defines backface culling state
  38985. * @param zOffset defines the value to apply to zOffset (0 by default)
  38986. * @param force defines if states must be applied even if cache is up to date
  38987. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  38988. */
  38989. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  38990. /**
  38991. * Set the z offset to apply to current rendering
  38992. * @param value defines the offset to apply
  38993. */
  38994. setZOffset(value: number): void;
  38995. /**
  38996. * Gets the current value of the zOffset
  38997. * @returns the current zOffset state
  38998. */
  38999. getZOffset(): number;
  39000. /**
  39001. * Enable or disable depth buffering
  39002. * @param enable defines the state to set
  39003. */
  39004. setDepthBuffer(enable: boolean): void;
  39005. /**
  39006. * Gets a boolean indicating if depth writing is enabled
  39007. * @returns the current depth writing state
  39008. */
  39009. getDepthWrite(): boolean;
  39010. /**
  39011. * Enable or disable depth writing
  39012. * @param enable defines the state to set
  39013. */
  39014. setDepthWrite(enable: boolean): void;
  39015. /**
  39016. * Gets a boolean indicating if stencil buffer is enabled
  39017. * @returns the current stencil buffer state
  39018. */
  39019. getStencilBuffer(): boolean;
  39020. /**
  39021. * Enable or disable the stencil buffer
  39022. * @param enable defines if the stencil buffer must be enabled or disabled
  39023. */
  39024. setStencilBuffer(enable: boolean): void;
  39025. /**
  39026. * Gets the current stencil mask
  39027. * @returns a number defining the new stencil mask to use
  39028. */
  39029. getStencilMask(): number;
  39030. /**
  39031. * Sets the current stencil mask
  39032. * @param mask defines the new stencil mask to use
  39033. */
  39034. setStencilMask(mask: number): void;
  39035. /**
  39036. * Gets the current stencil function
  39037. * @returns a number defining the stencil function to use
  39038. */
  39039. getStencilFunction(): number;
  39040. /**
  39041. * Gets the current stencil reference value
  39042. * @returns a number defining the stencil reference value to use
  39043. */
  39044. getStencilFunctionReference(): number;
  39045. /**
  39046. * Gets the current stencil mask
  39047. * @returns a number defining the stencil mask to use
  39048. */
  39049. getStencilFunctionMask(): number;
  39050. /**
  39051. * Sets the current stencil function
  39052. * @param stencilFunc defines the new stencil function to use
  39053. */
  39054. setStencilFunction(stencilFunc: number): void;
  39055. /**
  39056. * Sets the current stencil reference
  39057. * @param reference defines the new stencil reference to use
  39058. */
  39059. setStencilFunctionReference(reference: number): void;
  39060. /**
  39061. * Sets the current stencil mask
  39062. * @param mask defines the new stencil mask to use
  39063. */
  39064. setStencilFunctionMask(mask: number): void;
  39065. /**
  39066. * Gets the current stencil operation when stencil fails
  39067. * @returns a number defining stencil operation to use when stencil fails
  39068. */
  39069. getStencilOperationFail(): number;
  39070. /**
  39071. * Gets the current stencil operation when depth fails
  39072. * @returns a number defining stencil operation to use when depth fails
  39073. */
  39074. getStencilOperationDepthFail(): number;
  39075. /**
  39076. * Gets the current stencil operation when stencil passes
  39077. * @returns a number defining stencil operation to use when stencil passes
  39078. */
  39079. getStencilOperationPass(): number;
  39080. /**
  39081. * Sets the stencil operation to use when stencil fails
  39082. * @param operation defines the stencil operation to use when stencil fails
  39083. */
  39084. setStencilOperationFail(operation: number): void;
  39085. /**
  39086. * Sets the stencil operation to use when depth fails
  39087. * @param operation defines the stencil operation to use when depth fails
  39088. */
  39089. setStencilOperationDepthFail(operation: number): void;
  39090. /**
  39091. * Sets the stencil operation to use when stencil passes
  39092. * @param operation defines the stencil operation to use when stencil passes
  39093. */
  39094. setStencilOperationPass(operation: number): void;
  39095. /**
  39096. * Sets a boolean indicating if the dithering state is enabled or disabled
  39097. * @param value defines the dithering state
  39098. */
  39099. setDitheringState(value: boolean): void;
  39100. /**
  39101. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39102. * @param value defines the rasterizer state
  39103. */
  39104. setRasterizerState(value: boolean): void;
  39105. /**
  39106. * Gets the current depth function
  39107. * @returns a number defining the depth function
  39108. */
  39109. getDepthFunction(): Nullable<number>;
  39110. /**
  39111. * Sets the current depth function
  39112. * @param depthFunc defines the function to use
  39113. */
  39114. setDepthFunction(depthFunc: number): void;
  39115. /**
  39116. * Sets the current depth function to GREATER
  39117. */
  39118. setDepthFunctionToGreater(): void;
  39119. /**
  39120. * Sets the current depth function to GEQUAL
  39121. */
  39122. setDepthFunctionToGreaterOrEqual(): void;
  39123. /**
  39124. * Sets the current depth function to LESS
  39125. */
  39126. setDepthFunctionToLess(): void;
  39127. /**
  39128. * Sets the current depth function to LEQUAL
  39129. */
  39130. setDepthFunctionToLessOrEqual(): void;
  39131. private _cachedStencilBuffer;
  39132. private _cachedStencilFunction;
  39133. private _cachedStencilMask;
  39134. private _cachedStencilOperationPass;
  39135. private _cachedStencilOperationFail;
  39136. private _cachedStencilOperationDepthFail;
  39137. private _cachedStencilReference;
  39138. /**
  39139. * Caches the the state of the stencil buffer
  39140. */
  39141. cacheStencilState(): void;
  39142. /**
  39143. * Restores the state of the stencil buffer
  39144. */
  39145. restoreStencilState(): void;
  39146. /**
  39147. * Directly set the WebGL Viewport
  39148. * @param x defines the x coordinate of the viewport (in screen space)
  39149. * @param y defines the y coordinate of the viewport (in screen space)
  39150. * @param width defines the width of the viewport (in screen space)
  39151. * @param height defines the height of the viewport (in screen space)
  39152. * @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
  39153. */
  39154. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39155. /**
  39156. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39157. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39158. * @param y defines the y-coordinate of the corner of the clear rectangle
  39159. * @param width defines the width of the clear rectangle
  39160. * @param height defines the height of the clear rectangle
  39161. * @param clearColor defines the clear color
  39162. */
  39163. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39164. /**
  39165. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39166. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39167. * @param y defines the y-coordinate of the corner of the clear rectangle
  39168. * @param width defines the width of the clear rectangle
  39169. * @param height defines the height of the clear rectangle
  39170. */
  39171. enableScissor(x: number, y: number, width: number, height: number): void;
  39172. /**
  39173. * Disable previously set scissor test rectangle
  39174. */
  39175. disableScissor(): void;
  39176. protected _reportDrawCall(): void;
  39177. /**
  39178. * Initializes a webVR display and starts listening to display change events
  39179. * The onVRDisplayChangedObservable will be notified upon these changes
  39180. * @returns The onVRDisplayChangedObservable
  39181. */
  39182. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39183. /** @hidden */
  39184. _prepareVRComponent(): void;
  39185. /** @hidden */
  39186. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39187. /** @hidden */
  39188. _submitVRFrame(): void;
  39189. /**
  39190. * Call this function to leave webVR mode
  39191. * Will do nothing if webVR is not supported or if there is no webVR device
  39192. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39193. */
  39194. disableVR(): void;
  39195. /**
  39196. * Gets a boolean indicating that the system is in VR mode and is presenting
  39197. * @returns true if VR mode is engaged
  39198. */
  39199. isVRPresenting(): boolean;
  39200. /** @hidden */
  39201. _requestVRFrame(): void;
  39202. /** @hidden */
  39203. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39204. /**
  39205. * Gets the source code of the vertex shader associated with a specific webGL program
  39206. * @param program defines the program to use
  39207. * @returns a string containing the source code of the vertex shader associated with the program
  39208. */
  39209. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39210. /**
  39211. * Gets the source code of the fragment shader associated with a specific webGL program
  39212. * @param program defines the program to use
  39213. * @returns a string containing the source code of the fragment shader associated with the program
  39214. */
  39215. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39216. /**
  39217. * Sets a depth stencil texture from a render target to the according uniform.
  39218. * @param channel The texture channel
  39219. * @param uniform The uniform to set
  39220. * @param texture The render target texture containing the depth stencil texture to apply
  39221. */
  39222. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39223. /**
  39224. * Sets a texture to the webGL context from a postprocess
  39225. * @param channel defines the channel to use
  39226. * @param postProcess defines the source postprocess
  39227. */
  39228. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39229. /**
  39230. * Binds the output of the passed in post process to the texture channel specified
  39231. * @param channel The channel the texture should be bound to
  39232. * @param postProcess The post process which's output should be bound
  39233. */
  39234. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39235. protected _rebuildBuffers(): void;
  39236. /** @hidden */
  39237. _renderFrame(): void;
  39238. _renderLoop(): void;
  39239. /** @hidden */
  39240. _renderViews(): boolean;
  39241. /**
  39242. * Toggle full screen mode
  39243. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39244. */
  39245. switchFullscreen(requestPointerLock: boolean): void;
  39246. /**
  39247. * Enters full screen mode
  39248. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39249. */
  39250. enterFullscreen(requestPointerLock: boolean): void;
  39251. /**
  39252. * Exits full screen mode
  39253. */
  39254. exitFullscreen(): void;
  39255. /**
  39256. * Enters Pointerlock mode
  39257. */
  39258. enterPointerlock(): void;
  39259. /**
  39260. * Exits Pointerlock mode
  39261. */
  39262. exitPointerlock(): void;
  39263. /**
  39264. * Begin a new frame
  39265. */
  39266. beginFrame(): void;
  39267. /**
  39268. * Enf the current frame
  39269. */
  39270. endFrame(): void;
  39271. resize(): void;
  39272. /**
  39273. * Force a specific size of the canvas
  39274. * @param width defines the new canvas' width
  39275. * @param height defines the new canvas' height
  39276. * @returns true if the size was changed
  39277. */
  39278. setSize(width: number, height: number): boolean;
  39279. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39280. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39281. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39282. _releaseTexture(texture: InternalTexture): void;
  39283. /**
  39284. * @hidden
  39285. * Rescales a texture
  39286. * @param source input texutre
  39287. * @param destination destination texture
  39288. * @param scene scene to use to render the resize
  39289. * @param internalFormat format to use when resizing
  39290. * @param onComplete callback to be called when resize has completed
  39291. */
  39292. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39293. /**
  39294. * Gets the current framerate
  39295. * @returns a number representing the framerate
  39296. */
  39297. getFps(): number;
  39298. /**
  39299. * Gets the time spent between current and previous frame
  39300. * @returns a number representing the delta time in ms
  39301. */
  39302. getDeltaTime(): number;
  39303. private _measureFps;
  39304. /** @hidden */
  39305. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39306. /**
  39307. * Updates the sample count of a render target texture
  39308. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39309. * @param texture defines the texture to update
  39310. * @param samples defines the sample count to set
  39311. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39312. */
  39313. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39314. /**
  39315. * Updates a depth texture Comparison Mode and Function.
  39316. * If the comparison Function is equal to 0, the mode will be set to none.
  39317. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39318. * @param texture The texture to set the comparison function for
  39319. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39320. */
  39321. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39322. /**
  39323. * Creates a webGL buffer to use with instanciation
  39324. * @param capacity defines the size of the buffer
  39325. * @returns the webGL buffer
  39326. */
  39327. createInstancesBuffer(capacity: number): DataBuffer;
  39328. /**
  39329. * Delete a webGL buffer used with instanciation
  39330. * @param buffer defines the webGL buffer to delete
  39331. */
  39332. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39333. private _clientWaitAsync;
  39334. /** @hidden */
  39335. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39336. dispose(): void;
  39337. private _disableTouchAction;
  39338. /**
  39339. * Display the loading screen
  39340. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39341. */
  39342. displayLoadingUI(): void;
  39343. /**
  39344. * Hide the loading screen
  39345. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39346. */
  39347. hideLoadingUI(): void;
  39348. /**
  39349. * Gets the current loading screen object
  39350. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39351. */
  39352. get loadingScreen(): ILoadingScreen;
  39353. /**
  39354. * Sets the current loading screen object
  39355. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39356. */
  39357. set loadingScreen(loadingScreen: ILoadingScreen);
  39358. /**
  39359. * Sets the current loading screen text
  39360. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39361. */
  39362. set loadingUIText(text: string);
  39363. /**
  39364. * Sets the current loading screen background color
  39365. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39366. */
  39367. set loadingUIBackgroundColor(color: string);
  39368. /** Pointerlock and fullscreen */
  39369. /**
  39370. * Ask the browser to promote the current element to pointerlock mode
  39371. * @param element defines the DOM element to promote
  39372. */
  39373. static _RequestPointerlock(element: HTMLElement): void;
  39374. /**
  39375. * Asks the browser to exit pointerlock mode
  39376. */
  39377. static _ExitPointerlock(): void;
  39378. /**
  39379. * Ask the browser to promote the current element to fullscreen rendering mode
  39380. * @param element defines the DOM element to promote
  39381. */
  39382. static _RequestFullscreen(element: HTMLElement): void;
  39383. /**
  39384. * Asks the browser to exit fullscreen mode
  39385. */
  39386. static _ExitFullscreen(): void;
  39387. }
  39388. }
  39389. declare module "babylonjs/Engines/engineStore" {
  39390. import { Nullable } from "babylonjs/types";
  39391. import { Engine } from "babylonjs/Engines/engine";
  39392. import { Scene } from "babylonjs/scene";
  39393. /**
  39394. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39395. * during the life time of the application.
  39396. */
  39397. export class EngineStore {
  39398. /** Gets the list of created engines */
  39399. static Instances: import("babylonjs/Engines/engine").Engine[];
  39400. /** @hidden */
  39401. static _LastCreatedScene: Nullable<Scene>;
  39402. /**
  39403. * Gets the latest created engine
  39404. */
  39405. static get LastCreatedEngine(): Nullable<Engine>;
  39406. /**
  39407. * Gets the latest created scene
  39408. */
  39409. static get LastCreatedScene(): Nullable<Scene>;
  39410. /**
  39411. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39412. * @ignorenaming
  39413. */
  39414. static UseFallbackTexture: boolean;
  39415. /**
  39416. * Texture content used if a texture cannot loaded
  39417. * @ignorenaming
  39418. */
  39419. static FallbackTexture: string;
  39420. }
  39421. }
  39422. declare module "babylonjs/Misc/promise" {
  39423. /**
  39424. * Helper class that provides a small promise polyfill
  39425. */
  39426. export class PromisePolyfill {
  39427. /**
  39428. * Static function used to check if the polyfill is required
  39429. * If this is the case then the function will inject the polyfill to window.Promise
  39430. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39431. */
  39432. static Apply(force?: boolean): void;
  39433. }
  39434. }
  39435. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39436. /**
  39437. * Interface for screenshot methods with describe argument called `size` as object with options
  39438. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39439. */
  39440. export interface IScreenshotSize {
  39441. /**
  39442. * number in pixels for canvas height
  39443. */
  39444. height?: number;
  39445. /**
  39446. * multiplier allowing render at a higher or lower resolution
  39447. * If value is defined then height and width will be ignored and taken from camera
  39448. */
  39449. precision?: number;
  39450. /**
  39451. * number in pixels for canvas width
  39452. */
  39453. width?: number;
  39454. }
  39455. }
  39456. declare module "babylonjs/Misc/tools" {
  39457. import { Nullable, float } from "babylonjs/types";
  39458. import { DomManagement } from "babylonjs/Misc/domManagement";
  39459. import { WebRequest } from "babylonjs/Misc/webRequest";
  39460. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39461. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39462. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39463. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39464. import { Camera } from "babylonjs/Cameras/camera";
  39465. import { Engine } from "babylonjs/Engines/engine";
  39466. interface IColor4Like {
  39467. r: float;
  39468. g: float;
  39469. b: float;
  39470. a: float;
  39471. }
  39472. /**
  39473. * Class containing a set of static utilities functions
  39474. */
  39475. export class Tools {
  39476. /**
  39477. * Gets or sets the base URL to use to load assets
  39478. */
  39479. static get BaseUrl(): string;
  39480. static set BaseUrl(value: string);
  39481. /**
  39482. * Enable/Disable Custom HTTP Request Headers globally.
  39483. * default = false
  39484. * @see CustomRequestHeaders
  39485. */
  39486. static UseCustomRequestHeaders: boolean;
  39487. /**
  39488. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39489. * i.e. when loading files, where the server/service expects an Authorization header
  39490. */
  39491. static CustomRequestHeaders: {
  39492. [key: string]: string;
  39493. };
  39494. /**
  39495. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39496. */
  39497. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39498. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39499. /**
  39500. * Default behaviour for cors in the application.
  39501. * It can be a string if the expected behavior is identical in the entire app.
  39502. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39503. */
  39504. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39505. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39506. /**
  39507. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39508. * @ignorenaming
  39509. */
  39510. static get UseFallbackTexture(): boolean;
  39511. static set UseFallbackTexture(value: boolean);
  39512. /**
  39513. * Use this object to register external classes like custom textures or material
  39514. * to allow the laoders to instantiate them
  39515. */
  39516. static get RegisteredExternalClasses(): {
  39517. [key: string]: Object;
  39518. };
  39519. static set RegisteredExternalClasses(classes: {
  39520. [key: string]: Object;
  39521. });
  39522. /**
  39523. * Texture content used if a texture cannot loaded
  39524. * @ignorenaming
  39525. */
  39526. static get fallbackTexture(): string;
  39527. static set fallbackTexture(value: string);
  39528. /**
  39529. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39530. * @param u defines the coordinate on X axis
  39531. * @param v defines the coordinate on Y axis
  39532. * @param width defines the width of the source data
  39533. * @param height defines the height of the source data
  39534. * @param pixels defines the source byte array
  39535. * @param color defines the output color
  39536. */
  39537. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39538. /**
  39539. * Interpolates between a and b via alpha
  39540. * @param a The lower value (returned when alpha = 0)
  39541. * @param b The upper value (returned when alpha = 1)
  39542. * @param alpha The interpolation-factor
  39543. * @return The mixed value
  39544. */
  39545. static Mix(a: number, b: number, alpha: number): number;
  39546. /**
  39547. * Tries to instantiate a new object from a given class name
  39548. * @param className defines the class name to instantiate
  39549. * @returns the new object or null if the system was not able to do the instantiation
  39550. */
  39551. static Instantiate(className: string): any;
  39552. /**
  39553. * Provides a slice function that will work even on IE
  39554. * @param data defines the array to slice
  39555. * @param start defines the start of the data (optional)
  39556. * @param end defines the end of the data (optional)
  39557. * @returns the new sliced array
  39558. */
  39559. static Slice<T>(data: T, start?: number, end?: number): T;
  39560. /**
  39561. * Polyfill for setImmediate
  39562. * @param action defines the action to execute after the current execution block
  39563. */
  39564. static SetImmediate(action: () => void): void;
  39565. /**
  39566. * Function indicating if a number is an exponent of 2
  39567. * @param value defines the value to test
  39568. * @returns true if the value is an exponent of 2
  39569. */
  39570. static IsExponentOfTwo(value: number): boolean;
  39571. private static _tmpFloatArray;
  39572. /**
  39573. * Returns the nearest 32-bit single precision float representation of a Number
  39574. * @param value A Number. If the parameter is of a different type, it will get converted
  39575. * to a number or to NaN if it cannot be converted
  39576. * @returns number
  39577. */
  39578. static FloatRound(value: number): number;
  39579. /**
  39580. * Extracts the filename from a path
  39581. * @param path defines the path to use
  39582. * @returns the filename
  39583. */
  39584. static GetFilename(path: string): string;
  39585. /**
  39586. * Extracts the "folder" part of a path (everything before the filename).
  39587. * @param uri The URI to extract the info from
  39588. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39589. * @returns The "folder" part of the path
  39590. */
  39591. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39592. /**
  39593. * Extracts text content from a DOM element hierarchy
  39594. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39595. */
  39596. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39597. /**
  39598. * Convert an angle in radians to degrees
  39599. * @param angle defines the angle to convert
  39600. * @returns the angle in degrees
  39601. */
  39602. static ToDegrees(angle: number): number;
  39603. /**
  39604. * Convert an angle in degrees to radians
  39605. * @param angle defines the angle to convert
  39606. * @returns the angle in radians
  39607. */
  39608. static ToRadians(angle: number): number;
  39609. /**
  39610. * Returns an array if obj is not an array
  39611. * @param obj defines the object to evaluate as an array
  39612. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39613. * @returns either obj directly if obj is an array or a new array containing obj
  39614. */
  39615. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39616. /**
  39617. * Gets the pointer prefix to use
  39618. * @param engine defines the engine we are finding the prefix for
  39619. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39620. */
  39621. static GetPointerPrefix(engine: Engine): string;
  39622. /**
  39623. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39624. * @param url define the url we are trying
  39625. * @param element define the dom element where to configure the cors policy
  39626. */
  39627. static SetCorsBehavior(url: string | string[], element: {
  39628. crossOrigin: string | null;
  39629. }): void;
  39630. /**
  39631. * Removes unwanted characters from an url
  39632. * @param url defines the url to clean
  39633. * @returns the cleaned url
  39634. */
  39635. static CleanUrl(url: string): string;
  39636. /**
  39637. * Gets or sets a function used to pre-process url before using them to load assets
  39638. */
  39639. static get PreprocessUrl(): (url: string) => string;
  39640. static set PreprocessUrl(processor: (url: string) => string);
  39641. /**
  39642. * Loads an image as an HTMLImageElement.
  39643. * @param input url string, ArrayBuffer, or Blob to load
  39644. * @param onLoad callback called when the image successfully loads
  39645. * @param onError callback called when the image fails to load
  39646. * @param offlineProvider offline provider for caching
  39647. * @param mimeType optional mime type
  39648. * @returns the HTMLImageElement of the loaded image
  39649. */
  39650. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39651. /**
  39652. * Loads a file from a url
  39653. * @param url url string, ArrayBuffer, or Blob to load
  39654. * @param onSuccess callback called when the file successfully loads
  39655. * @param onProgress callback called while file is loading (if the server supports this mode)
  39656. * @param offlineProvider defines the offline provider for caching
  39657. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39658. * @param onError callback called when the file fails to load
  39659. * @returns a file request object
  39660. */
  39661. 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;
  39662. /**
  39663. * Loads a file from a url
  39664. * @param url the file url to load
  39665. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39666. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39667. */
  39668. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39669. /**
  39670. * Load a script (identified by an url). When the url returns, the
  39671. * content of this file is added into a new script element, attached to the DOM (body element)
  39672. * @param scriptUrl defines the url of the script to laod
  39673. * @param onSuccess defines the callback called when the script is loaded
  39674. * @param onError defines the callback to call if an error occurs
  39675. * @param scriptId defines the id of the script element
  39676. */
  39677. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39678. /**
  39679. * Load an asynchronous script (identified by an url). When the url returns, the
  39680. * content of this file is added into a new script element, attached to the DOM (body element)
  39681. * @param scriptUrl defines the url of the script to laod
  39682. * @param scriptId defines the id of the script element
  39683. * @returns a promise request object
  39684. */
  39685. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39686. /**
  39687. * Loads a file from a blob
  39688. * @param fileToLoad defines the blob to use
  39689. * @param callback defines the callback to call when data is loaded
  39690. * @param progressCallback defines the callback to call during loading process
  39691. * @returns a file request object
  39692. */
  39693. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39694. /**
  39695. * Reads a file from a File object
  39696. * @param file defines the file to load
  39697. * @param onSuccess defines the callback to call when data is loaded
  39698. * @param onProgress defines the callback to call during loading process
  39699. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39700. * @param onError defines the callback to call when an error occurs
  39701. * @returns a file request object
  39702. */
  39703. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39704. /**
  39705. * Creates a data url from a given string content
  39706. * @param content defines the content to convert
  39707. * @returns the new data url link
  39708. */
  39709. static FileAsURL(content: string): string;
  39710. /**
  39711. * Format the given number to a specific decimal format
  39712. * @param value defines the number to format
  39713. * @param decimals defines the number of decimals to use
  39714. * @returns the formatted string
  39715. */
  39716. static Format(value: number, decimals?: number): string;
  39717. /**
  39718. * Tries to copy an object by duplicating every property
  39719. * @param source defines the source object
  39720. * @param destination defines the target object
  39721. * @param doNotCopyList defines a list of properties to avoid
  39722. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39723. */
  39724. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39725. /**
  39726. * Gets a boolean indicating if the given object has no own property
  39727. * @param obj defines the object to test
  39728. * @returns true if object has no own property
  39729. */
  39730. static IsEmpty(obj: any): boolean;
  39731. /**
  39732. * Function used to register events at window level
  39733. * @param windowElement defines the Window object to use
  39734. * @param events defines the events to register
  39735. */
  39736. static RegisterTopRootEvents(windowElement: Window, events: {
  39737. name: string;
  39738. handler: Nullable<(e: FocusEvent) => any>;
  39739. }[]): void;
  39740. /**
  39741. * Function used to unregister events from window level
  39742. * @param windowElement defines the Window object to use
  39743. * @param events defines the events to unregister
  39744. */
  39745. static UnregisterTopRootEvents(windowElement: Window, events: {
  39746. name: string;
  39747. handler: Nullable<(e: FocusEvent) => any>;
  39748. }[]): void;
  39749. /**
  39750. * @ignore
  39751. */
  39752. static _ScreenshotCanvas: HTMLCanvasElement;
  39753. /**
  39754. * Dumps the current bound framebuffer
  39755. * @param width defines the rendering width
  39756. * @param height defines the rendering height
  39757. * @param engine defines the hosting engine
  39758. * @param successCallback defines the callback triggered once the data are available
  39759. * @param mimeType defines the mime type of the result
  39760. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39761. */
  39762. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39763. /**
  39764. * Converts the canvas data to blob.
  39765. * This acts as a polyfill for browsers not supporting the to blob function.
  39766. * @param canvas Defines the canvas to extract the data from
  39767. * @param successCallback Defines the callback triggered once the data are available
  39768. * @param mimeType Defines the mime type of the result
  39769. */
  39770. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39771. /**
  39772. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39773. * @param successCallback defines the callback triggered once the data are available
  39774. * @param mimeType defines the mime type of the result
  39775. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39776. */
  39777. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39778. /**
  39779. * Downloads a blob in the browser
  39780. * @param blob defines the blob to download
  39781. * @param fileName defines the name of the downloaded file
  39782. */
  39783. static Download(blob: Blob, fileName: string): void;
  39784. /**
  39785. * Captures a screenshot of the current rendering
  39786. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39787. * @param engine defines the rendering engine
  39788. * @param camera defines the source camera
  39789. * @param size This parameter can be set to a single number or to an object with the
  39790. * following (optional) properties: precision, width, height. If a single number is passed,
  39791. * it will be used for both width and height. If an object is passed, the screenshot size
  39792. * will be derived from the parameters. The precision property is a multiplier allowing
  39793. * rendering at a higher or lower resolution
  39794. * @param successCallback defines the callback receives a single parameter which contains the
  39795. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39796. * src parameter of an <img> to display it
  39797. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39798. * Check your browser for supported MIME types
  39799. */
  39800. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39801. /**
  39802. * Captures a screenshot of the current rendering
  39803. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39804. * @param engine defines the rendering engine
  39805. * @param camera defines the source camera
  39806. * @param size This parameter can be set to a single number or to an object with the
  39807. * following (optional) properties: precision, width, height. If a single number is passed,
  39808. * it will be used for both width and height. If an object is passed, the screenshot size
  39809. * will be derived from the parameters. The precision property is a multiplier allowing
  39810. * rendering at a higher or lower resolution
  39811. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39812. * Check your browser for supported MIME types
  39813. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39814. * to the src parameter of an <img> to display it
  39815. */
  39816. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39817. /**
  39818. * Generates an image screenshot from the specified camera.
  39819. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39820. * @param engine The engine to use for rendering
  39821. * @param camera The camera to use for rendering
  39822. * @param size This parameter can be set to a single number or to an object with the
  39823. * following (optional) properties: precision, width, height. If a single number is passed,
  39824. * it will be used for both width and height. If an object is passed, the screenshot size
  39825. * will be derived from the parameters. The precision property is a multiplier allowing
  39826. * rendering at a higher or lower resolution
  39827. * @param successCallback The callback receives a single parameter which contains the
  39828. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39829. * src parameter of an <img> to display it
  39830. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39831. * Check your browser for supported MIME types
  39832. * @param samples Texture samples (default: 1)
  39833. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39834. * @param fileName A name for for the downloaded file.
  39835. */
  39836. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39837. /**
  39838. * Generates an image screenshot from the specified camera.
  39839. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39840. * @param engine The engine to use for rendering
  39841. * @param camera The camera to use for rendering
  39842. * @param size This parameter can be set to a single number or to an object with the
  39843. * following (optional) properties: precision, width, height. If a single number is passed,
  39844. * it will be used for both width and height. If an object is passed, the screenshot size
  39845. * will be derived from the parameters. The precision property is a multiplier allowing
  39846. * rendering at a higher or lower resolution
  39847. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39848. * Check your browser for supported MIME types
  39849. * @param samples Texture samples (default: 1)
  39850. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39851. * @param fileName A name for for the downloaded file.
  39852. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39853. * to the src parameter of an <img> to display it
  39854. */
  39855. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39856. /**
  39857. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39858. * Be aware Math.random() could cause collisions, but:
  39859. * "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"
  39860. * @returns a pseudo random id
  39861. */
  39862. static RandomId(): string;
  39863. /**
  39864. * Test if the given uri is a base64 string
  39865. * @param uri The uri to test
  39866. * @return True if the uri is a base64 string or false otherwise
  39867. */
  39868. static IsBase64(uri: string): boolean;
  39869. /**
  39870. * Decode the given base64 uri.
  39871. * @param uri The uri to decode
  39872. * @return The decoded base64 data.
  39873. */
  39874. static DecodeBase64(uri: string): ArrayBuffer;
  39875. /**
  39876. * Gets the absolute url.
  39877. * @param url the input url
  39878. * @return the absolute url
  39879. */
  39880. static GetAbsoluteUrl(url: string): string;
  39881. /**
  39882. * No log
  39883. */
  39884. static readonly NoneLogLevel: number;
  39885. /**
  39886. * Only message logs
  39887. */
  39888. static readonly MessageLogLevel: number;
  39889. /**
  39890. * Only warning logs
  39891. */
  39892. static readonly WarningLogLevel: number;
  39893. /**
  39894. * Only error logs
  39895. */
  39896. static readonly ErrorLogLevel: number;
  39897. /**
  39898. * All logs
  39899. */
  39900. static readonly AllLogLevel: number;
  39901. /**
  39902. * Gets a value indicating the number of loading errors
  39903. * @ignorenaming
  39904. */
  39905. static get errorsCount(): number;
  39906. /**
  39907. * Callback called when a new log is added
  39908. */
  39909. static OnNewCacheEntry: (entry: string) => void;
  39910. /**
  39911. * Log a message to the console
  39912. * @param message defines the message to log
  39913. */
  39914. static Log(message: string): void;
  39915. /**
  39916. * Write a warning message to the console
  39917. * @param message defines the message to log
  39918. */
  39919. static Warn(message: string): void;
  39920. /**
  39921. * Write an error message to the console
  39922. * @param message defines the message to log
  39923. */
  39924. static Error(message: string): void;
  39925. /**
  39926. * Gets current log cache (list of logs)
  39927. */
  39928. static get LogCache(): string;
  39929. /**
  39930. * Clears the log cache
  39931. */
  39932. static ClearLogCache(): void;
  39933. /**
  39934. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39935. */
  39936. static set LogLevels(level: number);
  39937. /**
  39938. * Checks if the window object exists
  39939. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39940. */
  39941. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39942. /**
  39943. * No performance log
  39944. */
  39945. static readonly PerformanceNoneLogLevel: number;
  39946. /**
  39947. * Use user marks to log performance
  39948. */
  39949. static readonly PerformanceUserMarkLogLevel: number;
  39950. /**
  39951. * Log performance to the console
  39952. */
  39953. static readonly PerformanceConsoleLogLevel: number;
  39954. private static _performance;
  39955. /**
  39956. * Sets the current performance log level
  39957. */
  39958. static set PerformanceLogLevel(level: number);
  39959. private static _StartPerformanceCounterDisabled;
  39960. private static _EndPerformanceCounterDisabled;
  39961. private static _StartUserMark;
  39962. private static _EndUserMark;
  39963. private static _StartPerformanceConsole;
  39964. private static _EndPerformanceConsole;
  39965. /**
  39966. * Starts a performance counter
  39967. */
  39968. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39969. /**
  39970. * Ends a specific performance coutner
  39971. */
  39972. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39973. /**
  39974. * Gets either window.performance.now() if supported or Date.now() else
  39975. */
  39976. static get Now(): number;
  39977. /**
  39978. * This method will return the name of the class used to create the instance of the given object.
  39979. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39980. * @param object the object to get the class name from
  39981. * @param isType defines if the object is actually a type
  39982. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39983. */
  39984. static GetClassName(object: any, isType?: boolean): string;
  39985. /**
  39986. * Gets the first element of an array satisfying a given predicate
  39987. * @param array defines the array to browse
  39988. * @param predicate defines the predicate to use
  39989. * @returns null if not found or the element
  39990. */
  39991. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  39992. /**
  39993. * This method will return the name of the full name of the class, including its owning module (if any).
  39994. * 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).
  39995. * @param object the object to get the class name from
  39996. * @param isType defines if the object is actually a type
  39997. * @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.
  39998. * @ignorenaming
  39999. */
  40000. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40001. /**
  40002. * Returns a promise that resolves after the given amount of time.
  40003. * @param delay Number of milliseconds to delay
  40004. * @returns Promise that resolves after the given amount of time
  40005. */
  40006. static DelayAsync(delay: number): Promise<void>;
  40007. /**
  40008. * Utility function to detect if the current user agent is Safari
  40009. * @returns whether or not the current user agent is safari
  40010. */
  40011. static IsSafari(): boolean;
  40012. }
  40013. /**
  40014. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40015. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40016. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40017. * @param name The name of the class, case should be preserved
  40018. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40019. */
  40020. export function className(name: string, module?: string): (target: Object) => void;
  40021. /**
  40022. * An implementation of a loop for asynchronous functions.
  40023. */
  40024. export class AsyncLoop {
  40025. /**
  40026. * Defines the number of iterations for the loop
  40027. */
  40028. iterations: number;
  40029. /**
  40030. * Defines the current index of the loop.
  40031. */
  40032. index: number;
  40033. private _done;
  40034. private _fn;
  40035. private _successCallback;
  40036. /**
  40037. * Constructor.
  40038. * @param iterations the number of iterations.
  40039. * @param func the function to run each iteration
  40040. * @param successCallback the callback that will be called upon succesful execution
  40041. * @param offset starting offset.
  40042. */
  40043. constructor(
  40044. /**
  40045. * Defines the number of iterations for the loop
  40046. */
  40047. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40048. /**
  40049. * Execute the next iteration. Must be called after the last iteration was finished.
  40050. */
  40051. executeNext(): void;
  40052. /**
  40053. * Break the loop and run the success callback.
  40054. */
  40055. breakLoop(): void;
  40056. /**
  40057. * Create and run an async loop.
  40058. * @param iterations the number of iterations.
  40059. * @param fn the function to run each iteration
  40060. * @param successCallback the callback that will be called upon succesful execution
  40061. * @param offset starting offset.
  40062. * @returns the created async loop object
  40063. */
  40064. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40065. /**
  40066. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40067. * @param iterations total number of iterations
  40068. * @param syncedIterations number of synchronous iterations in each async iteration.
  40069. * @param fn the function to call each iteration.
  40070. * @param callback a success call back that will be called when iterating stops.
  40071. * @param breakFunction a break condition (optional)
  40072. * @param timeout timeout settings for the setTimeout function. default - 0.
  40073. * @returns the created async loop object
  40074. */
  40075. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40076. }
  40077. }
  40078. declare module "babylonjs/Misc/stringDictionary" {
  40079. import { Nullable } from "babylonjs/types";
  40080. /**
  40081. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40082. * The underlying implementation relies on an associative array to ensure the best performances.
  40083. * The value can be anything including 'null' but except 'undefined'
  40084. */
  40085. export class StringDictionary<T> {
  40086. /**
  40087. * This will clear this dictionary and copy the content from the 'source' one.
  40088. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40089. * @param source the dictionary to take the content from and copy to this dictionary
  40090. */
  40091. copyFrom(source: StringDictionary<T>): void;
  40092. /**
  40093. * Get a value based from its key
  40094. * @param key the given key to get the matching value from
  40095. * @return the value if found, otherwise undefined is returned
  40096. */
  40097. get(key: string): T | undefined;
  40098. /**
  40099. * Get a value from its key or add it if it doesn't exist.
  40100. * This method will ensure you that a given key/data will be present in the dictionary.
  40101. * @param key the given key to get the matching value from
  40102. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40103. * The factory will only be invoked if there's no data for the given key.
  40104. * @return the value corresponding to the key.
  40105. */
  40106. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40107. /**
  40108. * Get a value from its key if present in the dictionary otherwise add it
  40109. * @param key the key to get the value from
  40110. * @param val if there's no such key/value pair in the dictionary add it with this value
  40111. * @return the value corresponding to the key
  40112. */
  40113. getOrAdd(key: string, val: T): T;
  40114. /**
  40115. * Check if there's a given key in the dictionary
  40116. * @param key the key to check for
  40117. * @return true if the key is present, false otherwise
  40118. */
  40119. contains(key: string): boolean;
  40120. /**
  40121. * Add a new key and its corresponding value
  40122. * @param key the key to add
  40123. * @param value the value corresponding to the key
  40124. * @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
  40125. */
  40126. add(key: string, value: T): boolean;
  40127. /**
  40128. * Update a specific value associated to a key
  40129. * @param key defines the key to use
  40130. * @param value defines the value to store
  40131. * @returns true if the value was updated (or false if the key was not found)
  40132. */
  40133. set(key: string, value: T): boolean;
  40134. /**
  40135. * Get the element of the given key and remove it from the dictionary
  40136. * @param key defines the key to search
  40137. * @returns the value associated with the key or null if not found
  40138. */
  40139. getAndRemove(key: string): Nullable<T>;
  40140. /**
  40141. * Remove a key/value from the dictionary.
  40142. * @param key the key to remove
  40143. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40144. */
  40145. remove(key: string): boolean;
  40146. /**
  40147. * Clear the whole content of the dictionary
  40148. */
  40149. clear(): void;
  40150. /**
  40151. * Gets the current count
  40152. */
  40153. get count(): number;
  40154. /**
  40155. * Execute a callback on each key/val of the dictionary.
  40156. * Note that you can remove any element in this dictionary in the callback implementation
  40157. * @param callback the callback to execute on a given key/value pair
  40158. */
  40159. forEach(callback: (key: string, val: T) => void): void;
  40160. /**
  40161. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40162. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40163. * Note that you can remove any element in this dictionary in the callback implementation
  40164. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40165. * @returns the first item
  40166. */
  40167. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40168. private _count;
  40169. private _data;
  40170. }
  40171. }
  40172. declare module "babylonjs/Collisions/collisionCoordinator" {
  40173. import { Nullable } from "babylonjs/types";
  40174. import { Scene } from "babylonjs/scene";
  40175. import { Vector3 } from "babylonjs/Maths/math.vector";
  40176. import { Collider } from "babylonjs/Collisions/collider";
  40177. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40178. /** @hidden */
  40179. export interface ICollisionCoordinator {
  40180. createCollider(): Collider;
  40181. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40182. init(scene: Scene): void;
  40183. }
  40184. /** @hidden */
  40185. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40186. private _scene;
  40187. private _scaledPosition;
  40188. private _scaledVelocity;
  40189. private _finalPosition;
  40190. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40191. createCollider(): Collider;
  40192. init(scene: Scene): void;
  40193. private _collideWithWorld;
  40194. }
  40195. }
  40196. declare module "babylonjs/Inputs/scene.inputManager" {
  40197. import { Nullable } from "babylonjs/types";
  40198. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40199. import { Vector2 } from "babylonjs/Maths/math.vector";
  40200. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40201. import { Scene } from "babylonjs/scene";
  40202. /**
  40203. * Class used to manage all inputs for the scene.
  40204. */
  40205. export class InputManager {
  40206. /** The distance in pixel that you have to move to prevent some events */
  40207. static DragMovementThreshold: number;
  40208. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40209. static LongPressDelay: number;
  40210. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40211. static DoubleClickDelay: number;
  40212. /** If you need to check double click without raising a single click at first click, enable this flag */
  40213. static ExclusiveDoubleClickMode: boolean;
  40214. /** 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. */
  40215. private _alreadyAttached;
  40216. private _wheelEventName;
  40217. private _onPointerMove;
  40218. private _onPointerDown;
  40219. private _onPointerUp;
  40220. private _initClickEvent;
  40221. private _initActionManager;
  40222. private _delayedSimpleClick;
  40223. private _delayedSimpleClickTimeout;
  40224. private _previousDelayedSimpleClickTimeout;
  40225. private _meshPickProceed;
  40226. private _previousButtonPressed;
  40227. private _currentPickResult;
  40228. private _previousPickResult;
  40229. private _totalPointersPressed;
  40230. private _doubleClickOccured;
  40231. private _pointerOverMesh;
  40232. private _pickedDownMesh;
  40233. private _pickedUpMesh;
  40234. private _pointerX;
  40235. private _pointerY;
  40236. private _unTranslatedPointerX;
  40237. private _unTranslatedPointerY;
  40238. private _startingPointerPosition;
  40239. private _previousStartingPointerPosition;
  40240. private _startingPointerTime;
  40241. private _previousStartingPointerTime;
  40242. private _pointerCaptures;
  40243. private _onKeyDown;
  40244. private _onKeyUp;
  40245. private _onCanvasFocusObserver;
  40246. private _onCanvasBlurObserver;
  40247. private _scene;
  40248. /**
  40249. * Creates a new InputManager
  40250. * @param scene defines the hosting scene
  40251. */
  40252. constructor(scene: Scene);
  40253. /**
  40254. * Gets the mesh that is currently under the pointer
  40255. */
  40256. get meshUnderPointer(): Nullable<AbstractMesh>;
  40257. /**
  40258. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40259. */
  40260. get unTranslatedPointer(): Vector2;
  40261. /**
  40262. * Gets or sets the current on-screen X position of the pointer
  40263. */
  40264. get pointerX(): number;
  40265. set pointerX(value: number);
  40266. /**
  40267. * Gets or sets the current on-screen Y position of the pointer
  40268. */
  40269. get pointerY(): number;
  40270. set pointerY(value: number);
  40271. private _updatePointerPosition;
  40272. private _processPointerMove;
  40273. private _setRayOnPointerInfo;
  40274. private _checkPrePointerObservable;
  40275. /**
  40276. * Use this method to simulate a pointer move on a mesh
  40277. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40278. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40279. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40280. */
  40281. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40282. /**
  40283. * Use this method to simulate a pointer down on a mesh
  40284. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40285. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40286. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40287. */
  40288. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40289. private _processPointerDown;
  40290. /** @hidden */
  40291. _isPointerSwiping(): boolean;
  40292. /**
  40293. * Use this method to simulate a pointer up on a mesh
  40294. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40295. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40296. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40297. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40298. */
  40299. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40300. private _processPointerUp;
  40301. /**
  40302. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40303. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40304. * @returns true if the pointer was captured
  40305. */
  40306. isPointerCaptured(pointerId?: number): boolean;
  40307. /**
  40308. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40309. * @param attachUp defines if you want to attach events to pointerup
  40310. * @param attachDown defines if you want to attach events to pointerdown
  40311. * @param attachMove defines if you want to attach events to pointermove
  40312. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40313. */
  40314. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40315. /**
  40316. * Detaches all event handlers
  40317. */
  40318. detachControl(): void;
  40319. /**
  40320. * Force the value of meshUnderPointer
  40321. * @param mesh defines the mesh to use
  40322. */
  40323. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  40324. /**
  40325. * Gets the mesh under the pointer
  40326. * @returns a Mesh or null if no mesh is under the pointer
  40327. */
  40328. getPointerOverMesh(): Nullable<AbstractMesh>;
  40329. }
  40330. }
  40331. declare module "babylonjs/Animations/animationGroup" {
  40332. import { Animatable } from "babylonjs/Animations/animatable";
  40333. import { Animation } from "babylonjs/Animations/animation";
  40334. import { Scene, IDisposable } from "babylonjs/scene";
  40335. import { Observable } from "babylonjs/Misc/observable";
  40336. import { Nullable } from "babylonjs/types";
  40337. import "babylonjs/Animations/animatable";
  40338. /**
  40339. * This class defines the direct association between an animation and a target
  40340. */
  40341. export class TargetedAnimation {
  40342. /**
  40343. * Animation to perform
  40344. */
  40345. animation: Animation;
  40346. /**
  40347. * Target to animate
  40348. */
  40349. target: any;
  40350. /**
  40351. * Returns the string "TargetedAnimation"
  40352. * @returns "TargetedAnimation"
  40353. */
  40354. getClassName(): string;
  40355. /**
  40356. * Serialize the object
  40357. * @returns the JSON object representing the current entity
  40358. */
  40359. serialize(): any;
  40360. }
  40361. /**
  40362. * Use this class to create coordinated animations on multiple targets
  40363. */
  40364. export class AnimationGroup implements IDisposable {
  40365. /** The name of the animation group */
  40366. name: string;
  40367. private _scene;
  40368. private _targetedAnimations;
  40369. private _animatables;
  40370. private _from;
  40371. private _to;
  40372. private _isStarted;
  40373. private _isPaused;
  40374. private _speedRatio;
  40375. private _loopAnimation;
  40376. private _isAdditive;
  40377. /**
  40378. * Gets or sets the unique id of the node
  40379. */
  40380. uniqueId: number;
  40381. /**
  40382. * This observable will notify when one animation have ended
  40383. */
  40384. onAnimationEndObservable: Observable<TargetedAnimation>;
  40385. /**
  40386. * Observer raised when one animation loops
  40387. */
  40388. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40389. /**
  40390. * Observer raised when all animations have looped
  40391. */
  40392. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40393. /**
  40394. * This observable will notify when all animations have ended.
  40395. */
  40396. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40397. /**
  40398. * This observable will notify when all animations have paused.
  40399. */
  40400. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40401. /**
  40402. * This observable will notify when all animations are playing.
  40403. */
  40404. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40405. /**
  40406. * Gets the first frame
  40407. */
  40408. get from(): number;
  40409. /**
  40410. * Gets the last frame
  40411. */
  40412. get to(): number;
  40413. /**
  40414. * Define if the animations are started
  40415. */
  40416. get isStarted(): boolean;
  40417. /**
  40418. * Gets a value indicating that the current group is playing
  40419. */
  40420. get isPlaying(): boolean;
  40421. /**
  40422. * Gets or sets the speed ratio to use for all animations
  40423. */
  40424. get speedRatio(): number;
  40425. /**
  40426. * Gets or sets the speed ratio to use for all animations
  40427. */
  40428. set speedRatio(value: number);
  40429. /**
  40430. * Gets or sets if all animations should loop or not
  40431. */
  40432. get loopAnimation(): boolean;
  40433. set loopAnimation(value: boolean);
  40434. /**
  40435. * Gets or sets if all animations should be evaluated additively
  40436. */
  40437. get isAdditive(): boolean;
  40438. set isAdditive(value: boolean);
  40439. /**
  40440. * Gets the targeted animations for this animation group
  40441. */
  40442. get targetedAnimations(): Array<TargetedAnimation>;
  40443. /**
  40444. * returning the list of animatables controlled by this animation group.
  40445. */
  40446. get animatables(): Array<Animatable>;
  40447. /**
  40448. * Gets the list of target animations
  40449. */
  40450. get children(): TargetedAnimation[];
  40451. /**
  40452. * Instantiates a new Animation Group.
  40453. * This helps managing several animations at once.
  40454. * @see https://doc.babylonjs.com/how_to/group
  40455. * @param name Defines the name of the group
  40456. * @param scene Defines the scene the group belongs to
  40457. */
  40458. constructor(
  40459. /** The name of the animation group */
  40460. name: string, scene?: Nullable<Scene>);
  40461. /**
  40462. * Add an animation (with its target) in the group
  40463. * @param animation defines the animation we want to add
  40464. * @param target defines the target of the animation
  40465. * @returns the TargetedAnimation object
  40466. */
  40467. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40468. /**
  40469. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40470. * It can add constant keys at begin or end
  40471. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40472. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40473. * @returns the animation group
  40474. */
  40475. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40476. private _animationLoopCount;
  40477. private _animationLoopFlags;
  40478. private _processLoop;
  40479. /**
  40480. * Start all animations on given targets
  40481. * @param loop defines if animations must loop
  40482. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40483. * @param from defines the from key (optional)
  40484. * @param to defines the to key (optional)
  40485. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40486. * @returns the current animation group
  40487. */
  40488. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40489. /**
  40490. * Pause all animations
  40491. * @returns the animation group
  40492. */
  40493. pause(): AnimationGroup;
  40494. /**
  40495. * Play all animations to initial state
  40496. * This function will start() the animations if they were not started or will restart() them if they were paused
  40497. * @param loop defines if animations must loop
  40498. * @returns the animation group
  40499. */
  40500. play(loop?: boolean): AnimationGroup;
  40501. /**
  40502. * Reset all animations to initial state
  40503. * @returns the animation group
  40504. */
  40505. reset(): AnimationGroup;
  40506. /**
  40507. * Restart animations from key 0
  40508. * @returns the animation group
  40509. */
  40510. restart(): AnimationGroup;
  40511. /**
  40512. * Stop all animations
  40513. * @returns the animation group
  40514. */
  40515. stop(): AnimationGroup;
  40516. /**
  40517. * Set animation weight for all animatables
  40518. * @param weight defines the weight to use
  40519. * @return the animationGroup
  40520. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40521. */
  40522. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40523. /**
  40524. * Synchronize and normalize all animatables with a source animatable
  40525. * @param root defines the root animatable to synchronize with
  40526. * @return the animationGroup
  40527. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40528. */
  40529. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40530. /**
  40531. * Goes to a specific frame in this animation group
  40532. * @param frame the frame number to go to
  40533. * @return the animationGroup
  40534. */
  40535. goToFrame(frame: number): AnimationGroup;
  40536. /**
  40537. * Dispose all associated resources
  40538. */
  40539. dispose(): void;
  40540. private _checkAnimationGroupEnded;
  40541. /**
  40542. * Clone the current animation group and returns a copy
  40543. * @param newName defines the name of the new group
  40544. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40545. * @returns the new aniamtion group
  40546. */
  40547. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40548. /**
  40549. * Serializes the animationGroup to an object
  40550. * @returns Serialized object
  40551. */
  40552. serialize(): any;
  40553. /**
  40554. * Returns a new AnimationGroup object parsed from the source provided.
  40555. * @param parsedAnimationGroup defines the source
  40556. * @param scene defines the scene that will receive the animationGroup
  40557. * @returns a new AnimationGroup
  40558. */
  40559. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40560. /**
  40561. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40562. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40563. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40564. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40565. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40566. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40567. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40568. */
  40569. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40570. /**
  40571. * Returns the string "AnimationGroup"
  40572. * @returns "AnimationGroup"
  40573. */
  40574. getClassName(): string;
  40575. /**
  40576. * Creates a detailled string about the object
  40577. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40578. * @returns a string representing the object
  40579. */
  40580. toString(fullDetails?: boolean): string;
  40581. }
  40582. }
  40583. declare module "babylonjs/scene" {
  40584. import { Nullable } from "babylonjs/types";
  40585. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40586. import { Observable } from "babylonjs/Misc/observable";
  40587. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40588. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40589. import { Geometry } from "babylonjs/Meshes/geometry";
  40590. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40591. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40592. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40593. import { Mesh } from "babylonjs/Meshes/mesh";
  40594. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40595. import { Bone } from "babylonjs/Bones/bone";
  40596. import { Skeleton } from "babylonjs/Bones/skeleton";
  40597. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40598. import { Camera } from "babylonjs/Cameras/camera";
  40599. import { AbstractScene } from "babylonjs/abstractScene";
  40600. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40601. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40602. import { Material } from "babylonjs/Materials/material";
  40603. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40604. import { Effect } from "babylonjs/Materials/effect";
  40605. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40606. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40607. import { Light } from "babylonjs/Lights/light";
  40608. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40609. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40610. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40611. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40612. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40613. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40614. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40615. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40616. import { Engine } from "babylonjs/Engines/engine";
  40617. import { Node } from "babylonjs/node";
  40618. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40619. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40620. import { WebRequest } from "babylonjs/Misc/webRequest";
  40621. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40622. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40623. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40624. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40625. import { Plane } from "babylonjs/Maths/math.plane";
  40626. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40627. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40628. import { Ray } from "babylonjs/Culling/ray";
  40629. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40630. import { Animation } from "babylonjs/Animations/animation";
  40631. import { Animatable } from "babylonjs/Animations/animatable";
  40632. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40633. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40634. import { Collider } from "babylonjs/Collisions/collider";
  40635. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40636. /**
  40637. * Define an interface for all classes that will hold resources
  40638. */
  40639. export interface IDisposable {
  40640. /**
  40641. * Releases all held resources
  40642. */
  40643. dispose(): void;
  40644. }
  40645. /** Interface defining initialization parameters for Scene class */
  40646. export interface SceneOptions {
  40647. /**
  40648. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40649. * It will improve performance when the number of geometries becomes important.
  40650. */
  40651. useGeometryUniqueIdsMap?: boolean;
  40652. /**
  40653. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40654. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40655. */
  40656. useMaterialMeshMap?: boolean;
  40657. /**
  40658. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40659. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40660. */
  40661. useClonedMeshMap?: boolean;
  40662. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40663. virtual?: boolean;
  40664. }
  40665. /**
  40666. * Represents a scene to be rendered by the engine.
  40667. * @see https://doc.babylonjs.com/features/scene
  40668. */
  40669. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40670. /** The fog is deactivated */
  40671. static readonly FOGMODE_NONE: number;
  40672. /** The fog density is following an exponential function */
  40673. static readonly FOGMODE_EXP: number;
  40674. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40675. static readonly FOGMODE_EXP2: number;
  40676. /** The fog density is following a linear function. */
  40677. static readonly FOGMODE_LINEAR: number;
  40678. /**
  40679. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40680. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40681. */
  40682. static MinDeltaTime: number;
  40683. /**
  40684. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40685. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40686. */
  40687. static MaxDeltaTime: number;
  40688. /**
  40689. * Factory used to create the default material.
  40690. * @param name The name of the material to create
  40691. * @param scene The scene to create the material for
  40692. * @returns The default material
  40693. */
  40694. static DefaultMaterialFactory(scene: Scene): Material;
  40695. /**
  40696. * Factory used to create the a collision coordinator.
  40697. * @returns The collision coordinator
  40698. */
  40699. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40700. /** @hidden */
  40701. _inputManager: InputManager;
  40702. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40703. cameraToUseForPointers: Nullable<Camera>;
  40704. /** @hidden */
  40705. readonly _isScene: boolean;
  40706. /** @hidden */
  40707. _blockEntityCollection: boolean;
  40708. /**
  40709. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40710. */
  40711. autoClear: boolean;
  40712. /**
  40713. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40714. */
  40715. autoClearDepthAndStencil: boolean;
  40716. /**
  40717. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40718. */
  40719. clearColor: Color4;
  40720. /**
  40721. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40722. */
  40723. ambientColor: Color3;
  40724. /**
  40725. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40726. * It should only be one of the following (if not the default embedded one):
  40727. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40728. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40729. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40730. * The material properties need to be setup according to the type of texture in use.
  40731. */
  40732. environmentBRDFTexture: BaseTexture;
  40733. /** @hidden */
  40734. protected _environmentTexture: Nullable<BaseTexture>;
  40735. /**
  40736. * Texture used in all pbr material as the reflection texture.
  40737. * As in the majority of the scene they are the same (exception for multi room and so on),
  40738. * this is easier to reference from here than from all the materials.
  40739. */
  40740. get environmentTexture(): Nullable<BaseTexture>;
  40741. /**
  40742. * Texture used in all pbr material as the reflection texture.
  40743. * As in the majority of the scene they are the same (exception for multi room and so on),
  40744. * this is easier to set here than in all the materials.
  40745. */
  40746. set environmentTexture(value: Nullable<BaseTexture>);
  40747. /** @hidden */
  40748. protected _environmentIntensity: number;
  40749. /**
  40750. * Intensity of the environment in all pbr material.
  40751. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40752. * As in the majority of the scene they are the same (exception for multi room and so on),
  40753. * this is easier to reference from here than from all the materials.
  40754. */
  40755. get environmentIntensity(): number;
  40756. /**
  40757. * Intensity of the environment in all pbr material.
  40758. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40759. * As in the majority of the scene they are the same (exception for multi room and so on),
  40760. * this is easier to set here than in all the materials.
  40761. */
  40762. set environmentIntensity(value: number);
  40763. /** @hidden */
  40764. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40765. /**
  40766. * Default image processing configuration used either in the rendering
  40767. * Forward main pass or through the imageProcessingPostProcess if present.
  40768. * As in the majority of the scene they are the same (exception for multi camera),
  40769. * this is easier to reference from here than from all the materials and post process.
  40770. *
  40771. * No setter as we it is a shared configuration, you can set the values instead.
  40772. */
  40773. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40774. private _forceWireframe;
  40775. /**
  40776. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40777. */
  40778. set forceWireframe(value: boolean);
  40779. get forceWireframe(): boolean;
  40780. private _skipFrustumClipping;
  40781. /**
  40782. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40783. */
  40784. set skipFrustumClipping(value: boolean);
  40785. get skipFrustumClipping(): boolean;
  40786. private _forcePointsCloud;
  40787. /**
  40788. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40789. */
  40790. set forcePointsCloud(value: boolean);
  40791. get forcePointsCloud(): boolean;
  40792. /**
  40793. * Gets or sets the active clipplane 1
  40794. */
  40795. clipPlane: Nullable<Plane>;
  40796. /**
  40797. * Gets or sets the active clipplane 2
  40798. */
  40799. clipPlane2: Nullable<Plane>;
  40800. /**
  40801. * Gets or sets the active clipplane 3
  40802. */
  40803. clipPlane3: Nullable<Plane>;
  40804. /**
  40805. * Gets or sets the active clipplane 4
  40806. */
  40807. clipPlane4: Nullable<Plane>;
  40808. /**
  40809. * Gets or sets the active clipplane 5
  40810. */
  40811. clipPlane5: Nullable<Plane>;
  40812. /**
  40813. * Gets or sets the active clipplane 6
  40814. */
  40815. clipPlane6: Nullable<Plane>;
  40816. /**
  40817. * Gets or sets a boolean indicating if animations are enabled
  40818. */
  40819. animationsEnabled: boolean;
  40820. private _animationPropertiesOverride;
  40821. /**
  40822. * Gets or sets the animation properties override
  40823. */
  40824. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40825. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40826. /**
  40827. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40828. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40829. */
  40830. useConstantAnimationDeltaTime: boolean;
  40831. /**
  40832. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40833. * Please note that it requires to run a ray cast through the scene on every frame
  40834. */
  40835. constantlyUpdateMeshUnderPointer: boolean;
  40836. /**
  40837. * Defines the HTML cursor to use when hovering over interactive elements
  40838. */
  40839. hoverCursor: string;
  40840. /**
  40841. * Defines the HTML default cursor to use (empty by default)
  40842. */
  40843. defaultCursor: string;
  40844. /**
  40845. * Defines whether cursors are handled by the scene.
  40846. */
  40847. doNotHandleCursors: boolean;
  40848. /**
  40849. * This is used to call preventDefault() on pointer down
  40850. * in order to block unwanted artifacts like system double clicks
  40851. */
  40852. preventDefaultOnPointerDown: boolean;
  40853. /**
  40854. * This is used to call preventDefault() on pointer up
  40855. * in order to block unwanted artifacts like system double clicks
  40856. */
  40857. preventDefaultOnPointerUp: boolean;
  40858. /**
  40859. * Gets or sets user defined metadata
  40860. */
  40861. metadata: any;
  40862. /**
  40863. * For internal use only. Please do not use.
  40864. */
  40865. reservedDataStore: any;
  40866. /**
  40867. * Gets the name of the plugin used to load this scene (null by default)
  40868. */
  40869. loadingPluginName: string;
  40870. /**
  40871. * Use this array to add regular expressions used to disable offline support for specific urls
  40872. */
  40873. disableOfflineSupportExceptionRules: RegExp[];
  40874. /**
  40875. * An event triggered when the scene is disposed.
  40876. */
  40877. onDisposeObservable: Observable<Scene>;
  40878. private _onDisposeObserver;
  40879. /** Sets a function to be executed when this scene is disposed. */
  40880. set onDispose(callback: () => void);
  40881. /**
  40882. * An event triggered before rendering the scene (right after animations and physics)
  40883. */
  40884. onBeforeRenderObservable: Observable<Scene>;
  40885. private _onBeforeRenderObserver;
  40886. /** Sets a function to be executed before rendering this scene */
  40887. set beforeRender(callback: Nullable<() => void>);
  40888. /**
  40889. * An event triggered after rendering the scene
  40890. */
  40891. onAfterRenderObservable: Observable<Scene>;
  40892. /**
  40893. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40894. */
  40895. onAfterRenderCameraObservable: Observable<Camera>;
  40896. private _onAfterRenderObserver;
  40897. /** Sets a function to be executed after rendering this scene */
  40898. set afterRender(callback: Nullable<() => void>);
  40899. /**
  40900. * An event triggered before animating the scene
  40901. */
  40902. onBeforeAnimationsObservable: Observable<Scene>;
  40903. /**
  40904. * An event triggered after animations processing
  40905. */
  40906. onAfterAnimationsObservable: Observable<Scene>;
  40907. /**
  40908. * An event triggered before draw calls are ready to be sent
  40909. */
  40910. onBeforeDrawPhaseObservable: Observable<Scene>;
  40911. /**
  40912. * An event triggered after draw calls have been sent
  40913. */
  40914. onAfterDrawPhaseObservable: Observable<Scene>;
  40915. /**
  40916. * An event triggered when the scene is ready
  40917. */
  40918. onReadyObservable: Observable<Scene>;
  40919. /**
  40920. * An event triggered before rendering a camera
  40921. */
  40922. onBeforeCameraRenderObservable: Observable<Camera>;
  40923. private _onBeforeCameraRenderObserver;
  40924. /** Sets a function to be executed before rendering a camera*/
  40925. set beforeCameraRender(callback: () => void);
  40926. /**
  40927. * An event triggered after rendering a camera
  40928. */
  40929. onAfterCameraRenderObservable: Observable<Camera>;
  40930. private _onAfterCameraRenderObserver;
  40931. /** Sets a function to be executed after rendering a camera*/
  40932. set afterCameraRender(callback: () => void);
  40933. /**
  40934. * An event triggered when active meshes evaluation is about to start
  40935. */
  40936. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40937. /**
  40938. * An event triggered when active meshes evaluation is done
  40939. */
  40940. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40941. /**
  40942. * An event triggered when particles rendering is about to start
  40943. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40944. */
  40945. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40946. /**
  40947. * An event triggered when particles rendering is done
  40948. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40949. */
  40950. onAfterParticlesRenderingObservable: Observable<Scene>;
  40951. /**
  40952. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40953. */
  40954. onDataLoadedObservable: Observable<Scene>;
  40955. /**
  40956. * An event triggered when a camera is created
  40957. */
  40958. onNewCameraAddedObservable: Observable<Camera>;
  40959. /**
  40960. * An event triggered when a camera is removed
  40961. */
  40962. onCameraRemovedObservable: Observable<Camera>;
  40963. /**
  40964. * An event triggered when a light is created
  40965. */
  40966. onNewLightAddedObservable: Observable<Light>;
  40967. /**
  40968. * An event triggered when a light is removed
  40969. */
  40970. onLightRemovedObservable: Observable<Light>;
  40971. /**
  40972. * An event triggered when a geometry is created
  40973. */
  40974. onNewGeometryAddedObservable: Observable<Geometry>;
  40975. /**
  40976. * An event triggered when a geometry is removed
  40977. */
  40978. onGeometryRemovedObservable: Observable<Geometry>;
  40979. /**
  40980. * An event triggered when a transform node is created
  40981. */
  40982. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  40983. /**
  40984. * An event triggered when a transform node is removed
  40985. */
  40986. onTransformNodeRemovedObservable: Observable<TransformNode>;
  40987. /**
  40988. * An event triggered when a mesh is created
  40989. */
  40990. onNewMeshAddedObservable: Observable<AbstractMesh>;
  40991. /**
  40992. * An event triggered when a mesh is removed
  40993. */
  40994. onMeshRemovedObservable: Observable<AbstractMesh>;
  40995. /**
  40996. * An event triggered when a skeleton is created
  40997. */
  40998. onNewSkeletonAddedObservable: Observable<Skeleton>;
  40999. /**
  41000. * An event triggered when a skeleton is removed
  41001. */
  41002. onSkeletonRemovedObservable: Observable<Skeleton>;
  41003. /**
  41004. * An event triggered when a material is created
  41005. */
  41006. onNewMaterialAddedObservable: Observable<Material>;
  41007. /**
  41008. * An event triggered when a material is removed
  41009. */
  41010. onMaterialRemovedObservable: Observable<Material>;
  41011. /**
  41012. * An event triggered when a texture is created
  41013. */
  41014. onNewTextureAddedObservable: Observable<BaseTexture>;
  41015. /**
  41016. * An event triggered when a texture is removed
  41017. */
  41018. onTextureRemovedObservable: Observable<BaseTexture>;
  41019. /**
  41020. * An event triggered when render targets are about to be rendered
  41021. * Can happen multiple times per frame.
  41022. */
  41023. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41024. /**
  41025. * An event triggered when render targets were rendered.
  41026. * Can happen multiple times per frame.
  41027. */
  41028. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41029. /**
  41030. * An event triggered before calculating deterministic simulation step
  41031. */
  41032. onBeforeStepObservable: Observable<Scene>;
  41033. /**
  41034. * An event triggered after calculating deterministic simulation step
  41035. */
  41036. onAfterStepObservable: Observable<Scene>;
  41037. /**
  41038. * An event triggered when the activeCamera property is updated
  41039. */
  41040. onActiveCameraChanged: Observable<Scene>;
  41041. /**
  41042. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41043. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41044. * 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)
  41045. */
  41046. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41047. /**
  41048. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41049. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41050. * 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)
  41051. */
  41052. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41053. /**
  41054. * This Observable will when a mesh has been imported into the scene.
  41055. */
  41056. onMeshImportedObservable: Observable<AbstractMesh>;
  41057. /**
  41058. * This Observable will when an animation file has been imported into the scene.
  41059. */
  41060. onAnimationFileImportedObservable: Observable<Scene>;
  41061. /**
  41062. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41063. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41064. */
  41065. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41066. /** @hidden */
  41067. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41068. /**
  41069. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41070. */
  41071. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41072. /**
  41073. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41074. */
  41075. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41076. /**
  41077. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41078. */
  41079. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41080. /** Callback called when a pointer move is detected */
  41081. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41082. /** Callback called when a pointer down is detected */
  41083. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41084. /** Callback called when a pointer up is detected */
  41085. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41086. /** Callback called when a pointer pick is detected */
  41087. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41088. /**
  41089. * 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).
  41090. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41091. */
  41092. onPrePointerObservable: Observable<PointerInfoPre>;
  41093. /**
  41094. * Observable event triggered each time an input event is received from the rendering canvas
  41095. */
  41096. onPointerObservable: Observable<PointerInfo>;
  41097. /**
  41098. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41099. */
  41100. get unTranslatedPointer(): Vector2;
  41101. /**
  41102. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41103. */
  41104. static get DragMovementThreshold(): number;
  41105. static set DragMovementThreshold(value: number);
  41106. /**
  41107. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41108. */
  41109. static get LongPressDelay(): number;
  41110. static set LongPressDelay(value: number);
  41111. /**
  41112. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41113. */
  41114. static get DoubleClickDelay(): number;
  41115. static set DoubleClickDelay(value: number);
  41116. /** If you need to check double click without raising a single click at first click, enable this flag */
  41117. static get ExclusiveDoubleClickMode(): boolean;
  41118. static set ExclusiveDoubleClickMode(value: boolean);
  41119. /** @hidden */
  41120. _mirroredCameraPosition: Nullable<Vector3>;
  41121. /**
  41122. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41123. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41124. */
  41125. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41126. /**
  41127. * Observable event triggered each time an keyboard event is received from the hosting window
  41128. */
  41129. onKeyboardObservable: Observable<KeyboardInfo>;
  41130. private _useRightHandedSystem;
  41131. /**
  41132. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41133. */
  41134. set useRightHandedSystem(value: boolean);
  41135. get useRightHandedSystem(): boolean;
  41136. private _timeAccumulator;
  41137. private _currentStepId;
  41138. private _currentInternalStep;
  41139. /**
  41140. * Sets the step Id used by deterministic lock step
  41141. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41142. * @param newStepId defines the step Id
  41143. */
  41144. setStepId(newStepId: number): void;
  41145. /**
  41146. * Gets the step Id used by deterministic lock step
  41147. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41148. * @returns the step Id
  41149. */
  41150. getStepId(): number;
  41151. /**
  41152. * Gets the internal step used by deterministic lock step
  41153. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41154. * @returns the internal step
  41155. */
  41156. getInternalStep(): number;
  41157. private _fogEnabled;
  41158. /**
  41159. * Gets or sets a boolean indicating if fog is enabled on this scene
  41160. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41161. * (Default is true)
  41162. */
  41163. set fogEnabled(value: boolean);
  41164. get fogEnabled(): boolean;
  41165. private _fogMode;
  41166. /**
  41167. * Gets or sets the fog mode to use
  41168. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41169. * | mode | value |
  41170. * | --- | --- |
  41171. * | FOGMODE_NONE | 0 |
  41172. * | FOGMODE_EXP | 1 |
  41173. * | FOGMODE_EXP2 | 2 |
  41174. * | FOGMODE_LINEAR | 3 |
  41175. */
  41176. set fogMode(value: number);
  41177. get fogMode(): number;
  41178. /**
  41179. * Gets or sets the fog color to use
  41180. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41181. * (Default is Color3(0.2, 0.2, 0.3))
  41182. */
  41183. fogColor: Color3;
  41184. /**
  41185. * Gets or sets the fog density to use
  41186. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41187. * (Default is 0.1)
  41188. */
  41189. fogDensity: number;
  41190. /**
  41191. * Gets or sets the fog start distance to use
  41192. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41193. * (Default is 0)
  41194. */
  41195. fogStart: number;
  41196. /**
  41197. * Gets or sets the fog end distance to use
  41198. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41199. * (Default is 1000)
  41200. */
  41201. fogEnd: number;
  41202. /**
  41203. * Flag indicating that the frame buffer binding is handled by another component
  41204. */
  41205. prePass: boolean;
  41206. private _shadowsEnabled;
  41207. /**
  41208. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41209. */
  41210. set shadowsEnabled(value: boolean);
  41211. get shadowsEnabled(): boolean;
  41212. private _lightsEnabled;
  41213. /**
  41214. * Gets or sets a boolean indicating if lights are enabled on this scene
  41215. */
  41216. set lightsEnabled(value: boolean);
  41217. get lightsEnabled(): boolean;
  41218. /** All of the active cameras added to this scene. */
  41219. activeCameras: Camera[];
  41220. /** @hidden */
  41221. _activeCamera: Nullable<Camera>;
  41222. /** Gets or sets the current active camera */
  41223. get activeCamera(): Nullable<Camera>;
  41224. set activeCamera(value: Nullable<Camera>);
  41225. private _defaultMaterial;
  41226. /** The default material used on meshes when no material is affected */
  41227. get defaultMaterial(): Material;
  41228. /** The default material used on meshes when no material is affected */
  41229. set defaultMaterial(value: Material);
  41230. private _texturesEnabled;
  41231. /**
  41232. * Gets or sets a boolean indicating if textures are enabled on this scene
  41233. */
  41234. set texturesEnabled(value: boolean);
  41235. get texturesEnabled(): boolean;
  41236. /**
  41237. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41238. */
  41239. physicsEnabled: boolean;
  41240. /**
  41241. * Gets or sets a boolean indicating if particles are enabled on this scene
  41242. */
  41243. particlesEnabled: boolean;
  41244. /**
  41245. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41246. */
  41247. spritesEnabled: boolean;
  41248. private _skeletonsEnabled;
  41249. /**
  41250. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41251. */
  41252. set skeletonsEnabled(value: boolean);
  41253. get skeletonsEnabled(): boolean;
  41254. /**
  41255. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41256. */
  41257. lensFlaresEnabled: boolean;
  41258. /**
  41259. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41260. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41261. */
  41262. collisionsEnabled: boolean;
  41263. private _collisionCoordinator;
  41264. /** @hidden */
  41265. get collisionCoordinator(): ICollisionCoordinator;
  41266. /**
  41267. * Defines the gravity applied to this scene (used only for collisions)
  41268. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41269. */
  41270. gravity: Vector3;
  41271. /**
  41272. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41273. */
  41274. postProcessesEnabled: boolean;
  41275. /**
  41276. * Gets the current postprocess manager
  41277. */
  41278. postProcessManager: PostProcessManager;
  41279. /**
  41280. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41281. */
  41282. renderTargetsEnabled: boolean;
  41283. /**
  41284. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41285. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41286. */
  41287. dumpNextRenderTargets: boolean;
  41288. /**
  41289. * The list of user defined render targets added to the scene
  41290. */
  41291. customRenderTargets: RenderTargetTexture[];
  41292. /**
  41293. * Defines if texture loading must be delayed
  41294. * If true, textures will only be loaded when they need to be rendered
  41295. */
  41296. useDelayedTextureLoading: boolean;
  41297. /**
  41298. * Gets the list of meshes imported to the scene through SceneLoader
  41299. */
  41300. importedMeshesFiles: String[];
  41301. /**
  41302. * Gets or sets a boolean indicating if probes are enabled on this scene
  41303. */
  41304. probesEnabled: boolean;
  41305. /**
  41306. * Gets or sets the current offline provider to use to store scene data
  41307. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41308. */
  41309. offlineProvider: IOfflineProvider;
  41310. /**
  41311. * Gets or sets the action manager associated with the scene
  41312. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41313. */
  41314. actionManager: AbstractActionManager;
  41315. private _meshesForIntersections;
  41316. /**
  41317. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41318. */
  41319. proceduralTexturesEnabled: boolean;
  41320. private _engine;
  41321. private _totalVertices;
  41322. /** @hidden */
  41323. _activeIndices: PerfCounter;
  41324. /** @hidden */
  41325. _activeParticles: PerfCounter;
  41326. /** @hidden */
  41327. _activeBones: PerfCounter;
  41328. private _animationRatio;
  41329. /** @hidden */
  41330. _animationTimeLast: number;
  41331. /** @hidden */
  41332. _animationTime: number;
  41333. /**
  41334. * Gets or sets a general scale for animation speed
  41335. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41336. */
  41337. animationTimeScale: number;
  41338. /** @hidden */
  41339. _cachedMaterial: Nullable<Material>;
  41340. /** @hidden */
  41341. _cachedEffect: Nullable<Effect>;
  41342. /** @hidden */
  41343. _cachedVisibility: Nullable<number>;
  41344. private _renderId;
  41345. private _frameId;
  41346. private _executeWhenReadyTimeoutId;
  41347. private _intermediateRendering;
  41348. private _viewUpdateFlag;
  41349. private _projectionUpdateFlag;
  41350. /** @hidden */
  41351. _toBeDisposed: Nullable<IDisposable>[];
  41352. private _activeRequests;
  41353. /** @hidden */
  41354. _pendingData: any[];
  41355. private _isDisposed;
  41356. /**
  41357. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41358. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41359. */
  41360. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41361. private _activeMeshes;
  41362. private _processedMaterials;
  41363. private _renderTargets;
  41364. /** @hidden */
  41365. _activeParticleSystems: SmartArray<IParticleSystem>;
  41366. private _activeSkeletons;
  41367. private _softwareSkinnedMeshes;
  41368. private _renderingManager;
  41369. /** @hidden */
  41370. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41371. private _transformMatrix;
  41372. private _sceneUbo;
  41373. /** @hidden */
  41374. _viewMatrix: Matrix;
  41375. private _projectionMatrix;
  41376. /** @hidden */
  41377. _forcedViewPosition: Nullable<Vector3>;
  41378. /** @hidden */
  41379. _frustumPlanes: Plane[];
  41380. /**
  41381. * Gets the list of frustum planes (built from the active camera)
  41382. */
  41383. get frustumPlanes(): Plane[];
  41384. /**
  41385. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41386. * This is useful if there are more lights that the maximum simulteanous authorized
  41387. */
  41388. requireLightSorting: boolean;
  41389. /** @hidden */
  41390. readonly useMaterialMeshMap: boolean;
  41391. /** @hidden */
  41392. readonly useClonedMeshMap: boolean;
  41393. private _externalData;
  41394. private _uid;
  41395. /**
  41396. * @hidden
  41397. * Backing store of defined scene components.
  41398. */
  41399. _components: ISceneComponent[];
  41400. /**
  41401. * @hidden
  41402. * Backing store of defined scene components.
  41403. */
  41404. _serializableComponents: ISceneSerializableComponent[];
  41405. /**
  41406. * List of components to register on the next registration step.
  41407. */
  41408. private _transientComponents;
  41409. /**
  41410. * Registers the transient components if needed.
  41411. */
  41412. private _registerTransientComponents;
  41413. /**
  41414. * @hidden
  41415. * Add a component to the scene.
  41416. * Note that the ccomponent could be registered on th next frame if this is called after
  41417. * the register component stage.
  41418. * @param component Defines the component to add to the scene
  41419. */
  41420. _addComponent(component: ISceneComponent): void;
  41421. /**
  41422. * @hidden
  41423. * Gets a component from the scene.
  41424. * @param name defines the name of the component to retrieve
  41425. * @returns the component or null if not present
  41426. */
  41427. _getComponent(name: string): Nullable<ISceneComponent>;
  41428. /**
  41429. * @hidden
  41430. * Defines the actions happening before camera updates.
  41431. */
  41432. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41433. /**
  41434. * @hidden
  41435. * Defines the actions happening before clear the canvas.
  41436. */
  41437. _beforeClearStage: Stage<SimpleStageAction>;
  41438. /**
  41439. * @hidden
  41440. * Defines the actions when collecting render targets for the frame.
  41441. */
  41442. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41443. /**
  41444. * @hidden
  41445. * Defines the actions happening for one camera in the frame.
  41446. */
  41447. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41448. /**
  41449. * @hidden
  41450. * Defines the actions happening during the per mesh ready checks.
  41451. */
  41452. _isReadyForMeshStage: Stage<MeshStageAction>;
  41453. /**
  41454. * @hidden
  41455. * Defines the actions happening before evaluate active mesh checks.
  41456. */
  41457. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41458. /**
  41459. * @hidden
  41460. * Defines the actions happening during the evaluate sub mesh checks.
  41461. */
  41462. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41463. /**
  41464. * @hidden
  41465. * Defines the actions happening during the active mesh stage.
  41466. */
  41467. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41468. /**
  41469. * @hidden
  41470. * Defines the actions happening during the per camera render target step.
  41471. */
  41472. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41473. /**
  41474. * @hidden
  41475. * Defines the actions happening just before the active camera is drawing.
  41476. */
  41477. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41478. /**
  41479. * @hidden
  41480. * Defines the actions happening just before a render target is drawing.
  41481. */
  41482. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41483. /**
  41484. * @hidden
  41485. * Defines the actions happening just before a rendering group is drawing.
  41486. */
  41487. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41488. /**
  41489. * @hidden
  41490. * Defines the actions happening just before a mesh is drawing.
  41491. */
  41492. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41493. /**
  41494. * @hidden
  41495. * Defines the actions happening just after a mesh has been drawn.
  41496. */
  41497. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41498. /**
  41499. * @hidden
  41500. * Defines the actions happening just after a rendering group has been drawn.
  41501. */
  41502. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41503. /**
  41504. * @hidden
  41505. * Defines the actions happening just after the active camera has been drawn.
  41506. */
  41507. _afterCameraDrawStage: Stage<CameraStageAction>;
  41508. /**
  41509. * @hidden
  41510. * Defines the actions happening just after a render target has been drawn.
  41511. */
  41512. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41513. /**
  41514. * @hidden
  41515. * Defines the actions happening just after rendering all cameras and computing intersections.
  41516. */
  41517. _afterRenderStage: Stage<SimpleStageAction>;
  41518. /**
  41519. * @hidden
  41520. * Defines the actions happening when a pointer move event happens.
  41521. */
  41522. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41523. /**
  41524. * @hidden
  41525. * Defines the actions happening when a pointer down event happens.
  41526. */
  41527. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41528. /**
  41529. * @hidden
  41530. * Defines the actions happening when a pointer up event happens.
  41531. */
  41532. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41533. /**
  41534. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41535. */
  41536. private geometriesByUniqueId;
  41537. /**
  41538. * Creates a new Scene
  41539. * @param engine defines the engine to use to render this scene
  41540. * @param options defines the scene options
  41541. */
  41542. constructor(engine: Engine, options?: SceneOptions);
  41543. /**
  41544. * Gets a string identifying the name of the class
  41545. * @returns "Scene" string
  41546. */
  41547. getClassName(): string;
  41548. private _defaultMeshCandidates;
  41549. /**
  41550. * @hidden
  41551. */
  41552. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41553. private _defaultSubMeshCandidates;
  41554. /**
  41555. * @hidden
  41556. */
  41557. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41558. /**
  41559. * Sets the default candidate providers for the scene.
  41560. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41561. * and getCollidingSubMeshCandidates to their default function
  41562. */
  41563. setDefaultCandidateProviders(): void;
  41564. /**
  41565. * Gets the mesh that is currently under the pointer
  41566. */
  41567. get meshUnderPointer(): Nullable<AbstractMesh>;
  41568. /**
  41569. * Gets or sets the current on-screen X position of the pointer
  41570. */
  41571. get pointerX(): number;
  41572. set pointerX(value: number);
  41573. /**
  41574. * Gets or sets the current on-screen Y position of the pointer
  41575. */
  41576. get pointerY(): number;
  41577. set pointerY(value: number);
  41578. /**
  41579. * Gets the cached material (ie. the latest rendered one)
  41580. * @returns the cached material
  41581. */
  41582. getCachedMaterial(): Nullable<Material>;
  41583. /**
  41584. * Gets the cached effect (ie. the latest rendered one)
  41585. * @returns the cached effect
  41586. */
  41587. getCachedEffect(): Nullable<Effect>;
  41588. /**
  41589. * Gets the cached visibility state (ie. the latest rendered one)
  41590. * @returns the cached visibility state
  41591. */
  41592. getCachedVisibility(): Nullable<number>;
  41593. /**
  41594. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41595. * @param material defines the current material
  41596. * @param effect defines the current effect
  41597. * @param visibility defines the current visibility state
  41598. * @returns true if one parameter is not cached
  41599. */
  41600. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41601. /**
  41602. * Gets the engine associated with the scene
  41603. * @returns an Engine
  41604. */
  41605. getEngine(): Engine;
  41606. /**
  41607. * Gets the total number of vertices rendered per frame
  41608. * @returns the total number of vertices rendered per frame
  41609. */
  41610. getTotalVertices(): number;
  41611. /**
  41612. * Gets the performance counter for total vertices
  41613. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41614. */
  41615. get totalVerticesPerfCounter(): PerfCounter;
  41616. /**
  41617. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41618. * @returns the total number of active indices rendered per frame
  41619. */
  41620. getActiveIndices(): number;
  41621. /**
  41622. * Gets the performance counter for active indices
  41623. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41624. */
  41625. get totalActiveIndicesPerfCounter(): PerfCounter;
  41626. /**
  41627. * Gets the total number of active particles rendered per frame
  41628. * @returns the total number of active particles rendered per frame
  41629. */
  41630. getActiveParticles(): number;
  41631. /**
  41632. * Gets the performance counter for active particles
  41633. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41634. */
  41635. get activeParticlesPerfCounter(): PerfCounter;
  41636. /**
  41637. * Gets the total number of active bones rendered per frame
  41638. * @returns the total number of active bones rendered per frame
  41639. */
  41640. getActiveBones(): number;
  41641. /**
  41642. * Gets the performance counter for active bones
  41643. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41644. */
  41645. get activeBonesPerfCounter(): PerfCounter;
  41646. /**
  41647. * Gets the array of active meshes
  41648. * @returns an array of AbstractMesh
  41649. */
  41650. getActiveMeshes(): SmartArray<AbstractMesh>;
  41651. /**
  41652. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41653. * @returns a number
  41654. */
  41655. getAnimationRatio(): number;
  41656. /**
  41657. * Gets an unique Id for the current render phase
  41658. * @returns a number
  41659. */
  41660. getRenderId(): number;
  41661. /**
  41662. * Gets an unique Id for the current frame
  41663. * @returns a number
  41664. */
  41665. getFrameId(): number;
  41666. /** Call this function if you want to manually increment the render Id*/
  41667. incrementRenderId(): void;
  41668. private _createUbo;
  41669. /**
  41670. * Use this method to simulate a pointer move on a mesh
  41671. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41672. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41673. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41674. * @returns the current scene
  41675. */
  41676. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41677. /**
  41678. * Use this method to simulate a pointer down on a mesh
  41679. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41680. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41681. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41682. * @returns the current scene
  41683. */
  41684. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41685. /**
  41686. * Use this method to simulate a pointer up on a mesh
  41687. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41688. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41689. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41690. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41691. * @returns the current scene
  41692. */
  41693. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41694. /**
  41695. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41696. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41697. * @returns true if the pointer was captured
  41698. */
  41699. isPointerCaptured(pointerId?: number): boolean;
  41700. /**
  41701. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41702. * @param attachUp defines if you want to attach events to pointerup
  41703. * @param attachDown defines if you want to attach events to pointerdown
  41704. * @param attachMove defines if you want to attach events to pointermove
  41705. */
  41706. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41707. /** Detaches all event handlers*/
  41708. detachControl(): void;
  41709. /**
  41710. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41711. * Delay loaded resources are not taking in account
  41712. * @return true if all required resources are ready
  41713. */
  41714. isReady(): boolean;
  41715. /** Resets all cached information relative to material (including effect and visibility) */
  41716. resetCachedMaterial(): void;
  41717. /**
  41718. * Registers a function to be called before every frame render
  41719. * @param func defines the function to register
  41720. */
  41721. registerBeforeRender(func: () => void): void;
  41722. /**
  41723. * Unregisters a function called before every frame render
  41724. * @param func defines the function to unregister
  41725. */
  41726. unregisterBeforeRender(func: () => void): void;
  41727. /**
  41728. * Registers a function to be called after every frame render
  41729. * @param func defines the function to register
  41730. */
  41731. registerAfterRender(func: () => void): void;
  41732. /**
  41733. * Unregisters a function called after every frame render
  41734. * @param func defines the function to unregister
  41735. */
  41736. unregisterAfterRender(func: () => void): void;
  41737. private _executeOnceBeforeRender;
  41738. /**
  41739. * The provided function will run before render once and will be disposed afterwards.
  41740. * A timeout delay can be provided so that the function will be executed in N ms.
  41741. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41742. * @param func The function to be executed.
  41743. * @param timeout optional delay in ms
  41744. */
  41745. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41746. /** @hidden */
  41747. _addPendingData(data: any): void;
  41748. /** @hidden */
  41749. _removePendingData(data: any): void;
  41750. /**
  41751. * Returns the number of items waiting to be loaded
  41752. * @returns the number of items waiting to be loaded
  41753. */
  41754. getWaitingItemsCount(): number;
  41755. /**
  41756. * Returns a boolean indicating if the scene is still loading data
  41757. */
  41758. get isLoading(): boolean;
  41759. /**
  41760. * Registers a function to be executed when the scene is ready
  41761. * @param {Function} func - the function to be executed
  41762. */
  41763. executeWhenReady(func: () => void): void;
  41764. /**
  41765. * Returns a promise that resolves when the scene is ready
  41766. * @returns A promise that resolves when the scene is ready
  41767. */
  41768. whenReadyAsync(): Promise<void>;
  41769. /** @hidden */
  41770. _checkIsReady(): void;
  41771. /**
  41772. * Gets all animatable attached to the scene
  41773. */
  41774. get animatables(): Animatable[];
  41775. /**
  41776. * Resets the last animation time frame.
  41777. * Useful to override when animations start running when loading a scene for the first time.
  41778. */
  41779. resetLastAnimationTimeFrame(): void;
  41780. /**
  41781. * Gets the current view matrix
  41782. * @returns a Matrix
  41783. */
  41784. getViewMatrix(): Matrix;
  41785. /**
  41786. * Gets the current projection matrix
  41787. * @returns a Matrix
  41788. */
  41789. getProjectionMatrix(): Matrix;
  41790. /**
  41791. * Gets the current transform matrix
  41792. * @returns a Matrix made of View * Projection
  41793. */
  41794. getTransformMatrix(): Matrix;
  41795. /**
  41796. * Sets the current transform matrix
  41797. * @param viewL defines the View matrix to use
  41798. * @param projectionL defines the Projection matrix to use
  41799. * @param viewR defines the right View matrix to use (if provided)
  41800. * @param projectionR defines the right Projection matrix to use (if provided)
  41801. */
  41802. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41803. /**
  41804. * Gets the uniform buffer used to store scene data
  41805. * @returns a UniformBuffer
  41806. */
  41807. getSceneUniformBuffer(): UniformBuffer;
  41808. /**
  41809. * Gets an unique (relatively to the current scene) Id
  41810. * @returns an unique number for the scene
  41811. */
  41812. getUniqueId(): number;
  41813. /**
  41814. * Add a mesh to the list of scene's meshes
  41815. * @param newMesh defines the mesh to add
  41816. * @param recursive if all child meshes should also be added to the scene
  41817. */
  41818. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41819. /**
  41820. * Remove a mesh for the list of scene's meshes
  41821. * @param toRemove defines the mesh to remove
  41822. * @param recursive if all child meshes should also be removed from the scene
  41823. * @returns the index where the mesh was in the mesh list
  41824. */
  41825. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41826. /**
  41827. * Add a transform node to the list of scene's transform nodes
  41828. * @param newTransformNode defines the transform node to add
  41829. */
  41830. addTransformNode(newTransformNode: TransformNode): void;
  41831. /**
  41832. * Remove a transform node for the list of scene's transform nodes
  41833. * @param toRemove defines the transform node to remove
  41834. * @returns the index where the transform node was in the transform node list
  41835. */
  41836. removeTransformNode(toRemove: TransformNode): number;
  41837. /**
  41838. * Remove a skeleton for the list of scene's skeletons
  41839. * @param toRemove defines the skeleton to remove
  41840. * @returns the index where the skeleton was in the skeleton list
  41841. */
  41842. removeSkeleton(toRemove: Skeleton): number;
  41843. /**
  41844. * Remove a morph target for the list of scene's morph targets
  41845. * @param toRemove defines the morph target to remove
  41846. * @returns the index where the morph target was in the morph target list
  41847. */
  41848. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41849. /**
  41850. * Remove a light for the list of scene's lights
  41851. * @param toRemove defines the light to remove
  41852. * @returns the index where the light was in the light list
  41853. */
  41854. removeLight(toRemove: Light): number;
  41855. /**
  41856. * Remove a camera for the list of scene's cameras
  41857. * @param toRemove defines the camera to remove
  41858. * @returns the index where the camera was in the camera list
  41859. */
  41860. removeCamera(toRemove: Camera): number;
  41861. /**
  41862. * Remove a particle system for the list of scene's particle systems
  41863. * @param toRemove defines the particle system to remove
  41864. * @returns the index where the particle system was in the particle system list
  41865. */
  41866. removeParticleSystem(toRemove: IParticleSystem): number;
  41867. /**
  41868. * Remove a animation for the list of scene's animations
  41869. * @param toRemove defines the animation to remove
  41870. * @returns the index where the animation was in the animation list
  41871. */
  41872. removeAnimation(toRemove: Animation): number;
  41873. /**
  41874. * Will stop the animation of the given target
  41875. * @param target - the target
  41876. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41877. * @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)
  41878. */
  41879. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41880. /**
  41881. * Removes the given animation group from this scene.
  41882. * @param toRemove The animation group to remove
  41883. * @returns The index of the removed animation group
  41884. */
  41885. removeAnimationGroup(toRemove: AnimationGroup): number;
  41886. /**
  41887. * Removes the given multi-material from this scene.
  41888. * @param toRemove The multi-material to remove
  41889. * @returns The index of the removed multi-material
  41890. */
  41891. removeMultiMaterial(toRemove: MultiMaterial): number;
  41892. /**
  41893. * Removes the given material from this scene.
  41894. * @param toRemove The material to remove
  41895. * @returns The index of the removed material
  41896. */
  41897. removeMaterial(toRemove: Material): number;
  41898. /**
  41899. * Removes the given action manager from this scene.
  41900. * @param toRemove The action manager to remove
  41901. * @returns The index of the removed action manager
  41902. */
  41903. removeActionManager(toRemove: AbstractActionManager): number;
  41904. /**
  41905. * Removes the given texture from this scene.
  41906. * @param toRemove The texture to remove
  41907. * @returns The index of the removed texture
  41908. */
  41909. removeTexture(toRemove: BaseTexture): number;
  41910. /**
  41911. * Adds the given light to this scene
  41912. * @param newLight The light to add
  41913. */
  41914. addLight(newLight: Light): void;
  41915. /**
  41916. * Sorts the list list based on light priorities
  41917. */
  41918. sortLightsByPriority(): void;
  41919. /**
  41920. * Adds the given camera to this scene
  41921. * @param newCamera The camera to add
  41922. */
  41923. addCamera(newCamera: Camera): void;
  41924. /**
  41925. * Adds the given skeleton to this scene
  41926. * @param newSkeleton The skeleton to add
  41927. */
  41928. addSkeleton(newSkeleton: Skeleton): void;
  41929. /**
  41930. * Adds the given particle system to this scene
  41931. * @param newParticleSystem The particle system to add
  41932. */
  41933. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41934. /**
  41935. * Adds the given animation to this scene
  41936. * @param newAnimation The animation to add
  41937. */
  41938. addAnimation(newAnimation: Animation): void;
  41939. /**
  41940. * Adds the given animation group to this scene.
  41941. * @param newAnimationGroup The animation group to add
  41942. */
  41943. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41944. /**
  41945. * Adds the given multi-material to this scene
  41946. * @param newMultiMaterial The multi-material to add
  41947. */
  41948. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41949. /**
  41950. * Adds the given material to this scene
  41951. * @param newMaterial The material to add
  41952. */
  41953. addMaterial(newMaterial: Material): void;
  41954. /**
  41955. * Adds the given morph target to this scene
  41956. * @param newMorphTargetManager The morph target to add
  41957. */
  41958. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41959. /**
  41960. * Adds the given geometry to this scene
  41961. * @param newGeometry The geometry to add
  41962. */
  41963. addGeometry(newGeometry: Geometry): void;
  41964. /**
  41965. * Adds the given action manager to this scene
  41966. * @param newActionManager The action manager to add
  41967. */
  41968. addActionManager(newActionManager: AbstractActionManager): void;
  41969. /**
  41970. * Adds the given texture to this scene.
  41971. * @param newTexture The texture to add
  41972. */
  41973. addTexture(newTexture: BaseTexture): void;
  41974. /**
  41975. * Switch active camera
  41976. * @param newCamera defines the new active camera
  41977. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41978. */
  41979. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  41980. /**
  41981. * sets the active camera of the scene using its ID
  41982. * @param id defines the camera's ID
  41983. * @return the new active camera or null if none found.
  41984. */
  41985. setActiveCameraByID(id: string): Nullable<Camera>;
  41986. /**
  41987. * sets the active camera of the scene using its name
  41988. * @param name defines the camera's name
  41989. * @returns the new active camera or null if none found.
  41990. */
  41991. setActiveCameraByName(name: string): Nullable<Camera>;
  41992. /**
  41993. * get an animation group using its name
  41994. * @param name defines the material's name
  41995. * @return the animation group or null if none found.
  41996. */
  41997. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  41998. /**
  41999. * Get a material using its unique id
  42000. * @param uniqueId defines the material's unique id
  42001. * @return the material or null if none found.
  42002. */
  42003. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42004. /**
  42005. * get a material using its id
  42006. * @param id defines the material's ID
  42007. * @return the material or null if none found.
  42008. */
  42009. getMaterialByID(id: string): Nullable<Material>;
  42010. /**
  42011. * Gets a the last added material using a given id
  42012. * @param id defines the material's ID
  42013. * @return the last material with the given id or null if none found.
  42014. */
  42015. getLastMaterialByID(id: string): Nullable<Material>;
  42016. /**
  42017. * Gets a material using its name
  42018. * @param name defines the material's name
  42019. * @return the material or null if none found.
  42020. */
  42021. getMaterialByName(name: string): Nullable<Material>;
  42022. /**
  42023. * Get a texture using its unique id
  42024. * @param uniqueId defines the texture's unique id
  42025. * @return the texture or null if none found.
  42026. */
  42027. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42028. /**
  42029. * Gets a camera using its id
  42030. * @param id defines the id to look for
  42031. * @returns the camera or null if not found
  42032. */
  42033. getCameraByID(id: string): Nullable<Camera>;
  42034. /**
  42035. * Gets a camera using its unique id
  42036. * @param uniqueId defines the unique id to look for
  42037. * @returns the camera or null if not found
  42038. */
  42039. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42040. /**
  42041. * Gets a camera using its name
  42042. * @param name defines the camera's name
  42043. * @return the camera or null if none found.
  42044. */
  42045. getCameraByName(name: string): Nullable<Camera>;
  42046. /**
  42047. * Gets a bone using its id
  42048. * @param id defines the bone's id
  42049. * @return the bone or null if not found
  42050. */
  42051. getBoneByID(id: string): Nullable<Bone>;
  42052. /**
  42053. * Gets a bone using its id
  42054. * @param name defines the bone's name
  42055. * @return the bone or null if not found
  42056. */
  42057. getBoneByName(name: string): Nullable<Bone>;
  42058. /**
  42059. * Gets a light node using its name
  42060. * @param name defines the the light's name
  42061. * @return the light or null if none found.
  42062. */
  42063. getLightByName(name: string): Nullable<Light>;
  42064. /**
  42065. * Gets a light node using its id
  42066. * @param id defines the light's id
  42067. * @return the light or null if none found.
  42068. */
  42069. getLightByID(id: string): Nullable<Light>;
  42070. /**
  42071. * Gets a light node using its scene-generated unique ID
  42072. * @param uniqueId defines the light's unique id
  42073. * @return the light or null if none found.
  42074. */
  42075. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42076. /**
  42077. * Gets a particle system by id
  42078. * @param id defines the particle system id
  42079. * @return the corresponding system or null if none found
  42080. */
  42081. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42082. /**
  42083. * Gets a geometry using its ID
  42084. * @param id defines the geometry's id
  42085. * @return the geometry or null if none found.
  42086. */
  42087. getGeometryByID(id: string): Nullable<Geometry>;
  42088. private _getGeometryByUniqueID;
  42089. /**
  42090. * Add a new geometry to this scene
  42091. * @param geometry defines the geometry to be added to the scene.
  42092. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42093. * @return a boolean defining if the geometry was added or not
  42094. */
  42095. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42096. /**
  42097. * Removes an existing geometry
  42098. * @param geometry defines the geometry to be removed from the scene
  42099. * @return a boolean defining if the geometry was removed or not
  42100. */
  42101. removeGeometry(geometry: Geometry): boolean;
  42102. /**
  42103. * Gets the list of geometries attached to the scene
  42104. * @returns an array of Geometry
  42105. */
  42106. getGeometries(): Geometry[];
  42107. /**
  42108. * Gets the first added mesh found of a given ID
  42109. * @param id defines the id to search for
  42110. * @return the mesh found or null if not found at all
  42111. */
  42112. getMeshByID(id: string): Nullable<AbstractMesh>;
  42113. /**
  42114. * Gets a list of meshes using their id
  42115. * @param id defines the id to search for
  42116. * @returns a list of meshes
  42117. */
  42118. getMeshesByID(id: string): Array<AbstractMesh>;
  42119. /**
  42120. * Gets the first added transform node found of a given ID
  42121. * @param id defines the id to search for
  42122. * @return the found transform node or null if not found at all.
  42123. */
  42124. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42125. /**
  42126. * Gets a transform node with its auto-generated unique id
  42127. * @param uniqueId efines the unique id to search for
  42128. * @return the found transform node or null if not found at all.
  42129. */
  42130. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42131. /**
  42132. * Gets a list of transform nodes using their id
  42133. * @param id defines the id to search for
  42134. * @returns a list of transform nodes
  42135. */
  42136. getTransformNodesByID(id: string): Array<TransformNode>;
  42137. /**
  42138. * Gets a mesh with its auto-generated unique id
  42139. * @param uniqueId defines the unique id to search for
  42140. * @return the found mesh or null if not found at all.
  42141. */
  42142. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42143. /**
  42144. * Gets a the last added mesh using a given id
  42145. * @param id defines the id to search for
  42146. * @return the found mesh or null if not found at all.
  42147. */
  42148. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42149. /**
  42150. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42151. * @param id defines the id to search for
  42152. * @return the found node or null if not found at all
  42153. */
  42154. getLastEntryByID(id: string): Nullable<Node>;
  42155. /**
  42156. * Gets a node (Mesh, Camera, Light) using a given id
  42157. * @param id defines the id to search for
  42158. * @return the found node or null if not found at all
  42159. */
  42160. getNodeByID(id: string): Nullable<Node>;
  42161. /**
  42162. * Gets a node (Mesh, Camera, Light) using a given name
  42163. * @param name defines the name to search for
  42164. * @return the found node or null if not found at all.
  42165. */
  42166. getNodeByName(name: string): Nullable<Node>;
  42167. /**
  42168. * Gets a mesh using a given name
  42169. * @param name defines the name to search for
  42170. * @return the found mesh or null if not found at all.
  42171. */
  42172. getMeshByName(name: string): Nullable<AbstractMesh>;
  42173. /**
  42174. * Gets a transform node using a given name
  42175. * @param name defines the name to search for
  42176. * @return the found transform node or null if not found at all.
  42177. */
  42178. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42179. /**
  42180. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42181. * @param id defines the id to search for
  42182. * @return the found skeleton or null if not found at all.
  42183. */
  42184. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42185. /**
  42186. * Gets a skeleton using a given auto generated unique id
  42187. * @param uniqueId defines the unique id to search for
  42188. * @return the found skeleton or null if not found at all.
  42189. */
  42190. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42191. /**
  42192. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42193. * @param id defines the id to search for
  42194. * @return the found skeleton or null if not found at all.
  42195. */
  42196. getSkeletonById(id: string): Nullable<Skeleton>;
  42197. /**
  42198. * Gets a skeleton using a given name
  42199. * @param name defines the name to search for
  42200. * @return the found skeleton or null if not found at all.
  42201. */
  42202. getSkeletonByName(name: string): Nullable<Skeleton>;
  42203. /**
  42204. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42205. * @param id defines the id to search for
  42206. * @return the found morph target manager or null if not found at all.
  42207. */
  42208. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42209. /**
  42210. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42211. * @param id defines the id to search for
  42212. * @return the found morph target or null if not found at all.
  42213. */
  42214. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42215. /**
  42216. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42217. * @param name defines the name to search for
  42218. * @return the found morph target or null if not found at all.
  42219. */
  42220. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42221. /**
  42222. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42223. * @param name defines the name to search for
  42224. * @return the found post process or null if not found at all.
  42225. */
  42226. getPostProcessByName(name: string): Nullable<PostProcess>;
  42227. /**
  42228. * Gets a boolean indicating if the given mesh is active
  42229. * @param mesh defines the mesh to look for
  42230. * @returns true if the mesh is in the active list
  42231. */
  42232. isActiveMesh(mesh: AbstractMesh): boolean;
  42233. /**
  42234. * Return a unique id as a string which can serve as an identifier for the scene
  42235. */
  42236. get uid(): string;
  42237. /**
  42238. * Add an externaly attached data from its key.
  42239. * This method call will fail and return false, if such key already exists.
  42240. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42241. * @param key the unique key that identifies the data
  42242. * @param data the data object to associate to the key for this Engine instance
  42243. * @return true if no such key were already present and the data was added successfully, false otherwise
  42244. */
  42245. addExternalData<T>(key: string, data: T): boolean;
  42246. /**
  42247. * Get an externaly attached data from its key
  42248. * @param key the unique key that identifies the data
  42249. * @return the associated data, if present (can be null), or undefined if not present
  42250. */
  42251. getExternalData<T>(key: string): Nullable<T>;
  42252. /**
  42253. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42254. * @param key the unique key that identifies the data
  42255. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42256. * @return the associated data, can be null if the factory returned null.
  42257. */
  42258. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42259. /**
  42260. * Remove an externaly attached data from the Engine instance
  42261. * @param key the unique key that identifies the data
  42262. * @return true if the data was successfully removed, false if it doesn't exist
  42263. */
  42264. removeExternalData(key: string): boolean;
  42265. private _evaluateSubMesh;
  42266. /**
  42267. * Clear the processed materials smart array preventing retention point in material dispose.
  42268. */
  42269. freeProcessedMaterials(): void;
  42270. private _preventFreeActiveMeshesAndRenderingGroups;
  42271. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42272. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42273. * when disposing several meshes in a row or a hierarchy of meshes.
  42274. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42275. */
  42276. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42277. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42278. /**
  42279. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42280. */
  42281. freeActiveMeshes(): void;
  42282. /**
  42283. * Clear the info related to rendering groups preventing retention points during dispose.
  42284. */
  42285. freeRenderingGroups(): void;
  42286. /** @hidden */
  42287. _isInIntermediateRendering(): boolean;
  42288. /**
  42289. * Lambda returning the list of potentially active meshes.
  42290. */
  42291. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42292. /**
  42293. * Lambda returning the list of potentially active sub meshes.
  42294. */
  42295. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42296. /**
  42297. * Lambda returning the list of potentially intersecting sub meshes.
  42298. */
  42299. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42300. /**
  42301. * Lambda returning the list of potentially colliding sub meshes.
  42302. */
  42303. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42304. private _activeMeshesFrozen;
  42305. private _skipEvaluateActiveMeshesCompletely;
  42306. /**
  42307. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42308. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42309. * @returns the current scene
  42310. */
  42311. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42312. /**
  42313. * Use this function to restart evaluating active meshes on every frame
  42314. * @returns the current scene
  42315. */
  42316. unfreezeActiveMeshes(): Scene;
  42317. private _evaluateActiveMeshes;
  42318. private _activeMesh;
  42319. /**
  42320. * Update the transform matrix to update from the current active camera
  42321. * @param force defines a boolean used to force the update even if cache is up to date
  42322. */
  42323. updateTransformMatrix(force?: boolean): void;
  42324. private _bindFrameBuffer;
  42325. /** @hidden */
  42326. _allowPostProcessClearColor: boolean;
  42327. /** @hidden */
  42328. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42329. private _processSubCameras;
  42330. private _checkIntersections;
  42331. /** @hidden */
  42332. _advancePhysicsEngineStep(step: number): void;
  42333. /**
  42334. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42335. */
  42336. getDeterministicFrameTime: () => number;
  42337. /** @hidden */
  42338. _animate(): void;
  42339. /** Execute all animations (for a frame) */
  42340. animate(): void;
  42341. /**
  42342. * Render the scene
  42343. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42344. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42345. */
  42346. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42347. /**
  42348. * Freeze all materials
  42349. * A frozen material will not be updatable but should be faster to render
  42350. */
  42351. freezeMaterials(): void;
  42352. /**
  42353. * Unfreeze all materials
  42354. * A frozen material will not be updatable but should be faster to render
  42355. */
  42356. unfreezeMaterials(): void;
  42357. /**
  42358. * Releases all held ressources
  42359. */
  42360. dispose(): void;
  42361. /**
  42362. * Gets if the scene is already disposed
  42363. */
  42364. get isDisposed(): boolean;
  42365. /**
  42366. * Call this function to reduce memory footprint of the scene.
  42367. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42368. */
  42369. clearCachedVertexData(): void;
  42370. /**
  42371. * This function will remove the local cached buffer data from texture.
  42372. * It will save memory but will prevent the texture from being rebuilt
  42373. */
  42374. cleanCachedTextureBuffer(): void;
  42375. /**
  42376. * Get the world extend vectors with an optional filter
  42377. *
  42378. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42379. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42380. */
  42381. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42382. min: Vector3;
  42383. max: Vector3;
  42384. };
  42385. /**
  42386. * Creates a ray that can be used to pick in the scene
  42387. * @param x defines the x coordinate of the origin (on-screen)
  42388. * @param y defines the y coordinate of the origin (on-screen)
  42389. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42390. * @param camera defines the camera to use for the picking
  42391. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42392. * @returns a Ray
  42393. */
  42394. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42395. /**
  42396. * Creates a ray that can be used to pick in the scene
  42397. * @param x defines the x coordinate of the origin (on-screen)
  42398. * @param y defines the y coordinate of the origin (on-screen)
  42399. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42400. * @param result defines the ray where to store the picking ray
  42401. * @param camera defines the camera to use for the picking
  42402. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42403. * @returns the current scene
  42404. */
  42405. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42406. /**
  42407. * Creates a ray that can be used to pick in the scene
  42408. * @param x defines the x coordinate of the origin (on-screen)
  42409. * @param y defines the y coordinate of the origin (on-screen)
  42410. * @param camera defines the camera to use for the picking
  42411. * @returns a Ray
  42412. */
  42413. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42414. /**
  42415. * Creates a ray that can be used to pick in the scene
  42416. * @param x defines the x coordinate of the origin (on-screen)
  42417. * @param y defines the y coordinate of the origin (on-screen)
  42418. * @param result defines the ray where to store the picking ray
  42419. * @param camera defines the camera to use for the picking
  42420. * @returns the current scene
  42421. */
  42422. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42423. /** Launch a ray to try to pick a mesh in the scene
  42424. * @param x position on screen
  42425. * @param y position on screen
  42426. * @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
  42427. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42428. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42429. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42430. * @returns a PickingInfo
  42431. */
  42432. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42433. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42434. * @param x position on screen
  42435. * @param y position on screen
  42436. * @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
  42437. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42438. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42439. * @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)
  42440. */
  42441. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42442. /** Use the given ray to pick a mesh in the scene
  42443. * @param ray The ray to use to pick meshes
  42444. * @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
  42445. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42446. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42447. * @returns a PickingInfo
  42448. */
  42449. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42450. /**
  42451. * Launch a ray to try to pick a mesh in the scene
  42452. * @param x X position on screen
  42453. * @param y 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 camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42456. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42457. * @returns an array of PickingInfo
  42458. */
  42459. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42460. /**
  42461. * Launch a ray to try to pick a mesh in the scene
  42462. * @param ray Ray to use
  42463. * @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
  42464. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42465. * @returns an array of PickingInfo
  42466. */
  42467. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42468. /**
  42469. * Force the value of meshUnderPointer
  42470. * @param mesh defines the mesh to use
  42471. */
  42472. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  42473. /**
  42474. * Gets the mesh under the pointer
  42475. * @returns a Mesh or null if no mesh is under the pointer
  42476. */
  42477. getPointerOverMesh(): Nullable<AbstractMesh>;
  42478. /** @hidden */
  42479. _rebuildGeometries(): void;
  42480. /** @hidden */
  42481. _rebuildTextures(): void;
  42482. private _getByTags;
  42483. /**
  42484. * Get a list of meshes by tags
  42485. * @param tagsQuery defines the tags query to use
  42486. * @param forEach defines a predicate used to filter results
  42487. * @returns an array of Mesh
  42488. */
  42489. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42490. /**
  42491. * Get a list of cameras by tags
  42492. * @param tagsQuery defines the tags query to use
  42493. * @param forEach defines a predicate used to filter results
  42494. * @returns an array of Camera
  42495. */
  42496. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42497. /**
  42498. * Get a list of lights by tags
  42499. * @param tagsQuery defines the tags query to use
  42500. * @param forEach defines a predicate used to filter results
  42501. * @returns an array of Light
  42502. */
  42503. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42504. /**
  42505. * Get a list of materials by tags
  42506. * @param tagsQuery defines the tags query to use
  42507. * @param forEach defines a predicate used to filter results
  42508. * @returns an array of Material
  42509. */
  42510. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42511. /**
  42512. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42513. * This allowed control for front to back rendering or reversly depending of the special needs.
  42514. *
  42515. * @param renderingGroupId The rendering group id corresponding to its index
  42516. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42517. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42518. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42519. */
  42520. 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;
  42521. /**
  42522. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42523. *
  42524. * @param renderingGroupId The rendering group id corresponding to its index
  42525. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42526. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42527. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42528. */
  42529. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42530. /**
  42531. * Gets the current auto clear configuration for one rendering group of the rendering
  42532. * manager.
  42533. * @param index the rendering group index to get the information for
  42534. * @returns The auto clear setup for the requested rendering group
  42535. */
  42536. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42537. private _blockMaterialDirtyMechanism;
  42538. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42539. get blockMaterialDirtyMechanism(): boolean;
  42540. set blockMaterialDirtyMechanism(value: boolean);
  42541. /**
  42542. * Will flag all materials as dirty to trigger new shader compilation
  42543. * @param flag defines the flag used to specify which material part must be marked as dirty
  42544. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42545. */
  42546. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42547. /** @hidden */
  42548. _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;
  42549. /** @hidden */
  42550. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42551. /** @hidden */
  42552. _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;
  42553. /** @hidden */
  42554. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42555. /** @hidden */
  42556. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42557. /** @hidden */
  42558. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42559. }
  42560. }
  42561. declare module "babylonjs/assetContainer" {
  42562. import { AbstractScene } from "babylonjs/abstractScene";
  42563. import { Scene } from "babylonjs/scene";
  42564. import { Mesh } from "babylonjs/Meshes/mesh";
  42565. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42566. import { Skeleton } from "babylonjs/Bones/skeleton";
  42567. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42568. import { Animatable } from "babylonjs/Animations/animatable";
  42569. import { Nullable } from "babylonjs/types";
  42570. import { Node } from "babylonjs/node";
  42571. /**
  42572. * Set of assets to keep when moving a scene into an asset container.
  42573. */
  42574. export class KeepAssets extends AbstractScene {
  42575. }
  42576. /**
  42577. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42578. */
  42579. export class InstantiatedEntries {
  42580. /**
  42581. * List of new root nodes (eg. nodes with no parent)
  42582. */
  42583. rootNodes: TransformNode[];
  42584. /**
  42585. * List of new skeletons
  42586. */
  42587. skeletons: Skeleton[];
  42588. /**
  42589. * List of new animation groups
  42590. */
  42591. animationGroups: AnimationGroup[];
  42592. }
  42593. /**
  42594. * Container with a set of assets that can be added or removed from a scene.
  42595. */
  42596. export class AssetContainer extends AbstractScene {
  42597. private _wasAddedToScene;
  42598. /**
  42599. * The scene the AssetContainer belongs to.
  42600. */
  42601. scene: Scene;
  42602. /**
  42603. * Instantiates an AssetContainer.
  42604. * @param scene The scene the AssetContainer belongs to.
  42605. */
  42606. constructor(scene: Scene);
  42607. /**
  42608. * Instantiate or clone all meshes and add the new ones to the scene.
  42609. * Skeletons and animation groups will all be cloned
  42610. * @param nameFunction defines an optional function used to get new names for clones
  42611. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42612. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42613. */
  42614. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42615. /**
  42616. * Adds all the assets from the container to the scene.
  42617. */
  42618. addAllToScene(): void;
  42619. /**
  42620. * Removes all the assets in the container from the scene
  42621. */
  42622. removeAllFromScene(): void;
  42623. /**
  42624. * Disposes all the assets in the container
  42625. */
  42626. dispose(): void;
  42627. private _moveAssets;
  42628. /**
  42629. * Removes all the assets contained in the scene and adds them to the container.
  42630. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42631. */
  42632. moveAllFromScene(keepAssets?: KeepAssets): void;
  42633. /**
  42634. * 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.
  42635. * @returns the root mesh
  42636. */
  42637. createRootMesh(): Mesh;
  42638. /**
  42639. * Merge animations (direct and animation groups) from this asset container into a scene
  42640. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42641. * @param animatables set of animatables to retarget to a node from the scene
  42642. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42643. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42644. */
  42645. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42646. }
  42647. }
  42648. declare module "babylonjs/abstractScene" {
  42649. import { Scene } from "babylonjs/scene";
  42650. import { Nullable } from "babylonjs/types";
  42651. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42652. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42653. import { Geometry } from "babylonjs/Meshes/geometry";
  42654. import { Skeleton } from "babylonjs/Bones/skeleton";
  42655. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42656. import { AssetContainer } from "babylonjs/assetContainer";
  42657. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42658. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42659. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42660. import { Material } from "babylonjs/Materials/material";
  42661. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42662. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42663. import { Camera } from "babylonjs/Cameras/camera";
  42664. import { Light } from "babylonjs/Lights/light";
  42665. import { Node } from "babylonjs/node";
  42666. import { Animation } from "babylonjs/Animations/animation";
  42667. /**
  42668. * Defines how the parser contract is defined.
  42669. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42670. */
  42671. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42672. /**
  42673. * Defines how the individual parser contract is defined.
  42674. * These parser can parse an individual asset
  42675. */
  42676. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42677. /**
  42678. * Base class of the scene acting as a container for the different elements composing a scene.
  42679. * This class is dynamically extended by the different components of the scene increasing
  42680. * flexibility and reducing coupling
  42681. */
  42682. export abstract class AbstractScene {
  42683. /**
  42684. * Stores the list of available parsers in the application.
  42685. */
  42686. private static _BabylonFileParsers;
  42687. /**
  42688. * Stores the list of available individual parsers in the application.
  42689. */
  42690. private static _IndividualBabylonFileParsers;
  42691. /**
  42692. * Adds a parser in the list of available ones
  42693. * @param name Defines the name of the parser
  42694. * @param parser Defines the parser to add
  42695. */
  42696. static AddParser(name: string, parser: BabylonFileParser): void;
  42697. /**
  42698. * Gets a general parser from the list of avaialble ones
  42699. * @param name Defines the name of the parser
  42700. * @returns the requested parser or null
  42701. */
  42702. static GetParser(name: string): Nullable<BabylonFileParser>;
  42703. /**
  42704. * Adds n individual parser in the list of available ones
  42705. * @param name Defines the name of the parser
  42706. * @param parser Defines the parser to add
  42707. */
  42708. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42709. /**
  42710. * Gets an individual parser from the list of avaialble ones
  42711. * @param name Defines the name of the parser
  42712. * @returns the requested parser or null
  42713. */
  42714. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42715. /**
  42716. * Parser json data and populate both a scene and its associated container object
  42717. * @param jsonData Defines the data to parse
  42718. * @param scene Defines the scene to parse the data for
  42719. * @param container Defines the container attached to the parsing sequence
  42720. * @param rootUrl Defines the root url of the data
  42721. */
  42722. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42723. /**
  42724. * Gets the list of root nodes (ie. nodes with no parent)
  42725. */
  42726. rootNodes: Node[];
  42727. /** All of the cameras added to this scene
  42728. * @see https://doc.babylonjs.com/babylon101/cameras
  42729. */
  42730. cameras: Camera[];
  42731. /**
  42732. * All of the lights added to this scene
  42733. * @see https://doc.babylonjs.com/babylon101/lights
  42734. */
  42735. lights: Light[];
  42736. /**
  42737. * All of the (abstract) meshes added to this scene
  42738. */
  42739. meshes: AbstractMesh[];
  42740. /**
  42741. * The list of skeletons added to the scene
  42742. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42743. */
  42744. skeletons: Skeleton[];
  42745. /**
  42746. * All of the particle systems added to this scene
  42747. * @see https://doc.babylonjs.com/babylon101/particles
  42748. */
  42749. particleSystems: IParticleSystem[];
  42750. /**
  42751. * Gets a list of Animations associated with the scene
  42752. */
  42753. animations: Animation[];
  42754. /**
  42755. * All of the animation groups added to this scene
  42756. * @see https://doc.babylonjs.com/how_to/group
  42757. */
  42758. animationGroups: AnimationGroup[];
  42759. /**
  42760. * All of the multi-materials added to this scene
  42761. * @see https://doc.babylonjs.com/how_to/multi_materials
  42762. */
  42763. multiMaterials: MultiMaterial[];
  42764. /**
  42765. * All of the materials added to this scene
  42766. * In the context of a Scene, it is not supposed to be modified manually.
  42767. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42768. * Note also that the order of the Material within the array is not significant and might change.
  42769. * @see https://doc.babylonjs.com/babylon101/materials
  42770. */
  42771. materials: Material[];
  42772. /**
  42773. * The list of morph target managers added to the scene
  42774. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42775. */
  42776. morphTargetManagers: MorphTargetManager[];
  42777. /**
  42778. * The list of geometries used in the scene.
  42779. */
  42780. geometries: Geometry[];
  42781. /**
  42782. * All of the tranform nodes added to this scene
  42783. * In the context of a Scene, it is not supposed to be modified manually.
  42784. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42785. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42786. * @see https://doc.babylonjs.com/how_to/transformnode
  42787. */
  42788. transformNodes: TransformNode[];
  42789. /**
  42790. * ActionManagers available on the scene.
  42791. */
  42792. actionManagers: AbstractActionManager[];
  42793. /**
  42794. * Textures to keep.
  42795. */
  42796. textures: BaseTexture[];
  42797. /**
  42798. * Environment texture for the scene
  42799. */
  42800. environmentTexture: Nullable<BaseTexture>;
  42801. /**
  42802. * The list of postprocesses added to the scene
  42803. */
  42804. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42805. /**
  42806. * @returns all meshes, lights, cameras, transformNodes and bones
  42807. */
  42808. getNodes(): Array<Node>;
  42809. }
  42810. }
  42811. declare module "babylonjs/Audio/sound" {
  42812. import { Observable } from "babylonjs/Misc/observable";
  42813. import { Vector3 } from "babylonjs/Maths/math.vector";
  42814. import { Nullable } from "babylonjs/types";
  42815. import { Scene } from "babylonjs/scene";
  42816. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42817. /**
  42818. * Interface used to define options for Sound class
  42819. */
  42820. export interface ISoundOptions {
  42821. /**
  42822. * Does the sound autoplay once loaded.
  42823. */
  42824. autoplay?: boolean;
  42825. /**
  42826. * Does the sound loop after it finishes playing once.
  42827. */
  42828. loop?: boolean;
  42829. /**
  42830. * Sound's volume
  42831. */
  42832. volume?: number;
  42833. /**
  42834. * Is it a spatial sound?
  42835. */
  42836. spatialSound?: boolean;
  42837. /**
  42838. * Maximum distance to hear that sound
  42839. */
  42840. maxDistance?: number;
  42841. /**
  42842. * Uses user defined attenuation function
  42843. */
  42844. useCustomAttenuation?: boolean;
  42845. /**
  42846. * Define the roll off factor of spatial sounds.
  42847. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42848. */
  42849. rolloffFactor?: number;
  42850. /**
  42851. * Define the reference distance the sound should be heard perfectly.
  42852. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42853. */
  42854. refDistance?: number;
  42855. /**
  42856. * Define the distance attenuation model the sound will follow.
  42857. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42858. */
  42859. distanceModel?: string;
  42860. /**
  42861. * Defines the playback speed (1 by default)
  42862. */
  42863. playbackRate?: number;
  42864. /**
  42865. * Defines if the sound is from a streaming source
  42866. */
  42867. streaming?: boolean;
  42868. /**
  42869. * Defines an optional length (in seconds) inside the sound file
  42870. */
  42871. length?: number;
  42872. /**
  42873. * Defines an optional offset (in seconds) inside the sound file
  42874. */
  42875. offset?: number;
  42876. /**
  42877. * If true, URLs will not be required to state the audio file codec to use.
  42878. */
  42879. skipCodecCheck?: boolean;
  42880. }
  42881. /**
  42882. * Defines a sound that can be played in the application.
  42883. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42884. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42885. */
  42886. export class Sound {
  42887. /**
  42888. * The name of the sound in the scene.
  42889. */
  42890. name: string;
  42891. /**
  42892. * Does the sound autoplay once loaded.
  42893. */
  42894. autoplay: boolean;
  42895. /**
  42896. * Does the sound loop after it finishes playing once.
  42897. */
  42898. loop: boolean;
  42899. /**
  42900. * Does the sound use a custom attenuation curve to simulate the falloff
  42901. * happening when the source gets further away from the camera.
  42902. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42903. */
  42904. useCustomAttenuation: boolean;
  42905. /**
  42906. * The sound track id this sound belongs to.
  42907. */
  42908. soundTrackId: number;
  42909. /**
  42910. * Is this sound currently played.
  42911. */
  42912. isPlaying: boolean;
  42913. /**
  42914. * Is this sound currently paused.
  42915. */
  42916. isPaused: boolean;
  42917. /**
  42918. * Does this sound enables spatial sound.
  42919. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42920. */
  42921. spatialSound: boolean;
  42922. /**
  42923. * Define the reference distance the sound should be heard perfectly.
  42924. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42925. */
  42926. refDistance: number;
  42927. /**
  42928. * Define the roll off factor of spatial sounds.
  42929. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42930. */
  42931. rolloffFactor: number;
  42932. /**
  42933. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42934. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42935. */
  42936. maxDistance: number;
  42937. /**
  42938. * Define the distance attenuation model the sound will follow.
  42939. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42940. */
  42941. distanceModel: string;
  42942. /**
  42943. * @hidden
  42944. * Back Compat
  42945. **/
  42946. onended: () => any;
  42947. /**
  42948. * Gets or sets an object used to store user defined information for the sound.
  42949. */
  42950. metadata: any;
  42951. /**
  42952. * Observable event when the current playing sound finishes.
  42953. */
  42954. onEndedObservable: Observable<Sound>;
  42955. private _panningModel;
  42956. private _playbackRate;
  42957. private _streaming;
  42958. private _startTime;
  42959. private _startOffset;
  42960. private _position;
  42961. /** @hidden */
  42962. _positionInEmitterSpace: boolean;
  42963. private _localDirection;
  42964. private _volume;
  42965. private _isReadyToPlay;
  42966. private _isDirectional;
  42967. private _readyToPlayCallback;
  42968. private _audioBuffer;
  42969. private _soundSource;
  42970. private _streamingSource;
  42971. private _soundPanner;
  42972. private _soundGain;
  42973. private _inputAudioNode;
  42974. private _outputAudioNode;
  42975. private _coneInnerAngle;
  42976. private _coneOuterAngle;
  42977. private _coneOuterGain;
  42978. private _scene;
  42979. private _connectedTransformNode;
  42980. private _customAttenuationFunction;
  42981. private _registerFunc;
  42982. private _isOutputConnected;
  42983. private _htmlAudioElement;
  42984. private _urlType;
  42985. private _length?;
  42986. private _offset?;
  42987. /** @hidden */
  42988. static _SceneComponentInitialization: (scene: Scene) => void;
  42989. /**
  42990. * Create a sound and attach it to a scene
  42991. * @param name Name of your sound
  42992. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  42993. * @param scene defines the scene the sound belongs to
  42994. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  42995. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  42996. */
  42997. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  42998. /**
  42999. * Release the sound and its associated resources
  43000. */
  43001. dispose(): void;
  43002. /**
  43003. * Gets if the sounds is ready to be played or not.
  43004. * @returns true if ready, otherwise false
  43005. */
  43006. isReady(): boolean;
  43007. private _soundLoaded;
  43008. /**
  43009. * Sets the data of the sound from an audiobuffer
  43010. * @param audioBuffer The audioBuffer containing the data
  43011. */
  43012. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43013. /**
  43014. * Updates the current sounds options such as maxdistance, loop...
  43015. * @param options A JSON object containing values named as the object properties
  43016. */
  43017. updateOptions(options: ISoundOptions): void;
  43018. private _createSpatialParameters;
  43019. private _updateSpatialParameters;
  43020. /**
  43021. * Switch the panning model to HRTF:
  43022. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43023. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43024. */
  43025. switchPanningModelToHRTF(): void;
  43026. /**
  43027. * Switch the panning model to Equal Power:
  43028. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43029. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43030. */
  43031. switchPanningModelToEqualPower(): void;
  43032. private _switchPanningModel;
  43033. /**
  43034. * Connect this sound to a sound track audio node like gain...
  43035. * @param soundTrackAudioNode the sound track audio node to connect to
  43036. */
  43037. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43038. /**
  43039. * Transform this sound into a directional source
  43040. * @param coneInnerAngle Size of the inner cone in degree
  43041. * @param coneOuterAngle Size of the outer cone in degree
  43042. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43043. */
  43044. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43045. /**
  43046. * Gets or sets the inner angle for the directional cone.
  43047. */
  43048. get directionalConeInnerAngle(): number;
  43049. /**
  43050. * Gets or sets the inner angle for the directional cone.
  43051. */
  43052. set directionalConeInnerAngle(value: number);
  43053. /**
  43054. * Gets or sets the outer angle for the directional cone.
  43055. */
  43056. get directionalConeOuterAngle(): number;
  43057. /**
  43058. * Gets or sets the outer angle for the directional cone.
  43059. */
  43060. set directionalConeOuterAngle(value: number);
  43061. /**
  43062. * Sets the position of the emitter if spatial sound is enabled
  43063. * @param newPosition Defines the new posisiton
  43064. */
  43065. setPosition(newPosition: Vector3): void;
  43066. /**
  43067. * Sets the local direction of the emitter if spatial sound is enabled
  43068. * @param newLocalDirection Defines the new local direction
  43069. */
  43070. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43071. private _updateDirection;
  43072. /** @hidden */
  43073. updateDistanceFromListener(): void;
  43074. /**
  43075. * Sets a new custom attenuation function for the sound.
  43076. * @param callback Defines the function used for the attenuation
  43077. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43078. */
  43079. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43080. /**
  43081. * Play the sound
  43082. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43083. * @param offset (optional) Start the sound at a specific time in seconds
  43084. * @param length (optional) Sound duration (in seconds)
  43085. */
  43086. play(time?: number, offset?: number, length?: number): void;
  43087. private _onended;
  43088. /**
  43089. * Stop the sound
  43090. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43091. */
  43092. stop(time?: number): void;
  43093. /**
  43094. * Put the sound in pause
  43095. */
  43096. pause(): void;
  43097. /**
  43098. * Sets a dedicated volume for this sounds
  43099. * @param newVolume Define the new volume of the sound
  43100. * @param time Define time for gradual change to new volume
  43101. */
  43102. setVolume(newVolume: number, time?: number): void;
  43103. /**
  43104. * Set the sound play back rate
  43105. * @param newPlaybackRate Define the playback rate the sound should be played at
  43106. */
  43107. setPlaybackRate(newPlaybackRate: number): void;
  43108. /**
  43109. * Gets the volume of the sound.
  43110. * @returns the volume of the sound
  43111. */
  43112. getVolume(): number;
  43113. /**
  43114. * Attach the sound to a dedicated mesh
  43115. * @param transformNode The transform node to connect the sound with
  43116. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43117. */
  43118. attachToMesh(transformNode: TransformNode): void;
  43119. /**
  43120. * Detach the sound from the previously attached mesh
  43121. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43122. */
  43123. detachFromMesh(): void;
  43124. private _onRegisterAfterWorldMatrixUpdate;
  43125. /**
  43126. * Clone the current sound in the scene.
  43127. * @returns the new sound clone
  43128. */
  43129. clone(): Nullable<Sound>;
  43130. /**
  43131. * Gets the current underlying audio buffer containing the data
  43132. * @returns the audio buffer
  43133. */
  43134. getAudioBuffer(): Nullable<AudioBuffer>;
  43135. /**
  43136. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43137. * @returns the source node
  43138. */
  43139. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43140. /**
  43141. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43142. * @returns the gain node
  43143. */
  43144. getSoundGain(): Nullable<GainNode>;
  43145. /**
  43146. * Serializes the Sound in a JSON representation
  43147. * @returns the JSON representation of the sound
  43148. */
  43149. serialize(): any;
  43150. /**
  43151. * Parse a JSON representation of a sound to innstantiate in a given scene
  43152. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43153. * @param scene Define the scene the new parsed sound should be created in
  43154. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43155. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43156. * @returns the newly parsed sound
  43157. */
  43158. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43159. }
  43160. }
  43161. declare module "babylonjs/Actions/directAudioActions" {
  43162. import { Action } from "babylonjs/Actions/action";
  43163. import { Condition } from "babylonjs/Actions/condition";
  43164. import { Sound } from "babylonjs/Audio/sound";
  43165. /**
  43166. * This defines an action helpful to play a defined sound on a triggered action.
  43167. */
  43168. export class PlaySoundAction extends Action {
  43169. private _sound;
  43170. /**
  43171. * Instantiate the action
  43172. * @param triggerOptions defines the trigger options
  43173. * @param sound defines the sound to play
  43174. * @param condition defines the trigger related conditions
  43175. */
  43176. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43177. /** @hidden */
  43178. _prepare(): void;
  43179. /**
  43180. * Execute the action and play the sound.
  43181. */
  43182. execute(): void;
  43183. /**
  43184. * Serializes the actions and its related information.
  43185. * @param parent defines the object to serialize in
  43186. * @returns the serialized object
  43187. */
  43188. serialize(parent: any): any;
  43189. }
  43190. /**
  43191. * This defines an action helpful to stop a defined sound on a triggered action.
  43192. */
  43193. export class StopSoundAction extends Action {
  43194. private _sound;
  43195. /**
  43196. * Instantiate the action
  43197. * @param triggerOptions defines the trigger options
  43198. * @param sound defines the sound to stop
  43199. * @param condition defines the trigger related conditions
  43200. */
  43201. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43202. /** @hidden */
  43203. _prepare(): void;
  43204. /**
  43205. * Execute the action and stop the sound.
  43206. */
  43207. execute(): void;
  43208. /**
  43209. * Serializes the actions and its related information.
  43210. * @param parent defines the object to serialize in
  43211. * @returns the serialized object
  43212. */
  43213. serialize(parent: any): any;
  43214. }
  43215. }
  43216. declare module "babylonjs/Actions/interpolateValueAction" {
  43217. import { Action } from "babylonjs/Actions/action";
  43218. import { Condition } from "babylonjs/Actions/condition";
  43219. import { Observable } from "babylonjs/Misc/observable";
  43220. /**
  43221. * This defines an action responsible to change the value of a property
  43222. * by interpolating between its current value and the newly set one once triggered.
  43223. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43224. */
  43225. export class InterpolateValueAction extends Action {
  43226. /**
  43227. * Defines the path of the property where the value should be interpolated
  43228. */
  43229. propertyPath: string;
  43230. /**
  43231. * Defines the target value at the end of the interpolation.
  43232. */
  43233. value: any;
  43234. /**
  43235. * Defines the time it will take for the property to interpolate to the value.
  43236. */
  43237. duration: number;
  43238. /**
  43239. * Defines if the other scene animations should be stopped when the action has been triggered
  43240. */
  43241. stopOtherAnimations?: boolean;
  43242. /**
  43243. * Defines a callback raised once the interpolation animation has been done.
  43244. */
  43245. onInterpolationDone?: () => void;
  43246. /**
  43247. * Observable triggered once the interpolation animation has been done.
  43248. */
  43249. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43250. private _target;
  43251. private _effectiveTarget;
  43252. private _property;
  43253. /**
  43254. * Instantiate the action
  43255. * @param triggerOptions defines the trigger options
  43256. * @param target defines the object containing the value to interpolate
  43257. * @param propertyPath defines the path to the property in the target object
  43258. * @param value defines the target value at the end of the interpolation
  43259. * @param duration deines the time it will take for the property to interpolate to the value.
  43260. * @param condition defines the trigger related conditions
  43261. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43262. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43263. */
  43264. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43265. /** @hidden */
  43266. _prepare(): void;
  43267. /**
  43268. * Execute the action starts the value interpolation.
  43269. */
  43270. execute(): void;
  43271. /**
  43272. * Serializes the actions and its related information.
  43273. * @param parent defines the object to serialize in
  43274. * @returns the serialized object
  43275. */
  43276. serialize(parent: any): any;
  43277. }
  43278. }
  43279. declare module "babylonjs/Actions/index" {
  43280. export * from "babylonjs/Actions/abstractActionManager";
  43281. export * from "babylonjs/Actions/action";
  43282. export * from "babylonjs/Actions/actionEvent";
  43283. export * from "babylonjs/Actions/actionManager";
  43284. export * from "babylonjs/Actions/condition";
  43285. export * from "babylonjs/Actions/directActions";
  43286. export * from "babylonjs/Actions/directAudioActions";
  43287. export * from "babylonjs/Actions/interpolateValueAction";
  43288. }
  43289. declare module "babylonjs/Animations/index" {
  43290. export * from "babylonjs/Animations/animatable";
  43291. export * from "babylonjs/Animations/animation";
  43292. export * from "babylonjs/Animations/animationGroup";
  43293. export * from "babylonjs/Animations/animationPropertiesOverride";
  43294. export * from "babylonjs/Animations/easing";
  43295. export * from "babylonjs/Animations/runtimeAnimation";
  43296. export * from "babylonjs/Animations/animationEvent";
  43297. export * from "babylonjs/Animations/animationGroup";
  43298. export * from "babylonjs/Animations/animationKey";
  43299. export * from "babylonjs/Animations/animationRange";
  43300. export * from "babylonjs/Animations/animatable.interface";
  43301. }
  43302. declare module "babylonjs/Audio/soundTrack" {
  43303. import { Sound } from "babylonjs/Audio/sound";
  43304. import { Analyser } from "babylonjs/Audio/analyser";
  43305. import { Scene } from "babylonjs/scene";
  43306. /**
  43307. * Options allowed during the creation of a sound track.
  43308. */
  43309. export interface ISoundTrackOptions {
  43310. /**
  43311. * The volume the sound track should take during creation
  43312. */
  43313. volume?: number;
  43314. /**
  43315. * Define if the sound track is the main sound track of the scene
  43316. */
  43317. mainTrack?: boolean;
  43318. }
  43319. /**
  43320. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43321. * It will be also used in a future release to apply effects on a specific track.
  43322. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43323. */
  43324. export class SoundTrack {
  43325. /**
  43326. * The unique identifier of the sound track in the scene.
  43327. */
  43328. id: number;
  43329. /**
  43330. * The list of sounds included in the sound track.
  43331. */
  43332. soundCollection: Array<Sound>;
  43333. private _outputAudioNode;
  43334. private _scene;
  43335. private _connectedAnalyser;
  43336. private _options;
  43337. private _isInitialized;
  43338. /**
  43339. * Creates a new sound track.
  43340. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43341. * @param scene Define the scene the sound track belongs to
  43342. * @param options
  43343. */
  43344. constructor(scene: Scene, options?: ISoundTrackOptions);
  43345. private _initializeSoundTrackAudioGraph;
  43346. /**
  43347. * Release the sound track and its associated resources
  43348. */
  43349. dispose(): void;
  43350. /**
  43351. * Adds a sound to this sound track
  43352. * @param sound define the cound to add
  43353. * @ignoreNaming
  43354. */
  43355. AddSound(sound: Sound): void;
  43356. /**
  43357. * Removes a sound to this sound track
  43358. * @param sound define the cound to remove
  43359. * @ignoreNaming
  43360. */
  43361. RemoveSound(sound: Sound): void;
  43362. /**
  43363. * Set a global volume for the full sound track.
  43364. * @param newVolume Define the new volume of the sound track
  43365. */
  43366. setVolume(newVolume: number): void;
  43367. /**
  43368. * Switch the panning model to HRTF:
  43369. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43370. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43371. */
  43372. switchPanningModelToHRTF(): void;
  43373. /**
  43374. * Switch the panning model to Equal Power:
  43375. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43376. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43377. */
  43378. switchPanningModelToEqualPower(): void;
  43379. /**
  43380. * Connect the sound track to an audio analyser allowing some amazing
  43381. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43382. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43383. * @param analyser The analyser to connect to the engine
  43384. */
  43385. connectToAnalyser(analyser: Analyser): void;
  43386. }
  43387. }
  43388. declare module "babylonjs/Audio/audioSceneComponent" {
  43389. import { Sound } from "babylonjs/Audio/sound";
  43390. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43391. import { Nullable } from "babylonjs/types";
  43392. import { Vector3 } from "babylonjs/Maths/math.vector";
  43393. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43394. import { Scene } from "babylonjs/scene";
  43395. import { AbstractScene } from "babylonjs/abstractScene";
  43396. import "babylonjs/Audio/audioEngine";
  43397. module "babylonjs/abstractScene" {
  43398. interface AbstractScene {
  43399. /**
  43400. * The list of sounds used in the scene.
  43401. */
  43402. sounds: Nullable<Array<Sound>>;
  43403. }
  43404. }
  43405. module "babylonjs/scene" {
  43406. interface Scene {
  43407. /**
  43408. * @hidden
  43409. * Backing field
  43410. */
  43411. _mainSoundTrack: SoundTrack;
  43412. /**
  43413. * The main sound track played by the scene.
  43414. * It cotains your primary collection of sounds.
  43415. */
  43416. mainSoundTrack: SoundTrack;
  43417. /**
  43418. * The list of sound tracks added to the scene
  43419. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43420. */
  43421. soundTracks: Nullable<Array<SoundTrack>>;
  43422. /**
  43423. * Gets a sound using a given name
  43424. * @param name defines the name to search for
  43425. * @return the found sound or null if not found at all.
  43426. */
  43427. getSoundByName(name: string): Nullable<Sound>;
  43428. /**
  43429. * Gets or sets if audio support is enabled
  43430. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43431. */
  43432. audioEnabled: boolean;
  43433. /**
  43434. * Gets or sets if audio will be output to headphones
  43435. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43436. */
  43437. headphone: boolean;
  43438. /**
  43439. * Gets or sets custom audio listener position provider
  43440. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43441. */
  43442. audioListenerPositionProvider: Nullable<() => Vector3>;
  43443. /**
  43444. * Gets or sets a refresh rate when using 3D audio positioning
  43445. */
  43446. audioPositioningRefreshRate: number;
  43447. }
  43448. }
  43449. /**
  43450. * Defines the sound scene component responsible to manage any sounds
  43451. * in a given scene.
  43452. */
  43453. export class AudioSceneComponent implements ISceneSerializableComponent {
  43454. /**
  43455. * The component name helpfull to identify the component in the list of scene components.
  43456. */
  43457. readonly name: string;
  43458. /**
  43459. * The scene the component belongs to.
  43460. */
  43461. scene: Scene;
  43462. private _audioEnabled;
  43463. /**
  43464. * Gets whether audio is enabled or not.
  43465. * Please use related enable/disable method to switch state.
  43466. */
  43467. get audioEnabled(): boolean;
  43468. private _headphone;
  43469. /**
  43470. * Gets whether audio is outputing to headphone or not.
  43471. * Please use the according Switch methods to change output.
  43472. */
  43473. get headphone(): boolean;
  43474. /**
  43475. * Gets or sets a refresh rate when using 3D audio positioning
  43476. */
  43477. audioPositioningRefreshRate: number;
  43478. private _audioListenerPositionProvider;
  43479. /**
  43480. * Gets the current audio listener position provider
  43481. */
  43482. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43483. /**
  43484. * Sets a custom listener position for all sounds in the scene
  43485. * By default, this is the position of the first active camera
  43486. */
  43487. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43488. /**
  43489. * Creates a new instance of the component for the given scene
  43490. * @param scene Defines the scene to register the component in
  43491. */
  43492. constructor(scene: Scene);
  43493. /**
  43494. * Registers the component in a given scene
  43495. */
  43496. register(): void;
  43497. /**
  43498. * Rebuilds the elements related to this component in case of
  43499. * context lost for instance.
  43500. */
  43501. rebuild(): void;
  43502. /**
  43503. * Serializes the component data to the specified json object
  43504. * @param serializationObject The object to serialize to
  43505. */
  43506. serialize(serializationObject: any): void;
  43507. /**
  43508. * Adds all the elements from the container to the scene
  43509. * @param container the container holding the elements
  43510. */
  43511. addFromContainer(container: AbstractScene): void;
  43512. /**
  43513. * Removes all the elements in the container from the scene
  43514. * @param container contains the elements to remove
  43515. * @param dispose if the removed element should be disposed (default: false)
  43516. */
  43517. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43518. /**
  43519. * Disposes the component and the associated ressources.
  43520. */
  43521. dispose(): void;
  43522. /**
  43523. * Disables audio in the associated scene.
  43524. */
  43525. disableAudio(): void;
  43526. /**
  43527. * Enables audio in the associated scene.
  43528. */
  43529. enableAudio(): void;
  43530. /**
  43531. * Switch audio to headphone output.
  43532. */
  43533. switchAudioModeForHeadphones(): void;
  43534. /**
  43535. * Switch audio to normal speakers.
  43536. */
  43537. switchAudioModeForNormalSpeakers(): void;
  43538. private _cachedCameraDirection;
  43539. private _cachedCameraPosition;
  43540. private _lastCheck;
  43541. private _afterRender;
  43542. }
  43543. }
  43544. declare module "babylonjs/Audio/weightedsound" {
  43545. import { Sound } from "babylonjs/Audio/sound";
  43546. /**
  43547. * Wraps one or more Sound objects and selects one with random weight for playback.
  43548. */
  43549. export class WeightedSound {
  43550. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43551. loop: boolean;
  43552. private _coneInnerAngle;
  43553. private _coneOuterAngle;
  43554. private _volume;
  43555. /** A Sound is currently playing. */
  43556. isPlaying: boolean;
  43557. /** A Sound is currently paused. */
  43558. isPaused: boolean;
  43559. private _sounds;
  43560. private _weights;
  43561. private _currentIndex?;
  43562. /**
  43563. * Creates a new WeightedSound from the list of sounds given.
  43564. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43565. * @param sounds Array of Sounds that will be selected from.
  43566. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43567. */
  43568. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43569. /**
  43570. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43571. */
  43572. get directionalConeInnerAngle(): number;
  43573. /**
  43574. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43575. */
  43576. set directionalConeInnerAngle(value: number);
  43577. /**
  43578. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43579. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43580. */
  43581. get directionalConeOuterAngle(): number;
  43582. /**
  43583. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43584. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43585. */
  43586. set directionalConeOuterAngle(value: number);
  43587. /**
  43588. * Playback volume.
  43589. */
  43590. get volume(): number;
  43591. /**
  43592. * Playback volume.
  43593. */
  43594. set volume(value: number);
  43595. private _onended;
  43596. /**
  43597. * Suspend playback
  43598. */
  43599. pause(): void;
  43600. /**
  43601. * Stop playback
  43602. */
  43603. stop(): void;
  43604. /**
  43605. * Start playback.
  43606. * @param startOffset Position the clip head at a specific time in seconds.
  43607. */
  43608. play(startOffset?: number): void;
  43609. }
  43610. }
  43611. declare module "babylonjs/Audio/index" {
  43612. export * from "babylonjs/Audio/analyser";
  43613. export * from "babylonjs/Audio/audioEngine";
  43614. export * from "babylonjs/Audio/audioSceneComponent";
  43615. export * from "babylonjs/Audio/sound";
  43616. export * from "babylonjs/Audio/soundTrack";
  43617. export * from "babylonjs/Audio/weightedsound";
  43618. }
  43619. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43620. import { Behavior } from "babylonjs/Behaviors/behavior";
  43621. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43622. import { BackEase } from "babylonjs/Animations/easing";
  43623. /**
  43624. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43625. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43626. */
  43627. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43628. /**
  43629. * Gets the name of the behavior.
  43630. */
  43631. get name(): string;
  43632. /**
  43633. * The easing function used by animations
  43634. */
  43635. static EasingFunction: BackEase;
  43636. /**
  43637. * The easing mode used by animations
  43638. */
  43639. static EasingMode: number;
  43640. /**
  43641. * The duration of the animation, in milliseconds
  43642. */
  43643. transitionDuration: number;
  43644. /**
  43645. * Length of the distance animated by the transition when lower radius is reached
  43646. */
  43647. lowerRadiusTransitionRange: number;
  43648. /**
  43649. * Length of the distance animated by the transition when upper radius is reached
  43650. */
  43651. upperRadiusTransitionRange: number;
  43652. private _autoTransitionRange;
  43653. /**
  43654. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43655. */
  43656. get autoTransitionRange(): boolean;
  43657. /**
  43658. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43659. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43660. */
  43661. set autoTransitionRange(value: boolean);
  43662. private _attachedCamera;
  43663. private _onAfterCheckInputsObserver;
  43664. private _onMeshTargetChangedObserver;
  43665. /**
  43666. * Initializes the behavior.
  43667. */
  43668. init(): void;
  43669. /**
  43670. * Attaches the behavior to its arc rotate camera.
  43671. * @param camera Defines the camera to attach the behavior to
  43672. */
  43673. attach(camera: ArcRotateCamera): void;
  43674. /**
  43675. * Detaches the behavior from its current arc rotate camera.
  43676. */
  43677. detach(): void;
  43678. private _radiusIsAnimating;
  43679. private _radiusBounceTransition;
  43680. private _animatables;
  43681. private _cachedWheelPrecision;
  43682. /**
  43683. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43684. * @param radiusLimit The limit to check against.
  43685. * @return Bool to indicate if at limit.
  43686. */
  43687. private _isRadiusAtLimit;
  43688. /**
  43689. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43690. * @param radiusDelta The delta by which to animate to. Can be negative.
  43691. */
  43692. private _applyBoundRadiusAnimation;
  43693. /**
  43694. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43695. */
  43696. protected _clearAnimationLocks(): void;
  43697. /**
  43698. * Stops and removes all animations that have been applied to the camera
  43699. */
  43700. stopAllAnimations(): void;
  43701. }
  43702. }
  43703. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43704. import { Behavior } from "babylonjs/Behaviors/behavior";
  43705. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43706. import { ExponentialEase } from "babylonjs/Animations/easing";
  43707. import { Nullable } from "babylonjs/types";
  43708. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43709. import { Vector3 } from "babylonjs/Maths/math.vector";
  43710. /**
  43711. * 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.
  43712. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43713. */
  43714. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43715. /**
  43716. * Gets the name of the behavior.
  43717. */
  43718. get name(): string;
  43719. private _mode;
  43720. private _radiusScale;
  43721. private _positionScale;
  43722. private _defaultElevation;
  43723. private _elevationReturnTime;
  43724. private _elevationReturnWaitTime;
  43725. private _zoomStopsAnimation;
  43726. private _framingTime;
  43727. /**
  43728. * The easing function used by animations
  43729. */
  43730. static EasingFunction: ExponentialEase;
  43731. /**
  43732. * The easing mode used by animations
  43733. */
  43734. static EasingMode: number;
  43735. /**
  43736. * Sets the current mode used by the behavior
  43737. */
  43738. set mode(mode: number);
  43739. /**
  43740. * Gets current mode used by the behavior.
  43741. */
  43742. get mode(): number;
  43743. /**
  43744. * Sets the scale applied to the radius (1 by default)
  43745. */
  43746. set radiusScale(radius: number);
  43747. /**
  43748. * Gets the scale applied to the radius
  43749. */
  43750. get radiusScale(): number;
  43751. /**
  43752. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43753. */
  43754. set positionScale(scale: number);
  43755. /**
  43756. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43757. */
  43758. get positionScale(): number;
  43759. /**
  43760. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43761. * behaviour is triggered, in radians.
  43762. */
  43763. set defaultElevation(elevation: number);
  43764. /**
  43765. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43766. * behaviour is triggered, in radians.
  43767. */
  43768. get defaultElevation(): number;
  43769. /**
  43770. * Sets the time (in milliseconds) taken to return to the default beta position.
  43771. * Negative value indicates camera should not return to default.
  43772. */
  43773. set elevationReturnTime(speed: number);
  43774. /**
  43775. * Gets the time (in milliseconds) taken to return to the default beta position.
  43776. * Negative value indicates camera should not return to default.
  43777. */
  43778. get elevationReturnTime(): number;
  43779. /**
  43780. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43781. */
  43782. set elevationReturnWaitTime(time: number);
  43783. /**
  43784. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43785. */
  43786. get elevationReturnWaitTime(): number;
  43787. /**
  43788. * Sets the flag that indicates if user zooming should stop animation.
  43789. */
  43790. set zoomStopsAnimation(flag: boolean);
  43791. /**
  43792. * Gets the flag that indicates if user zooming should stop animation.
  43793. */
  43794. get zoomStopsAnimation(): boolean;
  43795. /**
  43796. * Sets the transition time when framing the mesh, in milliseconds
  43797. */
  43798. set framingTime(time: number);
  43799. /**
  43800. * Gets the transition time when framing the mesh, in milliseconds
  43801. */
  43802. get framingTime(): number;
  43803. /**
  43804. * Define if the behavior should automatically change the configured
  43805. * camera limits and sensibilities.
  43806. */
  43807. autoCorrectCameraLimitsAndSensibility: boolean;
  43808. private _onPrePointerObservableObserver;
  43809. private _onAfterCheckInputsObserver;
  43810. private _onMeshTargetChangedObserver;
  43811. private _attachedCamera;
  43812. private _isPointerDown;
  43813. private _lastInteractionTime;
  43814. /**
  43815. * Initializes the behavior.
  43816. */
  43817. init(): void;
  43818. /**
  43819. * Attaches the behavior to its arc rotate camera.
  43820. * @param camera Defines the camera to attach the behavior to
  43821. */
  43822. attach(camera: ArcRotateCamera): void;
  43823. /**
  43824. * Detaches the behavior from its current arc rotate camera.
  43825. */
  43826. detach(): void;
  43827. private _animatables;
  43828. private _betaIsAnimating;
  43829. private _betaTransition;
  43830. private _radiusTransition;
  43831. private _vectorTransition;
  43832. /**
  43833. * Targets the given mesh and updates zoom level accordingly.
  43834. * @param mesh The mesh to target.
  43835. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43836. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43837. */
  43838. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43839. /**
  43840. * Targets the given mesh with its children and updates zoom level accordingly.
  43841. * @param mesh The mesh to target.
  43842. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43843. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43844. */
  43845. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43846. /**
  43847. * Targets the given meshes with their children and updates zoom level accordingly.
  43848. * @param meshes The mesh to target.
  43849. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43850. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43851. */
  43852. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43853. /**
  43854. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43855. * @param minimumWorld Determines the smaller position of the bounding box extend
  43856. * @param maximumWorld Determines the bigger position of the bounding box extend
  43857. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43858. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43859. */
  43860. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43861. /**
  43862. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43863. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43864. * frustum width.
  43865. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43866. * to fully enclose the mesh in the viewing frustum.
  43867. */
  43868. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43869. /**
  43870. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43871. * is automatically returned to its default position (expected to be above ground plane).
  43872. */
  43873. private _maintainCameraAboveGround;
  43874. /**
  43875. * Returns the frustum slope based on the canvas ratio and camera FOV
  43876. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43877. */
  43878. private _getFrustumSlope;
  43879. /**
  43880. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43881. */
  43882. private _clearAnimationLocks;
  43883. /**
  43884. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43885. */
  43886. private _applyUserInteraction;
  43887. /**
  43888. * Stops and removes all animations that have been applied to the camera
  43889. */
  43890. stopAllAnimations(): void;
  43891. /**
  43892. * Gets a value indicating if the user is moving the camera
  43893. */
  43894. get isUserIsMoving(): boolean;
  43895. /**
  43896. * The camera can move all the way towards the mesh.
  43897. */
  43898. static IgnoreBoundsSizeMode: number;
  43899. /**
  43900. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43901. */
  43902. static FitFrustumSidesMode: number;
  43903. }
  43904. }
  43905. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43906. import { Nullable } from "babylonjs/types";
  43907. import { Camera } from "babylonjs/Cameras/camera";
  43908. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43909. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43910. /**
  43911. * Base class for Camera Pointer Inputs.
  43912. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43913. * for example usage.
  43914. */
  43915. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43916. /**
  43917. * Defines the camera the input is attached to.
  43918. */
  43919. abstract camera: Camera;
  43920. /**
  43921. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43922. */
  43923. protected _altKey: boolean;
  43924. protected _ctrlKey: boolean;
  43925. protected _metaKey: boolean;
  43926. protected _shiftKey: boolean;
  43927. /**
  43928. * Which mouse buttons were pressed at time of last mouse event.
  43929. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43930. */
  43931. protected _buttonsPressed: number;
  43932. /**
  43933. * Defines the buttons associated with the input to handle camera move.
  43934. */
  43935. buttons: number[];
  43936. /**
  43937. * Attach the input controls to a specific dom element to get the input from.
  43938. * @param element Defines the element the controls should be listened from
  43939. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43940. */
  43941. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43942. /**
  43943. * Detach the current controls from the specified dom element.
  43944. * @param element Defines the element to stop listening the inputs from
  43945. */
  43946. detachControl(element: Nullable<HTMLElement>): void;
  43947. /**
  43948. * Gets the class name of the current input.
  43949. * @returns the class name
  43950. */
  43951. getClassName(): string;
  43952. /**
  43953. * Get the friendly name associated with the input class.
  43954. * @returns the input friendly name
  43955. */
  43956. getSimpleName(): string;
  43957. /**
  43958. * Called on pointer POINTERDOUBLETAP event.
  43959. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43960. */
  43961. protected onDoubleTap(type: string): void;
  43962. /**
  43963. * Called on pointer POINTERMOVE event if only a single touch is active.
  43964. * Override this method to provide functionality.
  43965. */
  43966. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43967. /**
  43968. * Called on pointer POINTERMOVE event if multiple touches are active.
  43969. * Override this method to provide functionality.
  43970. */
  43971. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43972. /**
  43973. * Called on JS contextmenu event.
  43974. * Override this method to provide functionality.
  43975. */
  43976. protected onContextMenu(evt: PointerEvent): void;
  43977. /**
  43978. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43979. * press.
  43980. * Override this method to provide functionality.
  43981. */
  43982. protected onButtonDown(evt: PointerEvent): void;
  43983. /**
  43984. * Called each time a new POINTERUP event occurs. Ie, for each button
  43985. * release.
  43986. * Override this method to provide functionality.
  43987. */
  43988. protected onButtonUp(evt: PointerEvent): void;
  43989. /**
  43990. * Called when window becomes inactive.
  43991. * Override this method to provide functionality.
  43992. */
  43993. protected onLostFocus(): void;
  43994. private _pointerInput;
  43995. private _observer;
  43996. private _onLostFocus;
  43997. private pointA;
  43998. private pointB;
  43999. }
  44000. }
  44001. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44002. import { Nullable } from "babylonjs/types";
  44003. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44004. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44005. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44006. /**
  44007. * Manage the pointers inputs to control an arc rotate camera.
  44008. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44009. */
  44010. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44011. /**
  44012. * Defines the camera the input is attached to.
  44013. */
  44014. camera: ArcRotateCamera;
  44015. /**
  44016. * Gets the class name of the current input.
  44017. * @returns the class name
  44018. */
  44019. getClassName(): string;
  44020. /**
  44021. * Defines the buttons associated with the input to handle camera move.
  44022. */
  44023. buttons: number[];
  44024. /**
  44025. * Defines the pointer angular sensibility along the X axis or how fast is
  44026. * the camera rotating.
  44027. */
  44028. angularSensibilityX: number;
  44029. /**
  44030. * Defines the pointer angular sensibility along the Y axis or how fast is
  44031. * the camera rotating.
  44032. */
  44033. angularSensibilityY: number;
  44034. /**
  44035. * Defines the pointer pinch precision or how fast is the camera zooming.
  44036. */
  44037. pinchPrecision: number;
  44038. /**
  44039. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44040. * from 0.
  44041. * It defines the percentage of current camera.radius to use as delta when
  44042. * pinch zoom is used.
  44043. */
  44044. pinchDeltaPercentage: number;
  44045. /**
  44046. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44047. * that any object in the plane at the camera's target point will scale
  44048. * perfectly with finger motion.
  44049. * Overrides pinchDeltaPercentage and pinchPrecision.
  44050. */
  44051. useNaturalPinchZoom: boolean;
  44052. /**
  44053. * Defines the pointer panning sensibility or how fast is the camera moving.
  44054. */
  44055. panningSensibility: number;
  44056. /**
  44057. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44058. */
  44059. multiTouchPanning: boolean;
  44060. /**
  44061. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44062. * zoom (pinch) through multitouch.
  44063. */
  44064. multiTouchPanAndZoom: boolean;
  44065. /**
  44066. * Revers pinch action direction.
  44067. */
  44068. pinchInwards: boolean;
  44069. private _isPanClick;
  44070. private _twoFingerActivityCount;
  44071. private _isPinching;
  44072. /**
  44073. * Called on pointer POINTERMOVE event if only a single touch is active.
  44074. */
  44075. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44076. /**
  44077. * Called on pointer POINTERDOUBLETAP event.
  44078. */
  44079. protected onDoubleTap(type: string): void;
  44080. /**
  44081. * Called on pointer POINTERMOVE event if multiple touches are active.
  44082. */
  44083. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44084. /**
  44085. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44086. * press.
  44087. */
  44088. protected onButtonDown(evt: PointerEvent): void;
  44089. /**
  44090. * Called each time a new POINTERUP event occurs. Ie, for each button
  44091. * release.
  44092. */
  44093. protected onButtonUp(evt: PointerEvent): void;
  44094. /**
  44095. * Called when window becomes inactive.
  44096. */
  44097. protected onLostFocus(): void;
  44098. }
  44099. }
  44100. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44101. import { Nullable } from "babylonjs/types";
  44102. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44103. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44104. /**
  44105. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44106. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44107. */
  44108. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44109. /**
  44110. * Defines the camera the input is attached to.
  44111. */
  44112. camera: ArcRotateCamera;
  44113. /**
  44114. * Defines the list of key codes associated with the up action (increase alpha)
  44115. */
  44116. keysUp: number[];
  44117. /**
  44118. * Defines the list of key codes associated with the down action (decrease alpha)
  44119. */
  44120. keysDown: number[];
  44121. /**
  44122. * Defines the list of key codes associated with the left action (increase beta)
  44123. */
  44124. keysLeft: number[];
  44125. /**
  44126. * Defines the list of key codes associated with the right action (decrease beta)
  44127. */
  44128. keysRight: number[];
  44129. /**
  44130. * Defines the list of key codes associated with the reset action.
  44131. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44132. */
  44133. keysReset: number[];
  44134. /**
  44135. * Defines the panning sensibility of the inputs.
  44136. * (How fast is the camera panning)
  44137. */
  44138. panningSensibility: number;
  44139. /**
  44140. * Defines the zooming sensibility of the inputs.
  44141. * (How fast is the camera zooming)
  44142. */
  44143. zoomingSensibility: number;
  44144. /**
  44145. * Defines whether maintaining the alt key down switch the movement mode from
  44146. * orientation to zoom.
  44147. */
  44148. useAltToZoom: boolean;
  44149. /**
  44150. * Rotation speed of the camera
  44151. */
  44152. angularSpeed: number;
  44153. private _keys;
  44154. private _ctrlPressed;
  44155. private _altPressed;
  44156. private _onCanvasBlurObserver;
  44157. private _onKeyboardObserver;
  44158. private _engine;
  44159. private _scene;
  44160. /**
  44161. * Attach the input controls to a specific dom element to get the input from.
  44162. * @param element Defines the element the controls should be listened from
  44163. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44164. */
  44165. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44166. /**
  44167. * Detach the current controls from the specified dom element.
  44168. * @param element Defines the element to stop listening the inputs from
  44169. */
  44170. detachControl(element: Nullable<HTMLElement>): void;
  44171. /**
  44172. * Update the current camera state depending on the inputs that have been used this frame.
  44173. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44174. */
  44175. checkInputs(): void;
  44176. /**
  44177. * Gets the class name of the current intput.
  44178. * @returns the class name
  44179. */
  44180. getClassName(): string;
  44181. /**
  44182. * Get the friendly name associated with the input class.
  44183. * @returns the input friendly name
  44184. */
  44185. getSimpleName(): string;
  44186. }
  44187. }
  44188. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44189. import { Nullable } from "babylonjs/types";
  44190. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44191. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44192. /**
  44193. * Manage the mouse wheel inputs to control an arc rotate camera.
  44194. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44195. */
  44196. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44197. /**
  44198. * Defines the camera the input is attached to.
  44199. */
  44200. camera: ArcRotateCamera;
  44201. /**
  44202. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44203. */
  44204. wheelPrecision: number;
  44205. /**
  44206. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44207. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44208. */
  44209. wheelDeltaPercentage: number;
  44210. private _wheel;
  44211. private _observer;
  44212. private computeDeltaFromMouseWheelLegacyEvent;
  44213. /**
  44214. * Attach the input controls to a specific dom element to get the input from.
  44215. * @param element Defines the element the controls should be listened from
  44216. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44217. */
  44218. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44219. /**
  44220. * Detach the current controls from the specified dom element.
  44221. * @param element Defines the element to stop listening the inputs from
  44222. */
  44223. detachControl(element: Nullable<HTMLElement>): void;
  44224. /**
  44225. * Gets the class name of the current intput.
  44226. * @returns the class name
  44227. */
  44228. getClassName(): string;
  44229. /**
  44230. * Get the friendly name associated with the input class.
  44231. * @returns the input friendly name
  44232. */
  44233. getSimpleName(): string;
  44234. }
  44235. }
  44236. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44237. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44238. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44239. /**
  44240. * Default Inputs manager for the ArcRotateCamera.
  44241. * It groups all the default supported inputs for ease of use.
  44242. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44243. */
  44244. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44245. /**
  44246. * Instantiates a new ArcRotateCameraInputsManager.
  44247. * @param camera Defines the camera the inputs belong to
  44248. */
  44249. constructor(camera: ArcRotateCamera);
  44250. /**
  44251. * Add mouse wheel input support to the input manager.
  44252. * @returns the current input manager
  44253. */
  44254. addMouseWheel(): ArcRotateCameraInputsManager;
  44255. /**
  44256. * Add pointers input support to the input manager.
  44257. * @returns the current input manager
  44258. */
  44259. addPointers(): ArcRotateCameraInputsManager;
  44260. /**
  44261. * Add keyboard input support to the input manager.
  44262. * @returns the current input manager
  44263. */
  44264. addKeyboard(): ArcRotateCameraInputsManager;
  44265. }
  44266. }
  44267. declare module "babylonjs/Cameras/arcRotateCamera" {
  44268. import { Observable } from "babylonjs/Misc/observable";
  44269. import { Nullable } from "babylonjs/types";
  44270. import { Scene } from "babylonjs/scene";
  44271. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44272. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44273. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44274. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44275. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44276. import { Camera } from "babylonjs/Cameras/camera";
  44277. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44278. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44279. import { Collider } from "babylonjs/Collisions/collider";
  44280. /**
  44281. * This represents an orbital type of camera.
  44282. *
  44283. * 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.
  44284. * 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.
  44285. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44286. */
  44287. export class ArcRotateCamera extends TargetCamera {
  44288. /**
  44289. * Defines the rotation angle of the camera along the longitudinal axis.
  44290. */
  44291. alpha: number;
  44292. /**
  44293. * Defines the rotation angle of the camera along the latitudinal axis.
  44294. */
  44295. beta: number;
  44296. /**
  44297. * Defines the radius of the camera from it s target point.
  44298. */
  44299. radius: number;
  44300. protected _target: Vector3;
  44301. protected _targetHost: Nullable<AbstractMesh>;
  44302. /**
  44303. * Defines the target point of the camera.
  44304. * The camera looks towards it form the radius distance.
  44305. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44306. */
  44307. get target(): Vector3;
  44308. set target(value: Vector3);
  44309. /**
  44310. * Define the current local position of the camera in the scene
  44311. */
  44312. get position(): Vector3;
  44313. set position(newPosition: Vector3);
  44314. protected _upVector: Vector3;
  44315. protected _upToYMatrix: Matrix;
  44316. protected _YToUpMatrix: Matrix;
  44317. /**
  44318. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44319. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44320. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44321. */
  44322. set upVector(vec: Vector3);
  44323. get upVector(): Vector3;
  44324. /**
  44325. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44326. */
  44327. setMatUp(): void;
  44328. /**
  44329. * Current inertia value on the longitudinal axis.
  44330. * The bigger this number the longer it will take for the camera to stop.
  44331. */
  44332. inertialAlphaOffset: number;
  44333. /**
  44334. * Current inertia value on the latitudinal axis.
  44335. * The bigger this number the longer it will take for the camera to stop.
  44336. */
  44337. inertialBetaOffset: number;
  44338. /**
  44339. * Current inertia value on the radius axis.
  44340. * The bigger this number the longer it will take for the camera to stop.
  44341. */
  44342. inertialRadiusOffset: number;
  44343. /**
  44344. * Minimum allowed angle on the longitudinal axis.
  44345. * This can help limiting how the Camera is able to move in the scene.
  44346. */
  44347. lowerAlphaLimit: Nullable<number>;
  44348. /**
  44349. * Maximum allowed angle on the longitudinal axis.
  44350. * This can help limiting how the Camera is able to move in the scene.
  44351. */
  44352. upperAlphaLimit: Nullable<number>;
  44353. /**
  44354. * Minimum allowed angle on the latitudinal axis.
  44355. * This can help limiting how the Camera is able to move in the scene.
  44356. */
  44357. lowerBetaLimit: number;
  44358. /**
  44359. * Maximum allowed angle on the latitudinal axis.
  44360. * This can help limiting how the Camera is able to move in the scene.
  44361. */
  44362. upperBetaLimit: number;
  44363. /**
  44364. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44365. * This can help limiting how the Camera is able to move in the scene.
  44366. */
  44367. lowerRadiusLimit: Nullable<number>;
  44368. /**
  44369. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44370. * This can help limiting how the Camera is able to move in the scene.
  44371. */
  44372. upperRadiusLimit: Nullable<number>;
  44373. /**
  44374. * Defines the current inertia value used during panning of the camera along the X axis.
  44375. */
  44376. inertialPanningX: number;
  44377. /**
  44378. * Defines the current inertia value used during panning of the camera along the Y axis.
  44379. */
  44380. inertialPanningY: number;
  44381. /**
  44382. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44383. * Basically if your fingers moves away from more than this distance you will be considered
  44384. * in pinch mode.
  44385. */
  44386. pinchToPanMaxDistance: number;
  44387. /**
  44388. * Defines the maximum distance the camera can pan.
  44389. * This could help keeping the cammera always in your scene.
  44390. */
  44391. panningDistanceLimit: Nullable<number>;
  44392. /**
  44393. * Defines the target of the camera before paning.
  44394. */
  44395. panningOriginTarget: Vector3;
  44396. /**
  44397. * Defines the value of the inertia used during panning.
  44398. * 0 would mean stop inertia and one would mean no decelleration at all.
  44399. */
  44400. panningInertia: number;
  44401. /**
  44402. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44403. */
  44404. get angularSensibilityX(): number;
  44405. set angularSensibilityX(value: number);
  44406. /**
  44407. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44408. */
  44409. get angularSensibilityY(): number;
  44410. set angularSensibilityY(value: number);
  44411. /**
  44412. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44413. */
  44414. get pinchPrecision(): number;
  44415. set pinchPrecision(value: number);
  44416. /**
  44417. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44418. * It will be used instead of pinchDeltaPrecision if different from 0.
  44419. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44420. */
  44421. get pinchDeltaPercentage(): number;
  44422. set pinchDeltaPercentage(value: number);
  44423. /**
  44424. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44425. * and pinch delta percentage.
  44426. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44427. * that any object in the plane at the camera's target point will scale
  44428. * perfectly with finger motion.
  44429. */
  44430. get useNaturalPinchZoom(): boolean;
  44431. set useNaturalPinchZoom(value: boolean);
  44432. /**
  44433. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44434. */
  44435. get panningSensibility(): number;
  44436. set panningSensibility(value: number);
  44437. /**
  44438. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44439. */
  44440. get keysUp(): number[];
  44441. set keysUp(value: number[]);
  44442. /**
  44443. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44444. */
  44445. get keysDown(): number[];
  44446. set keysDown(value: number[]);
  44447. /**
  44448. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44449. */
  44450. get keysLeft(): number[];
  44451. set keysLeft(value: number[]);
  44452. /**
  44453. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44454. */
  44455. get keysRight(): number[];
  44456. set keysRight(value: number[]);
  44457. /**
  44458. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44459. */
  44460. get wheelPrecision(): number;
  44461. set wheelPrecision(value: number);
  44462. /**
  44463. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44464. * It will be used instead of pinchDeltaPrecision if different from 0.
  44465. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44466. */
  44467. get wheelDeltaPercentage(): number;
  44468. set wheelDeltaPercentage(value: number);
  44469. /**
  44470. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44471. */
  44472. zoomOnFactor: number;
  44473. /**
  44474. * Defines a screen offset for the camera position.
  44475. */
  44476. targetScreenOffset: Vector2;
  44477. /**
  44478. * Allows the camera to be completely reversed.
  44479. * If false the camera can not arrive upside down.
  44480. */
  44481. allowUpsideDown: boolean;
  44482. /**
  44483. * Define if double tap/click is used to restore the previously saved state of the camera.
  44484. */
  44485. useInputToRestoreState: boolean;
  44486. /** @hidden */
  44487. _viewMatrix: Matrix;
  44488. /** @hidden */
  44489. _useCtrlForPanning: boolean;
  44490. /** @hidden */
  44491. _panningMouseButton: number;
  44492. /**
  44493. * Defines the input associated to the camera.
  44494. */
  44495. inputs: ArcRotateCameraInputsManager;
  44496. /** @hidden */
  44497. _reset: () => void;
  44498. /**
  44499. * Defines the allowed panning axis.
  44500. */
  44501. panningAxis: Vector3;
  44502. protected _localDirection: Vector3;
  44503. protected _transformedDirection: Vector3;
  44504. private _bouncingBehavior;
  44505. /**
  44506. * Gets the bouncing behavior of the camera if it has been enabled.
  44507. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44508. */
  44509. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44510. /**
  44511. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44512. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44513. */
  44514. get useBouncingBehavior(): boolean;
  44515. set useBouncingBehavior(value: boolean);
  44516. private _framingBehavior;
  44517. /**
  44518. * Gets the framing behavior of the camera if it has been enabled.
  44519. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44520. */
  44521. get framingBehavior(): Nullable<FramingBehavior>;
  44522. /**
  44523. * Defines if the framing behavior of the camera is enabled on the camera.
  44524. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44525. */
  44526. get useFramingBehavior(): boolean;
  44527. set useFramingBehavior(value: boolean);
  44528. private _autoRotationBehavior;
  44529. /**
  44530. * Gets the auto rotation behavior of the camera if it has been enabled.
  44531. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44532. */
  44533. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44534. /**
  44535. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44536. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44537. */
  44538. get useAutoRotationBehavior(): boolean;
  44539. set useAutoRotationBehavior(value: boolean);
  44540. /**
  44541. * Observable triggered when the mesh target has been changed on the camera.
  44542. */
  44543. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44544. /**
  44545. * Event raised when the camera is colliding with a mesh.
  44546. */
  44547. onCollide: (collidedMesh: AbstractMesh) => void;
  44548. /**
  44549. * Defines whether the camera should check collision with the objects oh the scene.
  44550. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44551. */
  44552. checkCollisions: boolean;
  44553. /**
  44554. * Defines the collision radius of the camera.
  44555. * This simulates a sphere around the camera.
  44556. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44557. */
  44558. collisionRadius: Vector3;
  44559. protected _collider: Collider;
  44560. protected _previousPosition: Vector3;
  44561. protected _collisionVelocity: Vector3;
  44562. protected _newPosition: Vector3;
  44563. protected _previousAlpha: number;
  44564. protected _previousBeta: number;
  44565. protected _previousRadius: number;
  44566. protected _collisionTriggered: boolean;
  44567. protected _targetBoundingCenter: Nullable<Vector3>;
  44568. private _computationVector;
  44569. /**
  44570. * Instantiates a new ArcRotateCamera in a given scene
  44571. * @param name Defines the name of the camera
  44572. * @param alpha Defines the camera rotation along the logitudinal axis
  44573. * @param beta Defines the camera rotation along the latitudinal axis
  44574. * @param radius Defines the camera distance from its target
  44575. * @param target Defines the camera target
  44576. * @param scene Defines the scene the camera belongs to
  44577. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44578. */
  44579. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44580. /** @hidden */
  44581. _initCache(): void;
  44582. /** @hidden */
  44583. _updateCache(ignoreParentClass?: boolean): void;
  44584. protected _getTargetPosition(): Vector3;
  44585. private _storedAlpha;
  44586. private _storedBeta;
  44587. private _storedRadius;
  44588. private _storedTarget;
  44589. private _storedTargetScreenOffset;
  44590. /**
  44591. * Stores the current state of the camera (alpha, beta, radius and target)
  44592. * @returns the camera itself
  44593. */
  44594. storeState(): Camera;
  44595. /**
  44596. * @hidden
  44597. * Restored camera state. You must call storeState() first
  44598. */
  44599. _restoreStateValues(): boolean;
  44600. /** @hidden */
  44601. _isSynchronizedViewMatrix(): boolean;
  44602. /**
  44603. * Attached controls to the current camera.
  44604. * @param element Defines the element the controls should be listened from
  44605. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44606. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44607. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44608. */
  44609. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44610. /**
  44611. * Detach the current controls from the camera.
  44612. * The camera will stop reacting to inputs.
  44613. * @param element Defines the element to stop listening the inputs from
  44614. */
  44615. detachControl(element: HTMLElement): void;
  44616. /** @hidden */
  44617. _checkInputs(): void;
  44618. protected _checkLimits(): void;
  44619. /**
  44620. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44621. */
  44622. rebuildAnglesAndRadius(): void;
  44623. /**
  44624. * Use a position to define the current camera related information like alpha, beta and radius
  44625. * @param position Defines the position to set the camera at
  44626. */
  44627. setPosition(position: Vector3): void;
  44628. /**
  44629. * Defines the target the camera should look at.
  44630. * This will automatically adapt alpha beta and radius to fit within the new target.
  44631. * @param target Defines the new target as a Vector or a mesh
  44632. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44633. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44634. */
  44635. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44636. /** @hidden */
  44637. _getViewMatrix(): Matrix;
  44638. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44639. /**
  44640. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44641. * @param meshes Defines the mesh to zoom on
  44642. * @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)
  44643. */
  44644. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44645. /**
  44646. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44647. * The target will be changed but the radius
  44648. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44649. * @param doNotUpdateMaxZ Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
  44650. */
  44651. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44652. min: Vector3;
  44653. max: Vector3;
  44654. distance: number;
  44655. }, doNotUpdateMaxZ?: boolean): void;
  44656. /**
  44657. * @override
  44658. * Override Camera.createRigCamera
  44659. */
  44660. createRigCamera(name: string, cameraIndex: number): Camera;
  44661. /**
  44662. * @hidden
  44663. * @override
  44664. * Override Camera._updateRigCameras
  44665. */
  44666. _updateRigCameras(): void;
  44667. /**
  44668. * Destroy the camera and release the current resources hold by it.
  44669. */
  44670. dispose(): void;
  44671. /**
  44672. * Gets the current object class name.
  44673. * @return the class name
  44674. */
  44675. getClassName(): string;
  44676. }
  44677. }
  44678. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44679. import { Behavior } from "babylonjs/Behaviors/behavior";
  44680. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44681. /**
  44682. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44683. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44684. */
  44685. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44686. /**
  44687. * Gets the name of the behavior.
  44688. */
  44689. get name(): string;
  44690. private _zoomStopsAnimation;
  44691. private _idleRotationSpeed;
  44692. private _idleRotationWaitTime;
  44693. private _idleRotationSpinupTime;
  44694. /**
  44695. * Sets the flag that indicates if user zooming should stop animation.
  44696. */
  44697. set zoomStopsAnimation(flag: boolean);
  44698. /**
  44699. * Gets the flag that indicates if user zooming should stop animation.
  44700. */
  44701. get zoomStopsAnimation(): boolean;
  44702. /**
  44703. * Sets the default speed at which the camera rotates around the model.
  44704. */
  44705. set idleRotationSpeed(speed: number);
  44706. /**
  44707. * Gets the default speed at which the camera rotates around the model.
  44708. */
  44709. get idleRotationSpeed(): number;
  44710. /**
  44711. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44712. */
  44713. set idleRotationWaitTime(time: number);
  44714. /**
  44715. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44716. */
  44717. get idleRotationWaitTime(): number;
  44718. /**
  44719. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44720. */
  44721. set idleRotationSpinupTime(time: number);
  44722. /**
  44723. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44724. */
  44725. get idleRotationSpinupTime(): number;
  44726. /**
  44727. * Gets a value indicating if the camera is currently rotating because of this behavior
  44728. */
  44729. get rotationInProgress(): boolean;
  44730. private _onPrePointerObservableObserver;
  44731. private _onAfterCheckInputsObserver;
  44732. private _attachedCamera;
  44733. private _isPointerDown;
  44734. private _lastFrameTime;
  44735. private _lastInteractionTime;
  44736. private _cameraRotationSpeed;
  44737. /**
  44738. * Initializes the behavior.
  44739. */
  44740. init(): void;
  44741. /**
  44742. * Attaches the behavior to its arc rotate camera.
  44743. * @param camera Defines the camera to attach the behavior to
  44744. */
  44745. attach(camera: ArcRotateCamera): void;
  44746. /**
  44747. * Detaches the behavior from its current arc rotate camera.
  44748. */
  44749. detach(): void;
  44750. /**
  44751. * Returns true if user is scrolling.
  44752. * @return true if user is scrolling.
  44753. */
  44754. private _userIsZooming;
  44755. private _lastFrameRadius;
  44756. private _shouldAnimationStopForInteraction;
  44757. /**
  44758. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44759. */
  44760. private _applyUserInteraction;
  44761. private _userIsMoving;
  44762. }
  44763. }
  44764. declare module "babylonjs/Behaviors/Cameras/index" {
  44765. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44766. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44767. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44768. }
  44769. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44770. import { Mesh } from "babylonjs/Meshes/mesh";
  44771. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44772. import { Behavior } from "babylonjs/Behaviors/behavior";
  44773. /**
  44774. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44775. */
  44776. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44777. private ui;
  44778. /**
  44779. * The name of the behavior
  44780. */
  44781. name: string;
  44782. /**
  44783. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44784. */
  44785. distanceAwayFromFace: number;
  44786. /**
  44787. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44788. */
  44789. distanceAwayFromBottomOfFace: number;
  44790. private _faceVectors;
  44791. private _target;
  44792. private _scene;
  44793. private _onRenderObserver;
  44794. private _tmpMatrix;
  44795. private _tmpVector;
  44796. /**
  44797. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44798. * @param ui The transform node that should be attched to the mesh
  44799. */
  44800. constructor(ui: TransformNode);
  44801. /**
  44802. * Initializes the behavior
  44803. */
  44804. init(): void;
  44805. private _closestFace;
  44806. private _zeroVector;
  44807. private _lookAtTmpMatrix;
  44808. private _lookAtToRef;
  44809. /**
  44810. * Attaches the AttachToBoxBehavior to the passed in mesh
  44811. * @param target The mesh that the specified node will be attached to
  44812. */
  44813. attach(target: Mesh): void;
  44814. /**
  44815. * Detaches the behavior from the mesh
  44816. */
  44817. detach(): void;
  44818. }
  44819. }
  44820. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44821. import { Behavior } from "babylonjs/Behaviors/behavior";
  44822. import { Mesh } from "babylonjs/Meshes/mesh";
  44823. /**
  44824. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44825. */
  44826. export class FadeInOutBehavior implements Behavior<Mesh> {
  44827. /**
  44828. * Time in milliseconds to delay before fading in (Default: 0)
  44829. */
  44830. delay: number;
  44831. /**
  44832. * Time in milliseconds for the mesh to fade in (Default: 300)
  44833. */
  44834. fadeInTime: number;
  44835. private _millisecondsPerFrame;
  44836. private _hovered;
  44837. private _hoverValue;
  44838. private _ownerNode;
  44839. /**
  44840. * Instatiates the FadeInOutBehavior
  44841. */
  44842. constructor();
  44843. /**
  44844. * The name of the behavior
  44845. */
  44846. get name(): string;
  44847. /**
  44848. * Initializes the behavior
  44849. */
  44850. init(): void;
  44851. /**
  44852. * Attaches the fade behavior on the passed in mesh
  44853. * @param ownerNode The mesh that will be faded in/out once attached
  44854. */
  44855. attach(ownerNode: Mesh): void;
  44856. /**
  44857. * Detaches the behavior from the mesh
  44858. */
  44859. detach(): void;
  44860. /**
  44861. * Triggers the mesh to begin fading in or out
  44862. * @param value if the object should fade in or out (true to fade in)
  44863. */
  44864. fadeIn(value: boolean): void;
  44865. private _update;
  44866. private _setAllVisibility;
  44867. }
  44868. }
  44869. declare module "babylonjs/Misc/pivotTools" {
  44870. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44871. /**
  44872. * Class containing a set of static utilities functions for managing Pivots
  44873. * @hidden
  44874. */
  44875. export class PivotTools {
  44876. private static _PivotCached;
  44877. private static _OldPivotPoint;
  44878. private static _PivotTranslation;
  44879. private static _PivotTmpVector;
  44880. /** @hidden */
  44881. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44882. /** @hidden */
  44883. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44884. }
  44885. }
  44886. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44887. import { Scene } from "babylonjs/scene";
  44888. import { Vector4 } from "babylonjs/Maths/math.vector";
  44889. import { Mesh } from "babylonjs/Meshes/mesh";
  44890. import { Nullable } from "babylonjs/types";
  44891. import { Plane } from "babylonjs/Maths/math.plane";
  44892. /**
  44893. * Class containing static functions to help procedurally build meshes
  44894. */
  44895. export class PlaneBuilder {
  44896. /**
  44897. * Creates a plane mesh
  44898. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44899. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44900. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44901. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44902. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44903. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44904. * @param name defines the name of the mesh
  44905. * @param options defines the options used to create the mesh
  44906. * @param scene defines the hosting scene
  44907. * @returns the plane mesh
  44908. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44909. */
  44910. static CreatePlane(name: string, options: {
  44911. size?: number;
  44912. width?: number;
  44913. height?: number;
  44914. sideOrientation?: number;
  44915. frontUVs?: Vector4;
  44916. backUVs?: Vector4;
  44917. updatable?: boolean;
  44918. sourcePlane?: Plane;
  44919. }, scene?: Nullable<Scene>): Mesh;
  44920. }
  44921. }
  44922. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44923. import { Behavior } from "babylonjs/Behaviors/behavior";
  44924. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44925. import { Observable } from "babylonjs/Misc/observable";
  44926. import { Vector3 } from "babylonjs/Maths/math.vector";
  44927. import { Ray } from "babylonjs/Culling/ray";
  44928. import "babylonjs/Meshes/Builders/planeBuilder";
  44929. /**
  44930. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44931. */
  44932. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44933. private static _AnyMouseID;
  44934. /**
  44935. * Abstract mesh the behavior is set on
  44936. */
  44937. attachedNode: AbstractMesh;
  44938. private _dragPlane;
  44939. private _scene;
  44940. private _pointerObserver;
  44941. private _beforeRenderObserver;
  44942. private static _planeScene;
  44943. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44944. /**
  44945. * 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)
  44946. */
  44947. maxDragAngle: number;
  44948. /**
  44949. * @hidden
  44950. */
  44951. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44952. /**
  44953. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44954. */
  44955. currentDraggingPointerID: number;
  44956. /**
  44957. * The last position where the pointer hit the drag plane in world space
  44958. */
  44959. lastDragPosition: Vector3;
  44960. /**
  44961. * If the behavior is currently in a dragging state
  44962. */
  44963. dragging: boolean;
  44964. /**
  44965. * 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)
  44966. */
  44967. dragDeltaRatio: number;
  44968. /**
  44969. * If the drag plane orientation should be updated during the dragging (Default: true)
  44970. */
  44971. updateDragPlane: boolean;
  44972. private _debugMode;
  44973. private _moving;
  44974. /**
  44975. * Fires each time the attached mesh is dragged with the pointer
  44976. * * delta between last drag position and current drag position in world space
  44977. * * dragDistance along the drag axis
  44978. * * dragPlaneNormal normal of the current drag plane used during the drag
  44979. * * dragPlanePoint in world space where the drag intersects the drag plane
  44980. */
  44981. onDragObservable: Observable<{
  44982. delta: Vector3;
  44983. dragPlanePoint: Vector3;
  44984. dragPlaneNormal: Vector3;
  44985. dragDistance: number;
  44986. pointerId: number;
  44987. }>;
  44988. /**
  44989. * Fires each time a drag begins (eg. mouse down on mesh)
  44990. */
  44991. onDragStartObservable: Observable<{
  44992. dragPlanePoint: Vector3;
  44993. pointerId: number;
  44994. }>;
  44995. /**
  44996. * Fires each time a drag ends (eg. mouse release after drag)
  44997. */
  44998. onDragEndObservable: Observable<{
  44999. dragPlanePoint: Vector3;
  45000. pointerId: number;
  45001. }>;
  45002. /**
  45003. * If the attached mesh should be moved when dragged
  45004. */
  45005. moveAttached: boolean;
  45006. /**
  45007. * If the drag behavior will react to drag events (Default: true)
  45008. */
  45009. enabled: boolean;
  45010. /**
  45011. * If pointer events should start and release the drag (Default: true)
  45012. */
  45013. startAndReleaseDragOnPointerEvents: boolean;
  45014. /**
  45015. * If camera controls should be detached during the drag
  45016. */
  45017. detachCameraControls: boolean;
  45018. /**
  45019. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45020. */
  45021. useObjectOrientationForDragging: boolean;
  45022. private _options;
  45023. /**
  45024. * Gets the options used by the behavior
  45025. */
  45026. get options(): {
  45027. dragAxis?: Vector3;
  45028. dragPlaneNormal?: Vector3;
  45029. };
  45030. /**
  45031. * Sets the options used by the behavior
  45032. */
  45033. set options(options: {
  45034. dragAxis?: Vector3;
  45035. dragPlaneNormal?: Vector3;
  45036. });
  45037. /**
  45038. * Creates a pointer drag behavior that can be attached to a mesh
  45039. * @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)
  45040. */
  45041. constructor(options?: {
  45042. dragAxis?: Vector3;
  45043. dragPlaneNormal?: Vector3;
  45044. });
  45045. /**
  45046. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45047. */
  45048. validateDrag: (targetPosition: Vector3) => boolean;
  45049. /**
  45050. * The name of the behavior
  45051. */
  45052. get name(): string;
  45053. /**
  45054. * Initializes the behavior
  45055. */
  45056. init(): void;
  45057. private _tmpVector;
  45058. private _alternatePickedPoint;
  45059. private _worldDragAxis;
  45060. private _targetPosition;
  45061. private _attachedElement;
  45062. /**
  45063. * Attaches the drag behavior the passed in mesh
  45064. * @param ownerNode The mesh that will be dragged around once attached
  45065. * @param predicate Predicate to use for pick filtering
  45066. */
  45067. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45068. /**
  45069. * Force relase the drag action by code.
  45070. */
  45071. releaseDrag(): void;
  45072. private _startDragRay;
  45073. private _lastPointerRay;
  45074. /**
  45075. * Simulates the start of a pointer drag event on the behavior
  45076. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45077. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45078. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45079. */
  45080. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45081. private _startDrag;
  45082. private _dragDelta;
  45083. private _moveDrag;
  45084. private _pickWithRayOnDragPlane;
  45085. private _pointA;
  45086. private _pointC;
  45087. private _localAxis;
  45088. private _lookAt;
  45089. private _updateDragPlanePosition;
  45090. /**
  45091. * Detaches the behavior from the mesh
  45092. */
  45093. detach(): void;
  45094. }
  45095. }
  45096. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45097. import { Mesh } from "babylonjs/Meshes/mesh";
  45098. import { Behavior } from "babylonjs/Behaviors/behavior";
  45099. /**
  45100. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45101. */
  45102. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45103. private _dragBehaviorA;
  45104. private _dragBehaviorB;
  45105. private _startDistance;
  45106. private _initialScale;
  45107. private _targetScale;
  45108. private _ownerNode;
  45109. private _sceneRenderObserver;
  45110. /**
  45111. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45112. */
  45113. constructor();
  45114. /**
  45115. * The name of the behavior
  45116. */
  45117. get name(): string;
  45118. /**
  45119. * Initializes the behavior
  45120. */
  45121. init(): void;
  45122. private _getCurrentDistance;
  45123. /**
  45124. * Attaches the scale behavior the passed in mesh
  45125. * @param ownerNode The mesh that will be scaled around once attached
  45126. */
  45127. attach(ownerNode: Mesh): void;
  45128. /**
  45129. * Detaches the behavior from the mesh
  45130. */
  45131. detach(): void;
  45132. }
  45133. }
  45134. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45135. import { Behavior } from "babylonjs/Behaviors/behavior";
  45136. import { Mesh } from "babylonjs/Meshes/mesh";
  45137. import { Observable } from "babylonjs/Misc/observable";
  45138. /**
  45139. * 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
  45140. */
  45141. export class SixDofDragBehavior implements Behavior<Mesh> {
  45142. private static _virtualScene;
  45143. private _ownerNode;
  45144. private _sceneRenderObserver;
  45145. private _scene;
  45146. private _targetPosition;
  45147. private _virtualOriginMesh;
  45148. private _virtualDragMesh;
  45149. private _pointerObserver;
  45150. private _moving;
  45151. private _startingOrientation;
  45152. private _attachedElement;
  45153. /**
  45154. * 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)
  45155. */
  45156. private zDragFactor;
  45157. /**
  45158. * If the object should rotate to face the drag origin
  45159. */
  45160. rotateDraggedObject: boolean;
  45161. /**
  45162. * If the behavior is currently in a dragging state
  45163. */
  45164. dragging: boolean;
  45165. /**
  45166. * 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)
  45167. */
  45168. dragDeltaRatio: number;
  45169. /**
  45170. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45171. */
  45172. currentDraggingPointerID: number;
  45173. /**
  45174. * If camera controls should be detached during the drag
  45175. */
  45176. detachCameraControls: boolean;
  45177. /**
  45178. * Fires each time a drag starts
  45179. */
  45180. onDragStartObservable: Observable<{}>;
  45181. /**
  45182. * Fires each time a drag ends (eg. mouse release after drag)
  45183. */
  45184. onDragEndObservable: Observable<{}>;
  45185. /**
  45186. * 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
  45187. */
  45188. constructor();
  45189. /**
  45190. * The name of the behavior
  45191. */
  45192. get name(): string;
  45193. /**
  45194. * Initializes the behavior
  45195. */
  45196. init(): void;
  45197. /**
  45198. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45199. */
  45200. private get _pointerCamera();
  45201. /**
  45202. * Attaches the scale behavior the passed in mesh
  45203. * @param ownerNode The mesh that will be scaled around once attached
  45204. */
  45205. attach(ownerNode: Mesh): void;
  45206. /**
  45207. * Detaches the behavior from the mesh
  45208. */
  45209. detach(): void;
  45210. }
  45211. }
  45212. declare module "babylonjs/Behaviors/Meshes/index" {
  45213. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45214. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45215. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45216. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45217. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45218. }
  45219. declare module "babylonjs/Behaviors/index" {
  45220. export * from "babylonjs/Behaviors/behavior";
  45221. export * from "babylonjs/Behaviors/Cameras/index";
  45222. export * from "babylonjs/Behaviors/Meshes/index";
  45223. }
  45224. declare module "babylonjs/Bones/boneIKController" {
  45225. import { Bone } from "babylonjs/Bones/bone";
  45226. import { Vector3 } from "babylonjs/Maths/math.vector";
  45227. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45228. import { Nullable } from "babylonjs/types";
  45229. /**
  45230. * Class used to apply inverse kinematics to bones
  45231. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45232. */
  45233. export class BoneIKController {
  45234. private static _tmpVecs;
  45235. private static _tmpQuat;
  45236. private static _tmpMats;
  45237. /**
  45238. * Gets or sets the target mesh
  45239. */
  45240. targetMesh: AbstractMesh;
  45241. /** Gets or sets the mesh used as pole */
  45242. poleTargetMesh: AbstractMesh;
  45243. /**
  45244. * Gets or sets the bone used as pole
  45245. */
  45246. poleTargetBone: Nullable<Bone>;
  45247. /**
  45248. * Gets or sets the target position
  45249. */
  45250. targetPosition: Vector3;
  45251. /**
  45252. * Gets or sets the pole target position
  45253. */
  45254. poleTargetPosition: Vector3;
  45255. /**
  45256. * Gets or sets the pole target local offset
  45257. */
  45258. poleTargetLocalOffset: Vector3;
  45259. /**
  45260. * Gets or sets the pole angle
  45261. */
  45262. poleAngle: number;
  45263. /**
  45264. * Gets or sets the mesh associated with the controller
  45265. */
  45266. mesh: AbstractMesh;
  45267. /**
  45268. * 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)
  45269. */
  45270. slerpAmount: number;
  45271. private _bone1Quat;
  45272. private _bone1Mat;
  45273. private _bone2Ang;
  45274. private _bone1;
  45275. private _bone2;
  45276. private _bone1Length;
  45277. private _bone2Length;
  45278. private _maxAngle;
  45279. private _maxReach;
  45280. private _rightHandedSystem;
  45281. private _bendAxis;
  45282. private _slerping;
  45283. private _adjustRoll;
  45284. /**
  45285. * Gets or sets maximum allowed angle
  45286. */
  45287. get maxAngle(): number;
  45288. set maxAngle(value: number);
  45289. /**
  45290. * Creates a new BoneIKController
  45291. * @param mesh defines the mesh to control
  45292. * @param bone defines the bone to control
  45293. * @param options defines options to set up the controller
  45294. */
  45295. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45296. targetMesh?: AbstractMesh;
  45297. poleTargetMesh?: AbstractMesh;
  45298. poleTargetBone?: Bone;
  45299. poleTargetLocalOffset?: Vector3;
  45300. poleAngle?: number;
  45301. bendAxis?: Vector3;
  45302. maxAngle?: number;
  45303. slerpAmount?: number;
  45304. });
  45305. private _setMaxAngle;
  45306. /**
  45307. * Force the controller to update the bones
  45308. */
  45309. update(): void;
  45310. }
  45311. }
  45312. declare module "babylonjs/Bones/boneLookController" {
  45313. import { Vector3 } from "babylonjs/Maths/math.vector";
  45314. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45315. import { Bone } from "babylonjs/Bones/bone";
  45316. import { Space } from "babylonjs/Maths/math.axis";
  45317. /**
  45318. * Class used to make a bone look toward a point in space
  45319. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45320. */
  45321. export class BoneLookController {
  45322. private static _tmpVecs;
  45323. private static _tmpQuat;
  45324. private static _tmpMats;
  45325. /**
  45326. * The target Vector3 that the bone will look at
  45327. */
  45328. target: Vector3;
  45329. /**
  45330. * The mesh that the bone is attached to
  45331. */
  45332. mesh: AbstractMesh;
  45333. /**
  45334. * The bone that will be looking to the target
  45335. */
  45336. bone: Bone;
  45337. /**
  45338. * The up axis of the coordinate system that is used when the bone is rotated
  45339. */
  45340. upAxis: Vector3;
  45341. /**
  45342. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45343. */
  45344. upAxisSpace: Space;
  45345. /**
  45346. * Used to make an adjustment to the yaw of the bone
  45347. */
  45348. adjustYaw: number;
  45349. /**
  45350. * Used to make an adjustment to the pitch of the bone
  45351. */
  45352. adjustPitch: number;
  45353. /**
  45354. * Used to make an adjustment to the roll of the bone
  45355. */
  45356. adjustRoll: number;
  45357. /**
  45358. * 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)
  45359. */
  45360. slerpAmount: number;
  45361. private _minYaw;
  45362. private _maxYaw;
  45363. private _minPitch;
  45364. private _maxPitch;
  45365. private _minYawSin;
  45366. private _minYawCos;
  45367. private _maxYawSin;
  45368. private _maxYawCos;
  45369. private _midYawConstraint;
  45370. private _minPitchTan;
  45371. private _maxPitchTan;
  45372. private _boneQuat;
  45373. private _slerping;
  45374. private _transformYawPitch;
  45375. private _transformYawPitchInv;
  45376. private _firstFrameSkipped;
  45377. private _yawRange;
  45378. private _fowardAxis;
  45379. /**
  45380. * Gets or sets the minimum yaw angle that the bone can look to
  45381. */
  45382. get minYaw(): number;
  45383. set minYaw(value: number);
  45384. /**
  45385. * Gets or sets the maximum yaw angle that the bone can look to
  45386. */
  45387. get maxYaw(): number;
  45388. set maxYaw(value: number);
  45389. /**
  45390. * Gets or sets the minimum pitch angle that the bone can look to
  45391. */
  45392. get minPitch(): number;
  45393. set minPitch(value: number);
  45394. /**
  45395. * Gets or sets the maximum pitch angle that the bone can look to
  45396. */
  45397. get maxPitch(): number;
  45398. set maxPitch(value: number);
  45399. /**
  45400. * Create a BoneLookController
  45401. * @param mesh the mesh that the bone belongs to
  45402. * @param bone the bone that will be looking to the target
  45403. * @param target the target Vector3 to look at
  45404. * @param options optional settings:
  45405. * * maxYaw: the maximum angle the bone will yaw to
  45406. * * minYaw: the minimum angle the bone will yaw to
  45407. * * maxPitch: the maximum angle the bone will pitch to
  45408. * * minPitch: the minimum angle the bone will yaw to
  45409. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45410. * * upAxis: the up axis of the coordinate system
  45411. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45412. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45413. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45414. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45415. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45416. * * adjustRoll: used to make an adjustment to the roll of the bone
  45417. **/
  45418. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45419. maxYaw?: number;
  45420. minYaw?: number;
  45421. maxPitch?: number;
  45422. minPitch?: number;
  45423. slerpAmount?: number;
  45424. upAxis?: Vector3;
  45425. upAxisSpace?: Space;
  45426. yawAxis?: Vector3;
  45427. pitchAxis?: Vector3;
  45428. adjustYaw?: number;
  45429. adjustPitch?: number;
  45430. adjustRoll?: number;
  45431. });
  45432. /**
  45433. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45434. */
  45435. update(): void;
  45436. private _getAngleDiff;
  45437. private _getAngleBetween;
  45438. private _isAngleBetween;
  45439. }
  45440. }
  45441. declare module "babylonjs/Bones/index" {
  45442. export * from "babylonjs/Bones/bone";
  45443. export * from "babylonjs/Bones/boneIKController";
  45444. export * from "babylonjs/Bones/boneLookController";
  45445. export * from "babylonjs/Bones/skeleton";
  45446. }
  45447. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45448. import { Nullable } from "babylonjs/types";
  45449. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45450. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45451. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45452. /**
  45453. * Manage the gamepad inputs to control an arc rotate camera.
  45454. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45455. */
  45456. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45457. /**
  45458. * Defines the camera the input is attached to.
  45459. */
  45460. camera: ArcRotateCamera;
  45461. /**
  45462. * Defines the gamepad the input is gathering event from.
  45463. */
  45464. gamepad: Nullable<Gamepad>;
  45465. /**
  45466. * Defines the gamepad rotation sensiblity.
  45467. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45468. */
  45469. gamepadRotationSensibility: number;
  45470. /**
  45471. * Defines the gamepad move sensiblity.
  45472. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45473. */
  45474. gamepadMoveSensibility: number;
  45475. private _yAxisScale;
  45476. /**
  45477. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45478. */
  45479. get invertYAxis(): boolean;
  45480. set invertYAxis(value: boolean);
  45481. private _onGamepadConnectedObserver;
  45482. private _onGamepadDisconnectedObserver;
  45483. /**
  45484. * Attach the input controls to a specific dom element to get the input from.
  45485. * @param element Defines the element the controls should be listened from
  45486. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45487. */
  45488. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45489. /**
  45490. * Detach the current controls from the specified dom element.
  45491. * @param element Defines the element to stop listening the inputs from
  45492. */
  45493. detachControl(element: Nullable<HTMLElement>): void;
  45494. /**
  45495. * Update the current camera state depending on the inputs that have been used this frame.
  45496. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45497. */
  45498. checkInputs(): void;
  45499. /**
  45500. * Gets the class name of the current intput.
  45501. * @returns the class name
  45502. */
  45503. getClassName(): string;
  45504. /**
  45505. * Get the friendly name associated with the input class.
  45506. * @returns the input friendly name
  45507. */
  45508. getSimpleName(): string;
  45509. }
  45510. }
  45511. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45512. import { Nullable } from "babylonjs/types";
  45513. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45514. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45515. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45516. interface ArcRotateCameraInputsManager {
  45517. /**
  45518. * Add orientation input support to the input manager.
  45519. * @returns the current input manager
  45520. */
  45521. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45522. }
  45523. }
  45524. /**
  45525. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45526. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45527. */
  45528. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45529. /**
  45530. * Defines the camera the input is attached to.
  45531. */
  45532. camera: ArcRotateCamera;
  45533. /**
  45534. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45535. */
  45536. alphaCorrection: number;
  45537. /**
  45538. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45539. */
  45540. gammaCorrection: number;
  45541. private _alpha;
  45542. private _gamma;
  45543. private _dirty;
  45544. private _deviceOrientationHandler;
  45545. /**
  45546. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45547. */
  45548. constructor();
  45549. /**
  45550. * Attach the input controls to a specific dom element to get the input from.
  45551. * @param element Defines the element the controls should be listened from
  45552. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45553. */
  45554. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45555. /** @hidden */
  45556. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45557. /**
  45558. * Update the current camera state depending on the inputs that have been used this frame.
  45559. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45560. */
  45561. checkInputs(): void;
  45562. /**
  45563. * Detach the current controls from the specified dom element.
  45564. * @param element Defines the element to stop listening the inputs from
  45565. */
  45566. detachControl(element: Nullable<HTMLElement>): void;
  45567. /**
  45568. * Gets the class name of the current intput.
  45569. * @returns the class name
  45570. */
  45571. getClassName(): string;
  45572. /**
  45573. * Get the friendly name associated with the input class.
  45574. * @returns the input friendly name
  45575. */
  45576. getSimpleName(): string;
  45577. }
  45578. }
  45579. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45580. import { Nullable } from "babylonjs/types";
  45581. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45582. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45583. /**
  45584. * Listen to mouse events to control the camera.
  45585. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45586. */
  45587. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45588. /**
  45589. * Defines the camera the input is attached to.
  45590. */
  45591. camera: FlyCamera;
  45592. /**
  45593. * Defines if touch is enabled. (Default is true.)
  45594. */
  45595. touchEnabled: boolean;
  45596. /**
  45597. * Defines the buttons associated with the input to handle camera rotation.
  45598. */
  45599. buttons: number[];
  45600. /**
  45601. * Assign buttons for Yaw control.
  45602. */
  45603. buttonsYaw: number[];
  45604. /**
  45605. * Assign buttons for Pitch control.
  45606. */
  45607. buttonsPitch: number[];
  45608. /**
  45609. * Assign buttons for Roll control.
  45610. */
  45611. buttonsRoll: number[];
  45612. /**
  45613. * Detect if any button is being pressed while mouse is moved.
  45614. * -1 = Mouse locked.
  45615. * 0 = Left button.
  45616. * 1 = Middle Button.
  45617. * 2 = Right Button.
  45618. */
  45619. activeButton: number;
  45620. /**
  45621. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45622. * Higher values reduce its sensitivity.
  45623. */
  45624. angularSensibility: number;
  45625. private _mousemoveCallback;
  45626. private _observer;
  45627. private _rollObserver;
  45628. private previousPosition;
  45629. private noPreventDefault;
  45630. private element;
  45631. /**
  45632. * Listen to mouse events to control the camera.
  45633. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45634. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45635. */
  45636. constructor(touchEnabled?: boolean);
  45637. /**
  45638. * Attach the mouse control to the HTML DOM element.
  45639. * @param element Defines the element that listens to the input events.
  45640. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45641. */
  45642. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45643. /**
  45644. * Detach the current controls from the specified dom element.
  45645. * @param element Defines the element to stop listening the inputs from
  45646. */
  45647. detachControl(element: Nullable<HTMLElement>): void;
  45648. /**
  45649. * Gets the class name of the current input.
  45650. * @returns the class name.
  45651. */
  45652. getClassName(): string;
  45653. /**
  45654. * Get the friendly name associated with the input class.
  45655. * @returns the input's friendly name.
  45656. */
  45657. getSimpleName(): string;
  45658. private _pointerInput;
  45659. private _onMouseMove;
  45660. /**
  45661. * Rotate camera by mouse offset.
  45662. */
  45663. private rotateCamera;
  45664. }
  45665. }
  45666. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45667. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45668. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45669. /**
  45670. * Default Inputs manager for the FlyCamera.
  45671. * It groups all the default supported inputs for ease of use.
  45672. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45673. */
  45674. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45675. /**
  45676. * Instantiates a new FlyCameraInputsManager.
  45677. * @param camera Defines the camera the inputs belong to.
  45678. */
  45679. constructor(camera: FlyCamera);
  45680. /**
  45681. * Add keyboard input support to the input manager.
  45682. * @returns the new FlyCameraKeyboardMoveInput().
  45683. */
  45684. addKeyboard(): FlyCameraInputsManager;
  45685. /**
  45686. * Add mouse input support to the input manager.
  45687. * @param touchEnabled Enable touch screen support.
  45688. * @returns the new FlyCameraMouseInput().
  45689. */
  45690. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45691. }
  45692. }
  45693. declare module "babylonjs/Cameras/flyCamera" {
  45694. import { Scene } from "babylonjs/scene";
  45695. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45696. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45697. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45698. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45699. /**
  45700. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45701. * such as in a 3D Space Shooter or a Flight Simulator.
  45702. */
  45703. export class FlyCamera extends TargetCamera {
  45704. /**
  45705. * Define the collision ellipsoid of the camera.
  45706. * This is helpful for simulating a camera body, like a player's body.
  45707. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45708. */
  45709. ellipsoid: Vector3;
  45710. /**
  45711. * Define an offset for the position of the ellipsoid around the camera.
  45712. * This can be helpful if the camera is attached away from the player's body center,
  45713. * such as at its head.
  45714. */
  45715. ellipsoidOffset: Vector3;
  45716. /**
  45717. * Enable or disable collisions of the camera with the rest of the scene objects.
  45718. */
  45719. checkCollisions: boolean;
  45720. /**
  45721. * Enable or disable gravity on the camera.
  45722. */
  45723. applyGravity: boolean;
  45724. /**
  45725. * Define the current direction the camera is moving to.
  45726. */
  45727. cameraDirection: Vector3;
  45728. /**
  45729. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45730. * This overrides and empties cameraRotation.
  45731. */
  45732. rotationQuaternion: Quaternion;
  45733. /**
  45734. * Track Roll to maintain the wanted Rolling when looking around.
  45735. */
  45736. _trackRoll: number;
  45737. /**
  45738. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45739. */
  45740. rollCorrect: number;
  45741. /**
  45742. * Mimic a banked turn, Rolling the camera when Yawing.
  45743. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45744. */
  45745. bankedTurn: boolean;
  45746. /**
  45747. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45748. */
  45749. bankedTurnLimit: number;
  45750. /**
  45751. * Value of 0 disables the banked Roll.
  45752. * Value of 1 is equal to the Yaw angle in radians.
  45753. */
  45754. bankedTurnMultiplier: number;
  45755. /**
  45756. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45757. */
  45758. inputs: FlyCameraInputsManager;
  45759. /**
  45760. * Gets the input sensibility for mouse input.
  45761. * Higher values reduce sensitivity.
  45762. */
  45763. get angularSensibility(): number;
  45764. /**
  45765. * Sets the input sensibility for a mouse input.
  45766. * Higher values reduce sensitivity.
  45767. */
  45768. set angularSensibility(value: number);
  45769. /**
  45770. * Get the keys for camera movement forward.
  45771. */
  45772. get keysForward(): number[];
  45773. /**
  45774. * Set the keys for camera movement forward.
  45775. */
  45776. set keysForward(value: number[]);
  45777. /**
  45778. * Get the keys for camera movement backward.
  45779. */
  45780. get keysBackward(): number[];
  45781. set keysBackward(value: number[]);
  45782. /**
  45783. * Get the keys for camera movement up.
  45784. */
  45785. get keysUp(): number[];
  45786. /**
  45787. * Set the keys for camera movement up.
  45788. */
  45789. set keysUp(value: number[]);
  45790. /**
  45791. * Get the keys for camera movement down.
  45792. */
  45793. get keysDown(): number[];
  45794. /**
  45795. * Set the keys for camera movement down.
  45796. */
  45797. set keysDown(value: number[]);
  45798. /**
  45799. * Get the keys for camera movement left.
  45800. */
  45801. get keysLeft(): number[];
  45802. /**
  45803. * Set the keys for camera movement left.
  45804. */
  45805. set keysLeft(value: number[]);
  45806. /**
  45807. * Set the keys for camera movement right.
  45808. */
  45809. get keysRight(): number[];
  45810. /**
  45811. * Set the keys for camera movement right.
  45812. */
  45813. set keysRight(value: number[]);
  45814. /**
  45815. * Event raised when the camera collides with a mesh in the scene.
  45816. */
  45817. onCollide: (collidedMesh: AbstractMesh) => void;
  45818. private _collider;
  45819. private _needMoveForGravity;
  45820. private _oldPosition;
  45821. private _diffPosition;
  45822. private _newPosition;
  45823. /** @hidden */
  45824. _localDirection: Vector3;
  45825. /** @hidden */
  45826. _transformedDirection: Vector3;
  45827. /**
  45828. * Instantiates a FlyCamera.
  45829. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45830. * such as in a 3D Space Shooter or a Flight Simulator.
  45831. * @param name Define the name of the camera in the scene.
  45832. * @param position Define the starting position of the camera in the scene.
  45833. * @param scene Define the scene the camera belongs to.
  45834. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45835. */
  45836. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45837. /**
  45838. * Attach a control to the HTML DOM element.
  45839. * @param element Defines the element that listens to the input events.
  45840. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45841. */
  45842. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45843. /**
  45844. * Detach a control from the HTML DOM element.
  45845. * The camera will stop reacting to that input.
  45846. * @param element Defines the element that listens to the input events.
  45847. */
  45848. detachControl(element: HTMLElement): void;
  45849. private _collisionMask;
  45850. /**
  45851. * Get the mask that the camera ignores in collision events.
  45852. */
  45853. get collisionMask(): number;
  45854. /**
  45855. * Set the mask that the camera ignores in collision events.
  45856. */
  45857. set collisionMask(mask: number);
  45858. /** @hidden */
  45859. _collideWithWorld(displacement: Vector3): void;
  45860. /** @hidden */
  45861. private _onCollisionPositionChange;
  45862. /** @hidden */
  45863. _checkInputs(): void;
  45864. /** @hidden */
  45865. _decideIfNeedsToMove(): boolean;
  45866. /** @hidden */
  45867. _updatePosition(): void;
  45868. /**
  45869. * Restore the Roll to its target value at the rate specified.
  45870. * @param rate - Higher means slower restoring.
  45871. * @hidden
  45872. */
  45873. restoreRoll(rate: number): void;
  45874. /**
  45875. * Destroy the camera and release the current resources held by it.
  45876. */
  45877. dispose(): void;
  45878. /**
  45879. * Get the current object class name.
  45880. * @returns the class name.
  45881. */
  45882. getClassName(): string;
  45883. }
  45884. }
  45885. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45886. import { Nullable } from "babylonjs/types";
  45887. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45888. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45889. /**
  45890. * Listen to keyboard events to control the camera.
  45891. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45892. */
  45893. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45894. /**
  45895. * Defines the camera the input is attached to.
  45896. */
  45897. camera: FlyCamera;
  45898. /**
  45899. * The list of keyboard keys used to control the forward move of the camera.
  45900. */
  45901. keysForward: number[];
  45902. /**
  45903. * The list of keyboard keys used to control the backward move of the camera.
  45904. */
  45905. keysBackward: number[];
  45906. /**
  45907. * The list of keyboard keys used to control the forward move of the camera.
  45908. */
  45909. keysUp: number[];
  45910. /**
  45911. * The list of keyboard keys used to control the backward move of the camera.
  45912. */
  45913. keysDown: number[];
  45914. /**
  45915. * The list of keyboard keys used to control the right strafe move of the camera.
  45916. */
  45917. keysRight: number[];
  45918. /**
  45919. * The list of keyboard keys used to control the left strafe move of the camera.
  45920. */
  45921. keysLeft: number[];
  45922. private _keys;
  45923. private _onCanvasBlurObserver;
  45924. private _onKeyboardObserver;
  45925. private _engine;
  45926. private _scene;
  45927. /**
  45928. * Attach the input controls to a specific dom element to get the input from.
  45929. * @param element Defines the element the controls should be listened from
  45930. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45931. */
  45932. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45933. /**
  45934. * Detach the current controls from the specified dom element.
  45935. * @param element Defines the element to stop listening the inputs from
  45936. */
  45937. detachControl(element: Nullable<HTMLElement>): void;
  45938. /**
  45939. * Gets the class name of the current intput.
  45940. * @returns the class name
  45941. */
  45942. getClassName(): string;
  45943. /** @hidden */
  45944. _onLostFocus(e: FocusEvent): void;
  45945. /**
  45946. * Get the friendly name associated with the input class.
  45947. * @returns the input friendly name
  45948. */
  45949. getSimpleName(): string;
  45950. /**
  45951. * Update the current camera state depending on the inputs that have been used this frame.
  45952. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45953. */
  45954. checkInputs(): void;
  45955. }
  45956. }
  45957. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45958. import { Nullable } from "babylonjs/types";
  45959. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45960. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45961. /**
  45962. * Manage the mouse wheel inputs to control a follow camera.
  45963. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45964. */
  45965. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  45966. /**
  45967. * Defines the camera the input is attached to.
  45968. */
  45969. camera: FollowCamera;
  45970. /**
  45971. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  45972. */
  45973. axisControlRadius: boolean;
  45974. /**
  45975. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  45976. */
  45977. axisControlHeight: boolean;
  45978. /**
  45979. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  45980. */
  45981. axisControlRotation: boolean;
  45982. /**
  45983. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  45984. * relation to mouseWheel events.
  45985. */
  45986. wheelPrecision: number;
  45987. /**
  45988. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  45989. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  45990. */
  45991. wheelDeltaPercentage: number;
  45992. private _wheel;
  45993. private _observer;
  45994. /**
  45995. * Attach the input controls to a specific dom element to get the input from.
  45996. * @param element Defines the element the controls should be listened from
  45997. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45998. */
  45999. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46000. /**
  46001. * Detach the current controls from the specified dom element.
  46002. * @param element Defines the element to stop listening the inputs from
  46003. */
  46004. detachControl(element: Nullable<HTMLElement>): void;
  46005. /**
  46006. * Gets the class name of the current intput.
  46007. * @returns the class name
  46008. */
  46009. getClassName(): string;
  46010. /**
  46011. * Get the friendly name associated with the input class.
  46012. * @returns the input friendly name
  46013. */
  46014. getSimpleName(): string;
  46015. }
  46016. }
  46017. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46018. import { Nullable } from "babylonjs/types";
  46019. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46020. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46021. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46022. /**
  46023. * Manage the pointers inputs to control an follow camera.
  46024. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46025. */
  46026. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46027. /**
  46028. * Defines the camera the input is attached to.
  46029. */
  46030. camera: FollowCamera;
  46031. /**
  46032. * Gets the class name of the current input.
  46033. * @returns the class name
  46034. */
  46035. getClassName(): string;
  46036. /**
  46037. * Defines the pointer angular sensibility along the X axis or how fast is
  46038. * the camera rotating.
  46039. * A negative number will reverse the axis direction.
  46040. */
  46041. angularSensibilityX: number;
  46042. /**
  46043. * Defines the pointer angular sensibility along the Y axis or how fast is
  46044. * the camera rotating.
  46045. * A negative number will reverse the axis direction.
  46046. */
  46047. angularSensibilityY: number;
  46048. /**
  46049. * Defines the pointer pinch precision or how fast is the camera zooming.
  46050. * A negative number will reverse the axis direction.
  46051. */
  46052. pinchPrecision: number;
  46053. /**
  46054. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46055. * from 0.
  46056. * It defines the percentage of current camera.radius to use as delta when
  46057. * pinch zoom is used.
  46058. */
  46059. pinchDeltaPercentage: number;
  46060. /**
  46061. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46062. */
  46063. axisXControlRadius: boolean;
  46064. /**
  46065. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46066. */
  46067. axisXControlHeight: boolean;
  46068. /**
  46069. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46070. */
  46071. axisXControlRotation: boolean;
  46072. /**
  46073. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46074. */
  46075. axisYControlRadius: boolean;
  46076. /**
  46077. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46078. */
  46079. axisYControlHeight: boolean;
  46080. /**
  46081. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46082. */
  46083. axisYControlRotation: boolean;
  46084. /**
  46085. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46086. */
  46087. axisPinchControlRadius: boolean;
  46088. /**
  46089. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46090. */
  46091. axisPinchControlHeight: boolean;
  46092. /**
  46093. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46094. */
  46095. axisPinchControlRotation: boolean;
  46096. /**
  46097. * Log error messages if basic misconfiguration has occurred.
  46098. */
  46099. warningEnable: boolean;
  46100. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46101. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46102. private _warningCounter;
  46103. private _warning;
  46104. }
  46105. }
  46106. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46107. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46108. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46109. /**
  46110. * Default Inputs manager for the FollowCamera.
  46111. * It groups all the default supported inputs for ease of use.
  46112. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46113. */
  46114. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46115. /**
  46116. * Instantiates a new FollowCameraInputsManager.
  46117. * @param camera Defines the camera the inputs belong to
  46118. */
  46119. constructor(camera: FollowCamera);
  46120. /**
  46121. * Add keyboard input support to the input manager.
  46122. * @returns the current input manager
  46123. */
  46124. addKeyboard(): FollowCameraInputsManager;
  46125. /**
  46126. * Add mouse wheel input support to the input manager.
  46127. * @returns the current input manager
  46128. */
  46129. addMouseWheel(): FollowCameraInputsManager;
  46130. /**
  46131. * Add pointers input support to the input manager.
  46132. * @returns the current input manager
  46133. */
  46134. addPointers(): FollowCameraInputsManager;
  46135. /**
  46136. * Add orientation input support to the input manager.
  46137. * @returns the current input manager
  46138. */
  46139. addVRDeviceOrientation(): FollowCameraInputsManager;
  46140. }
  46141. }
  46142. declare module "babylonjs/Cameras/followCamera" {
  46143. import { Nullable } from "babylonjs/types";
  46144. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46145. import { Scene } from "babylonjs/scene";
  46146. import { Vector3 } from "babylonjs/Maths/math.vector";
  46147. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46148. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46149. /**
  46150. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46151. * an arc rotate version arcFollowCamera are available.
  46152. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46153. */
  46154. export class FollowCamera extends TargetCamera {
  46155. /**
  46156. * Distance the follow camera should follow an object at
  46157. */
  46158. radius: number;
  46159. /**
  46160. * Minimum allowed distance of the camera to the axis of rotation
  46161. * (The camera can not get closer).
  46162. * This can help limiting how the Camera is able to move in the scene.
  46163. */
  46164. lowerRadiusLimit: Nullable<number>;
  46165. /**
  46166. * Maximum allowed distance of the camera to the axis of rotation
  46167. * (The camera can not get further).
  46168. * This can help limiting how the Camera is able to move in the scene.
  46169. */
  46170. upperRadiusLimit: Nullable<number>;
  46171. /**
  46172. * Define a rotation offset between the camera and the object it follows
  46173. */
  46174. rotationOffset: number;
  46175. /**
  46176. * Minimum allowed angle to camera position relative to target object.
  46177. * This can help limiting how the Camera is able to move in the scene.
  46178. */
  46179. lowerRotationOffsetLimit: Nullable<number>;
  46180. /**
  46181. * Maximum allowed angle to camera position relative to target object.
  46182. * This can help limiting how the Camera is able to move in the scene.
  46183. */
  46184. upperRotationOffsetLimit: Nullable<number>;
  46185. /**
  46186. * Define a height offset between the camera and the object it follows.
  46187. * It can help following an object from the top (like a car chaing a plane)
  46188. */
  46189. heightOffset: number;
  46190. /**
  46191. * Minimum allowed height of camera position relative to target object.
  46192. * This can help limiting how the Camera is able to move in the scene.
  46193. */
  46194. lowerHeightOffsetLimit: Nullable<number>;
  46195. /**
  46196. * Maximum allowed height of camera position relative to target object.
  46197. * This can help limiting how the Camera is able to move in the scene.
  46198. */
  46199. upperHeightOffsetLimit: Nullable<number>;
  46200. /**
  46201. * Define how fast the camera can accelerate to follow it s target.
  46202. */
  46203. cameraAcceleration: number;
  46204. /**
  46205. * Define the speed limit of the camera following an object.
  46206. */
  46207. maxCameraSpeed: number;
  46208. /**
  46209. * Define the target of the camera.
  46210. */
  46211. lockedTarget: Nullable<AbstractMesh>;
  46212. /**
  46213. * Defines the input associated with the camera.
  46214. */
  46215. inputs: FollowCameraInputsManager;
  46216. /**
  46217. * Instantiates the follow camera.
  46218. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46219. * @param name Define the name of the camera in the scene
  46220. * @param position Define the position of the camera
  46221. * @param scene Define the scene the camera belong to
  46222. * @param lockedTarget Define the target of the camera
  46223. */
  46224. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46225. private _follow;
  46226. /**
  46227. * Attached controls to the current camera.
  46228. * @param element Defines the element the controls should be listened from
  46229. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46230. */
  46231. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46232. /**
  46233. * Detach the current controls from the camera.
  46234. * The camera will stop reacting to inputs.
  46235. * @param element Defines the element to stop listening the inputs from
  46236. */
  46237. detachControl(element: HTMLElement): void;
  46238. /** @hidden */
  46239. _checkInputs(): void;
  46240. private _checkLimits;
  46241. /**
  46242. * Gets the camera class name.
  46243. * @returns the class name
  46244. */
  46245. getClassName(): string;
  46246. }
  46247. /**
  46248. * Arc Rotate version of the follow camera.
  46249. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46250. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46251. */
  46252. export class ArcFollowCamera extends TargetCamera {
  46253. /** The longitudinal angle of the camera */
  46254. alpha: number;
  46255. /** The latitudinal angle of the camera */
  46256. beta: number;
  46257. /** The radius of the camera from its target */
  46258. radius: number;
  46259. private _cartesianCoordinates;
  46260. /** Define the camera target (the mesh it should follow) */
  46261. private _meshTarget;
  46262. /**
  46263. * Instantiates a new ArcFollowCamera
  46264. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46265. * @param name Define the name of the camera
  46266. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46267. * @param beta Define the rotation angle of the camera around the elevation axis
  46268. * @param radius Define the radius of the camera from its target point
  46269. * @param target Define the target of the camera
  46270. * @param scene Define the scene the camera belongs to
  46271. */
  46272. constructor(name: string,
  46273. /** The longitudinal angle of the camera */
  46274. alpha: number,
  46275. /** The latitudinal angle of the camera */
  46276. beta: number,
  46277. /** The radius of the camera from its target */
  46278. radius: number,
  46279. /** Define the camera target (the mesh it should follow) */
  46280. target: Nullable<AbstractMesh>, scene: Scene);
  46281. private _follow;
  46282. /** @hidden */
  46283. _checkInputs(): void;
  46284. /**
  46285. * Returns the class name of the object.
  46286. * It is mostly used internally for serialization purposes.
  46287. */
  46288. getClassName(): string;
  46289. }
  46290. }
  46291. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46292. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46293. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46294. import { Nullable } from "babylonjs/types";
  46295. /**
  46296. * Manage the keyboard inputs to control the movement of a follow camera.
  46297. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46298. */
  46299. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46300. /**
  46301. * Defines the camera the input is attached to.
  46302. */
  46303. camera: FollowCamera;
  46304. /**
  46305. * Defines the list of key codes associated with the up action (increase heightOffset)
  46306. */
  46307. keysHeightOffsetIncr: number[];
  46308. /**
  46309. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46310. */
  46311. keysHeightOffsetDecr: number[];
  46312. /**
  46313. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46314. */
  46315. keysHeightOffsetModifierAlt: boolean;
  46316. /**
  46317. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46318. */
  46319. keysHeightOffsetModifierCtrl: boolean;
  46320. /**
  46321. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46322. */
  46323. keysHeightOffsetModifierShift: boolean;
  46324. /**
  46325. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46326. */
  46327. keysRotationOffsetIncr: number[];
  46328. /**
  46329. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46330. */
  46331. keysRotationOffsetDecr: number[];
  46332. /**
  46333. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46334. */
  46335. keysRotationOffsetModifierAlt: boolean;
  46336. /**
  46337. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46338. */
  46339. keysRotationOffsetModifierCtrl: boolean;
  46340. /**
  46341. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46342. */
  46343. keysRotationOffsetModifierShift: boolean;
  46344. /**
  46345. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46346. */
  46347. keysRadiusIncr: number[];
  46348. /**
  46349. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46350. */
  46351. keysRadiusDecr: number[];
  46352. /**
  46353. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46354. */
  46355. keysRadiusModifierAlt: boolean;
  46356. /**
  46357. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46358. */
  46359. keysRadiusModifierCtrl: boolean;
  46360. /**
  46361. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46362. */
  46363. keysRadiusModifierShift: boolean;
  46364. /**
  46365. * Defines the rate of change of heightOffset.
  46366. */
  46367. heightSensibility: number;
  46368. /**
  46369. * Defines the rate of change of rotationOffset.
  46370. */
  46371. rotationSensibility: number;
  46372. /**
  46373. * Defines the rate of change of radius.
  46374. */
  46375. radiusSensibility: number;
  46376. private _keys;
  46377. private _ctrlPressed;
  46378. private _altPressed;
  46379. private _shiftPressed;
  46380. private _onCanvasBlurObserver;
  46381. private _onKeyboardObserver;
  46382. private _engine;
  46383. private _scene;
  46384. /**
  46385. * Attach the input controls to a specific dom element to get the input from.
  46386. * @param element Defines the element the controls should be listened from
  46387. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46388. */
  46389. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46390. /**
  46391. * Detach the current controls from the specified dom element.
  46392. * @param element Defines the element to stop listening the inputs from
  46393. */
  46394. detachControl(element: Nullable<HTMLElement>): void;
  46395. /**
  46396. * Update the current camera state depending on the inputs that have been used this frame.
  46397. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46398. */
  46399. checkInputs(): void;
  46400. /**
  46401. * Gets the class name of the current input.
  46402. * @returns the class name
  46403. */
  46404. getClassName(): string;
  46405. /**
  46406. * Get the friendly name associated with the input class.
  46407. * @returns the input friendly name
  46408. */
  46409. getSimpleName(): string;
  46410. /**
  46411. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46412. * allow modification of the heightOffset value.
  46413. */
  46414. private _modifierHeightOffset;
  46415. /**
  46416. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46417. * allow modification of the rotationOffset value.
  46418. */
  46419. private _modifierRotationOffset;
  46420. /**
  46421. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46422. * allow modification of the radius value.
  46423. */
  46424. private _modifierRadius;
  46425. }
  46426. }
  46427. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46428. import { Nullable } from "babylonjs/types";
  46429. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46430. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46431. import { Observable } from "babylonjs/Misc/observable";
  46432. module "babylonjs/Cameras/freeCameraInputsManager" {
  46433. interface FreeCameraInputsManager {
  46434. /**
  46435. * @hidden
  46436. */
  46437. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46438. /**
  46439. * Add orientation input support to the input manager.
  46440. * @returns the current input manager
  46441. */
  46442. addDeviceOrientation(): FreeCameraInputsManager;
  46443. }
  46444. }
  46445. /**
  46446. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46447. * Screen rotation is taken into account.
  46448. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46449. */
  46450. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46451. private _camera;
  46452. private _screenOrientationAngle;
  46453. private _constantTranform;
  46454. private _screenQuaternion;
  46455. private _alpha;
  46456. private _beta;
  46457. private _gamma;
  46458. /**
  46459. * Can be used to detect if a device orientation sensor is available on a device
  46460. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46461. * @returns a promise that will resolve on orientation change
  46462. */
  46463. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46464. /**
  46465. * @hidden
  46466. */
  46467. _onDeviceOrientationChangedObservable: Observable<void>;
  46468. /**
  46469. * Instantiates a new input
  46470. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46471. */
  46472. constructor();
  46473. /**
  46474. * Define the camera controlled by the input.
  46475. */
  46476. get camera(): FreeCamera;
  46477. set camera(camera: FreeCamera);
  46478. /**
  46479. * Attach the input controls to a specific dom element to get the input from.
  46480. * @param element Defines the element the controls should be listened from
  46481. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46482. */
  46483. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46484. private _orientationChanged;
  46485. private _deviceOrientation;
  46486. /**
  46487. * Detach the current controls from the specified dom element.
  46488. * @param element Defines the element to stop listening the inputs from
  46489. */
  46490. detachControl(element: Nullable<HTMLElement>): void;
  46491. /**
  46492. * Update the current camera state depending on the inputs that have been used this frame.
  46493. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46494. */
  46495. checkInputs(): void;
  46496. /**
  46497. * Gets the class name of the current intput.
  46498. * @returns the class name
  46499. */
  46500. getClassName(): string;
  46501. /**
  46502. * Get the friendly name associated with the input class.
  46503. * @returns the input friendly name
  46504. */
  46505. getSimpleName(): string;
  46506. }
  46507. }
  46508. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46509. import { Nullable } from "babylonjs/types";
  46510. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46511. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46512. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46513. /**
  46514. * Manage the gamepad inputs to control a free camera.
  46515. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46516. */
  46517. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46518. /**
  46519. * Define the camera the input is attached to.
  46520. */
  46521. camera: FreeCamera;
  46522. /**
  46523. * Define the Gamepad controlling the input
  46524. */
  46525. gamepad: Nullable<Gamepad>;
  46526. /**
  46527. * Defines the gamepad rotation sensiblity.
  46528. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46529. */
  46530. gamepadAngularSensibility: number;
  46531. /**
  46532. * Defines the gamepad move sensiblity.
  46533. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46534. */
  46535. gamepadMoveSensibility: number;
  46536. private _yAxisScale;
  46537. /**
  46538. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46539. */
  46540. get invertYAxis(): boolean;
  46541. set invertYAxis(value: boolean);
  46542. private _onGamepadConnectedObserver;
  46543. private _onGamepadDisconnectedObserver;
  46544. private _cameraTransform;
  46545. private _deltaTransform;
  46546. private _vector3;
  46547. private _vector2;
  46548. /**
  46549. * Attach the input controls to a specific dom element to get the input from.
  46550. * @param element Defines the element the controls should be listened from
  46551. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46552. */
  46553. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46554. /**
  46555. * Detach the current controls from the specified dom element.
  46556. * @param element Defines the element to stop listening the inputs from
  46557. */
  46558. detachControl(element: Nullable<HTMLElement>): void;
  46559. /**
  46560. * Update the current camera state depending on the inputs that have been used this frame.
  46561. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46562. */
  46563. checkInputs(): void;
  46564. /**
  46565. * Gets the class name of the current intput.
  46566. * @returns the class name
  46567. */
  46568. getClassName(): string;
  46569. /**
  46570. * Get the friendly name associated with the input class.
  46571. * @returns the input friendly name
  46572. */
  46573. getSimpleName(): string;
  46574. }
  46575. }
  46576. declare module "babylonjs/Misc/virtualJoystick" {
  46577. import { Nullable } from "babylonjs/types";
  46578. import { Vector3 } from "babylonjs/Maths/math.vector";
  46579. /**
  46580. * Defines the potential axis of a Joystick
  46581. */
  46582. export enum JoystickAxis {
  46583. /** X axis */
  46584. X = 0,
  46585. /** Y axis */
  46586. Y = 1,
  46587. /** Z axis */
  46588. Z = 2
  46589. }
  46590. /**
  46591. * Represents the different customization options available
  46592. * for VirtualJoystick
  46593. */
  46594. interface VirtualJoystickCustomizations {
  46595. /**
  46596. * Size of the joystick's puck
  46597. */
  46598. puckSize: number;
  46599. /**
  46600. * Size of the joystick's container
  46601. */
  46602. containerSize: number;
  46603. /**
  46604. * Color of the joystick && puck
  46605. */
  46606. color: string;
  46607. /**
  46608. * Image URL for the joystick's puck
  46609. */
  46610. puckImage?: string;
  46611. /**
  46612. * Image URL for the joystick's container
  46613. */
  46614. containerImage?: string;
  46615. /**
  46616. * Defines the unmoving position of the joystick container
  46617. */
  46618. position?: {
  46619. x: number;
  46620. y: number;
  46621. };
  46622. /**
  46623. * Defines whether or not the joystick container is always visible
  46624. */
  46625. alwaysVisible: boolean;
  46626. /**
  46627. * Defines whether or not to limit the movement of the puck to the joystick's container
  46628. */
  46629. limitToContainer: boolean;
  46630. }
  46631. /**
  46632. * Class used to define virtual joystick (used in touch mode)
  46633. */
  46634. export class VirtualJoystick {
  46635. /**
  46636. * Gets or sets a boolean indicating that left and right values must be inverted
  46637. */
  46638. reverseLeftRight: boolean;
  46639. /**
  46640. * Gets or sets a boolean indicating that up and down values must be inverted
  46641. */
  46642. reverseUpDown: boolean;
  46643. /**
  46644. * Gets the offset value for the position (ie. the change of the position value)
  46645. */
  46646. deltaPosition: Vector3;
  46647. /**
  46648. * Gets a boolean indicating if the virtual joystick was pressed
  46649. */
  46650. pressed: boolean;
  46651. /**
  46652. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46653. */
  46654. static Canvas: Nullable<HTMLCanvasElement>;
  46655. /**
  46656. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46657. */
  46658. limitToContainer: boolean;
  46659. private static _globalJoystickIndex;
  46660. private static _alwaysVisibleSticks;
  46661. private static vjCanvasContext;
  46662. private static vjCanvasWidth;
  46663. private static vjCanvasHeight;
  46664. private static halfWidth;
  46665. private static _GetDefaultOptions;
  46666. private _action;
  46667. private _axisTargetedByLeftAndRight;
  46668. private _axisTargetedByUpAndDown;
  46669. private _joystickSensibility;
  46670. private _inversedSensibility;
  46671. private _joystickPointerID;
  46672. private _joystickColor;
  46673. private _joystickPointerPos;
  46674. private _joystickPreviousPointerPos;
  46675. private _joystickPointerStartPos;
  46676. private _deltaJoystickVector;
  46677. private _leftJoystick;
  46678. private _touches;
  46679. private _joystickPosition;
  46680. private _alwaysVisible;
  46681. private _puckImage;
  46682. private _containerImage;
  46683. private _joystickPuckSize;
  46684. private _joystickContainerSize;
  46685. private _clearPuckSize;
  46686. private _clearContainerSize;
  46687. private _clearPuckSizeOffset;
  46688. private _clearContainerSizeOffset;
  46689. private _onPointerDownHandlerRef;
  46690. private _onPointerMoveHandlerRef;
  46691. private _onPointerUpHandlerRef;
  46692. private _onResize;
  46693. /**
  46694. * Creates a new virtual joystick
  46695. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46696. * @param customizations Defines the options we want to customize the VirtualJoystick
  46697. */
  46698. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46699. /**
  46700. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46701. * @param newJoystickSensibility defines the new sensibility
  46702. */
  46703. setJoystickSensibility(newJoystickSensibility: number): void;
  46704. private _onPointerDown;
  46705. private _onPointerMove;
  46706. private _onPointerUp;
  46707. /**
  46708. * Change the color of the virtual joystick
  46709. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46710. */
  46711. setJoystickColor(newColor: string): void;
  46712. /**
  46713. * Size of the joystick's container
  46714. */
  46715. set containerSize(newSize: number);
  46716. get containerSize(): number;
  46717. /**
  46718. * Size of the joystick's puck
  46719. */
  46720. set puckSize(newSize: number);
  46721. get puckSize(): number;
  46722. /**
  46723. * Clears the set position of the joystick
  46724. */
  46725. clearPosition(): void;
  46726. /**
  46727. * Defines whether or not the joystick container is always visible
  46728. */
  46729. set alwaysVisible(value: boolean);
  46730. get alwaysVisible(): boolean;
  46731. /**
  46732. * Sets the constant position of the Joystick container
  46733. * @param x X axis coordinate
  46734. * @param y Y axis coordinate
  46735. */
  46736. setPosition(x: number, y: number): void;
  46737. /**
  46738. * Defines a callback to call when the joystick is touched
  46739. * @param action defines the callback
  46740. */
  46741. setActionOnTouch(action: () => any): void;
  46742. /**
  46743. * Defines which axis you'd like to control for left & right
  46744. * @param axis defines the axis to use
  46745. */
  46746. setAxisForLeftRight(axis: JoystickAxis): void;
  46747. /**
  46748. * Defines which axis you'd like to control for up & down
  46749. * @param axis defines the axis to use
  46750. */
  46751. setAxisForUpDown(axis: JoystickAxis): void;
  46752. /**
  46753. * Clears the canvas from the previous puck / container draw
  46754. */
  46755. private _clearPreviousDraw;
  46756. /**
  46757. * Loads `urlPath` to be used for the container's image
  46758. * @param urlPath defines the urlPath of an image to use
  46759. */
  46760. setContainerImage(urlPath: string): void;
  46761. /**
  46762. * Loads `urlPath` to be used for the puck's image
  46763. * @param urlPath defines the urlPath of an image to use
  46764. */
  46765. setPuckImage(urlPath: string): void;
  46766. /**
  46767. * Draws the Virtual Joystick's container
  46768. */
  46769. private _drawContainer;
  46770. /**
  46771. * Draws the Virtual Joystick's puck
  46772. */
  46773. private _drawPuck;
  46774. private _drawVirtualJoystick;
  46775. /**
  46776. * Release internal HTML canvas
  46777. */
  46778. releaseCanvas(): void;
  46779. }
  46780. }
  46781. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46782. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46783. import { Nullable } from "babylonjs/types";
  46784. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46785. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46786. module "babylonjs/Cameras/freeCameraInputsManager" {
  46787. interface FreeCameraInputsManager {
  46788. /**
  46789. * Add virtual joystick input support to the input manager.
  46790. * @returns the current input manager
  46791. */
  46792. addVirtualJoystick(): FreeCameraInputsManager;
  46793. }
  46794. }
  46795. /**
  46796. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46797. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46798. */
  46799. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46800. /**
  46801. * Defines the camera the input is attached to.
  46802. */
  46803. camera: FreeCamera;
  46804. private _leftjoystick;
  46805. private _rightjoystick;
  46806. /**
  46807. * Gets the left stick of the virtual joystick.
  46808. * @returns The virtual Joystick
  46809. */
  46810. getLeftJoystick(): VirtualJoystick;
  46811. /**
  46812. * Gets the right stick of the virtual joystick.
  46813. * @returns The virtual Joystick
  46814. */
  46815. getRightJoystick(): VirtualJoystick;
  46816. /**
  46817. * Update the current camera state depending on the inputs that have been used this frame.
  46818. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46819. */
  46820. checkInputs(): void;
  46821. /**
  46822. * Attach the input controls to a specific dom element to get the input from.
  46823. * @param element Defines the element the controls should be listened from
  46824. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46825. */
  46826. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46827. /**
  46828. * Detach the current controls from the specified dom element.
  46829. * @param element Defines the element to stop listening the inputs from
  46830. */
  46831. detachControl(element: Nullable<HTMLElement>): void;
  46832. /**
  46833. * Gets the class name of the current intput.
  46834. * @returns the class name
  46835. */
  46836. getClassName(): string;
  46837. /**
  46838. * Get the friendly name associated with the input class.
  46839. * @returns the input friendly name
  46840. */
  46841. getSimpleName(): string;
  46842. }
  46843. }
  46844. declare module "babylonjs/Cameras/Inputs/index" {
  46845. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46846. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46847. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46848. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46849. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46850. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46851. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46852. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46853. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46854. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46855. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46856. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46857. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46858. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46859. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46860. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46861. }
  46862. declare module "babylonjs/Cameras/touchCamera" {
  46863. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46864. import { Scene } from "babylonjs/scene";
  46865. import { Vector3 } from "babylonjs/Maths/math.vector";
  46866. /**
  46867. * This represents a FPS type of camera controlled by touch.
  46868. * This is like a universal camera minus the Gamepad controls.
  46869. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46870. */
  46871. export class TouchCamera extends FreeCamera {
  46872. /**
  46873. * Defines the touch sensibility for rotation.
  46874. * The higher the faster.
  46875. */
  46876. get touchAngularSensibility(): number;
  46877. set touchAngularSensibility(value: number);
  46878. /**
  46879. * Defines the touch sensibility for move.
  46880. * The higher the faster.
  46881. */
  46882. get touchMoveSensibility(): number;
  46883. set touchMoveSensibility(value: number);
  46884. /**
  46885. * Instantiates a new touch camera.
  46886. * This represents a FPS type of camera controlled by touch.
  46887. * This is like a universal camera minus the Gamepad controls.
  46888. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46889. * @param name Define the name of the camera in the scene
  46890. * @param position Define the start position of the camera in the scene
  46891. * @param scene Define the scene the camera belongs to
  46892. */
  46893. constructor(name: string, position: Vector3, scene: Scene);
  46894. /**
  46895. * Gets the current object class name.
  46896. * @return the class name
  46897. */
  46898. getClassName(): string;
  46899. /** @hidden */
  46900. _setupInputs(): void;
  46901. }
  46902. }
  46903. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46904. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46905. import { Scene } from "babylonjs/scene";
  46906. import { Vector3 } from "babylonjs/Maths/math.vector";
  46907. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46908. import { Axis } from "babylonjs/Maths/math.axis";
  46909. /**
  46910. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46911. * being tilted forward or back and left or right.
  46912. */
  46913. export class DeviceOrientationCamera extends FreeCamera {
  46914. private _initialQuaternion;
  46915. private _quaternionCache;
  46916. private _tmpDragQuaternion;
  46917. private _disablePointerInputWhenUsingDeviceOrientation;
  46918. /**
  46919. * Creates a new device orientation camera
  46920. * @param name The name of the camera
  46921. * @param position The start position camera
  46922. * @param scene The scene the camera belongs to
  46923. */
  46924. constructor(name: string, position: Vector3, scene: Scene);
  46925. /**
  46926. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46927. */
  46928. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46929. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46930. private _dragFactor;
  46931. /**
  46932. * Enabled turning on the y axis when the orientation sensor is active
  46933. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46934. */
  46935. enableHorizontalDragging(dragFactor?: number): void;
  46936. /**
  46937. * Gets the current instance class name ("DeviceOrientationCamera").
  46938. * This helps avoiding instanceof at run time.
  46939. * @returns the class name
  46940. */
  46941. getClassName(): string;
  46942. /**
  46943. * @hidden
  46944. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46945. */
  46946. _checkInputs(): void;
  46947. /**
  46948. * Reset the camera to its default orientation on the specified axis only.
  46949. * @param axis The axis to reset
  46950. */
  46951. resetToCurrentRotation(axis?: Axis): void;
  46952. }
  46953. }
  46954. declare module "babylonjs/Gamepads/xboxGamepad" {
  46955. import { Observable } from "babylonjs/Misc/observable";
  46956. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46957. /**
  46958. * Defines supported buttons for XBox360 compatible gamepads
  46959. */
  46960. export enum Xbox360Button {
  46961. /** A */
  46962. A = 0,
  46963. /** B */
  46964. B = 1,
  46965. /** X */
  46966. X = 2,
  46967. /** Y */
  46968. Y = 3,
  46969. /** Left button */
  46970. LB = 4,
  46971. /** Right button */
  46972. RB = 5,
  46973. /** Back */
  46974. Back = 8,
  46975. /** Start */
  46976. Start = 9,
  46977. /** Left stick */
  46978. LeftStick = 10,
  46979. /** Right stick */
  46980. RightStick = 11
  46981. }
  46982. /** Defines values for XBox360 DPad */
  46983. export enum Xbox360Dpad {
  46984. /** Up */
  46985. Up = 12,
  46986. /** Down */
  46987. Down = 13,
  46988. /** Left */
  46989. Left = 14,
  46990. /** Right */
  46991. Right = 15
  46992. }
  46993. /**
  46994. * Defines a XBox360 gamepad
  46995. */
  46996. export class Xbox360Pad extends Gamepad {
  46997. private _leftTrigger;
  46998. private _rightTrigger;
  46999. private _onlefttriggerchanged;
  47000. private _onrighttriggerchanged;
  47001. private _onbuttondown;
  47002. private _onbuttonup;
  47003. private _ondpaddown;
  47004. private _ondpadup;
  47005. /** Observable raised when a button is pressed */
  47006. onButtonDownObservable: Observable<Xbox360Button>;
  47007. /** Observable raised when a button is released */
  47008. onButtonUpObservable: Observable<Xbox360Button>;
  47009. /** Observable raised when a pad is pressed */
  47010. onPadDownObservable: Observable<Xbox360Dpad>;
  47011. /** Observable raised when a pad is released */
  47012. onPadUpObservable: Observable<Xbox360Dpad>;
  47013. private _buttonA;
  47014. private _buttonB;
  47015. private _buttonX;
  47016. private _buttonY;
  47017. private _buttonBack;
  47018. private _buttonStart;
  47019. private _buttonLB;
  47020. private _buttonRB;
  47021. private _buttonLeftStick;
  47022. private _buttonRightStick;
  47023. private _dPadUp;
  47024. private _dPadDown;
  47025. private _dPadLeft;
  47026. private _dPadRight;
  47027. private _isXboxOnePad;
  47028. /**
  47029. * Creates a new XBox360 gamepad object
  47030. * @param id defines the id of this gamepad
  47031. * @param index defines its index
  47032. * @param gamepad defines the internal HTML gamepad object
  47033. * @param xboxOne defines if it is a XBox One gamepad
  47034. */
  47035. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47036. /**
  47037. * Defines the callback to call when left trigger is pressed
  47038. * @param callback defines the callback to use
  47039. */
  47040. onlefttriggerchanged(callback: (value: number) => void): void;
  47041. /**
  47042. * Defines the callback to call when right trigger is pressed
  47043. * @param callback defines the callback to use
  47044. */
  47045. onrighttriggerchanged(callback: (value: number) => void): void;
  47046. /**
  47047. * Gets the left trigger value
  47048. */
  47049. get leftTrigger(): number;
  47050. /**
  47051. * Sets the left trigger value
  47052. */
  47053. set leftTrigger(newValue: number);
  47054. /**
  47055. * Gets the right trigger value
  47056. */
  47057. get rightTrigger(): number;
  47058. /**
  47059. * Sets the right trigger value
  47060. */
  47061. set rightTrigger(newValue: number);
  47062. /**
  47063. * Defines the callback to call when a button is pressed
  47064. * @param callback defines the callback to use
  47065. */
  47066. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47067. /**
  47068. * Defines the callback to call when a button is released
  47069. * @param callback defines the callback to use
  47070. */
  47071. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47072. /**
  47073. * Defines the callback to call when a pad is pressed
  47074. * @param callback defines the callback to use
  47075. */
  47076. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47077. /**
  47078. * Defines the callback to call when a pad is released
  47079. * @param callback defines the callback to use
  47080. */
  47081. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47082. private _setButtonValue;
  47083. private _setDPadValue;
  47084. /**
  47085. * Gets the value of the `A` button
  47086. */
  47087. get buttonA(): number;
  47088. /**
  47089. * Sets the value of the `A` button
  47090. */
  47091. set buttonA(value: number);
  47092. /**
  47093. * Gets the value of the `B` button
  47094. */
  47095. get buttonB(): number;
  47096. /**
  47097. * Sets the value of the `B` button
  47098. */
  47099. set buttonB(value: number);
  47100. /**
  47101. * Gets the value of the `X` button
  47102. */
  47103. get buttonX(): number;
  47104. /**
  47105. * Sets the value of the `X` button
  47106. */
  47107. set buttonX(value: number);
  47108. /**
  47109. * Gets the value of the `Y` button
  47110. */
  47111. get buttonY(): number;
  47112. /**
  47113. * Sets the value of the `Y` button
  47114. */
  47115. set buttonY(value: number);
  47116. /**
  47117. * Gets the value of the `Start` button
  47118. */
  47119. get buttonStart(): number;
  47120. /**
  47121. * Sets the value of the `Start` button
  47122. */
  47123. set buttonStart(value: number);
  47124. /**
  47125. * Gets the value of the `Back` button
  47126. */
  47127. get buttonBack(): number;
  47128. /**
  47129. * Sets the value of the `Back` button
  47130. */
  47131. set buttonBack(value: number);
  47132. /**
  47133. * Gets the value of the `Left` button
  47134. */
  47135. get buttonLB(): number;
  47136. /**
  47137. * Sets the value of the `Left` button
  47138. */
  47139. set buttonLB(value: number);
  47140. /**
  47141. * Gets the value of the `Right` button
  47142. */
  47143. get buttonRB(): number;
  47144. /**
  47145. * Sets the value of the `Right` button
  47146. */
  47147. set buttonRB(value: number);
  47148. /**
  47149. * Gets the value of the Left joystick
  47150. */
  47151. get buttonLeftStick(): number;
  47152. /**
  47153. * Sets the value of the Left joystick
  47154. */
  47155. set buttonLeftStick(value: number);
  47156. /**
  47157. * Gets the value of the Right joystick
  47158. */
  47159. get buttonRightStick(): number;
  47160. /**
  47161. * Sets the value of the Right joystick
  47162. */
  47163. set buttonRightStick(value: number);
  47164. /**
  47165. * Gets the value of D-pad up
  47166. */
  47167. get dPadUp(): number;
  47168. /**
  47169. * Sets the value of D-pad up
  47170. */
  47171. set dPadUp(value: number);
  47172. /**
  47173. * Gets the value of D-pad down
  47174. */
  47175. get dPadDown(): number;
  47176. /**
  47177. * Sets the value of D-pad down
  47178. */
  47179. set dPadDown(value: number);
  47180. /**
  47181. * Gets the value of D-pad left
  47182. */
  47183. get dPadLeft(): number;
  47184. /**
  47185. * Sets the value of D-pad left
  47186. */
  47187. set dPadLeft(value: number);
  47188. /**
  47189. * Gets the value of D-pad right
  47190. */
  47191. get dPadRight(): number;
  47192. /**
  47193. * Sets the value of D-pad right
  47194. */
  47195. set dPadRight(value: number);
  47196. /**
  47197. * Force the gamepad to synchronize with device values
  47198. */
  47199. update(): void;
  47200. /**
  47201. * Disposes the gamepad
  47202. */
  47203. dispose(): void;
  47204. }
  47205. }
  47206. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47207. import { Observable } from "babylonjs/Misc/observable";
  47208. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47209. /**
  47210. * Defines supported buttons for DualShock compatible gamepads
  47211. */
  47212. export enum DualShockButton {
  47213. /** Cross */
  47214. Cross = 0,
  47215. /** Circle */
  47216. Circle = 1,
  47217. /** Square */
  47218. Square = 2,
  47219. /** Triangle */
  47220. Triangle = 3,
  47221. /** L1 */
  47222. L1 = 4,
  47223. /** R1 */
  47224. R1 = 5,
  47225. /** Share */
  47226. Share = 8,
  47227. /** Options */
  47228. Options = 9,
  47229. /** Left stick */
  47230. LeftStick = 10,
  47231. /** Right stick */
  47232. RightStick = 11
  47233. }
  47234. /** Defines values for DualShock DPad */
  47235. export enum DualShockDpad {
  47236. /** Up */
  47237. Up = 12,
  47238. /** Down */
  47239. Down = 13,
  47240. /** Left */
  47241. Left = 14,
  47242. /** Right */
  47243. Right = 15
  47244. }
  47245. /**
  47246. * Defines a DualShock gamepad
  47247. */
  47248. export class DualShockPad extends Gamepad {
  47249. private _leftTrigger;
  47250. private _rightTrigger;
  47251. private _onlefttriggerchanged;
  47252. private _onrighttriggerchanged;
  47253. private _onbuttondown;
  47254. private _onbuttonup;
  47255. private _ondpaddown;
  47256. private _ondpadup;
  47257. /** Observable raised when a button is pressed */
  47258. onButtonDownObservable: Observable<DualShockButton>;
  47259. /** Observable raised when a button is released */
  47260. onButtonUpObservable: Observable<DualShockButton>;
  47261. /** Observable raised when a pad is pressed */
  47262. onPadDownObservable: Observable<DualShockDpad>;
  47263. /** Observable raised when a pad is released */
  47264. onPadUpObservable: Observable<DualShockDpad>;
  47265. private _buttonCross;
  47266. private _buttonCircle;
  47267. private _buttonSquare;
  47268. private _buttonTriangle;
  47269. private _buttonShare;
  47270. private _buttonOptions;
  47271. private _buttonL1;
  47272. private _buttonR1;
  47273. private _buttonLeftStick;
  47274. private _buttonRightStick;
  47275. private _dPadUp;
  47276. private _dPadDown;
  47277. private _dPadLeft;
  47278. private _dPadRight;
  47279. /**
  47280. * Creates a new DualShock gamepad object
  47281. * @param id defines the id of this gamepad
  47282. * @param index defines its index
  47283. * @param gamepad defines the internal HTML gamepad object
  47284. */
  47285. constructor(id: string, index: number, gamepad: any);
  47286. /**
  47287. * Defines the callback to call when left trigger is pressed
  47288. * @param callback defines the callback to use
  47289. */
  47290. onlefttriggerchanged(callback: (value: number) => void): void;
  47291. /**
  47292. * Defines the callback to call when right trigger is pressed
  47293. * @param callback defines the callback to use
  47294. */
  47295. onrighttriggerchanged(callback: (value: number) => void): void;
  47296. /**
  47297. * Gets the left trigger value
  47298. */
  47299. get leftTrigger(): number;
  47300. /**
  47301. * Sets the left trigger value
  47302. */
  47303. set leftTrigger(newValue: number);
  47304. /**
  47305. * Gets the right trigger value
  47306. */
  47307. get rightTrigger(): number;
  47308. /**
  47309. * Sets the right trigger value
  47310. */
  47311. set rightTrigger(newValue: number);
  47312. /**
  47313. * Defines the callback to call when a button is pressed
  47314. * @param callback defines the callback to use
  47315. */
  47316. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47317. /**
  47318. * Defines the callback to call when a button is released
  47319. * @param callback defines the callback to use
  47320. */
  47321. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47322. /**
  47323. * Defines the callback to call when a pad is pressed
  47324. * @param callback defines the callback to use
  47325. */
  47326. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47327. /**
  47328. * Defines the callback to call when a pad is released
  47329. * @param callback defines the callback to use
  47330. */
  47331. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47332. private _setButtonValue;
  47333. private _setDPadValue;
  47334. /**
  47335. * Gets the value of the `Cross` button
  47336. */
  47337. get buttonCross(): number;
  47338. /**
  47339. * Sets the value of the `Cross` button
  47340. */
  47341. set buttonCross(value: number);
  47342. /**
  47343. * Gets the value of the `Circle` button
  47344. */
  47345. get buttonCircle(): number;
  47346. /**
  47347. * Sets the value of the `Circle` button
  47348. */
  47349. set buttonCircle(value: number);
  47350. /**
  47351. * Gets the value of the `Square` button
  47352. */
  47353. get buttonSquare(): number;
  47354. /**
  47355. * Sets the value of the `Square` button
  47356. */
  47357. set buttonSquare(value: number);
  47358. /**
  47359. * Gets the value of the `Triangle` button
  47360. */
  47361. get buttonTriangle(): number;
  47362. /**
  47363. * Sets the value of the `Triangle` button
  47364. */
  47365. set buttonTriangle(value: number);
  47366. /**
  47367. * Gets the value of the `Options` button
  47368. */
  47369. get buttonOptions(): number;
  47370. /**
  47371. * Sets the value of the `Options` button
  47372. */
  47373. set buttonOptions(value: number);
  47374. /**
  47375. * Gets the value of the `Share` button
  47376. */
  47377. get buttonShare(): number;
  47378. /**
  47379. * Sets the value of the `Share` button
  47380. */
  47381. set buttonShare(value: number);
  47382. /**
  47383. * Gets the value of the `L1` button
  47384. */
  47385. get buttonL1(): number;
  47386. /**
  47387. * Sets the value of the `L1` button
  47388. */
  47389. set buttonL1(value: number);
  47390. /**
  47391. * Gets the value of the `R1` button
  47392. */
  47393. get buttonR1(): number;
  47394. /**
  47395. * Sets the value of the `R1` button
  47396. */
  47397. set buttonR1(value: number);
  47398. /**
  47399. * Gets the value of the Left joystick
  47400. */
  47401. get buttonLeftStick(): number;
  47402. /**
  47403. * Sets the value of the Left joystick
  47404. */
  47405. set buttonLeftStick(value: number);
  47406. /**
  47407. * Gets the value of the Right joystick
  47408. */
  47409. get buttonRightStick(): number;
  47410. /**
  47411. * Sets the value of the Right joystick
  47412. */
  47413. set buttonRightStick(value: number);
  47414. /**
  47415. * Gets the value of D-pad up
  47416. */
  47417. get dPadUp(): number;
  47418. /**
  47419. * Sets the value of D-pad up
  47420. */
  47421. set dPadUp(value: number);
  47422. /**
  47423. * Gets the value of D-pad down
  47424. */
  47425. get dPadDown(): number;
  47426. /**
  47427. * Sets the value of D-pad down
  47428. */
  47429. set dPadDown(value: number);
  47430. /**
  47431. * Gets the value of D-pad left
  47432. */
  47433. get dPadLeft(): number;
  47434. /**
  47435. * Sets the value of D-pad left
  47436. */
  47437. set dPadLeft(value: number);
  47438. /**
  47439. * Gets the value of D-pad right
  47440. */
  47441. get dPadRight(): number;
  47442. /**
  47443. * Sets the value of D-pad right
  47444. */
  47445. set dPadRight(value: number);
  47446. /**
  47447. * Force the gamepad to synchronize with device values
  47448. */
  47449. update(): void;
  47450. /**
  47451. * Disposes the gamepad
  47452. */
  47453. dispose(): void;
  47454. }
  47455. }
  47456. declare module "babylonjs/Gamepads/gamepadManager" {
  47457. import { Observable } from "babylonjs/Misc/observable";
  47458. import { Nullable } from "babylonjs/types";
  47459. import { Scene } from "babylonjs/scene";
  47460. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47461. /**
  47462. * Manager for handling gamepads
  47463. */
  47464. export class GamepadManager {
  47465. private _scene?;
  47466. private _babylonGamepads;
  47467. private _oneGamepadConnected;
  47468. /** @hidden */
  47469. _isMonitoring: boolean;
  47470. private _gamepadEventSupported;
  47471. private _gamepadSupport?;
  47472. /**
  47473. * observable to be triggered when the gamepad controller has been connected
  47474. */
  47475. onGamepadConnectedObservable: Observable<Gamepad>;
  47476. /**
  47477. * observable to be triggered when the gamepad controller has been disconnected
  47478. */
  47479. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47480. private _onGamepadConnectedEvent;
  47481. private _onGamepadDisconnectedEvent;
  47482. /**
  47483. * Initializes the gamepad manager
  47484. * @param _scene BabylonJS scene
  47485. */
  47486. constructor(_scene?: Scene | undefined);
  47487. /**
  47488. * The gamepads in the game pad manager
  47489. */
  47490. get gamepads(): Gamepad[];
  47491. /**
  47492. * Get the gamepad controllers based on type
  47493. * @param type The type of gamepad controller
  47494. * @returns Nullable gamepad
  47495. */
  47496. getGamepadByType(type?: number): Nullable<Gamepad>;
  47497. /**
  47498. * Disposes the gamepad manager
  47499. */
  47500. dispose(): void;
  47501. private _addNewGamepad;
  47502. private _startMonitoringGamepads;
  47503. private _stopMonitoringGamepads;
  47504. /** @hidden */
  47505. _checkGamepadsStatus(): void;
  47506. private _updateGamepadObjects;
  47507. }
  47508. }
  47509. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47510. import { Nullable } from "babylonjs/types";
  47511. import { Scene } from "babylonjs/scene";
  47512. import { ISceneComponent } from "babylonjs/sceneComponent";
  47513. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47514. module "babylonjs/scene" {
  47515. interface Scene {
  47516. /** @hidden */
  47517. _gamepadManager: Nullable<GamepadManager>;
  47518. /**
  47519. * Gets the gamepad manager associated with the scene
  47520. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47521. */
  47522. gamepadManager: GamepadManager;
  47523. }
  47524. }
  47525. module "babylonjs/Cameras/freeCameraInputsManager" {
  47526. /**
  47527. * Interface representing a free camera inputs manager
  47528. */
  47529. interface FreeCameraInputsManager {
  47530. /**
  47531. * Adds gamepad input support to the FreeCameraInputsManager.
  47532. * @returns the FreeCameraInputsManager
  47533. */
  47534. addGamepad(): FreeCameraInputsManager;
  47535. }
  47536. }
  47537. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47538. /**
  47539. * Interface representing an arc rotate camera inputs manager
  47540. */
  47541. interface ArcRotateCameraInputsManager {
  47542. /**
  47543. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47544. * @returns the camera inputs manager
  47545. */
  47546. addGamepad(): ArcRotateCameraInputsManager;
  47547. }
  47548. }
  47549. /**
  47550. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47551. */
  47552. export class GamepadSystemSceneComponent implements ISceneComponent {
  47553. /**
  47554. * The component name helpfull to identify the component in the list of scene components.
  47555. */
  47556. readonly name: string;
  47557. /**
  47558. * The scene the component belongs to.
  47559. */
  47560. scene: Scene;
  47561. /**
  47562. * Creates a new instance of the component for the given scene
  47563. * @param scene Defines the scene to register the component in
  47564. */
  47565. constructor(scene: Scene);
  47566. /**
  47567. * Registers the component in a given scene
  47568. */
  47569. register(): void;
  47570. /**
  47571. * Rebuilds the elements related to this component in case of
  47572. * context lost for instance.
  47573. */
  47574. rebuild(): void;
  47575. /**
  47576. * Disposes the component and the associated ressources
  47577. */
  47578. dispose(): void;
  47579. private _beforeCameraUpdate;
  47580. }
  47581. }
  47582. declare module "babylonjs/Cameras/universalCamera" {
  47583. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47584. import { Scene } from "babylonjs/scene";
  47585. import { Vector3 } from "babylonjs/Maths/math.vector";
  47586. import "babylonjs/Gamepads/gamepadSceneComponent";
  47587. /**
  47588. * 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,
  47589. * which still works and will still be found in many Playgrounds.
  47590. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47591. */
  47592. export class UniversalCamera extends TouchCamera {
  47593. /**
  47594. * Defines the gamepad rotation sensiblity.
  47595. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47596. */
  47597. get gamepadAngularSensibility(): number;
  47598. set gamepadAngularSensibility(value: number);
  47599. /**
  47600. * Defines the gamepad move sensiblity.
  47601. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47602. */
  47603. get gamepadMoveSensibility(): number;
  47604. set gamepadMoveSensibility(value: number);
  47605. /**
  47606. * 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,
  47607. * which still works and will still be found in many Playgrounds.
  47608. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47609. * @param name Define the name of the camera in the scene
  47610. * @param position Define the start position of the camera in the scene
  47611. * @param scene Define the scene the camera belongs to
  47612. */
  47613. constructor(name: string, position: Vector3, scene: Scene);
  47614. /**
  47615. * Gets the current object class name.
  47616. * @return the class name
  47617. */
  47618. getClassName(): string;
  47619. }
  47620. }
  47621. declare module "babylonjs/Cameras/gamepadCamera" {
  47622. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47623. import { Scene } from "babylonjs/scene";
  47624. import { Vector3 } from "babylonjs/Maths/math.vector";
  47625. /**
  47626. * This represents a FPS type of camera. This is only here for back compat purpose.
  47627. * Please use the UniversalCamera instead as both are identical.
  47628. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47629. */
  47630. export class GamepadCamera extends UniversalCamera {
  47631. /**
  47632. * Instantiates a new Gamepad Camera
  47633. * This represents a FPS type of camera. This is only here for back compat purpose.
  47634. * Please use the UniversalCamera instead as both are identical.
  47635. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47636. * @param name Define the name of the camera in the scene
  47637. * @param position Define the start position of the camera in the scene
  47638. * @param scene Define the scene the camera belongs to
  47639. */
  47640. constructor(name: string, position: Vector3, scene: Scene);
  47641. /**
  47642. * Gets the current object class name.
  47643. * @return the class name
  47644. */
  47645. getClassName(): string;
  47646. }
  47647. }
  47648. declare module "babylonjs/Shaders/pass.fragment" {
  47649. /** @hidden */
  47650. export var passPixelShader: {
  47651. name: string;
  47652. shader: string;
  47653. };
  47654. }
  47655. declare module "babylonjs/Shaders/passCube.fragment" {
  47656. /** @hidden */
  47657. export var passCubePixelShader: {
  47658. name: string;
  47659. shader: string;
  47660. };
  47661. }
  47662. declare module "babylonjs/PostProcesses/passPostProcess" {
  47663. import { Nullable } from "babylonjs/types";
  47664. import { Camera } from "babylonjs/Cameras/camera";
  47665. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47666. import { Engine } from "babylonjs/Engines/engine";
  47667. import "babylonjs/Shaders/pass.fragment";
  47668. import "babylonjs/Shaders/passCube.fragment";
  47669. import { Scene } from "babylonjs/scene";
  47670. /**
  47671. * PassPostProcess which produces an output the same as it's input
  47672. */
  47673. export class PassPostProcess extends PostProcess {
  47674. /**
  47675. * Gets a string identifying the name of the class
  47676. * @returns "PassPostProcess" string
  47677. */
  47678. getClassName(): string;
  47679. /**
  47680. * Creates the PassPostProcess
  47681. * @param name The name of the effect.
  47682. * @param options The required width/height ratio to downsize to before computing the render pass.
  47683. * @param camera The camera to apply the render pass to.
  47684. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47685. * @param engine The engine which the post process will be applied. (default: current engine)
  47686. * @param reusable If the post process can be reused on the same frame. (default: false)
  47687. * @param textureType The type of texture to be used when performing the post processing.
  47688. * @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)
  47689. */
  47690. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47691. /** @hidden */
  47692. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47693. }
  47694. /**
  47695. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47696. */
  47697. export class PassCubePostProcess extends PostProcess {
  47698. private _face;
  47699. /**
  47700. * Gets or sets the cube face to display.
  47701. * * 0 is +X
  47702. * * 1 is -X
  47703. * * 2 is +Y
  47704. * * 3 is -Y
  47705. * * 4 is +Z
  47706. * * 5 is -Z
  47707. */
  47708. get face(): number;
  47709. set face(value: number);
  47710. /**
  47711. * Gets a string identifying the name of the class
  47712. * @returns "PassCubePostProcess" string
  47713. */
  47714. getClassName(): string;
  47715. /**
  47716. * Creates the PassCubePostProcess
  47717. * @param name The name of the effect.
  47718. * @param options The required width/height ratio to downsize to before computing the render pass.
  47719. * @param camera The camera to apply the render pass to.
  47720. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47721. * @param engine The engine which the post process will be applied. (default: current engine)
  47722. * @param reusable If the post process can be reused on the same frame. (default: false)
  47723. * @param textureType The type of texture to be used when performing the post processing.
  47724. * @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)
  47725. */
  47726. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47727. /** @hidden */
  47728. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47729. }
  47730. }
  47731. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47732. /** @hidden */
  47733. export var anaglyphPixelShader: {
  47734. name: string;
  47735. shader: string;
  47736. };
  47737. }
  47738. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47739. import { Engine } from "babylonjs/Engines/engine";
  47740. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47741. import { Camera } from "babylonjs/Cameras/camera";
  47742. import "babylonjs/Shaders/anaglyph.fragment";
  47743. /**
  47744. * Postprocess used to generate anaglyphic rendering
  47745. */
  47746. export class AnaglyphPostProcess extends PostProcess {
  47747. private _passedProcess;
  47748. /**
  47749. * Gets a string identifying the name of the class
  47750. * @returns "AnaglyphPostProcess" string
  47751. */
  47752. getClassName(): string;
  47753. /**
  47754. * Creates a new AnaglyphPostProcess
  47755. * @param name defines postprocess name
  47756. * @param options defines creation options or target ratio scale
  47757. * @param rigCameras defines cameras using this postprocess
  47758. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47759. * @param engine defines hosting engine
  47760. * @param reusable defines if the postprocess will be reused multiple times per frame
  47761. */
  47762. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47763. }
  47764. }
  47765. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47766. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47767. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47768. import { Scene } from "babylonjs/scene";
  47769. import { Vector3 } from "babylonjs/Maths/math.vector";
  47770. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47771. /**
  47772. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47773. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47774. */
  47775. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47776. /**
  47777. * Creates a new AnaglyphArcRotateCamera
  47778. * @param name defines camera name
  47779. * @param alpha defines alpha angle (in radians)
  47780. * @param beta defines beta angle (in radians)
  47781. * @param radius defines radius
  47782. * @param target defines camera target
  47783. * @param interaxialDistance defines distance between each color axis
  47784. * @param scene defines the hosting scene
  47785. */
  47786. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47787. /**
  47788. * Gets camera class name
  47789. * @returns AnaglyphArcRotateCamera
  47790. */
  47791. getClassName(): string;
  47792. }
  47793. }
  47794. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47795. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47796. import { Scene } from "babylonjs/scene";
  47797. import { Vector3 } from "babylonjs/Maths/math.vector";
  47798. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47799. /**
  47800. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47801. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47802. */
  47803. export class AnaglyphFreeCamera extends FreeCamera {
  47804. /**
  47805. * Creates a new AnaglyphFreeCamera
  47806. * @param name defines camera name
  47807. * @param position defines initial position
  47808. * @param interaxialDistance defines distance between each color axis
  47809. * @param scene defines the hosting scene
  47810. */
  47811. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47812. /**
  47813. * Gets camera class name
  47814. * @returns AnaglyphFreeCamera
  47815. */
  47816. getClassName(): string;
  47817. }
  47818. }
  47819. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47820. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47821. import { Scene } from "babylonjs/scene";
  47822. import { Vector3 } from "babylonjs/Maths/math.vector";
  47823. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47824. /**
  47825. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47826. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47827. */
  47828. export class AnaglyphGamepadCamera extends GamepadCamera {
  47829. /**
  47830. * Creates a new AnaglyphGamepadCamera
  47831. * @param name defines camera name
  47832. * @param position defines initial position
  47833. * @param interaxialDistance defines distance between each color axis
  47834. * @param scene defines the hosting scene
  47835. */
  47836. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47837. /**
  47838. * Gets camera class name
  47839. * @returns AnaglyphGamepadCamera
  47840. */
  47841. getClassName(): string;
  47842. }
  47843. }
  47844. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47845. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47846. import { Scene } from "babylonjs/scene";
  47847. import { Vector3 } from "babylonjs/Maths/math.vector";
  47848. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47849. /**
  47850. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47851. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47852. */
  47853. export class AnaglyphUniversalCamera extends UniversalCamera {
  47854. /**
  47855. * Creates a new AnaglyphUniversalCamera
  47856. * @param name defines camera name
  47857. * @param position defines initial position
  47858. * @param interaxialDistance defines distance between each color axis
  47859. * @param scene defines the hosting scene
  47860. */
  47861. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47862. /**
  47863. * Gets camera class name
  47864. * @returns AnaglyphUniversalCamera
  47865. */
  47866. getClassName(): string;
  47867. }
  47868. }
  47869. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47870. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47871. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47872. import { Scene } from "babylonjs/scene";
  47873. import { Vector3 } from "babylonjs/Maths/math.vector";
  47874. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47875. /**
  47876. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47877. * @see https://doc.babylonjs.com/features/cameras
  47878. */
  47879. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47880. /**
  47881. * Creates a new StereoscopicArcRotateCamera
  47882. * @param name defines camera name
  47883. * @param alpha defines alpha angle (in radians)
  47884. * @param beta defines beta angle (in radians)
  47885. * @param radius defines radius
  47886. * @param target defines camera target
  47887. * @param interaxialDistance defines distance between each color axis
  47888. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47889. * @param scene defines the hosting scene
  47890. */
  47891. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47892. /**
  47893. * Gets camera class name
  47894. * @returns StereoscopicArcRotateCamera
  47895. */
  47896. getClassName(): string;
  47897. }
  47898. }
  47899. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47900. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47901. import { Scene } from "babylonjs/scene";
  47902. import { Vector3 } from "babylonjs/Maths/math.vector";
  47903. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47904. /**
  47905. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47906. * @see https://doc.babylonjs.com/features/cameras
  47907. */
  47908. export class StereoscopicFreeCamera extends FreeCamera {
  47909. /**
  47910. * Creates a new StereoscopicFreeCamera
  47911. * @param name defines camera name
  47912. * @param position defines initial position
  47913. * @param interaxialDistance defines distance between each color axis
  47914. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47915. * @param scene defines the hosting scene
  47916. */
  47917. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47918. /**
  47919. * Gets camera class name
  47920. * @returns StereoscopicFreeCamera
  47921. */
  47922. getClassName(): string;
  47923. }
  47924. }
  47925. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47926. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47927. import { Scene } from "babylonjs/scene";
  47928. import { Vector3 } from "babylonjs/Maths/math.vector";
  47929. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47930. /**
  47931. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47932. * @see https://doc.babylonjs.com/features/cameras
  47933. */
  47934. export class StereoscopicGamepadCamera extends GamepadCamera {
  47935. /**
  47936. * Creates a new StereoscopicGamepadCamera
  47937. * @param name defines camera name
  47938. * @param position defines initial position
  47939. * @param interaxialDistance defines distance between each color axis
  47940. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47941. * @param scene defines the hosting scene
  47942. */
  47943. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47944. /**
  47945. * Gets camera class name
  47946. * @returns StereoscopicGamepadCamera
  47947. */
  47948. getClassName(): string;
  47949. }
  47950. }
  47951. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47952. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47953. import { Scene } from "babylonjs/scene";
  47954. import { Vector3 } from "babylonjs/Maths/math.vector";
  47955. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47956. /**
  47957. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47958. * @see https://doc.babylonjs.com/features/cameras
  47959. */
  47960. export class StereoscopicUniversalCamera extends UniversalCamera {
  47961. /**
  47962. * Creates a new StereoscopicUniversalCamera
  47963. * @param name defines camera name
  47964. * @param position defines initial position
  47965. * @param interaxialDistance defines distance between each color axis
  47966. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47967. * @param scene defines the hosting scene
  47968. */
  47969. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47970. /**
  47971. * Gets camera class name
  47972. * @returns StereoscopicUniversalCamera
  47973. */
  47974. getClassName(): string;
  47975. }
  47976. }
  47977. declare module "babylonjs/Cameras/Stereoscopic/index" {
  47978. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  47979. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  47980. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  47981. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  47982. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  47983. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  47984. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  47985. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  47986. }
  47987. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  47988. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47989. import { Scene } from "babylonjs/scene";
  47990. import { Vector3 } from "babylonjs/Maths/math.vector";
  47991. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  47992. /**
  47993. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  47994. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  47995. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  47996. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  47997. */
  47998. export class VirtualJoysticksCamera extends FreeCamera {
  47999. /**
  48000. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48001. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48002. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48003. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48004. * @param name Define the name of the camera in the scene
  48005. * @param position Define the start position of the camera in the scene
  48006. * @param scene Define the scene the camera belongs to
  48007. */
  48008. constructor(name: string, position: Vector3, scene: Scene);
  48009. /**
  48010. * Gets the current object class name.
  48011. * @return the class name
  48012. */
  48013. getClassName(): string;
  48014. }
  48015. }
  48016. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48017. import { Matrix } from "babylonjs/Maths/math.vector";
  48018. /**
  48019. * This represents all the required metrics to create a VR camera.
  48020. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48021. */
  48022. export class VRCameraMetrics {
  48023. /**
  48024. * Define the horizontal resolution off the screen.
  48025. */
  48026. hResolution: number;
  48027. /**
  48028. * Define the vertical resolution off the screen.
  48029. */
  48030. vResolution: number;
  48031. /**
  48032. * Define the horizontal screen size.
  48033. */
  48034. hScreenSize: number;
  48035. /**
  48036. * Define the vertical screen size.
  48037. */
  48038. vScreenSize: number;
  48039. /**
  48040. * Define the vertical screen center position.
  48041. */
  48042. vScreenCenter: number;
  48043. /**
  48044. * Define the distance of the eyes to the screen.
  48045. */
  48046. eyeToScreenDistance: number;
  48047. /**
  48048. * Define the distance between both lenses
  48049. */
  48050. lensSeparationDistance: number;
  48051. /**
  48052. * Define the distance between both viewer's eyes.
  48053. */
  48054. interpupillaryDistance: number;
  48055. /**
  48056. * Define the distortion factor of the VR postprocess.
  48057. * Please, touch with care.
  48058. */
  48059. distortionK: number[];
  48060. /**
  48061. * Define the chromatic aberration correction factors for the VR post process.
  48062. */
  48063. chromaAbCorrection: number[];
  48064. /**
  48065. * Define the scale factor of the post process.
  48066. * The smaller the better but the slower.
  48067. */
  48068. postProcessScaleFactor: number;
  48069. /**
  48070. * Define an offset for the lens center.
  48071. */
  48072. lensCenterOffset: number;
  48073. /**
  48074. * Define if the current vr camera should compensate the distortion of the lense or not.
  48075. */
  48076. compensateDistortion: boolean;
  48077. /**
  48078. * Defines if multiview should be enabled when rendering (Default: false)
  48079. */
  48080. multiviewEnabled: boolean;
  48081. /**
  48082. * Gets the rendering aspect ratio based on the provided resolutions.
  48083. */
  48084. get aspectRatio(): number;
  48085. /**
  48086. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48087. */
  48088. get aspectRatioFov(): number;
  48089. /**
  48090. * @hidden
  48091. */
  48092. get leftHMatrix(): Matrix;
  48093. /**
  48094. * @hidden
  48095. */
  48096. get rightHMatrix(): Matrix;
  48097. /**
  48098. * @hidden
  48099. */
  48100. get leftPreViewMatrix(): Matrix;
  48101. /**
  48102. * @hidden
  48103. */
  48104. get rightPreViewMatrix(): Matrix;
  48105. /**
  48106. * Get the default VRMetrics based on the most generic setup.
  48107. * @returns the default vr metrics
  48108. */
  48109. static GetDefault(): VRCameraMetrics;
  48110. }
  48111. }
  48112. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48113. /** @hidden */
  48114. export var vrDistortionCorrectionPixelShader: {
  48115. name: string;
  48116. shader: string;
  48117. };
  48118. }
  48119. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48120. import { Camera } from "babylonjs/Cameras/camera";
  48121. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48122. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48123. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48124. /**
  48125. * VRDistortionCorrectionPostProcess used for mobile VR
  48126. */
  48127. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48128. private _isRightEye;
  48129. private _distortionFactors;
  48130. private _postProcessScaleFactor;
  48131. private _lensCenterOffset;
  48132. private _scaleIn;
  48133. private _scaleFactor;
  48134. private _lensCenter;
  48135. /**
  48136. * Gets a string identifying the name of the class
  48137. * @returns "VRDistortionCorrectionPostProcess" string
  48138. */
  48139. getClassName(): string;
  48140. /**
  48141. * Initializes the VRDistortionCorrectionPostProcess
  48142. * @param name The name of the effect.
  48143. * @param camera The camera to apply the render pass to.
  48144. * @param isRightEye If this is for the right eye distortion
  48145. * @param vrMetrics All the required metrics for the VR camera
  48146. */
  48147. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48148. }
  48149. }
  48150. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48151. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48152. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48153. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48154. import { Scene } from "babylonjs/scene";
  48155. import { Vector3 } from "babylonjs/Maths/math.vector";
  48156. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48157. import "babylonjs/Cameras/RigModes/vrRigMode";
  48158. /**
  48159. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48160. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48161. */
  48162. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48163. /**
  48164. * Creates a new VRDeviceOrientationArcRotateCamera
  48165. * @param name defines camera name
  48166. * @param alpha defines the camera rotation along the logitudinal axis
  48167. * @param beta defines the camera rotation along the latitudinal axis
  48168. * @param radius defines the camera distance from its target
  48169. * @param target defines the camera target
  48170. * @param scene defines the scene the camera belongs to
  48171. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48172. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48173. */
  48174. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48175. /**
  48176. * Gets camera class name
  48177. * @returns VRDeviceOrientationArcRotateCamera
  48178. */
  48179. getClassName(): string;
  48180. }
  48181. }
  48182. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48183. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48184. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48185. import { Scene } from "babylonjs/scene";
  48186. import { Vector3 } from "babylonjs/Maths/math.vector";
  48187. import "babylonjs/Cameras/RigModes/vrRigMode";
  48188. /**
  48189. * Camera used to simulate VR rendering (based on FreeCamera)
  48190. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48191. */
  48192. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48193. /**
  48194. * Creates a new VRDeviceOrientationFreeCamera
  48195. * @param name defines camera name
  48196. * @param position defines the start position of the camera
  48197. * @param scene defines the scene the camera belongs to
  48198. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48199. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48200. */
  48201. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48202. /**
  48203. * Gets camera class name
  48204. * @returns VRDeviceOrientationFreeCamera
  48205. */
  48206. getClassName(): string;
  48207. }
  48208. }
  48209. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48210. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48211. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48212. import { Scene } from "babylonjs/scene";
  48213. import { Vector3 } from "babylonjs/Maths/math.vector";
  48214. import "babylonjs/Gamepads/gamepadSceneComponent";
  48215. /**
  48216. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48217. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48218. */
  48219. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48220. /**
  48221. * Creates a new VRDeviceOrientationGamepadCamera
  48222. * @param name defines camera name
  48223. * @param position defines the start position of the camera
  48224. * @param scene defines the scene the camera belongs to
  48225. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48226. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48227. */
  48228. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48229. /**
  48230. * Gets camera class name
  48231. * @returns VRDeviceOrientationGamepadCamera
  48232. */
  48233. getClassName(): string;
  48234. }
  48235. }
  48236. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48237. import { Scene } from "babylonjs/scene";
  48238. import { Texture } from "babylonjs/Materials/Textures/texture";
  48239. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48240. /**
  48241. * A class extending Texture allowing drawing on a texture
  48242. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48243. */
  48244. export class DynamicTexture extends Texture {
  48245. private _generateMipMaps;
  48246. private _canvas;
  48247. private _context;
  48248. /**
  48249. * Creates a DynamicTexture
  48250. * @param name defines the name of the texture
  48251. * @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
  48252. * @param scene defines the scene where you want the texture
  48253. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48254. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48255. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48256. */
  48257. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48258. /**
  48259. * Get the current class name of the texture useful for serialization or dynamic coding.
  48260. * @returns "DynamicTexture"
  48261. */
  48262. getClassName(): string;
  48263. /**
  48264. * Gets the current state of canRescale
  48265. */
  48266. get canRescale(): boolean;
  48267. private _recreate;
  48268. /**
  48269. * Scales the texture
  48270. * @param ratio the scale factor to apply to both width and height
  48271. */
  48272. scale(ratio: number): void;
  48273. /**
  48274. * Resizes the texture
  48275. * @param width the new width
  48276. * @param height the new height
  48277. */
  48278. scaleTo(width: number, height: number): void;
  48279. /**
  48280. * Gets the context of the canvas used by the texture
  48281. * @returns the canvas context of the dynamic texture
  48282. */
  48283. getContext(): CanvasRenderingContext2D;
  48284. /**
  48285. * Clears the texture
  48286. */
  48287. clear(): void;
  48288. /**
  48289. * Updates the texture
  48290. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48291. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48292. */
  48293. update(invertY?: boolean, premulAlpha?: boolean): void;
  48294. /**
  48295. * Draws text onto the texture
  48296. * @param text defines the text to be drawn
  48297. * @param x defines the placement of the text from the left
  48298. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48299. * @param font defines the font to be used with font-style, font-size, font-name
  48300. * @param color defines the color used for the text
  48301. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48302. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48303. * @param update defines whether texture is immediately update (default is true)
  48304. */
  48305. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48306. /**
  48307. * Clones the texture
  48308. * @returns the clone of the texture.
  48309. */
  48310. clone(): DynamicTexture;
  48311. /**
  48312. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48313. * @returns a serialized dynamic texture object
  48314. */
  48315. serialize(): any;
  48316. private _IsCanvasElement;
  48317. /** @hidden */
  48318. _rebuild(): void;
  48319. }
  48320. }
  48321. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48322. import { Scene } from "babylonjs/scene";
  48323. import { Color3 } from "babylonjs/Maths/math.color";
  48324. import { Mesh } from "babylonjs/Meshes/mesh";
  48325. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48326. import { Nullable } from "babylonjs/types";
  48327. /**
  48328. * Class containing static functions to help procedurally build meshes
  48329. */
  48330. export class GroundBuilder {
  48331. /**
  48332. * Creates a ground mesh
  48333. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48334. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48335. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48336. * @param name defines the name of the mesh
  48337. * @param options defines the options used to create the mesh
  48338. * @param scene defines the hosting scene
  48339. * @returns the ground mesh
  48340. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48341. */
  48342. static CreateGround(name: string, options: {
  48343. width?: number;
  48344. height?: number;
  48345. subdivisions?: number;
  48346. subdivisionsX?: number;
  48347. subdivisionsY?: number;
  48348. updatable?: boolean;
  48349. }, scene: any): Mesh;
  48350. /**
  48351. * Creates a tiled ground mesh
  48352. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48353. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48354. * * 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
  48355. * * 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
  48356. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48357. * @param name defines the name of the mesh
  48358. * @param options defines the options used to create the mesh
  48359. * @param scene defines the hosting scene
  48360. * @returns the tiled ground mesh
  48361. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48362. */
  48363. static CreateTiledGround(name: string, options: {
  48364. xmin: number;
  48365. zmin: number;
  48366. xmax: number;
  48367. zmax: number;
  48368. subdivisions?: {
  48369. w: number;
  48370. h: number;
  48371. };
  48372. precision?: {
  48373. w: number;
  48374. h: number;
  48375. };
  48376. updatable?: boolean;
  48377. }, scene?: Nullable<Scene>): Mesh;
  48378. /**
  48379. * Creates a ground mesh from a height map
  48380. * * The parameter `url` sets the URL of the height map image resource.
  48381. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48382. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48383. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48384. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48385. * * 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.
  48386. * * 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).
  48387. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48388. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48389. * @param name defines the name of the mesh
  48390. * @param url defines the url to the height map
  48391. * @param options defines the options used to create the mesh
  48392. * @param scene defines the hosting scene
  48393. * @returns the ground mesh
  48394. * @see https://doc.babylonjs.com/babylon101/height_map
  48395. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48396. */
  48397. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48398. width?: number;
  48399. height?: number;
  48400. subdivisions?: number;
  48401. minHeight?: number;
  48402. maxHeight?: number;
  48403. colorFilter?: Color3;
  48404. alphaFilter?: number;
  48405. updatable?: boolean;
  48406. onReady?: (mesh: GroundMesh) => void;
  48407. }, scene?: Nullable<Scene>): GroundMesh;
  48408. }
  48409. }
  48410. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48411. import { Vector4 } from "babylonjs/Maths/math.vector";
  48412. import { Mesh } from "babylonjs/Meshes/mesh";
  48413. /**
  48414. * Class containing static functions to help procedurally build meshes
  48415. */
  48416. export class TorusBuilder {
  48417. /**
  48418. * Creates a torus mesh
  48419. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48420. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48421. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48422. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48423. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48424. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48425. * @param name defines the name of the mesh
  48426. * @param options defines the options used to create the mesh
  48427. * @param scene defines the hosting scene
  48428. * @returns the torus mesh
  48429. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48430. */
  48431. static CreateTorus(name: string, options: {
  48432. diameter?: number;
  48433. thickness?: number;
  48434. tessellation?: number;
  48435. updatable?: boolean;
  48436. sideOrientation?: number;
  48437. frontUVs?: Vector4;
  48438. backUVs?: Vector4;
  48439. }, scene: any): Mesh;
  48440. }
  48441. }
  48442. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48443. import { Vector4 } from "babylonjs/Maths/math.vector";
  48444. import { Color4 } from "babylonjs/Maths/math.color";
  48445. import { Mesh } from "babylonjs/Meshes/mesh";
  48446. /**
  48447. * Class containing static functions to help procedurally build meshes
  48448. */
  48449. export class CylinderBuilder {
  48450. /**
  48451. * Creates a cylinder or a cone mesh
  48452. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48453. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48454. * * 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.
  48455. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48456. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48457. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48458. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48459. * * 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).
  48460. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48461. * * 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).
  48462. * * 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
  48463. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48464. * * 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
  48465. * * 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.
  48466. * * If `enclose` is false, a ring surface is one element.
  48467. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48468. * * 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
  48469. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48470. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48471. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48472. * @param name defines the name of the mesh
  48473. * @param options defines the options used to create the mesh
  48474. * @param scene defines the hosting scene
  48475. * @returns the cylinder mesh
  48476. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48477. */
  48478. static CreateCylinder(name: string, options: {
  48479. height?: number;
  48480. diameterTop?: number;
  48481. diameterBottom?: number;
  48482. diameter?: number;
  48483. tessellation?: number;
  48484. subdivisions?: number;
  48485. arc?: number;
  48486. faceColors?: Color4[];
  48487. faceUV?: Vector4[];
  48488. updatable?: boolean;
  48489. hasRings?: boolean;
  48490. enclose?: boolean;
  48491. cap?: number;
  48492. sideOrientation?: number;
  48493. frontUVs?: Vector4;
  48494. backUVs?: Vector4;
  48495. }, scene: any): Mesh;
  48496. }
  48497. }
  48498. declare module "babylonjs/XR/webXRTypes" {
  48499. import { Nullable } from "babylonjs/types";
  48500. import { IDisposable } from "babylonjs/scene";
  48501. /**
  48502. * States of the webXR experience
  48503. */
  48504. export enum WebXRState {
  48505. /**
  48506. * Transitioning to being in XR mode
  48507. */
  48508. ENTERING_XR = 0,
  48509. /**
  48510. * Transitioning to non XR mode
  48511. */
  48512. EXITING_XR = 1,
  48513. /**
  48514. * In XR mode and presenting
  48515. */
  48516. IN_XR = 2,
  48517. /**
  48518. * Not entered XR mode
  48519. */
  48520. NOT_IN_XR = 3
  48521. }
  48522. /**
  48523. * Abstraction of the XR render target
  48524. */
  48525. export interface WebXRRenderTarget extends IDisposable {
  48526. /**
  48527. * xrpresent context of the canvas which can be used to display/mirror xr content
  48528. */
  48529. canvasContext: WebGLRenderingContext;
  48530. /**
  48531. * xr layer for the canvas
  48532. */
  48533. xrLayer: Nullable<XRWebGLLayer>;
  48534. /**
  48535. * Initializes the xr layer for the session
  48536. * @param xrSession xr session
  48537. * @returns a promise that will resolve once the XR Layer has been created
  48538. */
  48539. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48540. }
  48541. }
  48542. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48543. import { Nullable } from "babylonjs/types";
  48544. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48545. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48546. import { Observable } from "babylonjs/Misc/observable";
  48547. /**
  48548. * COnfiguration object for WebXR output canvas
  48549. */
  48550. export class WebXRManagedOutputCanvasOptions {
  48551. /**
  48552. * An optional canvas in case you wish to create it yourself and provide it here.
  48553. * If not provided, a new canvas will be created
  48554. */
  48555. canvasElement?: HTMLCanvasElement;
  48556. /**
  48557. * Options for this XR Layer output
  48558. */
  48559. canvasOptions?: XRWebGLLayerOptions;
  48560. /**
  48561. * CSS styling for a newly created canvas (if not provided)
  48562. */
  48563. newCanvasCssStyle?: string;
  48564. /**
  48565. * Get the default values of the configuration object
  48566. * @returns default values of this configuration object
  48567. */
  48568. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  48569. }
  48570. /**
  48571. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48572. */
  48573. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48574. private _options;
  48575. private _canvas;
  48576. private _engine;
  48577. private _originalCanvasSize;
  48578. /**
  48579. * Rendering context of the canvas which can be used to display/mirror xr content
  48580. */
  48581. canvasContext: WebGLRenderingContext;
  48582. /**
  48583. * xr layer for the canvas
  48584. */
  48585. xrLayer: Nullable<XRWebGLLayer>;
  48586. /**
  48587. * Obseervers registered here will be triggered when the xr layer was initialized
  48588. */
  48589. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48590. /**
  48591. * Initializes the canvas to be added/removed upon entering/exiting xr
  48592. * @param _xrSessionManager The XR Session manager
  48593. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48594. */
  48595. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48596. /**
  48597. * Disposes of the object
  48598. */
  48599. dispose(): void;
  48600. /**
  48601. * Initializes the xr layer for the session
  48602. * @param xrSession xr session
  48603. * @returns a promise that will resolve once the XR Layer has been created
  48604. */
  48605. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48606. private _addCanvas;
  48607. private _removeCanvas;
  48608. private _setCanvasSize;
  48609. private _setManagedOutputCanvas;
  48610. }
  48611. }
  48612. declare module "babylonjs/XR/webXRSessionManager" {
  48613. import { Observable } from "babylonjs/Misc/observable";
  48614. import { Nullable } from "babylonjs/types";
  48615. import { IDisposable, Scene } from "babylonjs/scene";
  48616. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48617. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48618. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48619. /**
  48620. * Manages an XRSession to work with Babylon's engine
  48621. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48622. */
  48623. export class WebXRSessionManager implements IDisposable {
  48624. /** The scene which the session should be created for */
  48625. scene: Scene;
  48626. private _referenceSpace;
  48627. private _rttProvider;
  48628. private _sessionEnded;
  48629. private _xrNavigator;
  48630. private baseLayer;
  48631. /**
  48632. * The base reference space from which the session started. good if you want to reset your
  48633. * reference space
  48634. */
  48635. baseReferenceSpace: XRReferenceSpace;
  48636. /**
  48637. * Current XR frame
  48638. */
  48639. currentFrame: Nullable<XRFrame>;
  48640. /** WebXR timestamp updated every frame */
  48641. currentTimestamp: number;
  48642. /**
  48643. * Used just in case of a failure to initialize an immersive session.
  48644. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48645. */
  48646. defaultHeightCompensation: number;
  48647. /**
  48648. * Fires every time a new xrFrame arrives which can be used to update the camera
  48649. */
  48650. onXRFrameObservable: Observable<XRFrame>;
  48651. /**
  48652. * Fires when the reference space changed
  48653. */
  48654. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48655. /**
  48656. * Fires when the xr session is ended either by the device or manually done
  48657. */
  48658. onXRSessionEnded: Observable<any>;
  48659. /**
  48660. * Fires when the xr session is ended either by the device or manually done
  48661. */
  48662. onXRSessionInit: Observable<XRSession>;
  48663. /**
  48664. * Underlying xr session
  48665. */
  48666. session: XRSession;
  48667. /**
  48668. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48669. * or get the offset the player is currently at.
  48670. */
  48671. viewerReferenceSpace: XRReferenceSpace;
  48672. /**
  48673. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48674. * @param scene The scene which the session should be created for
  48675. */
  48676. constructor(
  48677. /** The scene which the session should be created for */
  48678. scene: Scene);
  48679. /**
  48680. * The current reference space used in this session. This reference space can constantly change!
  48681. * It is mainly used to offset the camera's position.
  48682. */
  48683. get referenceSpace(): XRReferenceSpace;
  48684. /**
  48685. * Set a new reference space and triggers the observable
  48686. */
  48687. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48688. /**
  48689. * Disposes of the session manager
  48690. */
  48691. dispose(): void;
  48692. /**
  48693. * Stops the xrSession and restores the render loop
  48694. * @returns Promise which resolves after it exits XR
  48695. */
  48696. exitXRAsync(): Promise<void>;
  48697. /**
  48698. * Gets the correct render target texture to be rendered this frame for this eye
  48699. * @param eye the eye for which to get the render target
  48700. * @returns the render target for the specified eye
  48701. */
  48702. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48703. /**
  48704. * Creates a WebXRRenderTarget object for the XR session
  48705. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48706. * @param options optional options to provide when creating a new render target
  48707. * @returns a WebXR render target to which the session can render
  48708. */
  48709. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48710. /**
  48711. * Initializes the manager
  48712. * After initialization enterXR can be called to start an XR session
  48713. * @returns Promise which resolves after it is initialized
  48714. */
  48715. initializeAsync(): Promise<void>;
  48716. /**
  48717. * Initializes an xr session
  48718. * @param xrSessionMode mode to initialize
  48719. * @param xrSessionInit defines optional and required values to pass to the session builder
  48720. * @returns a promise which will resolve once the session has been initialized
  48721. */
  48722. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48723. /**
  48724. * Checks if a session would be supported for the creation options specified
  48725. * @param sessionMode session mode to check if supported eg. immersive-vr
  48726. * @returns A Promise that resolves to true if supported and false if not
  48727. */
  48728. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48729. /**
  48730. * Resets the reference space to the one started the session
  48731. */
  48732. resetReferenceSpace(): void;
  48733. /**
  48734. * Starts rendering to the xr layer
  48735. */
  48736. runXRRenderLoop(): void;
  48737. /**
  48738. * Sets the reference space on the xr session
  48739. * @param referenceSpaceType space to set
  48740. * @returns a promise that will resolve once the reference space has been set
  48741. */
  48742. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48743. /**
  48744. * Updates the render state of the session
  48745. * @param state state to set
  48746. * @returns a promise that resolves once the render state has been updated
  48747. */
  48748. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48749. /**
  48750. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48751. * @param sessionMode defines the session to test
  48752. * @returns a promise with boolean as final value
  48753. */
  48754. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48755. private _createRenderTargetTexture;
  48756. }
  48757. }
  48758. declare module "babylonjs/XR/webXRCamera" {
  48759. import { Vector3 } from "babylonjs/Maths/math.vector";
  48760. import { Scene } from "babylonjs/scene";
  48761. import { Camera } from "babylonjs/Cameras/camera";
  48762. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48763. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48764. import { Observable } from "babylonjs/Misc/observable";
  48765. /**
  48766. * WebXR Camera which holds the views for the xrSession
  48767. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48768. */
  48769. export class WebXRCamera extends FreeCamera {
  48770. private _xrSessionManager;
  48771. private _firstFrame;
  48772. private _referenceQuaternion;
  48773. private _referencedPosition;
  48774. private _xrInvPositionCache;
  48775. private _xrInvQuaternionCache;
  48776. /**
  48777. * Observable raised before camera teleportation
  48778. */
  48779. onBeforeCameraTeleport: Observable<Vector3>;
  48780. /**
  48781. * Observable raised after camera teleportation
  48782. */
  48783. onAfterCameraTeleport: Observable<Vector3>;
  48784. /**
  48785. * Should position compensation execute on first frame.
  48786. * This is used when copying the position from a native (non XR) camera
  48787. */
  48788. compensateOnFirstFrame: boolean;
  48789. /**
  48790. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48791. * @param name the name of the camera
  48792. * @param scene the scene to add the camera to
  48793. * @param _xrSessionManager a constructed xr session manager
  48794. */
  48795. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48796. /**
  48797. * Return the user's height, unrelated to the current ground.
  48798. * This will be the y position of this camera, when ground level is 0.
  48799. */
  48800. get realWorldHeight(): number;
  48801. /** @hidden */
  48802. _updateForDualEyeDebugging(): void;
  48803. /**
  48804. * Sets this camera's transformation based on a non-vr camera
  48805. * @param otherCamera the non-vr camera to copy the transformation from
  48806. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48807. */
  48808. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48809. /**
  48810. * Gets the current instance class name ("WebXRCamera").
  48811. * @returns the class name
  48812. */
  48813. getClassName(): string;
  48814. private _rotate180;
  48815. private _updateFromXRSession;
  48816. private _updateNumberOfRigCameras;
  48817. private _updateReferenceSpace;
  48818. private _updateReferenceSpaceOffset;
  48819. }
  48820. }
  48821. declare module "babylonjs/XR/webXRFeaturesManager" {
  48822. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48823. import { IDisposable } from "babylonjs/scene";
  48824. /**
  48825. * Defining the interface required for a (webxr) feature
  48826. */
  48827. export interface IWebXRFeature extends IDisposable {
  48828. /**
  48829. * Is this feature attached
  48830. */
  48831. attached: boolean;
  48832. /**
  48833. * Should auto-attach be disabled?
  48834. */
  48835. disableAutoAttach: boolean;
  48836. /**
  48837. * Attach the feature to the session
  48838. * Will usually be called by the features manager
  48839. *
  48840. * @param force should attachment be forced (even when already attached)
  48841. * @returns true if successful.
  48842. */
  48843. attach(force?: boolean): boolean;
  48844. /**
  48845. * Detach the feature from the session
  48846. * Will usually be called by the features manager
  48847. *
  48848. * @returns true if successful.
  48849. */
  48850. detach(): boolean;
  48851. /**
  48852. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48853. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48854. *
  48855. * @returns whether or not the feature is compatible in this environment
  48856. */
  48857. isCompatible(): boolean;
  48858. /**
  48859. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48860. */
  48861. xrNativeFeatureName?: string;
  48862. }
  48863. /**
  48864. * A list of the currently available features without referencing them
  48865. */
  48866. export class WebXRFeatureName {
  48867. /**
  48868. * The name of the anchor system feature
  48869. */
  48870. static ANCHOR_SYSTEM: string;
  48871. /**
  48872. * The name of the background remover feature
  48873. */
  48874. static BACKGROUND_REMOVER: string;
  48875. /**
  48876. * The name of the hit test feature
  48877. */
  48878. static HIT_TEST: string;
  48879. /**
  48880. * physics impostors for xr controllers feature
  48881. */
  48882. static PHYSICS_CONTROLLERS: string;
  48883. /**
  48884. * The name of the plane detection feature
  48885. */
  48886. static PLANE_DETECTION: string;
  48887. /**
  48888. * The name of the pointer selection feature
  48889. */
  48890. static POINTER_SELECTION: string;
  48891. /**
  48892. * The name of the teleportation feature
  48893. */
  48894. static TELEPORTATION: string;
  48895. }
  48896. /**
  48897. * Defining the constructor of a feature. Used to register the modules.
  48898. */
  48899. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48900. /**
  48901. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48902. * It is mainly used in AR sessions.
  48903. *
  48904. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48905. */
  48906. export class WebXRFeaturesManager implements IDisposable {
  48907. private _xrSessionManager;
  48908. private static readonly _AvailableFeatures;
  48909. private _features;
  48910. /**
  48911. * constructs a new features manages.
  48912. *
  48913. * @param _xrSessionManager an instance of WebXRSessionManager
  48914. */
  48915. constructor(_xrSessionManager: WebXRSessionManager);
  48916. /**
  48917. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48918. * Mainly used internally.
  48919. *
  48920. * @param featureName the name of the feature to register
  48921. * @param constructorFunction the function used to construct the module
  48922. * @param version the (babylon) version of the module
  48923. * @param stable is that a stable version of this module
  48924. */
  48925. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48926. /**
  48927. * Returns a constructor of a specific feature.
  48928. *
  48929. * @param featureName the name of the feature to construct
  48930. * @param version the version of the feature to load
  48931. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48932. * @param options optional options provided to the module.
  48933. * @returns a function that, when called, will return a new instance of this feature
  48934. */
  48935. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48936. /**
  48937. * Can be used to return the list of features currently registered
  48938. *
  48939. * @returns an Array of available features
  48940. */
  48941. static GetAvailableFeatures(): string[];
  48942. /**
  48943. * Gets the versions available for a specific feature
  48944. * @param featureName the name of the feature
  48945. * @returns an array with the available versions
  48946. */
  48947. static GetAvailableVersions(featureName: string): string[];
  48948. /**
  48949. * Return the latest unstable version of this feature
  48950. * @param featureName the name of the feature to search
  48951. * @returns the version number. if not found will return -1
  48952. */
  48953. static GetLatestVersionOfFeature(featureName: string): number;
  48954. /**
  48955. * Return the latest stable version of this feature
  48956. * @param featureName the name of the feature to search
  48957. * @returns the version number. if not found will return -1
  48958. */
  48959. static GetStableVersionOfFeature(featureName: string): number;
  48960. /**
  48961. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  48962. * Can be used during a session to start a feature
  48963. * @param featureName the name of feature to attach
  48964. */
  48965. attachFeature(featureName: string): void;
  48966. /**
  48967. * Can be used inside a session or when the session ends to detach a specific feature
  48968. * @param featureName the name of the feature to detach
  48969. */
  48970. detachFeature(featureName: string): void;
  48971. /**
  48972. * Used to disable an already-enabled feature
  48973. * The feature will be disposed and will be recreated once enabled.
  48974. * @param featureName the feature to disable
  48975. * @returns true if disable was successful
  48976. */
  48977. disableFeature(featureName: string | {
  48978. Name: string;
  48979. }): boolean;
  48980. /**
  48981. * dispose this features manager
  48982. */
  48983. dispose(): void;
  48984. /**
  48985. * 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.
  48986. * 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.
  48987. *
  48988. * @param featureName the name of the feature to load or the class of the feature
  48989. * @param version optional version to load. if not provided the latest version will be enabled
  48990. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  48991. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  48992. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  48993. * @returns a new constructed feature or throws an error if feature not found.
  48994. */
  48995. enableFeature(featureName: string | {
  48996. Name: string;
  48997. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  48998. /**
  48999. * get the implementation of an enabled feature.
  49000. * @param featureName the name of the feature to load
  49001. * @returns the feature class, if found
  49002. */
  49003. getEnabledFeature(featureName: string): IWebXRFeature;
  49004. /**
  49005. * Get the list of enabled features
  49006. * @returns an array of enabled features
  49007. */
  49008. getEnabledFeatures(): string[];
  49009. /**
  49010. * This function will exten the session creation configuration object with enabled features.
  49011. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49012. * according to the defined "required" variable, provided during enableFeature call
  49013. * @param xrSessionInit the xr Session init object to extend
  49014. *
  49015. * @returns an extended XRSessionInit object
  49016. */
  49017. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49018. }
  49019. }
  49020. declare module "babylonjs/XR/webXRExperienceHelper" {
  49021. import { Observable } from "babylonjs/Misc/observable";
  49022. import { IDisposable, Scene } from "babylonjs/scene";
  49023. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49024. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49025. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49026. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49027. /**
  49028. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49029. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49030. */
  49031. export class WebXRExperienceHelper implements IDisposable {
  49032. private scene;
  49033. private _nonVRCamera;
  49034. private _originalSceneAutoClear;
  49035. private _supported;
  49036. /**
  49037. * Camera used to render xr content
  49038. */
  49039. camera: WebXRCamera;
  49040. /** A features manager for this xr session */
  49041. featuresManager: WebXRFeaturesManager;
  49042. /**
  49043. * Observers registered here will be triggered after the camera's initial transformation is set
  49044. * This can be used to set a different ground level or an extra rotation.
  49045. *
  49046. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49047. * to the position set after this observable is done executing.
  49048. */
  49049. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49050. /**
  49051. * Fires when the state of the experience helper has changed
  49052. */
  49053. onStateChangedObservable: Observable<WebXRState>;
  49054. /** Session manager used to keep track of xr session */
  49055. sessionManager: WebXRSessionManager;
  49056. /**
  49057. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49058. */
  49059. state: WebXRState;
  49060. /**
  49061. * Creates a WebXRExperienceHelper
  49062. * @param scene The scene the helper should be created in
  49063. */
  49064. private constructor();
  49065. /**
  49066. * Creates the experience helper
  49067. * @param scene the scene to attach the experience helper to
  49068. * @returns a promise for the experience helper
  49069. */
  49070. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49071. /**
  49072. * Disposes of the experience helper
  49073. */
  49074. dispose(): void;
  49075. /**
  49076. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49077. * @param sessionMode options for the XR session
  49078. * @param referenceSpaceType frame of reference of the XR session
  49079. * @param renderTarget the output canvas that will be used to enter XR mode
  49080. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49081. * @returns promise that resolves after xr mode has entered
  49082. */
  49083. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49084. /**
  49085. * Exits XR mode and returns the scene to its original state
  49086. * @returns promise that resolves after xr mode has exited
  49087. */
  49088. exitXRAsync(): Promise<void>;
  49089. private _nonXRToXRCamera;
  49090. private _setState;
  49091. }
  49092. }
  49093. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49094. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49095. import { Observable } from "babylonjs/Misc/observable";
  49096. import { IDisposable } from "babylonjs/scene";
  49097. /**
  49098. * X-Y values for axes in WebXR
  49099. */
  49100. export interface IWebXRMotionControllerAxesValue {
  49101. /**
  49102. * The value of the x axis
  49103. */
  49104. x: number;
  49105. /**
  49106. * The value of the y-axis
  49107. */
  49108. y: number;
  49109. }
  49110. /**
  49111. * changed / previous values for the values of this component
  49112. */
  49113. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49114. /**
  49115. * current (this frame) value
  49116. */
  49117. current: T;
  49118. /**
  49119. * previous (last change) value
  49120. */
  49121. previous: T;
  49122. }
  49123. /**
  49124. * Represents changes in the component between current frame and last values recorded
  49125. */
  49126. export interface IWebXRMotionControllerComponentChanges {
  49127. /**
  49128. * will be populated with previous and current values if axes changed
  49129. */
  49130. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49131. /**
  49132. * will be populated with previous and current values if pressed changed
  49133. */
  49134. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49135. /**
  49136. * will be populated with previous and current values if touched changed
  49137. */
  49138. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49139. /**
  49140. * will be populated with previous and current values if value changed
  49141. */
  49142. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49143. }
  49144. /**
  49145. * This class represents a single component (for example button or thumbstick) of a motion controller
  49146. */
  49147. export class WebXRControllerComponent implements IDisposable {
  49148. /**
  49149. * the id of this component
  49150. */
  49151. id: string;
  49152. /**
  49153. * the type of the component
  49154. */
  49155. type: MotionControllerComponentType;
  49156. private _buttonIndex;
  49157. private _axesIndices;
  49158. private _axes;
  49159. private _changes;
  49160. private _currentValue;
  49161. private _hasChanges;
  49162. private _pressed;
  49163. private _touched;
  49164. /**
  49165. * button component type
  49166. */
  49167. static BUTTON_TYPE: MotionControllerComponentType;
  49168. /**
  49169. * squeeze component type
  49170. */
  49171. static SQUEEZE_TYPE: MotionControllerComponentType;
  49172. /**
  49173. * Thumbstick component type
  49174. */
  49175. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49176. /**
  49177. * Touchpad component type
  49178. */
  49179. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49180. /**
  49181. * trigger component type
  49182. */
  49183. static TRIGGER_TYPE: MotionControllerComponentType;
  49184. /**
  49185. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49186. * the axes data changes
  49187. */
  49188. onAxisValueChangedObservable: Observable<{
  49189. x: number;
  49190. y: number;
  49191. }>;
  49192. /**
  49193. * Observers registered here will be triggered when the state of a button changes
  49194. * State change is either pressed / touched / value
  49195. */
  49196. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49197. /**
  49198. * Creates a new component for a motion controller.
  49199. * It is created by the motion controller itself
  49200. *
  49201. * @param id the id of this component
  49202. * @param type the type of the component
  49203. * @param _buttonIndex index in the buttons array of the gamepad
  49204. * @param _axesIndices indices of the values in the axes array of the gamepad
  49205. */
  49206. constructor(
  49207. /**
  49208. * the id of this component
  49209. */
  49210. id: string,
  49211. /**
  49212. * the type of the component
  49213. */
  49214. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49215. /**
  49216. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49217. */
  49218. get axes(): IWebXRMotionControllerAxesValue;
  49219. /**
  49220. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49221. */
  49222. get changes(): IWebXRMotionControllerComponentChanges;
  49223. /**
  49224. * Return whether or not the component changed the last frame
  49225. */
  49226. get hasChanges(): boolean;
  49227. /**
  49228. * is the button currently pressed
  49229. */
  49230. get pressed(): boolean;
  49231. /**
  49232. * is the button currently touched
  49233. */
  49234. get touched(): boolean;
  49235. /**
  49236. * Get the current value of this component
  49237. */
  49238. get value(): number;
  49239. /**
  49240. * Dispose this component
  49241. */
  49242. dispose(): void;
  49243. /**
  49244. * Are there axes correlating to this component
  49245. * @return true is axes data is available
  49246. */
  49247. isAxes(): boolean;
  49248. /**
  49249. * Is this component a button (hence - pressable)
  49250. * @returns true if can be pressed
  49251. */
  49252. isButton(): boolean;
  49253. /**
  49254. * update this component using the gamepad object it is in. Called on every frame
  49255. * @param nativeController the native gamepad controller object
  49256. */
  49257. update(nativeController: IMinimalMotionControllerObject): void;
  49258. }
  49259. }
  49260. declare module "babylonjs/Loading/sceneLoader" {
  49261. import { Observable } from "babylonjs/Misc/observable";
  49262. import { Nullable } from "babylonjs/types";
  49263. import { Scene } from "babylonjs/scene";
  49264. import { Engine } from "babylonjs/Engines/engine";
  49265. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49266. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49267. import { AssetContainer } from "babylonjs/assetContainer";
  49268. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49269. import { Skeleton } from "babylonjs/Bones/skeleton";
  49270. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49271. import { WebRequest } from "babylonjs/Misc/webRequest";
  49272. /**
  49273. * Interface used to represent data loading progression
  49274. */
  49275. export interface ISceneLoaderProgressEvent {
  49276. /**
  49277. * Defines if data length to load can be evaluated
  49278. */
  49279. readonly lengthComputable: boolean;
  49280. /**
  49281. * Defines the loaded data length
  49282. */
  49283. readonly loaded: number;
  49284. /**
  49285. * Defines the data length to load
  49286. */
  49287. readonly total: number;
  49288. }
  49289. /**
  49290. * Interface used by SceneLoader plugins to define supported file extensions
  49291. */
  49292. export interface ISceneLoaderPluginExtensions {
  49293. /**
  49294. * Defines the list of supported extensions
  49295. */
  49296. [extension: string]: {
  49297. isBinary: boolean;
  49298. };
  49299. }
  49300. /**
  49301. * Interface used by SceneLoader plugin factory
  49302. */
  49303. export interface ISceneLoaderPluginFactory {
  49304. /**
  49305. * Defines the name of the factory
  49306. */
  49307. name: string;
  49308. /**
  49309. * Function called to create a new plugin
  49310. * @return the new plugin
  49311. */
  49312. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49313. /**
  49314. * The callback that returns true if the data can be directly loaded.
  49315. * @param data string containing the file data
  49316. * @returns if the data can be loaded directly
  49317. */
  49318. canDirectLoad?(data: string): boolean;
  49319. }
  49320. /**
  49321. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49322. */
  49323. export interface ISceneLoaderPluginBase {
  49324. /**
  49325. * The friendly name of this plugin.
  49326. */
  49327. name: string;
  49328. /**
  49329. * The file extensions supported by this plugin.
  49330. */
  49331. extensions: string | ISceneLoaderPluginExtensions;
  49332. /**
  49333. * The callback called when loading from a url.
  49334. * @param scene scene loading this url
  49335. * @param url url to load
  49336. * @param onSuccess callback called when the file successfully loads
  49337. * @param onProgress callback called while file is loading (if the server supports this mode)
  49338. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49339. * @param onError callback called when the file fails to load
  49340. * @returns a file request object
  49341. */
  49342. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49343. /**
  49344. * The callback called when loading from a file object.
  49345. * @param scene scene loading this file
  49346. * @param file defines the file to load
  49347. * @param onSuccess defines the callback to call when data is loaded
  49348. * @param onProgress defines the callback to call during loading process
  49349. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49350. * @param onError defines the callback to call when an error occurs
  49351. * @returns a file request object
  49352. */
  49353. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49354. /**
  49355. * The callback that returns true if the data can be directly loaded.
  49356. * @param data string containing the file data
  49357. * @returns if the data can be loaded directly
  49358. */
  49359. canDirectLoad?(data: string): boolean;
  49360. /**
  49361. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49362. * @param scene scene loading this data
  49363. * @param data string containing the data
  49364. * @returns data to pass to the plugin
  49365. */
  49366. directLoad?(scene: Scene, data: string): any;
  49367. /**
  49368. * The callback that allows custom handling of the root url based on the response url.
  49369. * @param rootUrl the original root url
  49370. * @param responseURL the response url if available
  49371. * @returns the new root url
  49372. */
  49373. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49374. }
  49375. /**
  49376. * Interface used to define a SceneLoader plugin
  49377. */
  49378. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49379. /**
  49380. * Import meshes into a scene.
  49381. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49382. * @param scene The scene to import into
  49383. * @param data The data to import
  49384. * @param rootUrl The root url for scene and resources
  49385. * @param meshes The meshes array to import into
  49386. * @param particleSystems The particle systems array to import into
  49387. * @param skeletons The skeletons array to import into
  49388. * @param onError The callback when import fails
  49389. * @returns True if successful or false otherwise
  49390. */
  49391. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49392. /**
  49393. * Load into a scene.
  49394. * @param scene The scene to load into
  49395. * @param data The data to import
  49396. * @param rootUrl The root url for scene and resources
  49397. * @param onError The callback when import fails
  49398. * @returns True if successful or false otherwise
  49399. */
  49400. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49401. /**
  49402. * Load into an asset container.
  49403. * @param scene The scene to load into
  49404. * @param data The data to import
  49405. * @param rootUrl The root url for scene and resources
  49406. * @param onError The callback when import fails
  49407. * @returns The loaded asset container
  49408. */
  49409. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49410. }
  49411. /**
  49412. * Interface used to define an async SceneLoader plugin
  49413. */
  49414. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49415. /**
  49416. * Import meshes into a scene.
  49417. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49418. * @param scene The scene to import into
  49419. * @param data The data to import
  49420. * @param rootUrl The root url for scene and resources
  49421. * @param onProgress The callback when the load progresses
  49422. * @param fileName Defines the name of the file to load
  49423. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49424. */
  49425. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49426. meshes: AbstractMesh[];
  49427. particleSystems: IParticleSystem[];
  49428. skeletons: Skeleton[];
  49429. animationGroups: AnimationGroup[];
  49430. }>;
  49431. /**
  49432. * Load into a scene.
  49433. * @param scene The scene to load into
  49434. * @param data The data to import
  49435. * @param rootUrl The root url for scene and resources
  49436. * @param onProgress The callback when the load progresses
  49437. * @param fileName Defines the name of the file to load
  49438. * @returns Nothing
  49439. */
  49440. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49441. /**
  49442. * Load into an asset container.
  49443. * @param scene The scene to load into
  49444. * @param data The data to import
  49445. * @param rootUrl The root url for scene and resources
  49446. * @param onProgress The callback when the load progresses
  49447. * @param fileName Defines the name of the file to load
  49448. * @returns The loaded asset container
  49449. */
  49450. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49451. }
  49452. /**
  49453. * Mode that determines how to handle old animation groups before loading new ones.
  49454. */
  49455. export enum SceneLoaderAnimationGroupLoadingMode {
  49456. /**
  49457. * Reset all old animations to initial state then dispose them.
  49458. */
  49459. Clean = 0,
  49460. /**
  49461. * Stop all old animations.
  49462. */
  49463. Stop = 1,
  49464. /**
  49465. * Restart old animations from first frame.
  49466. */
  49467. Sync = 2,
  49468. /**
  49469. * Old animations remains untouched.
  49470. */
  49471. NoSync = 3
  49472. }
  49473. /**
  49474. * Defines a plugin registered by the SceneLoader
  49475. */
  49476. interface IRegisteredPlugin {
  49477. /**
  49478. * Defines the plugin to use
  49479. */
  49480. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49481. /**
  49482. * Defines if the plugin supports binary data
  49483. */
  49484. isBinary: boolean;
  49485. }
  49486. /**
  49487. * Class used to load scene from various file formats using registered plugins
  49488. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49489. */
  49490. export class SceneLoader {
  49491. /**
  49492. * No logging while loading
  49493. */
  49494. static readonly NO_LOGGING: number;
  49495. /**
  49496. * Minimal logging while loading
  49497. */
  49498. static readonly MINIMAL_LOGGING: number;
  49499. /**
  49500. * Summary logging while loading
  49501. */
  49502. static readonly SUMMARY_LOGGING: number;
  49503. /**
  49504. * Detailled logging while loading
  49505. */
  49506. static readonly DETAILED_LOGGING: number;
  49507. /**
  49508. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49509. */
  49510. static get ForceFullSceneLoadingForIncremental(): boolean;
  49511. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49512. /**
  49513. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49514. */
  49515. static get ShowLoadingScreen(): boolean;
  49516. static set ShowLoadingScreen(value: boolean);
  49517. /**
  49518. * Defines the current logging level (while loading the scene)
  49519. * @ignorenaming
  49520. */
  49521. static get loggingLevel(): number;
  49522. static set loggingLevel(value: number);
  49523. /**
  49524. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49525. */
  49526. static get CleanBoneMatrixWeights(): boolean;
  49527. static set CleanBoneMatrixWeights(value: boolean);
  49528. /**
  49529. * Event raised when a plugin is used to load a scene
  49530. */
  49531. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49532. private static _registeredPlugins;
  49533. private static _showingLoadingScreen;
  49534. /**
  49535. * Gets the default plugin (used to load Babylon files)
  49536. * @returns the .babylon plugin
  49537. */
  49538. static GetDefaultPlugin(): IRegisteredPlugin;
  49539. private static _GetPluginForExtension;
  49540. private static _GetPluginForDirectLoad;
  49541. private static _GetPluginForFilename;
  49542. private static _GetDirectLoad;
  49543. private static _LoadData;
  49544. private static _GetFileInfo;
  49545. /**
  49546. * Gets a plugin that can load the given extension
  49547. * @param extension defines the extension to load
  49548. * @returns a plugin or null if none works
  49549. */
  49550. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49551. /**
  49552. * Gets a boolean indicating that the given extension can be loaded
  49553. * @param extension defines the extension to load
  49554. * @returns true if the extension is supported
  49555. */
  49556. static IsPluginForExtensionAvailable(extension: string): boolean;
  49557. /**
  49558. * Adds a new plugin to the list of registered plugins
  49559. * @param plugin defines the plugin to add
  49560. */
  49561. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49562. /**
  49563. * Import meshes into a scene
  49564. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49565. * @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)
  49566. * @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)
  49567. * @param scene the instance of BABYLON.Scene to append to
  49568. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49569. * @param onProgress a callback with a progress event for each file being loaded
  49570. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49571. * @param pluginExtension the extension used to determine the plugin
  49572. * @returns The loaded plugin
  49573. */
  49574. 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>;
  49575. /**
  49576. * Import meshes into a scene
  49577. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49578. * @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)
  49579. * @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)
  49580. * @param scene the instance of BABYLON.Scene to append to
  49581. * @param onProgress a callback with a progress event for each file being loaded
  49582. * @param pluginExtension the extension used to determine the plugin
  49583. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49584. */
  49585. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49586. meshes: AbstractMesh[];
  49587. particleSystems: IParticleSystem[];
  49588. skeletons: Skeleton[];
  49589. animationGroups: AnimationGroup[];
  49590. }>;
  49591. /**
  49592. * Load a scene
  49593. * @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)
  49594. * @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)
  49595. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49596. * @param onSuccess a callback with the scene when import succeeds
  49597. * @param onProgress a callback with a progress event for each file being loaded
  49598. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49599. * @param pluginExtension the extension used to determine the plugin
  49600. * @returns The loaded plugin
  49601. */
  49602. 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>;
  49603. /**
  49604. * Load a scene
  49605. * @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)
  49606. * @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)
  49607. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49608. * @param onProgress a callback with a progress event for each file being loaded
  49609. * @param pluginExtension the extension used to determine the plugin
  49610. * @returns The loaded scene
  49611. */
  49612. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49613. /**
  49614. * Append a scene
  49615. * @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)
  49616. * @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)
  49617. * @param scene is the instance of BABYLON.Scene to append to
  49618. * @param onSuccess a callback with the scene when import succeeds
  49619. * @param onProgress a callback with a progress event for each file being loaded
  49620. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49621. * @param pluginExtension the extension used to determine the plugin
  49622. * @returns The loaded plugin
  49623. */
  49624. 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>;
  49625. /**
  49626. * Append a scene
  49627. * @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)
  49628. * @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)
  49629. * @param scene is the instance of BABYLON.Scene to append to
  49630. * @param onProgress a callback with a progress event for each file being loaded
  49631. * @param pluginExtension the extension used to determine the plugin
  49632. * @returns The given scene
  49633. */
  49634. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49635. /**
  49636. * Load a scene into an asset container
  49637. * @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)
  49638. * @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)
  49639. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49640. * @param onSuccess a callback with the scene when import succeeds
  49641. * @param onProgress a callback with a progress event for each file being loaded
  49642. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49643. * @param pluginExtension the extension used to determine the plugin
  49644. * @returns The loaded plugin
  49645. */
  49646. 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>;
  49647. /**
  49648. * Load a scene into an asset container
  49649. * @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)
  49650. * @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)
  49651. * @param scene is the instance of Scene to append to
  49652. * @param onProgress a callback with a progress event for each file being loaded
  49653. * @param pluginExtension the extension used to determine the plugin
  49654. * @returns The loaded asset container
  49655. */
  49656. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49657. /**
  49658. * Import animations from a file into a scene
  49659. * @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)
  49660. * @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)
  49661. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49662. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49663. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49664. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49665. * @param onSuccess a callback with the scene when import succeeds
  49666. * @param onProgress a callback with a progress event for each file being loaded
  49667. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49668. * @param pluginExtension the extension used to determine the plugin
  49669. */
  49670. 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;
  49671. /**
  49672. * Import animations from a file into a scene
  49673. * @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)
  49674. * @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)
  49675. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49676. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49677. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49678. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49679. * @param onSuccess a callback with the scene when import succeeds
  49680. * @param onProgress a callback with a progress event for each file being loaded
  49681. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49682. * @param pluginExtension the extension used to determine the plugin
  49683. * @returns the updated scene with imported animations
  49684. */
  49685. 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>;
  49686. }
  49687. }
  49688. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49689. import { IDisposable, Scene } from "babylonjs/scene";
  49690. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49691. import { Observable } from "babylonjs/Misc/observable";
  49692. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49693. import { Nullable } from "babylonjs/types";
  49694. /**
  49695. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49696. */
  49697. export type MotionControllerHandedness = "none" | "left" | "right";
  49698. /**
  49699. * The type of components available in motion controllers.
  49700. * This is not the name of the component.
  49701. */
  49702. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49703. /**
  49704. * The state of a controller component
  49705. */
  49706. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49707. /**
  49708. * The schema of motion controller layout.
  49709. * No object will be initialized using this interface
  49710. * This is used just to define the profile.
  49711. */
  49712. export interface IMotionControllerLayout {
  49713. /**
  49714. * Path to load the assets. Usually relative to the base path
  49715. */
  49716. assetPath: string;
  49717. /**
  49718. * Available components (unsorted)
  49719. */
  49720. components: {
  49721. /**
  49722. * A map of component Ids
  49723. */
  49724. [componentId: string]: {
  49725. /**
  49726. * The type of input the component outputs
  49727. */
  49728. type: MotionControllerComponentType;
  49729. /**
  49730. * The indices of this component in the gamepad object
  49731. */
  49732. gamepadIndices: {
  49733. /**
  49734. * Index of button
  49735. */
  49736. button?: number;
  49737. /**
  49738. * If available, index of x-axis
  49739. */
  49740. xAxis?: number;
  49741. /**
  49742. * If available, index of y-axis
  49743. */
  49744. yAxis?: number;
  49745. };
  49746. /**
  49747. * The mesh's root node name
  49748. */
  49749. rootNodeName: string;
  49750. /**
  49751. * Animation definitions for this model
  49752. */
  49753. visualResponses: {
  49754. [stateKey: string]: {
  49755. /**
  49756. * What property will be animated
  49757. */
  49758. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49759. /**
  49760. * What states influence this visual response
  49761. */
  49762. states: MotionControllerComponentStateType[];
  49763. /**
  49764. * Type of animation - movement or visibility
  49765. */
  49766. valueNodeProperty: "transform" | "visibility";
  49767. /**
  49768. * Base node name to move. Its position will be calculated according to the min and max nodes
  49769. */
  49770. valueNodeName?: string;
  49771. /**
  49772. * Minimum movement node
  49773. */
  49774. minNodeName?: string;
  49775. /**
  49776. * Max movement node
  49777. */
  49778. maxNodeName?: string;
  49779. };
  49780. };
  49781. /**
  49782. * If touch enabled, what is the name of node to display user feedback
  49783. */
  49784. touchPointNodeName?: string;
  49785. };
  49786. };
  49787. /**
  49788. * Is it xr standard mapping or not
  49789. */
  49790. gamepadMapping: "" | "xr-standard";
  49791. /**
  49792. * Base root node of this entire model
  49793. */
  49794. rootNodeName: string;
  49795. /**
  49796. * Defines the main button component id
  49797. */
  49798. selectComponentId: string;
  49799. }
  49800. /**
  49801. * A definition for the layout map in the input profile
  49802. */
  49803. export interface IMotionControllerLayoutMap {
  49804. /**
  49805. * Layouts with handedness type as a key
  49806. */
  49807. [handedness: string]: IMotionControllerLayout;
  49808. }
  49809. /**
  49810. * The XR Input profile schema
  49811. * Profiles can be found here:
  49812. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49813. */
  49814. export interface IMotionControllerProfile {
  49815. /**
  49816. * fallback profiles for this profileId
  49817. */
  49818. fallbackProfileIds: string[];
  49819. /**
  49820. * The layout map, with handedness as key
  49821. */
  49822. layouts: IMotionControllerLayoutMap;
  49823. /**
  49824. * The id of this profile
  49825. * correlates to the profile(s) in the xrInput.profiles array
  49826. */
  49827. profileId: string;
  49828. }
  49829. /**
  49830. * A helper-interface for the 3 meshes needed for controller button animation
  49831. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49832. */
  49833. export interface IMotionControllerButtonMeshMap {
  49834. /**
  49835. * the mesh that defines the pressed value mesh position.
  49836. * This is used to find the max-position of this button
  49837. */
  49838. pressedMesh: AbstractMesh;
  49839. /**
  49840. * the mesh that defines the unpressed value mesh position.
  49841. * This is used to find the min (or initial) position of this button
  49842. */
  49843. unpressedMesh: AbstractMesh;
  49844. /**
  49845. * The mesh that will be changed when value changes
  49846. */
  49847. valueMesh: AbstractMesh;
  49848. }
  49849. /**
  49850. * A helper-interface for the 3 meshes needed for controller axis animation.
  49851. * This will be expanded when touchpad animations are fully supported
  49852. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49853. */
  49854. export interface IMotionControllerMeshMap {
  49855. /**
  49856. * the mesh that defines the maximum value mesh position.
  49857. */
  49858. maxMesh?: AbstractMesh;
  49859. /**
  49860. * the mesh that defines the minimum value mesh position.
  49861. */
  49862. minMesh?: AbstractMesh;
  49863. /**
  49864. * The mesh that will be changed when axis value changes
  49865. */
  49866. valueMesh: AbstractMesh;
  49867. }
  49868. /**
  49869. * The elements needed for change-detection of the gamepad objects in motion controllers
  49870. */
  49871. export interface IMinimalMotionControllerObject {
  49872. /**
  49873. * Available axes of this controller
  49874. */
  49875. axes: number[];
  49876. /**
  49877. * An array of available buttons
  49878. */
  49879. buttons: Array<{
  49880. /**
  49881. * Value of the button/trigger
  49882. */
  49883. value: number;
  49884. /**
  49885. * If the button/trigger is currently touched
  49886. */
  49887. touched: boolean;
  49888. /**
  49889. * If the button/trigger is currently pressed
  49890. */
  49891. pressed: boolean;
  49892. }>;
  49893. /**
  49894. * EXPERIMENTAL haptic support.
  49895. */
  49896. hapticActuators?: Array<{
  49897. pulse: (value: number, duration: number) => Promise<boolean>;
  49898. }>;
  49899. }
  49900. /**
  49901. * An Abstract Motion controller
  49902. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49903. * Each component has an observable to check for changes in value and state
  49904. */
  49905. export abstract class WebXRAbstractMotionController implements IDisposable {
  49906. protected scene: Scene;
  49907. protected layout: IMotionControllerLayout;
  49908. /**
  49909. * The gamepad object correlating to this controller
  49910. */
  49911. gamepadObject: IMinimalMotionControllerObject;
  49912. /**
  49913. * handedness (left/right/none) of this controller
  49914. */
  49915. handedness: MotionControllerHandedness;
  49916. private _initComponent;
  49917. private _modelReady;
  49918. /**
  49919. * A map of components (WebXRControllerComponent) in this motion controller
  49920. * Components have a ComponentType and can also have both button and axis definitions
  49921. */
  49922. readonly components: {
  49923. [id: string]: WebXRControllerComponent;
  49924. };
  49925. /**
  49926. * Disable the model's animation. Can be set at any time.
  49927. */
  49928. disableAnimation: boolean;
  49929. /**
  49930. * Observers registered here will be triggered when the model of this controller is done loading
  49931. */
  49932. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49933. /**
  49934. * The profile id of this motion controller
  49935. */
  49936. abstract profileId: string;
  49937. /**
  49938. * The root mesh of the model. It is null if the model was not yet initialized
  49939. */
  49940. rootMesh: Nullable<AbstractMesh>;
  49941. /**
  49942. * constructs a new abstract motion controller
  49943. * @param scene the scene to which the model of the controller will be added
  49944. * @param layout The profile layout to load
  49945. * @param gamepadObject The gamepad object correlating to this controller
  49946. * @param handedness handedness (left/right/none) of this controller
  49947. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49948. */
  49949. constructor(scene: Scene, layout: IMotionControllerLayout,
  49950. /**
  49951. * The gamepad object correlating to this controller
  49952. */
  49953. gamepadObject: IMinimalMotionControllerObject,
  49954. /**
  49955. * handedness (left/right/none) of this controller
  49956. */
  49957. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  49958. /**
  49959. * Dispose this controller, the model mesh and all its components
  49960. */
  49961. dispose(): void;
  49962. /**
  49963. * Returns all components of specific type
  49964. * @param type the type to search for
  49965. * @return an array of components with this type
  49966. */
  49967. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  49968. /**
  49969. * get a component based an its component id as defined in layout.components
  49970. * @param id the id of the component
  49971. * @returns the component correlates to the id or undefined if not found
  49972. */
  49973. getComponent(id: string): WebXRControllerComponent;
  49974. /**
  49975. * Get the list of components available in this motion controller
  49976. * @returns an array of strings correlating to available components
  49977. */
  49978. getComponentIds(): string[];
  49979. /**
  49980. * Get the first component of specific type
  49981. * @param type type of component to find
  49982. * @return a controller component or null if not found
  49983. */
  49984. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  49985. /**
  49986. * Get the main (Select) component of this controller as defined in the layout
  49987. * @returns the main component of this controller
  49988. */
  49989. getMainComponent(): WebXRControllerComponent;
  49990. /**
  49991. * Loads the model correlating to this controller
  49992. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  49993. * @returns A promise fulfilled with the result of the model loading
  49994. */
  49995. loadModel(): Promise<boolean>;
  49996. /**
  49997. * Update this model using the current XRFrame
  49998. * @param xrFrame the current xr frame to use and update the model
  49999. */
  50000. updateFromXRFrame(xrFrame: XRFrame): void;
  50001. /**
  50002. * Backwards compatibility due to a deeply-integrated typo
  50003. */
  50004. get handness(): XREye;
  50005. /**
  50006. * Pulse (vibrate) this controller
  50007. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50008. * Consecutive calls to this function will cancel the last pulse call
  50009. *
  50010. * @param value the strength of the pulse in 0.0...1.0 range
  50011. * @param duration Duration of the pulse in milliseconds
  50012. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50013. * @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
  50014. */
  50015. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50016. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  50017. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  50018. /**
  50019. * Moves the axis on the controller mesh based on its current state
  50020. * @param axis the index of the axis
  50021. * @param axisValue the value of the axis which determines the meshes new position
  50022. * @hidden
  50023. */
  50024. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50025. /**
  50026. * Update the model itself with the current frame data
  50027. * @param xrFrame the frame to use for updating the model mesh
  50028. */
  50029. protected updateModel(xrFrame: XRFrame): void;
  50030. /**
  50031. * Get the filename and path for this controller's model
  50032. * @returns a map of filename and path
  50033. */
  50034. protected abstract _getFilenameAndPath(): {
  50035. filename: string;
  50036. path: string;
  50037. };
  50038. /**
  50039. * This function is called before the mesh is loaded. It checks for loading constraints.
  50040. * For example, this function can check if the GLB loader is available
  50041. * If this function returns false, the generic controller will be loaded instead
  50042. * @returns Is the client ready to load the mesh
  50043. */
  50044. protected abstract _getModelLoadingConstraints(): boolean;
  50045. /**
  50046. * This function will be called after the model was successfully loaded and can be used
  50047. * for mesh transformations before it is available for the user
  50048. * @param meshes the loaded meshes
  50049. */
  50050. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50051. /**
  50052. * Set the root mesh for this controller. Important for the WebXR controller class
  50053. * @param meshes the loaded meshes
  50054. */
  50055. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50056. /**
  50057. * A function executed each frame that updates the mesh (if needed)
  50058. * @param xrFrame the current xrFrame
  50059. */
  50060. protected abstract _updateModel(xrFrame: XRFrame): void;
  50061. private _getGenericFilenameAndPath;
  50062. private _getGenericParentMesh;
  50063. }
  50064. }
  50065. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50066. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50067. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50068. import { Scene } from "babylonjs/scene";
  50069. /**
  50070. * A generic trigger-only motion controller for WebXR
  50071. */
  50072. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50073. /**
  50074. * Static version of the profile id of this controller
  50075. */
  50076. static ProfileId: string;
  50077. profileId: string;
  50078. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50079. protected _getFilenameAndPath(): {
  50080. filename: string;
  50081. path: string;
  50082. };
  50083. protected _getModelLoadingConstraints(): boolean;
  50084. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50085. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50086. protected _updateModel(): void;
  50087. }
  50088. }
  50089. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50090. import { Vector4 } from "babylonjs/Maths/math.vector";
  50091. import { Mesh } from "babylonjs/Meshes/mesh";
  50092. import { Scene } from "babylonjs/scene";
  50093. import { Nullable } from "babylonjs/types";
  50094. /**
  50095. * Class containing static functions to help procedurally build meshes
  50096. */
  50097. export class SphereBuilder {
  50098. /**
  50099. * Creates a sphere mesh
  50100. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50101. * * 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`)
  50102. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50103. * * 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
  50104. * * 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)
  50105. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50106. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50107. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50108. * @param name defines the name of the mesh
  50109. * @param options defines the options used to create the mesh
  50110. * @param scene defines the hosting scene
  50111. * @returns the sphere mesh
  50112. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50113. */
  50114. static CreateSphere(name: string, options: {
  50115. segments?: number;
  50116. diameter?: number;
  50117. diameterX?: number;
  50118. diameterY?: number;
  50119. diameterZ?: number;
  50120. arc?: number;
  50121. slice?: number;
  50122. sideOrientation?: number;
  50123. frontUVs?: Vector4;
  50124. backUVs?: Vector4;
  50125. updatable?: boolean;
  50126. }, scene?: Nullable<Scene>): Mesh;
  50127. }
  50128. }
  50129. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50130. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50131. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50132. import { Scene } from "babylonjs/scene";
  50133. /**
  50134. * A profiled motion controller has its profile loaded from an online repository.
  50135. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50136. */
  50137. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50138. private _repositoryUrl;
  50139. private _buttonMeshMapping;
  50140. private _touchDots;
  50141. /**
  50142. * The profile ID of this controller. Will be populated when the controller initializes.
  50143. */
  50144. profileId: string;
  50145. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50146. dispose(): void;
  50147. protected _getFilenameAndPath(): {
  50148. filename: string;
  50149. path: string;
  50150. };
  50151. protected _getModelLoadingConstraints(): boolean;
  50152. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50153. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50154. protected _updateModel(_xrFrame: XRFrame): void;
  50155. }
  50156. }
  50157. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50158. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50159. import { Scene } from "babylonjs/scene";
  50160. /**
  50161. * A construction function type to create a new controller based on an xrInput object
  50162. */
  50163. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50164. /**
  50165. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50166. *
  50167. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50168. * it should be replaced with auto-loaded controllers.
  50169. *
  50170. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50171. */
  50172. export class WebXRMotionControllerManager {
  50173. private static _AvailableControllers;
  50174. private static _Fallbacks;
  50175. private static _ProfileLoadingPromises;
  50176. private static _ProfilesList;
  50177. /**
  50178. * The base URL of the online controller repository. Can be changed at any time.
  50179. */
  50180. static BaseRepositoryUrl: string;
  50181. /**
  50182. * Which repository gets priority - local or online
  50183. */
  50184. static PrioritizeOnlineRepository: boolean;
  50185. /**
  50186. * Use the online repository, or use only locally-defined controllers
  50187. */
  50188. static UseOnlineRepository: boolean;
  50189. /**
  50190. * Clear the cache used for profile loading and reload when requested again
  50191. */
  50192. static ClearProfilesCache(): void;
  50193. /**
  50194. * Register the default fallbacks.
  50195. * This function is called automatically when this file is imported.
  50196. */
  50197. static DefaultFallbacks(): void;
  50198. /**
  50199. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50200. * @param profileId the profile to which a fallback needs to be found
  50201. * @return an array with corresponding fallback profiles
  50202. */
  50203. static FindFallbackWithProfileId(profileId: string): string[];
  50204. /**
  50205. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50206. * The order of search:
  50207. *
  50208. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50209. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50210. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50211. * 4) return the generic trigger controller if none were found
  50212. *
  50213. * @param xrInput the xrInput to which a new controller is initialized
  50214. * @param scene the scene to which the model will be added
  50215. * @param forceProfile force a certain profile for this controller
  50216. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50217. */
  50218. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50219. /**
  50220. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50221. *
  50222. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50223. *
  50224. * @param type the profile type to register
  50225. * @param constructFunction the function to be called when loading this profile
  50226. */
  50227. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50228. /**
  50229. * Register a fallback to a specific profile.
  50230. * @param profileId the profileId that will receive the fallbacks
  50231. * @param fallbacks A list of fallback profiles
  50232. */
  50233. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50234. /**
  50235. * Will update the list of profiles available in the repository
  50236. * @return a promise that resolves to a map of profiles available online
  50237. */
  50238. static UpdateProfilesList(): Promise<{
  50239. [profile: string]: string;
  50240. }>;
  50241. private static _LoadProfileFromRepository;
  50242. private static _LoadProfilesFromAvailableControllers;
  50243. }
  50244. }
  50245. declare module "babylonjs/XR/webXRInputSource" {
  50246. import { Observable } from "babylonjs/Misc/observable";
  50247. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50248. import { Ray } from "babylonjs/Culling/ray";
  50249. import { Scene } from "babylonjs/scene";
  50250. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50251. /**
  50252. * Configuration options for the WebXR controller creation
  50253. */
  50254. export interface IWebXRControllerOptions {
  50255. /**
  50256. * Should the controller mesh be animated when a user interacts with it
  50257. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50258. */
  50259. disableMotionControllerAnimation?: boolean;
  50260. /**
  50261. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50262. */
  50263. doNotLoadControllerMesh?: boolean;
  50264. /**
  50265. * Force a specific controller type for this controller.
  50266. * This can be used when creating your own profile or when testing different controllers
  50267. */
  50268. forceControllerProfile?: string;
  50269. /**
  50270. * Defines a rendering group ID for meshes that will be loaded.
  50271. * This is for the default controllers only.
  50272. */
  50273. renderingGroupId?: number;
  50274. }
  50275. /**
  50276. * Represents an XR controller
  50277. */
  50278. export class WebXRInputSource {
  50279. private _scene;
  50280. /** The underlying input source for the controller */
  50281. inputSource: XRInputSource;
  50282. private _options;
  50283. private _tmpVector;
  50284. private _uniqueId;
  50285. /**
  50286. * 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
  50287. */
  50288. grip?: AbstractMesh;
  50289. /**
  50290. * If available, this is the gamepad object related to this controller.
  50291. * Using this object it is possible to get click events and trackpad changes of the
  50292. * webxr controller that is currently being used.
  50293. */
  50294. motionController?: WebXRAbstractMotionController;
  50295. /**
  50296. * Event that fires when the controller is removed/disposed.
  50297. * The object provided as event data is this controller, after associated assets were disposed.
  50298. * uniqueId is still available.
  50299. */
  50300. onDisposeObservable: Observable<WebXRInputSource>;
  50301. /**
  50302. * Will be triggered when the mesh associated with the motion controller is done loading.
  50303. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50304. * A shortened version of controller -> motion controller -> on mesh loaded.
  50305. */
  50306. onMeshLoadedObservable: Observable<AbstractMesh>;
  50307. /**
  50308. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50309. */
  50310. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50311. /**
  50312. * Pointer which can be used to select objects or attach a visible laser to
  50313. */
  50314. pointer: AbstractMesh;
  50315. /**
  50316. * Creates the input source object
  50317. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50318. * @param _scene the scene which the controller should be associated to
  50319. * @param inputSource the underlying input source for the controller
  50320. * @param _options options for this controller creation
  50321. */
  50322. constructor(_scene: Scene,
  50323. /** The underlying input source for the controller */
  50324. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50325. /**
  50326. * Get this controllers unique id
  50327. */
  50328. get uniqueId(): string;
  50329. /**
  50330. * Disposes of the object
  50331. */
  50332. dispose(): void;
  50333. /**
  50334. * Gets a world space ray coming from the pointer or grip
  50335. * @param result the resulting ray
  50336. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50337. */
  50338. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50339. /**
  50340. * Updates the controller pose based on the given XRFrame
  50341. * @param xrFrame xr frame to update the pose with
  50342. * @param referenceSpace reference space to use
  50343. */
  50344. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50345. }
  50346. }
  50347. declare module "babylonjs/XR/webXRInput" {
  50348. import { Observable } from "babylonjs/Misc/observable";
  50349. import { IDisposable } from "babylonjs/scene";
  50350. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50351. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50352. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50353. /**
  50354. * The schema for initialization options of the XR Input class
  50355. */
  50356. export interface IWebXRInputOptions {
  50357. /**
  50358. * If set to true no model will be automatically loaded
  50359. */
  50360. doNotLoadControllerMeshes?: boolean;
  50361. /**
  50362. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50363. * If not found, the xr input profile data will be used.
  50364. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50365. */
  50366. forceInputProfile?: string;
  50367. /**
  50368. * Do not send a request to the controller repository to load the profile.
  50369. *
  50370. * Instead, use the controllers available in babylon itself.
  50371. */
  50372. disableOnlineControllerRepository?: boolean;
  50373. /**
  50374. * A custom URL for the controllers repository
  50375. */
  50376. customControllersRepositoryURL?: string;
  50377. /**
  50378. * Should the controller model's components not move according to the user input
  50379. */
  50380. disableControllerAnimation?: boolean;
  50381. /**
  50382. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50383. */
  50384. controllerOptions?: IWebXRControllerOptions;
  50385. }
  50386. /**
  50387. * XR input used to track XR inputs such as controllers/rays
  50388. */
  50389. export class WebXRInput implements IDisposable {
  50390. /**
  50391. * the xr session manager for this session
  50392. */
  50393. xrSessionManager: WebXRSessionManager;
  50394. /**
  50395. * the WebXR camera for this session. Mainly used for teleportation
  50396. */
  50397. xrCamera: WebXRCamera;
  50398. private readonly options;
  50399. /**
  50400. * XR controllers being tracked
  50401. */
  50402. controllers: Array<WebXRInputSource>;
  50403. private _frameObserver;
  50404. private _sessionEndedObserver;
  50405. private _sessionInitObserver;
  50406. /**
  50407. * Event when a controller has been connected/added
  50408. */
  50409. onControllerAddedObservable: Observable<WebXRInputSource>;
  50410. /**
  50411. * Event when a controller has been removed/disconnected
  50412. */
  50413. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50414. /**
  50415. * Initializes the WebXRInput
  50416. * @param xrSessionManager the xr session manager for this session
  50417. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50418. * @param options = initialization options for this xr input
  50419. */
  50420. constructor(
  50421. /**
  50422. * the xr session manager for this session
  50423. */
  50424. xrSessionManager: WebXRSessionManager,
  50425. /**
  50426. * the WebXR camera for this session. Mainly used for teleportation
  50427. */
  50428. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50429. private _onInputSourcesChange;
  50430. private _addAndRemoveControllers;
  50431. /**
  50432. * Disposes of the object
  50433. */
  50434. dispose(): void;
  50435. }
  50436. }
  50437. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50438. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50439. import { Observable, EventState } from "babylonjs/Misc/observable";
  50440. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50441. /**
  50442. * This is the base class for all WebXR features.
  50443. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50444. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50445. */
  50446. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50447. protected _xrSessionManager: WebXRSessionManager;
  50448. private _attached;
  50449. private _removeOnDetach;
  50450. /**
  50451. * Should auto-attach be disabled?
  50452. */
  50453. disableAutoAttach: boolean;
  50454. /**
  50455. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50456. */
  50457. xrNativeFeatureName: string;
  50458. /**
  50459. * Construct a new (abstract) WebXR feature
  50460. * @param _xrSessionManager the xr session manager for this feature
  50461. */
  50462. constructor(_xrSessionManager: WebXRSessionManager);
  50463. /**
  50464. * Is this feature attached
  50465. */
  50466. get attached(): boolean;
  50467. /**
  50468. * attach this feature
  50469. *
  50470. * @param force should attachment be forced (even when already attached)
  50471. * @returns true if successful, false is failed or already attached
  50472. */
  50473. attach(force?: boolean): boolean;
  50474. /**
  50475. * detach this feature.
  50476. *
  50477. * @returns true if successful, false if failed or already detached
  50478. */
  50479. detach(): boolean;
  50480. /**
  50481. * Dispose this feature and all of the resources attached
  50482. */
  50483. dispose(): void;
  50484. /**
  50485. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50486. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50487. *
  50488. * @returns whether or not the feature is compatible in this environment
  50489. */
  50490. isCompatible(): boolean;
  50491. /**
  50492. * This is used to register callbacks that will automatically be removed when detach is called.
  50493. * @param observable the observable to which the observer will be attached
  50494. * @param callback the callback to register
  50495. */
  50496. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50497. /**
  50498. * Code in this function will be executed on each xrFrame received from the browser.
  50499. * This function will not execute after the feature is detached.
  50500. * @param _xrFrame the current frame
  50501. */
  50502. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50503. }
  50504. }
  50505. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50506. import { IDisposable, Scene } from "babylonjs/scene";
  50507. import { Nullable } from "babylonjs/types";
  50508. import { Observable } from "babylonjs/Misc/observable";
  50509. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50510. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50511. import { Camera } from "babylonjs/Cameras/camera";
  50512. /**
  50513. * Renders a layer on top of an existing scene
  50514. */
  50515. export class UtilityLayerRenderer implements IDisposable {
  50516. /** the original scene that will be rendered on top of */
  50517. originalScene: Scene;
  50518. private _pointerCaptures;
  50519. private _lastPointerEvents;
  50520. private static _DefaultUtilityLayer;
  50521. private static _DefaultKeepDepthUtilityLayer;
  50522. private _sharedGizmoLight;
  50523. private _renderCamera;
  50524. /**
  50525. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50526. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50527. * @returns the camera that is used when rendering the utility layer
  50528. */
  50529. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50530. /**
  50531. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50532. * @param cam the camera that should be used when rendering the utility layer
  50533. */
  50534. setRenderCamera(cam: Nullable<Camera>): void;
  50535. /**
  50536. * @hidden
  50537. * Light which used by gizmos to get light shading
  50538. */
  50539. _getSharedGizmoLight(): HemisphericLight;
  50540. /**
  50541. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50542. */
  50543. pickUtilitySceneFirst: boolean;
  50544. /**
  50545. * 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)
  50546. */
  50547. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50548. /**
  50549. * 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)
  50550. */
  50551. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50552. /**
  50553. * The scene that is rendered on top of the original scene
  50554. */
  50555. utilityLayerScene: Scene;
  50556. /**
  50557. * If the utility layer should automatically be rendered on top of existing scene
  50558. */
  50559. shouldRender: boolean;
  50560. /**
  50561. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50562. */
  50563. onlyCheckPointerDownEvents: boolean;
  50564. /**
  50565. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50566. */
  50567. processAllEvents: boolean;
  50568. /**
  50569. * Observable raised when the pointer move from the utility layer scene to the main scene
  50570. */
  50571. onPointerOutObservable: Observable<number>;
  50572. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50573. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50574. private _afterRenderObserver;
  50575. private _sceneDisposeObserver;
  50576. private _originalPointerObserver;
  50577. /**
  50578. * Instantiates a UtilityLayerRenderer
  50579. * @param originalScene the original scene that will be rendered on top of
  50580. * @param handleEvents boolean indicating if the utility layer should handle events
  50581. */
  50582. constructor(
  50583. /** the original scene that will be rendered on top of */
  50584. originalScene: Scene, handleEvents?: boolean);
  50585. private _notifyObservers;
  50586. /**
  50587. * Renders the utility layers scene on top of the original scene
  50588. */
  50589. render(): void;
  50590. /**
  50591. * Disposes of the renderer
  50592. */
  50593. dispose(): void;
  50594. private _updateCamera;
  50595. }
  50596. }
  50597. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50598. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50599. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50600. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50601. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50602. import { Scene } from "babylonjs/scene";
  50603. import { Nullable } from "babylonjs/types";
  50604. import { Color3 } from "babylonjs/Maths/math.color";
  50605. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50606. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50607. /**
  50608. * Options interface for the pointer selection module
  50609. */
  50610. export interface IWebXRControllerPointerSelectionOptions {
  50611. /**
  50612. * if provided, this scene will be used to render meshes.
  50613. */
  50614. customUtilityLayerScene?: Scene;
  50615. /**
  50616. * 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)
  50617. * If not disabled, the last picked point will be used to execute a pointer up event
  50618. * If disabled, pointer up event will be triggered right after the pointer down event.
  50619. * Used in screen and gaze target ray mode only
  50620. */
  50621. disablePointerUpOnTouchOut: boolean;
  50622. /**
  50623. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50624. */
  50625. forceGazeMode: boolean;
  50626. /**
  50627. * 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
  50628. * to start a new countdown to the pointer down event.
  50629. * Defaults to 1.
  50630. */
  50631. gazeModePointerMovedFactor?: number;
  50632. /**
  50633. * Different button type to use instead of the main component
  50634. */
  50635. overrideButtonId?: string;
  50636. /**
  50637. * use this rendering group id for the meshes (optional)
  50638. */
  50639. renderingGroupId?: number;
  50640. /**
  50641. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50642. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50643. * 3000 means 3 seconds between pointing at something and selecting it
  50644. */
  50645. timeToSelect?: number;
  50646. /**
  50647. * Should meshes created here be added to a utility layer or the main scene
  50648. */
  50649. useUtilityLayer?: boolean;
  50650. /**
  50651. * Optional WebXR camera to be used for gaze selection
  50652. */
  50653. gazeCamera?: WebXRCamera;
  50654. /**
  50655. * the xr input to use with this pointer selection
  50656. */
  50657. xrInput: WebXRInput;
  50658. }
  50659. /**
  50660. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50661. */
  50662. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50663. private readonly _options;
  50664. private static _idCounter;
  50665. private _attachController;
  50666. private _controllers;
  50667. private _scene;
  50668. private _tmpVectorForPickCompare;
  50669. /**
  50670. * The module's name
  50671. */
  50672. static readonly Name: string;
  50673. /**
  50674. * The (Babylon) version of this module.
  50675. * This is an integer representing the implementation version.
  50676. * This number does not correspond to the WebXR specs version
  50677. */
  50678. static readonly Version: number;
  50679. /**
  50680. * Disable lighting on the laser pointer (so it will always be visible)
  50681. */
  50682. disablePointerLighting: boolean;
  50683. /**
  50684. * Disable lighting on the selection mesh (so it will always be visible)
  50685. */
  50686. disableSelectionMeshLighting: boolean;
  50687. /**
  50688. * Should the laser pointer be displayed
  50689. */
  50690. displayLaserPointer: boolean;
  50691. /**
  50692. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50693. */
  50694. displaySelectionMesh: boolean;
  50695. /**
  50696. * This color will be set to the laser pointer when selection is triggered
  50697. */
  50698. laserPointerPickedColor: Color3;
  50699. /**
  50700. * Default color of the laser pointer
  50701. */
  50702. laserPointerDefaultColor: Color3;
  50703. /**
  50704. * default color of the selection ring
  50705. */
  50706. selectionMeshDefaultColor: Color3;
  50707. /**
  50708. * This color will be applied to the selection ring when selection is triggered
  50709. */
  50710. selectionMeshPickedColor: Color3;
  50711. /**
  50712. * Optional filter to be used for ray selection. This predicate shares behavior with
  50713. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50714. */
  50715. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50716. /**
  50717. * constructs a new background remover module
  50718. * @param _xrSessionManager the session manager for this module
  50719. * @param _options read-only options to be used in this module
  50720. */
  50721. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50722. /**
  50723. * attach this feature
  50724. * Will usually be called by the features manager
  50725. *
  50726. * @returns true if successful.
  50727. */
  50728. attach(): boolean;
  50729. /**
  50730. * detach this feature.
  50731. * Will usually be called by the features manager
  50732. *
  50733. * @returns true if successful.
  50734. */
  50735. detach(): boolean;
  50736. /**
  50737. * Will get the mesh under a specific pointer.
  50738. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50739. * @param controllerId the controllerId to check
  50740. * @returns The mesh under pointer or null if no mesh is under the pointer
  50741. */
  50742. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50743. /**
  50744. * Get the xr controller that correlates to the pointer id in the pointer event
  50745. *
  50746. * @param id the pointer id to search for
  50747. * @returns the controller that correlates to this id or null if not found
  50748. */
  50749. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50750. protected _onXRFrame(_xrFrame: XRFrame): void;
  50751. private _attachGazeMode;
  50752. private _attachScreenRayMode;
  50753. private _attachTrackedPointerRayMode;
  50754. private _convertNormalToDirectionOfRay;
  50755. private _detachController;
  50756. private _generateNewMeshPair;
  50757. private _pickingMoved;
  50758. private _updatePointerDistance;
  50759. /** @hidden */
  50760. get lasterPointerDefaultColor(): Color3;
  50761. }
  50762. }
  50763. declare module "babylonjs/XR/webXREnterExitUI" {
  50764. import { Nullable } from "babylonjs/types";
  50765. import { Observable } from "babylonjs/Misc/observable";
  50766. import { IDisposable, Scene } from "babylonjs/scene";
  50767. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50768. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50769. /**
  50770. * Button which can be used to enter a different mode of XR
  50771. */
  50772. export class WebXREnterExitUIButton {
  50773. /** button element */
  50774. element: HTMLElement;
  50775. /** XR initialization options for the button */
  50776. sessionMode: XRSessionMode;
  50777. /** Reference space type */
  50778. referenceSpaceType: XRReferenceSpaceType;
  50779. /**
  50780. * Creates a WebXREnterExitUIButton
  50781. * @param element button element
  50782. * @param sessionMode XR initialization session mode
  50783. * @param referenceSpaceType the type of reference space to be used
  50784. */
  50785. constructor(
  50786. /** button element */
  50787. element: HTMLElement,
  50788. /** XR initialization options for the button */
  50789. sessionMode: XRSessionMode,
  50790. /** Reference space type */
  50791. referenceSpaceType: XRReferenceSpaceType);
  50792. /**
  50793. * Extendable function which can be used to update the button's visuals when the state changes
  50794. * @param activeButton the current active button in the UI
  50795. */
  50796. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50797. }
  50798. /**
  50799. * Options to create the webXR UI
  50800. */
  50801. export class WebXREnterExitUIOptions {
  50802. /**
  50803. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50804. */
  50805. customButtons?: Array<WebXREnterExitUIButton>;
  50806. /**
  50807. * A reference space type to use when creating the default button.
  50808. * Default is local-floor
  50809. */
  50810. referenceSpaceType?: XRReferenceSpaceType;
  50811. /**
  50812. * Context to enter xr with
  50813. */
  50814. renderTarget?: Nullable<WebXRRenderTarget>;
  50815. /**
  50816. * A session mode to use when creating the default button.
  50817. * Default is immersive-vr
  50818. */
  50819. sessionMode?: XRSessionMode;
  50820. /**
  50821. * A list of optional features to init the session with
  50822. */
  50823. optionalFeatures?: string[];
  50824. /**
  50825. * A list of optional features to init the session with
  50826. */
  50827. requiredFeatures?: string[];
  50828. }
  50829. /**
  50830. * UI to allow the user to enter/exit XR mode
  50831. */
  50832. export class WebXREnterExitUI implements IDisposable {
  50833. private scene;
  50834. /** version of the options passed to this UI */
  50835. options: WebXREnterExitUIOptions;
  50836. private _activeButton;
  50837. private _buttons;
  50838. private _overlay;
  50839. /**
  50840. * Fired every time the active button is changed.
  50841. *
  50842. * When xr is entered via a button that launches xr that button will be the callback parameter
  50843. *
  50844. * When exiting xr the callback parameter will be null)
  50845. */
  50846. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50847. /**
  50848. *
  50849. * @param scene babylon scene object to use
  50850. * @param options (read-only) version of the options passed to this UI
  50851. */
  50852. private constructor();
  50853. /**
  50854. * Creates UI to allow the user to enter/exit XR mode
  50855. * @param scene the scene to add the ui to
  50856. * @param helper the xr experience helper to enter/exit xr with
  50857. * @param options options to configure the UI
  50858. * @returns the created ui
  50859. */
  50860. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50861. /**
  50862. * Disposes of the XR UI component
  50863. */
  50864. dispose(): void;
  50865. private _updateButtons;
  50866. }
  50867. }
  50868. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50869. import { Vector3 } from "babylonjs/Maths/math.vector";
  50870. import { Color4 } from "babylonjs/Maths/math.color";
  50871. import { Nullable } from "babylonjs/types";
  50872. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50873. import { Scene } from "babylonjs/scene";
  50874. /**
  50875. * Class containing static functions to help procedurally build meshes
  50876. */
  50877. export class LinesBuilder {
  50878. /**
  50879. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50880. * * 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
  50881. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50882. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50883. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50884. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50885. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50886. * * 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
  50887. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50888. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50889. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50890. * @param name defines the name of the new line system
  50891. * @param options defines the options used to create the line system
  50892. * @param scene defines the hosting scene
  50893. * @returns a new line system mesh
  50894. */
  50895. static CreateLineSystem(name: string, options: {
  50896. lines: Vector3[][];
  50897. updatable?: boolean;
  50898. instance?: Nullable<LinesMesh>;
  50899. colors?: Nullable<Color4[][]>;
  50900. useVertexAlpha?: boolean;
  50901. }, scene: Nullable<Scene>): LinesMesh;
  50902. /**
  50903. * Creates a line mesh
  50904. * 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
  50905. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50906. * * The parameter `points` is an array successive Vector3
  50907. * * 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
  50908. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50909. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50910. * * When updating an instance, remember that only point positions can change, not the number of points
  50911. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50912. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50913. * @param name defines the name of the new line system
  50914. * @param options defines the options used to create the line system
  50915. * @param scene defines the hosting scene
  50916. * @returns a new line mesh
  50917. */
  50918. static CreateLines(name: string, options: {
  50919. points: Vector3[];
  50920. updatable?: boolean;
  50921. instance?: Nullable<LinesMesh>;
  50922. colors?: Color4[];
  50923. useVertexAlpha?: boolean;
  50924. }, scene?: Nullable<Scene>): LinesMesh;
  50925. /**
  50926. * Creates a dashed line mesh
  50927. * * 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
  50928. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50929. * * The parameter `points` is an array successive Vector3
  50930. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50931. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50932. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50933. * * 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
  50934. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50935. * * When updating an instance, remember that only point positions can change, not the number of points
  50936. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50937. * @param name defines the name of the mesh
  50938. * @param options defines the options used to create the mesh
  50939. * @param scene defines the hosting scene
  50940. * @returns the dashed line mesh
  50941. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50942. */
  50943. static CreateDashedLines(name: string, options: {
  50944. points: Vector3[];
  50945. dashSize?: number;
  50946. gapSize?: number;
  50947. dashNb?: number;
  50948. updatable?: boolean;
  50949. instance?: LinesMesh;
  50950. useVertexAlpha?: boolean;
  50951. }, scene?: Nullable<Scene>): LinesMesh;
  50952. }
  50953. }
  50954. declare module "babylonjs/Misc/timer" {
  50955. import { Observable, Observer } from "babylonjs/Misc/observable";
  50956. import { Nullable } from "babylonjs/types";
  50957. import { IDisposable } from "babylonjs/scene";
  50958. /**
  50959. * Construction options for a timer
  50960. */
  50961. export interface ITimerOptions<T> {
  50962. /**
  50963. * Time-to-end
  50964. */
  50965. timeout: number;
  50966. /**
  50967. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  50968. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  50969. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  50970. */
  50971. contextObservable: Observable<T>;
  50972. /**
  50973. * Optional parameters when adding an observer to the observable
  50974. */
  50975. observableParameters?: {
  50976. mask?: number;
  50977. insertFirst?: boolean;
  50978. scope?: any;
  50979. };
  50980. /**
  50981. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  50982. */
  50983. breakCondition?: (data?: ITimerData<T>) => boolean;
  50984. /**
  50985. * Will be triggered when the time condition has met
  50986. */
  50987. onEnded?: (data: ITimerData<any>) => void;
  50988. /**
  50989. * Will be triggered when the break condition has met (prematurely ended)
  50990. */
  50991. onAborted?: (data: ITimerData<any>) => void;
  50992. /**
  50993. * Optional function to execute on each tick (or count)
  50994. */
  50995. onTick?: (data: ITimerData<any>) => void;
  50996. }
  50997. /**
  50998. * An interface defining the data sent by the timer
  50999. */
  51000. export interface ITimerData<T> {
  51001. /**
  51002. * When did it start
  51003. */
  51004. startTime: number;
  51005. /**
  51006. * Time now
  51007. */
  51008. currentTime: number;
  51009. /**
  51010. * Time passed since started
  51011. */
  51012. deltaTime: number;
  51013. /**
  51014. * How much is completed, in [0.0...1.0].
  51015. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51016. */
  51017. completeRate: number;
  51018. /**
  51019. * What the registered observable sent in the last count
  51020. */
  51021. payload: T;
  51022. }
  51023. /**
  51024. * The current state of the timer
  51025. */
  51026. export enum TimerState {
  51027. /**
  51028. * Timer initialized, not yet started
  51029. */
  51030. INIT = 0,
  51031. /**
  51032. * Timer started and counting
  51033. */
  51034. STARTED = 1,
  51035. /**
  51036. * Timer ended (whether aborted or time reached)
  51037. */
  51038. ENDED = 2
  51039. }
  51040. /**
  51041. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51042. *
  51043. * @param options options with which to initialize this timer
  51044. */
  51045. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51046. /**
  51047. * An advanced implementation of a timer class
  51048. */
  51049. export class AdvancedTimer<T = any> implements IDisposable {
  51050. /**
  51051. * Will notify each time the timer calculates the remaining time
  51052. */
  51053. onEachCountObservable: Observable<ITimerData<T>>;
  51054. /**
  51055. * Will trigger when the timer was aborted due to the break condition
  51056. */
  51057. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51058. /**
  51059. * Will trigger when the timer ended successfully
  51060. */
  51061. onTimerEndedObservable: Observable<ITimerData<T>>;
  51062. /**
  51063. * Will trigger when the timer state has changed
  51064. */
  51065. onStateChangedObservable: Observable<TimerState>;
  51066. private _observer;
  51067. private _contextObservable;
  51068. private _observableParameters;
  51069. private _startTime;
  51070. private _timer;
  51071. private _state;
  51072. private _breakCondition;
  51073. private _timeToEnd;
  51074. private _breakOnNextTick;
  51075. /**
  51076. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51077. * @param options construction options for this advanced timer
  51078. */
  51079. constructor(options: ITimerOptions<T>);
  51080. /**
  51081. * set a breaking condition for this timer. Default is to never break during count
  51082. * @param predicate the new break condition. Returns true to break, false otherwise
  51083. */
  51084. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51085. /**
  51086. * Reset ALL associated observables in this advanced timer
  51087. */
  51088. clearObservables(): void;
  51089. /**
  51090. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51091. *
  51092. * @param timeToEnd how much time to measure until timer ended
  51093. */
  51094. start(timeToEnd?: number): void;
  51095. /**
  51096. * Will force a stop on the next tick.
  51097. */
  51098. stop(): void;
  51099. /**
  51100. * Dispose this timer, clearing all resources
  51101. */
  51102. dispose(): void;
  51103. private _setState;
  51104. private _tick;
  51105. private _stop;
  51106. }
  51107. }
  51108. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51109. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51110. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51111. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51112. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51113. import { Vector3 } from "babylonjs/Maths/math.vector";
  51114. import { Material } from "babylonjs/Materials/material";
  51115. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51116. import { Scene } from "babylonjs/scene";
  51117. /**
  51118. * The options container for the teleportation module
  51119. */
  51120. export interface IWebXRTeleportationOptions {
  51121. /**
  51122. * if provided, this scene will be used to render meshes.
  51123. */
  51124. customUtilityLayerScene?: Scene;
  51125. /**
  51126. * Values to configure the default target mesh
  51127. */
  51128. defaultTargetMeshOptions?: {
  51129. /**
  51130. * Fill color of the teleportation area
  51131. */
  51132. teleportationFillColor?: string;
  51133. /**
  51134. * Border color for the teleportation area
  51135. */
  51136. teleportationBorderColor?: string;
  51137. /**
  51138. * Disable the mesh's animation sequence
  51139. */
  51140. disableAnimation?: boolean;
  51141. /**
  51142. * Disable lighting on the material or the ring and arrow
  51143. */
  51144. disableLighting?: boolean;
  51145. /**
  51146. * Override the default material of the torus and arrow
  51147. */
  51148. torusArrowMaterial?: Material;
  51149. };
  51150. /**
  51151. * A list of meshes to use as floor meshes.
  51152. * Meshes can be added and removed after initializing the feature using the
  51153. * addFloorMesh and removeFloorMesh functions
  51154. * If empty, rotation will still work
  51155. */
  51156. floorMeshes?: AbstractMesh[];
  51157. /**
  51158. * use this rendering group id for the meshes (optional)
  51159. */
  51160. renderingGroupId?: number;
  51161. /**
  51162. * Should teleportation move only to snap points
  51163. */
  51164. snapPointsOnly?: boolean;
  51165. /**
  51166. * An array of points to which the teleportation will snap to.
  51167. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51168. */
  51169. snapPositions?: Vector3[];
  51170. /**
  51171. * How close should the teleportation ray be in order to snap to position.
  51172. * Default to 0.8 units (meters)
  51173. */
  51174. snapToPositionRadius?: number;
  51175. /**
  51176. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51177. * If you want to support rotation, make sure your mesh has a direction indicator.
  51178. *
  51179. * When left untouched, the default mesh will be initialized.
  51180. */
  51181. teleportationTargetMesh?: AbstractMesh;
  51182. /**
  51183. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51184. */
  51185. timeToTeleport?: number;
  51186. /**
  51187. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51188. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51189. */
  51190. useMainComponentOnly?: boolean;
  51191. /**
  51192. * Should meshes created here be added to a utility layer or the main scene
  51193. */
  51194. useUtilityLayer?: boolean;
  51195. /**
  51196. * Babylon XR Input class for controller
  51197. */
  51198. xrInput: WebXRInput;
  51199. }
  51200. /**
  51201. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51202. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51203. * the input of the attached controllers.
  51204. */
  51205. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51206. private _options;
  51207. private _controllers;
  51208. private _currentTeleportationControllerId;
  51209. private _floorMeshes;
  51210. private _quadraticBezierCurve;
  51211. private _selectionFeature;
  51212. private _snapToPositions;
  51213. private _snappedToPoint;
  51214. private _teleportationRingMaterial?;
  51215. private _tmpRay;
  51216. private _tmpVector;
  51217. /**
  51218. * The module's name
  51219. */
  51220. static readonly Name: string;
  51221. /**
  51222. * The (Babylon) version of this module.
  51223. * This is an integer representing the implementation version.
  51224. * This number does not correspond to the webxr specs version
  51225. */
  51226. static readonly Version: number;
  51227. /**
  51228. * Is movement backwards enabled
  51229. */
  51230. backwardsMovementEnabled: boolean;
  51231. /**
  51232. * Distance to travel when moving backwards
  51233. */
  51234. backwardsTeleportationDistance: number;
  51235. /**
  51236. * The distance from the user to the inspection point in the direction of the controller
  51237. * A higher number will allow the user to move further
  51238. * defaults to 5 (meters, in xr units)
  51239. */
  51240. parabolicCheckRadius: number;
  51241. /**
  51242. * Should the module support parabolic ray on top of direct ray
  51243. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51244. * Very helpful when moving between floors / different heights
  51245. */
  51246. parabolicRayEnabled: boolean;
  51247. /**
  51248. * How much rotation should be applied when rotating right and left
  51249. */
  51250. rotationAngle: number;
  51251. /**
  51252. * Is rotation enabled when moving forward?
  51253. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51254. */
  51255. rotationEnabled: boolean;
  51256. /**
  51257. * constructs a new anchor system
  51258. * @param _xrSessionManager an instance of WebXRSessionManager
  51259. * @param _options configuration object for this feature
  51260. */
  51261. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51262. /**
  51263. * Get the snapPointsOnly flag
  51264. */
  51265. get snapPointsOnly(): boolean;
  51266. /**
  51267. * Sets the snapPointsOnly flag
  51268. * @param snapToPoints should teleportation be exclusively to snap points
  51269. */
  51270. set snapPointsOnly(snapToPoints: boolean);
  51271. /**
  51272. * Add a new mesh to the floor meshes array
  51273. * @param mesh the mesh to use as floor mesh
  51274. */
  51275. addFloorMesh(mesh: AbstractMesh): void;
  51276. /**
  51277. * Add a new snap-to point to fix teleportation to this position
  51278. * @param newSnapPoint The new Snap-To point
  51279. */
  51280. addSnapPoint(newSnapPoint: Vector3): void;
  51281. attach(): boolean;
  51282. detach(): boolean;
  51283. dispose(): void;
  51284. /**
  51285. * Remove a mesh from the floor meshes array
  51286. * @param mesh the mesh to remove
  51287. */
  51288. removeFloorMesh(mesh: AbstractMesh): void;
  51289. /**
  51290. * Remove a mesh from the floor meshes array using its name
  51291. * @param name the mesh name to remove
  51292. */
  51293. removeFloorMeshByName(name: string): void;
  51294. /**
  51295. * 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
  51296. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51297. * @returns was the point found and removed or not
  51298. */
  51299. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51300. /**
  51301. * This function sets a selection feature that will be disabled when
  51302. * the forward ray is shown and will be reattached when hidden.
  51303. * This is used to remove the selection rays when moving.
  51304. * @param selectionFeature the feature to disable when forward movement is enabled
  51305. */
  51306. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51307. protected _onXRFrame(_xrFrame: XRFrame): void;
  51308. private _attachController;
  51309. private _createDefaultTargetMesh;
  51310. private _detachController;
  51311. private _findClosestSnapPointWithRadius;
  51312. private _setTargetMeshPosition;
  51313. private _setTargetMeshVisibility;
  51314. private _showParabolicPath;
  51315. private _teleportForward;
  51316. }
  51317. }
  51318. declare module "babylonjs/XR/webXRDefaultExperience" {
  51319. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51320. import { Scene } from "babylonjs/scene";
  51321. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51322. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51323. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51324. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51325. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51326. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51327. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51328. /**
  51329. * Options for the default xr helper
  51330. */
  51331. export class WebXRDefaultExperienceOptions {
  51332. /**
  51333. * Enable or disable default UI to enter XR
  51334. */
  51335. disableDefaultUI?: boolean;
  51336. /**
  51337. * Should teleportation not initialize. defaults to false.
  51338. */
  51339. disableTeleportation?: boolean;
  51340. /**
  51341. * Floor meshes that will be used for teleport
  51342. */
  51343. floorMeshes?: Array<AbstractMesh>;
  51344. /**
  51345. * If set to true, the first frame will not be used to reset position
  51346. * The first frame is mainly used when copying transformation from the old camera
  51347. * Mainly used in AR
  51348. */
  51349. ignoreNativeCameraTransformation?: boolean;
  51350. /**
  51351. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51352. */
  51353. inputOptions?: IWebXRInputOptions;
  51354. /**
  51355. * optional configuration for the output canvas
  51356. */
  51357. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51358. /**
  51359. * optional UI options. This can be used among other to change session mode and reference space type
  51360. */
  51361. uiOptions?: WebXREnterExitUIOptions;
  51362. /**
  51363. * When loading teleportation and pointer select, use stable versions instead of latest.
  51364. */
  51365. useStablePlugins?: boolean;
  51366. /**
  51367. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51368. */
  51369. renderingGroupId?: number;
  51370. /**
  51371. * A list of optional features to init the session with
  51372. * If set to true, all features we support will be added
  51373. */
  51374. optionalFeatures?: boolean | string[];
  51375. }
  51376. /**
  51377. * Default experience which provides a similar setup to the previous webVRExperience
  51378. */
  51379. export class WebXRDefaultExperience {
  51380. /**
  51381. * Base experience
  51382. */
  51383. baseExperience: WebXRExperienceHelper;
  51384. /**
  51385. * Enables ui for entering/exiting xr
  51386. */
  51387. enterExitUI: WebXREnterExitUI;
  51388. /**
  51389. * Input experience extension
  51390. */
  51391. input: WebXRInput;
  51392. /**
  51393. * Enables laser pointer and selection
  51394. */
  51395. pointerSelection: WebXRControllerPointerSelection;
  51396. /**
  51397. * Default target xr should render to
  51398. */
  51399. renderTarget: WebXRRenderTarget;
  51400. /**
  51401. * Enables teleportation
  51402. */
  51403. teleportation: WebXRMotionControllerTeleportation;
  51404. private constructor();
  51405. /**
  51406. * Creates the default xr experience
  51407. * @param scene scene
  51408. * @param options options for basic configuration
  51409. * @returns resulting WebXRDefaultExperience
  51410. */
  51411. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51412. /**
  51413. * DIsposes of the experience helper
  51414. */
  51415. dispose(): void;
  51416. }
  51417. }
  51418. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51419. import { Observable } from "babylonjs/Misc/observable";
  51420. import { Nullable } from "babylonjs/types";
  51421. import { Camera } from "babylonjs/Cameras/camera";
  51422. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51423. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51424. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51425. import { Scene } from "babylonjs/scene";
  51426. import { Vector3 } from "babylonjs/Maths/math.vector";
  51427. import { Color3 } from "babylonjs/Maths/math.color";
  51428. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51429. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51430. import { Mesh } from "babylonjs/Meshes/mesh";
  51431. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51432. import { EasingFunction } from "babylonjs/Animations/easing";
  51433. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51434. import "babylonjs/Meshes/Builders/groundBuilder";
  51435. import "babylonjs/Meshes/Builders/torusBuilder";
  51436. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51437. import "babylonjs/Gamepads/gamepadSceneComponent";
  51438. import "babylonjs/Animations/animatable";
  51439. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51440. /**
  51441. * Options to modify the vr teleportation behavior.
  51442. */
  51443. export interface VRTeleportationOptions {
  51444. /**
  51445. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51446. */
  51447. floorMeshName?: string;
  51448. /**
  51449. * A list of meshes to be used as the teleportation floor. (default: empty)
  51450. */
  51451. floorMeshes?: Mesh[];
  51452. /**
  51453. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51454. */
  51455. teleportationMode?: number;
  51456. /**
  51457. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51458. */
  51459. teleportationTime?: number;
  51460. /**
  51461. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51462. */
  51463. teleportationSpeed?: number;
  51464. /**
  51465. * The easing function used in the animation or null for Linear. (default CircleEase)
  51466. */
  51467. easingFunction?: EasingFunction;
  51468. }
  51469. /**
  51470. * Options to modify the vr experience helper's behavior.
  51471. */
  51472. export interface VRExperienceHelperOptions extends WebVROptions {
  51473. /**
  51474. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51475. */
  51476. createDeviceOrientationCamera?: boolean;
  51477. /**
  51478. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51479. */
  51480. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51481. /**
  51482. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51483. */
  51484. laserToggle?: boolean;
  51485. /**
  51486. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51487. */
  51488. floorMeshes?: Mesh[];
  51489. /**
  51490. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51491. */
  51492. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51493. /**
  51494. * Defines if WebXR should be used instead of WebVR (if available)
  51495. */
  51496. useXR?: boolean;
  51497. }
  51498. /**
  51499. * Event containing information after VR has been entered
  51500. */
  51501. export class OnAfterEnteringVRObservableEvent {
  51502. /**
  51503. * If entering vr was successful
  51504. */
  51505. success: boolean;
  51506. }
  51507. /**
  51508. * Helps to quickly add VR support to an existing scene.
  51509. * See https://doc.babylonjs.com/how_to/webvr_helper
  51510. */
  51511. export class VRExperienceHelper {
  51512. /** Options to modify the vr experience helper's behavior. */
  51513. webVROptions: VRExperienceHelperOptions;
  51514. private _scene;
  51515. private _position;
  51516. private _btnVR;
  51517. private _btnVRDisplayed;
  51518. private _webVRsupported;
  51519. private _webVRready;
  51520. private _webVRrequesting;
  51521. private _webVRpresenting;
  51522. private _hasEnteredVR;
  51523. private _fullscreenVRpresenting;
  51524. private _inputElement;
  51525. private _webVRCamera;
  51526. private _vrDeviceOrientationCamera;
  51527. private _deviceOrientationCamera;
  51528. private _existingCamera;
  51529. private _onKeyDown;
  51530. private _onVrDisplayPresentChange;
  51531. private _onVRDisplayChanged;
  51532. private _onVRRequestPresentStart;
  51533. private _onVRRequestPresentComplete;
  51534. /**
  51535. * 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)
  51536. */
  51537. enableGazeEvenWhenNoPointerLock: boolean;
  51538. /**
  51539. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51540. */
  51541. exitVROnDoubleTap: boolean;
  51542. /**
  51543. * Observable raised right before entering VR.
  51544. */
  51545. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51546. /**
  51547. * Observable raised when entering VR has completed.
  51548. */
  51549. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51550. /**
  51551. * Observable raised when exiting VR.
  51552. */
  51553. onExitingVRObservable: Observable<VRExperienceHelper>;
  51554. /**
  51555. * Observable raised when controller mesh is loaded.
  51556. */
  51557. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51558. /** Return this.onEnteringVRObservable
  51559. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51560. */
  51561. get onEnteringVR(): Observable<VRExperienceHelper>;
  51562. /** Return this.onExitingVRObservable
  51563. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51564. */
  51565. get onExitingVR(): Observable<VRExperienceHelper>;
  51566. /** Return this.onControllerMeshLoadedObservable
  51567. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51568. */
  51569. get onControllerMeshLoaded(): Observable<WebVRController>;
  51570. private _rayLength;
  51571. private _useCustomVRButton;
  51572. private _teleportationRequested;
  51573. private _teleportActive;
  51574. private _floorMeshName;
  51575. private _floorMeshesCollection;
  51576. private _teleportationMode;
  51577. private _teleportationTime;
  51578. private _teleportationSpeed;
  51579. private _teleportationEasing;
  51580. private _rotationAllowed;
  51581. private _teleportBackwardsVector;
  51582. private _teleportationTarget;
  51583. private _isDefaultTeleportationTarget;
  51584. private _postProcessMove;
  51585. private _teleportationFillColor;
  51586. private _teleportationBorderColor;
  51587. private _rotationAngle;
  51588. private _haloCenter;
  51589. private _cameraGazer;
  51590. private _padSensibilityUp;
  51591. private _padSensibilityDown;
  51592. private _leftController;
  51593. private _rightController;
  51594. private _gazeColor;
  51595. private _laserColor;
  51596. private _pickedLaserColor;
  51597. private _pickedGazeColor;
  51598. /**
  51599. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51600. */
  51601. onNewMeshSelected: Observable<AbstractMesh>;
  51602. /**
  51603. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51604. * This observable will provide the mesh and the controller used to select the mesh
  51605. */
  51606. onMeshSelectedWithController: Observable<{
  51607. mesh: AbstractMesh;
  51608. controller: WebVRController;
  51609. }>;
  51610. /**
  51611. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51612. */
  51613. onNewMeshPicked: Observable<PickingInfo>;
  51614. private _circleEase;
  51615. /**
  51616. * Observable raised before camera teleportation
  51617. */
  51618. onBeforeCameraTeleport: Observable<Vector3>;
  51619. /**
  51620. * Observable raised after camera teleportation
  51621. */
  51622. onAfterCameraTeleport: Observable<Vector3>;
  51623. /**
  51624. * Observable raised when current selected mesh gets unselected
  51625. */
  51626. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51627. private _raySelectionPredicate;
  51628. /**
  51629. * To be optionaly changed by user to define custom ray selection
  51630. */
  51631. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51632. /**
  51633. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51634. */
  51635. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51636. /**
  51637. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51638. */
  51639. teleportationEnabled: boolean;
  51640. private _defaultHeight;
  51641. private _teleportationInitialized;
  51642. private _interactionsEnabled;
  51643. private _interactionsRequested;
  51644. private _displayGaze;
  51645. private _displayLaserPointer;
  51646. /**
  51647. * The mesh used to display where the user is going to teleport.
  51648. */
  51649. get teleportationTarget(): Mesh;
  51650. /**
  51651. * Sets the mesh to be used to display where the user is going to teleport.
  51652. */
  51653. set teleportationTarget(value: Mesh);
  51654. /**
  51655. * 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
  51656. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51657. * See https://doc.babylonjs.com/resources/baking_transformations
  51658. */
  51659. get gazeTrackerMesh(): Mesh;
  51660. set gazeTrackerMesh(value: Mesh);
  51661. /**
  51662. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51663. */
  51664. updateGazeTrackerScale: boolean;
  51665. /**
  51666. * If the gaze trackers color should be updated when selecting meshes
  51667. */
  51668. updateGazeTrackerColor: boolean;
  51669. /**
  51670. * If the controller laser color should be updated when selecting meshes
  51671. */
  51672. updateControllerLaserColor: boolean;
  51673. /**
  51674. * The gaze tracking mesh corresponding to the left controller
  51675. */
  51676. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51677. /**
  51678. * The gaze tracking mesh corresponding to the right controller
  51679. */
  51680. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51681. /**
  51682. * If the ray of the gaze should be displayed.
  51683. */
  51684. get displayGaze(): boolean;
  51685. /**
  51686. * Sets if the ray of the gaze should be displayed.
  51687. */
  51688. set displayGaze(value: boolean);
  51689. /**
  51690. * If the ray of the LaserPointer should be displayed.
  51691. */
  51692. get displayLaserPointer(): boolean;
  51693. /**
  51694. * Sets if the ray of the LaserPointer should be displayed.
  51695. */
  51696. set displayLaserPointer(value: boolean);
  51697. /**
  51698. * The deviceOrientationCamera used as the camera when not in VR.
  51699. */
  51700. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51701. /**
  51702. * Based on the current WebVR support, returns the current VR camera used.
  51703. */
  51704. get currentVRCamera(): Nullable<Camera>;
  51705. /**
  51706. * The webVRCamera which is used when in VR.
  51707. */
  51708. get webVRCamera(): WebVRFreeCamera;
  51709. /**
  51710. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51711. */
  51712. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51713. /**
  51714. * The html button that is used to trigger entering into VR.
  51715. */
  51716. get vrButton(): Nullable<HTMLButtonElement>;
  51717. private get _teleportationRequestInitiated();
  51718. /**
  51719. * Defines whether or not Pointer lock should be requested when switching to
  51720. * full screen.
  51721. */
  51722. requestPointerLockOnFullScreen: boolean;
  51723. /**
  51724. * If asking to force XR, this will be populated with the default xr experience
  51725. */
  51726. xr: WebXRDefaultExperience;
  51727. /**
  51728. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51729. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51730. */
  51731. xrTestDone: boolean;
  51732. /**
  51733. * Instantiates a VRExperienceHelper.
  51734. * Helps to quickly add VR support to an existing scene.
  51735. * @param scene The scene the VRExperienceHelper belongs to.
  51736. * @param webVROptions Options to modify the vr experience helper's behavior.
  51737. */
  51738. constructor(scene: Scene,
  51739. /** Options to modify the vr experience helper's behavior. */
  51740. webVROptions?: VRExperienceHelperOptions);
  51741. private completeVRInit;
  51742. private _onDefaultMeshLoaded;
  51743. private _onResize;
  51744. private _onFullscreenChange;
  51745. /**
  51746. * Gets a value indicating if we are currently in VR mode.
  51747. */
  51748. get isInVRMode(): boolean;
  51749. private onVrDisplayPresentChange;
  51750. private onVRDisplayChanged;
  51751. private moveButtonToBottomRight;
  51752. private displayVRButton;
  51753. private updateButtonVisibility;
  51754. private _cachedAngularSensibility;
  51755. /**
  51756. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51757. * Otherwise, will use the fullscreen API.
  51758. */
  51759. enterVR(): void;
  51760. /**
  51761. * Attempt to exit VR, or fullscreen.
  51762. */
  51763. exitVR(): void;
  51764. /**
  51765. * The position of the vr experience helper.
  51766. */
  51767. get position(): Vector3;
  51768. /**
  51769. * Sets the position of the vr experience helper.
  51770. */
  51771. set position(value: Vector3);
  51772. /**
  51773. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51774. */
  51775. enableInteractions(): void;
  51776. private get _noControllerIsActive();
  51777. private beforeRender;
  51778. private _isTeleportationFloor;
  51779. /**
  51780. * Adds a floor mesh to be used for teleportation.
  51781. * @param floorMesh the mesh to be used for teleportation.
  51782. */
  51783. addFloorMesh(floorMesh: Mesh): void;
  51784. /**
  51785. * Removes a floor mesh from being used for teleportation.
  51786. * @param floorMesh the mesh to be removed.
  51787. */
  51788. removeFloorMesh(floorMesh: Mesh): void;
  51789. /**
  51790. * Enables interactions and teleportation using the VR controllers and gaze.
  51791. * @param vrTeleportationOptions options to modify teleportation behavior.
  51792. */
  51793. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51794. private _onNewGamepadConnected;
  51795. private _tryEnableInteractionOnController;
  51796. private _onNewGamepadDisconnected;
  51797. private _enableInteractionOnController;
  51798. private _checkTeleportWithRay;
  51799. private _checkRotate;
  51800. private _checkTeleportBackwards;
  51801. private _enableTeleportationOnController;
  51802. private _createTeleportationCircles;
  51803. private _displayTeleportationTarget;
  51804. private _hideTeleportationTarget;
  51805. private _rotateCamera;
  51806. private _moveTeleportationSelectorTo;
  51807. private _workingVector;
  51808. private _workingQuaternion;
  51809. private _workingMatrix;
  51810. /**
  51811. * Time Constant Teleportation Mode
  51812. */
  51813. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51814. /**
  51815. * Speed Constant Teleportation Mode
  51816. */
  51817. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51818. /**
  51819. * Teleports the users feet to the desired location
  51820. * @param location The location where the user's feet should be placed
  51821. */
  51822. teleportCamera(location: Vector3): void;
  51823. private _convertNormalToDirectionOfRay;
  51824. private _castRayAndSelectObject;
  51825. private _notifySelectedMeshUnselected;
  51826. /**
  51827. * Permanently set new colors for the laser pointer
  51828. * @param color the new laser color
  51829. * @param pickedColor the new laser color when picked mesh detected
  51830. */
  51831. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51832. /**
  51833. * Set lighting enabled / disabled on the laser pointer of both controllers
  51834. * @param enabled should the lighting be enabled on the laser pointer
  51835. */
  51836. setLaserLightingState(enabled?: boolean): void;
  51837. /**
  51838. * Permanently set new colors for the gaze pointer
  51839. * @param color the new gaze color
  51840. * @param pickedColor the new gaze color when picked mesh detected
  51841. */
  51842. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51843. /**
  51844. * Sets the color of the laser ray from the vr controllers.
  51845. * @param color new color for the ray.
  51846. */
  51847. changeLaserColor(color: Color3): void;
  51848. /**
  51849. * Sets the color of the ray from the vr headsets gaze.
  51850. * @param color new color for the ray.
  51851. */
  51852. changeGazeColor(color: Color3): void;
  51853. /**
  51854. * Exits VR and disposes of the vr experience helper
  51855. */
  51856. dispose(): void;
  51857. /**
  51858. * Gets the name of the VRExperienceHelper class
  51859. * @returns "VRExperienceHelper"
  51860. */
  51861. getClassName(): string;
  51862. }
  51863. }
  51864. declare module "babylonjs/Cameras/VR/index" {
  51865. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51866. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51867. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51868. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51869. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51870. export * from "babylonjs/Cameras/VR/webVRCamera";
  51871. }
  51872. declare module "babylonjs/Cameras/RigModes/index" {
  51873. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51874. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51875. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51876. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51877. }
  51878. declare module "babylonjs/Cameras/index" {
  51879. export * from "babylonjs/Cameras/Inputs/index";
  51880. export * from "babylonjs/Cameras/cameraInputsManager";
  51881. export * from "babylonjs/Cameras/camera";
  51882. export * from "babylonjs/Cameras/targetCamera";
  51883. export * from "babylonjs/Cameras/freeCamera";
  51884. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51885. export * from "babylonjs/Cameras/touchCamera";
  51886. export * from "babylonjs/Cameras/arcRotateCamera";
  51887. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51888. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51889. export * from "babylonjs/Cameras/flyCamera";
  51890. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51891. export * from "babylonjs/Cameras/followCamera";
  51892. export * from "babylonjs/Cameras/followCameraInputsManager";
  51893. export * from "babylonjs/Cameras/gamepadCamera";
  51894. export * from "babylonjs/Cameras/Stereoscopic/index";
  51895. export * from "babylonjs/Cameras/universalCamera";
  51896. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51897. export * from "babylonjs/Cameras/VR/index";
  51898. export * from "babylonjs/Cameras/RigModes/index";
  51899. }
  51900. declare module "babylonjs/Collisions/index" {
  51901. export * from "babylonjs/Collisions/collider";
  51902. export * from "babylonjs/Collisions/collisionCoordinator";
  51903. export * from "babylonjs/Collisions/pickingInfo";
  51904. export * from "babylonjs/Collisions/intersectionInfo";
  51905. export * from "babylonjs/Collisions/meshCollisionData";
  51906. }
  51907. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51908. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51909. import { Vector3 } from "babylonjs/Maths/math.vector";
  51910. import { Ray } from "babylonjs/Culling/ray";
  51911. import { Plane } from "babylonjs/Maths/math.plane";
  51912. /**
  51913. * Contains an array of blocks representing the octree
  51914. */
  51915. export interface IOctreeContainer<T> {
  51916. /**
  51917. * Blocks within the octree
  51918. */
  51919. blocks: Array<OctreeBlock<T>>;
  51920. }
  51921. /**
  51922. * Class used to store a cell in an octree
  51923. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51924. */
  51925. export class OctreeBlock<T> {
  51926. /**
  51927. * Gets the content of the current block
  51928. */
  51929. entries: T[];
  51930. /**
  51931. * Gets the list of block children
  51932. */
  51933. blocks: Array<OctreeBlock<T>>;
  51934. private _depth;
  51935. private _maxDepth;
  51936. private _capacity;
  51937. private _minPoint;
  51938. private _maxPoint;
  51939. private _boundingVectors;
  51940. private _creationFunc;
  51941. /**
  51942. * Creates a new block
  51943. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51944. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51945. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51946. * @param depth defines the current depth of this block in the octree
  51947. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51948. * @param creationFunc defines a callback to call when an element is added to the block
  51949. */
  51950. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  51951. /**
  51952. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51953. */
  51954. get capacity(): number;
  51955. /**
  51956. * Gets the minimum vector (in world space) of the block's bounding box
  51957. */
  51958. get minPoint(): Vector3;
  51959. /**
  51960. * Gets the maximum vector (in world space) of the block's bounding box
  51961. */
  51962. get maxPoint(): Vector3;
  51963. /**
  51964. * Add a new element to this block
  51965. * @param entry defines the element to add
  51966. */
  51967. addEntry(entry: T): void;
  51968. /**
  51969. * Remove an element from this block
  51970. * @param entry defines the element to remove
  51971. */
  51972. removeEntry(entry: T): void;
  51973. /**
  51974. * Add an array of elements to this block
  51975. * @param entries defines the array of elements to add
  51976. */
  51977. addEntries(entries: T[]): void;
  51978. /**
  51979. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  51980. * @param frustumPlanes defines the frustum planes to test
  51981. * @param selection defines the array to store current content if selection is positive
  51982. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51983. */
  51984. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51985. /**
  51986. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  51987. * @param sphereCenter defines the bounding sphere center
  51988. * @param sphereRadius defines the bounding sphere radius
  51989. * @param selection defines the array to store current content if selection is positive
  51990. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51991. */
  51992. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51993. /**
  51994. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  51995. * @param ray defines the ray to test with
  51996. * @param selection defines the array to store current content if selection is positive
  51997. */
  51998. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  51999. /**
  52000. * Subdivide the content into child blocks (this block will then be empty)
  52001. */
  52002. createInnerBlocks(): void;
  52003. /**
  52004. * @hidden
  52005. */
  52006. 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;
  52007. }
  52008. }
  52009. declare module "babylonjs/Culling/Octrees/octree" {
  52010. import { SmartArray } from "babylonjs/Misc/smartArray";
  52011. import { Vector3 } from "babylonjs/Maths/math.vector";
  52012. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52013. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52014. import { Ray } from "babylonjs/Culling/ray";
  52015. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52016. import { Plane } from "babylonjs/Maths/math.plane";
  52017. /**
  52018. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52019. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52020. */
  52021. export class Octree<T> {
  52022. /** 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.) */
  52023. maxDepth: number;
  52024. /**
  52025. * Blocks within the octree containing objects
  52026. */
  52027. blocks: Array<OctreeBlock<T>>;
  52028. /**
  52029. * Content stored in the octree
  52030. */
  52031. dynamicContent: T[];
  52032. private _maxBlockCapacity;
  52033. private _selectionContent;
  52034. private _creationFunc;
  52035. /**
  52036. * Creates a octree
  52037. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52038. * @param creationFunc function to be used to instatiate the octree
  52039. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52040. * @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.)
  52041. */
  52042. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52043. /** 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.) */
  52044. maxDepth?: number);
  52045. /**
  52046. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52047. * @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);
  52048. * @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);
  52049. * @param entries meshes to be added to the octree blocks
  52050. */
  52051. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52052. /**
  52053. * Adds a mesh to the octree
  52054. * @param entry Mesh to add to the octree
  52055. */
  52056. addMesh(entry: T): void;
  52057. /**
  52058. * Remove an element from the octree
  52059. * @param entry defines the element to remove
  52060. */
  52061. removeMesh(entry: T): void;
  52062. /**
  52063. * Selects an array of meshes within the frustum
  52064. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52065. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52066. * @returns array of meshes within the frustum
  52067. */
  52068. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52069. /**
  52070. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52071. * @param sphereCenter defines the bounding sphere center
  52072. * @param sphereRadius defines the bounding sphere radius
  52073. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52074. * @returns an array of objects that intersect the sphere
  52075. */
  52076. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52077. /**
  52078. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52079. * @param ray defines the ray to test with
  52080. * @returns array of intersected objects
  52081. */
  52082. intersectsRay(ray: Ray): SmartArray<T>;
  52083. /**
  52084. * Adds a mesh into the octree block if it intersects the block
  52085. */
  52086. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52087. /**
  52088. * Adds a submesh into the octree block if it intersects the block
  52089. */
  52090. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52091. }
  52092. }
  52093. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52094. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52095. import { Scene } from "babylonjs/scene";
  52096. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52097. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52098. import { Ray } from "babylonjs/Culling/ray";
  52099. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52100. import { Collider } from "babylonjs/Collisions/collider";
  52101. module "babylonjs/scene" {
  52102. interface Scene {
  52103. /**
  52104. * @hidden
  52105. * Backing Filed
  52106. */
  52107. _selectionOctree: Octree<AbstractMesh>;
  52108. /**
  52109. * Gets the octree used to boost mesh selection (picking)
  52110. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52111. */
  52112. selectionOctree: Octree<AbstractMesh>;
  52113. /**
  52114. * Creates or updates the octree used to boost selection (picking)
  52115. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52116. * @param maxCapacity defines the maximum capacity per leaf
  52117. * @param maxDepth defines the maximum depth of the octree
  52118. * @returns an octree of AbstractMesh
  52119. */
  52120. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52121. }
  52122. }
  52123. module "babylonjs/Meshes/abstractMesh" {
  52124. interface AbstractMesh {
  52125. /**
  52126. * @hidden
  52127. * Backing Field
  52128. */
  52129. _submeshesOctree: Octree<SubMesh>;
  52130. /**
  52131. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52132. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52133. * @param maxCapacity defines the maximum size of each block (64 by default)
  52134. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52135. * @returns the new octree
  52136. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52137. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52138. */
  52139. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52140. }
  52141. }
  52142. /**
  52143. * Defines the octree scene component responsible to manage any octrees
  52144. * in a given scene.
  52145. */
  52146. export class OctreeSceneComponent {
  52147. /**
  52148. * The component name help to identify the component in the list of scene components.
  52149. */
  52150. readonly name: string;
  52151. /**
  52152. * The scene the component belongs to.
  52153. */
  52154. scene: Scene;
  52155. /**
  52156. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52157. */
  52158. readonly checksIsEnabled: boolean;
  52159. /**
  52160. * Creates a new instance of the component for the given scene
  52161. * @param scene Defines the scene to register the component in
  52162. */
  52163. constructor(scene: Scene);
  52164. /**
  52165. * Registers the component in a given scene
  52166. */
  52167. register(): void;
  52168. /**
  52169. * Return the list of active meshes
  52170. * @returns the list of active meshes
  52171. */
  52172. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52173. /**
  52174. * Return the list of active sub meshes
  52175. * @param mesh The mesh to get the candidates sub meshes from
  52176. * @returns the list of active sub meshes
  52177. */
  52178. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52179. private _tempRay;
  52180. /**
  52181. * Return the list of sub meshes intersecting with a given local ray
  52182. * @param mesh defines the mesh to find the submesh for
  52183. * @param localRay defines the ray in local space
  52184. * @returns the list of intersecting sub meshes
  52185. */
  52186. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52187. /**
  52188. * Return the list of sub meshes colliding with a collider
  52189. * @param mesh defines the mesh to find the submesh for
  52190. * @param collider defines the collider to evaluate the collision against
  52191. * @returns the list of colliding sub meshes
  52192. */
  52193. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52194. /**
  52195. * Rebuilds the elements related to this component in case of
  52196. * context lost for instance.
  52197. */
  52198. rebuild(): void;
  52199. /**
  52200. * Disposes the component and the associated ressources.
  52201. */
  52202. dispose(): void;
  52203. }
  52204. }
  52205. declare module "babylonjs/Culling/Octrees/index" {
  52206. export * from "babylonjs/Culling/Octrees/octree";
  52207. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52208. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52209. }
  52210. declare module "babylonjs/Culling/index" {
  52211. export * from "babylonjs/Culling/boundingBox";
  52212. export * from "babylonjs/Culling/boundingInfo";
  52213. export * from "babylonjs/Culling/boundingSphere";
  52214. export * from "babylonjs/Culling/Octrees/index";
  52215. export * from "babylonjs/Culling/ray";
  52216. }
  52217. declare module "babylonjs/Gizmos/gizmo" {
  52218. import { Nullable } from "babylonjs/types";
  52219. import { IDisposable } from "babylonjs/scene";
  52220. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52221. import { Mesh } from "babylonjs/Meshes/mesh";
  52222. import { Node } from "babylonjs/node";
  52223. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52224. /**
  52225. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52226. */
  52227. export class Gizmo implements IDisposable {
  52228. /** The utility layer the gizmo will be added to */
  52229. gizmoLayer: UtilityLayerRenderer;
  52230. /**
  52231. * The root mesh of the gizmo
  52232. */
  52233. _rootMesh: Mesh;
  52234. private _attachedMesh;
  52235. private _attachedNode;
  52236. /**
  52237. * Ratio for the scale of the gizmo (Default: 1)
  52238. */
  52239. scaleRatio: number;
  52240. /**
  52241. * If a custom mesh has been set (Default: false)
  52242. */
  52243. protected _customMeshSet: boolean;
  52244. /**
  52245. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52246. * * When set, interactions will be enabled
  52247. */
  52248. get attachedMesh(): Nullable<AbstractMesh>;
  52249. set attachedMesh(value: Nullable<AbstractMesh>);
  52250. /**
  52251. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52252. * * When set, interactions will be enabled
  52253. */
  52254. get attachedNode(): Nullable<Node>;
  52255. set attachedNode(value: Nullable<Node>);
  52256. /**
  52257. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52258. * @param mesh The mesh to replace the default mesh of the gizmo
  52259. */
  52260. setCustomMesh(mesh: Mesh): void;
  52261. /**
  52262. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52263. */
  52264. updateGizmoRotationToMatchAttachedMesh: boolean;
  52265. /**
  52266. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52267. */
  52268. updateGizmoPositionToMatchAttachedMesh: boolean;
  52269. /**
  52270. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52271. */
  52272. updateScale: boolean;
  52273. protected _interactionsEnabled: boolean;
  52274. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52275. private _beforeRenderObserver;
  52276. private _tempQuaternion;
  52277. private _tempVector;
  52278. private _tempVector2;
  52279. /**
  52280. * Creates a gizmo
  52281. * @param gizmoLayer The utility layer the gizmo will be added to
  52282. */
  52283. constructor(
  52284. /** The utility layer the gizmo will be added to */
  52285. gizmoLayer?: UtilityLayerRenderer);
  52286. /**
  52287. * Updates the gizmo to match the attached mesh's position/rotation
  52288. */
  52289. protected _update(): void;
  52290. /**
  52291. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52292. * @param value Node, TransformNode or mesh
  52293. */
  52294. protected _matrixChanged(): void;
  52295. /**
  52296. * Disposes of the gizmo
  52297. */
  52298. dispose(): void;
  52299. }
  52300. }
  52301. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52302. import { Observable } from "babylonjs/Misc/observable";
  52303. import { Nullable } from "babylonjs/types";
  52304. import { Vector3 } from "babylonjs/Maths/math.vector";
  52305. import { Color3 } from "babylonjs/Maths/math.color";
  52306. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52307. import { Node } from "babylonjs/node";
  52308. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52309. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52310. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52311. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52312. import { Scene } from "babylonjs/scene";
  52313. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52314. /**
  52315. * Single plane drag gizmo
  52316. */
  52317. export class PlaneDragGizmo extends Gizmo {
  52318. /**
  52319. * Drag behavior responsible for the gizmos dragging interactions
  52320. */
  52321. dragBehavior: PointerDragBehavior;
  52322. private _pointerObserver;
  52323. /**
  52324. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52325. */
  52326. snapDistance: number;
  52327. /**
  52328. * Event that fires each time the gizmo snaps to a new location.
  52329. * * snapDistance is the the change in distance
  52330. */
  52331. onSnapObservable: Observable<{
  52332. snapDistance: number;
  52333. }>;
  52334. private _plane;
  52335. private _coloredMaterial;
  52336. private _hoverMaterial;
  52337. private _isEnabled;
  52338. private _parent;
  52339. /** @hidden */
  52340. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52341. /** @hidden */
  52342. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52343. /**
  52344. * Creates a PlaneDragGizmo
  52345. * @param gizmoLayer The utility layer the gizmo will be added to
  52346. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52347. * @param color The color of the gizmo
  52348. */
  52349. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52350. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52351. /**
  52352. * If the gizmo is enabled
  52353. */
  52354. set isEnabled(value: boolean);
  52355. get isEnabled(): boolean;
  52356. /**
  52357. * Disposes of the gizmo
  52358. */
  52359. dispose(): void;
  52360. }
  52361. }
  52362. declare module "babylonjs/Gizmos/positionGizmo" {
  52363. import { Observable } from "babylonjs/Misc/observable";
  52364. import { Nullable } from "babylonjs/types";
  52365. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52366. import { Node } from "babylonjs/node";
  52367. import { Mesh } from "babylonjs/Meshes/mesh";
  52368. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52369. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52370. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52371. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52372. /**
  52373. * Gizmo that enables dragging a mesh along 3 axis
  52374. */
  52375. export class PositionGizmo extends Gizmo {
  52376. /**
  52377. * Internal gizmo used for interactions on the x axis
  52378. */
  52379. xGizmo: AxisDragGizmo;
  52380. /**
  52381. * Internal gizmo used for interactions on the y axis
  52382. */
  52383. yGizmo: AxisDragGizmo;
  52384. /**
  52385. * Internal gizmo used for interactions on the z axis
  52386. */
  52387. zGizmo: AxisDragGizmo;
  52388. /**
  52389. * Internal gizmo used for interactions on the yz plane
  52390. */
  52391. xPlaneGizmo: PlaneDragGizmo;
  52392. /**
  52393. * Internal gizmo used for interactions on the xz plane
  52394. */
  52395. yPlaneGizmo: PlaneDragGizmo;
  52396. /**
  52397. * Internal gizmo used for interactions on the xy plane
  52398. */
  52399. zPlaneGizmo: PlaneDragGizmo;
  52400. /**
  52401. * private variables
  52402. */
  52403. private _meshAttached;
  52404. private _nodeAttached;
  52405. private _updateGizmoRotationToMatchAttachedMesh;
  52406. private _snapDistance;
  52407. private _scaleRatio;
  52408. /** Fires an event when any of it's sub gizmos are dragged */
  52409. onDragStartObservable: Observable<unknown>;
  52410. /** Fires an event when any of it's sub gizmos are released from dragging */
  52411. onDragEndObservable: Observable<unknown>;
  52412. /**
  52413. * If set to true, planar drag is enabled
  52414. */
  52415. private _planarGizmoEnabled;
  52416. get attachedMesh(): Nullable<AbstractMesh>;
  52417. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52418. get attachedNode(): Nullable<Node>;
  52419. set attachedNode(node: Nullable<Node>);
  52420. /**
  52421. * Creates a PositionGizmo
  52422. * @param gizmoLayer The utility layer the gizmo will be added to
  52423. @param thickness display gizmo axis thickness
  52424. */
  52425. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52426. /**
  52427. * If the planar drag gizmo is enabled
  52428. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52429. */
  52430. set planarGizmoEnabled(value: boolean);
  52431. get planarGizmoEnabled(): boolean;
  52432. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52433. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52434. /**
  52435. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52436. */
  52437. set snapDistance(value: number);
  52438. get snapDistance(): number;
  52439. /**
  52440. * Ratio for the scale of the gizmo (Default: 1)
  52441. */
  52442. set scaleRatio(value: number);
  52443. get scaleRatio(): number;
  52444. /**
  52445. * Disposes of the gizmo
  52446. */
  52447. dispose(): void;
  52448. /**
  52449. * CustomMeshes are not supported by this gizmo
  52450. * @param mesh The mesh to replace the default mesh of the gizmo
  52451. */
  52452. setCustomMesh(mesh: Mesh): void;
  52453. }
  52454. }
  52455. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52456. import { Observable } from "babylonjs/Misc/observable";
  52457. import { Nullable } from "babylonjs/types";
  52458. import { Vector3 } from "babylonjs/Maths/math.vector";
  52459. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52460. import { Node } from "babylonjs/node";
  52461. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52462. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52463. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52464. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52465. import { Scene } from "babylonjs/scene";
  52466. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52467. import { Color3 } from "babylonjs/Maths/math.color";
  52468. /**
  52469. * Single axis drag gizmo
  52470. */
  52471. export class AxisDragGizmo extends Gizmo {
  52472. /**
  52473. * Drag behavior responsible for the gizmos dragging interactions
  52474. */
  52475. dragBehavior: PointerDragBehavior;
  52476. private _pointerObserver;
  52477. /**
  52478. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52479. */
  52480. snapDistance: number;
  52481. /**
  52482. * Event that fires each time the gizmo snaps to a new location.
  52483. * * snapDistance is the the change in distance
  52484. */
  52485. onSnapObservable: Observable<{
  52486. snapDistance: number;
  52487. }>;
  52488. private _isEnabled;
  52489. private _parent;
  52490. private _arrow;
  52491. private _coloredMaterial;
  52492. private _hoverMaterial;
  52493. /** @hidden */
  52494. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52495. /** @hidden */
  52496. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52497. /**
  52498. * Creates an AxisDragGizmo
  52499. * @param gizmoLayer The utility layer the gizmo will be added to
  52500. * @param dragAxis The axis which the gizmo will be able to drag on
  52501. * @param color The color of the gizmo
  52502. * @param thickness display gizmo axis thickness
  52503. */
  52504. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52505. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52506. /**
  52507. * If the gizmo is enabled
  52508. */
  52509. set isEnabled(value: boolean);
  52510. get isEnabled(): boolean;
  52511. /**
  52512. * Disposes of the gizmo
  52513. */
  52514. dispose(): void;
  52515. }
  52516. }
  52517. declare module "babylonjs/Debug/axesViewer" {
  52518. import { Vector3 } from "babylonjs/Maths/math.vector";
  52519. import { Nullable } from "babylonjs/types";
  52520. import { Scene } from "babylonjs/scene";
  52521. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52522. /**
  52523. * The Axes viewer will show 3 axes in a specific point in space
  52524. */
  52525. export class AxesViewer {
  52526. private _xAxis;
  52527. private _yAxis;
  52528. private _zAxis;
  52529. private _scaleLinesFactor;
  52530. private _instanced;
  52531. /**
  52532. * Gets the hosting scene
  52533. */
  52534. scene: Scene;
  52535. /**
  52536. * Gets or sets a number used to scale line length
  52537. */
  52538. scaleLines: number;
  52539. /** Gets the node hierarchy used to render x-axis */
  52540. get xAxis(): TransformNode;
  52541. /** Gets the node hierarchy used to render y-axis */
  52542. get yAxis(): TransformNode;
  52543. /** Gets the node hierarchy used to render z-axis */
  52544. get zAxis(): TransformNode;
  52545. /**
  52546. * Creates a new AxesViewer
  52547. * @param scene defines the hosting scene
  52548. * @param scaleLines defines a number used to scale line length (1 by default)
  52549. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52550. * @param xAxis defines the node hierarchy used to render the x-axis
  52551. * @param yAxis defines the node hierarchy used to render the y-axis
  52552. * @param zAxis defines the node hierarchy used to render the z-axis
  52553. */
  52554. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52555. /**
  52556. * Force the viewer to update
  52557. * @param position defines the position of the viewer
  52558. * @param xaxis defines the x axis of the viewer
  52559. * @param yaxis defines the y axis of the viewer
  52560. * @param zaxis defines the z axis of the viewer
  52561. */
  52562. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52563. /**
  52564. * Creates an instance of this axes viewer.
  52565. * @returns a new axes viewer with instanced meshes
  52566. */
  52567. createInstance(): AxesViewer;
  52568. /** Releases resources */
  52569. dispose(): void;
  52570. private static _SetRenderingGroupId;
  52571. }
  52572. }
  52573. declare module "babylonjs/Debug/boneAxesViewer" {
  52574. import { Nullable } from "babylonjs/types";
  52575. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52576. import { Vector3 } from "babylonjs/Maths/math.vector";
  52577. import { Mesh } from "babylonjs/Meshes/mesh";
  52578. import { Bone } from "babylonjs/Bones/bone";
  52579. import { Scene } from "babylonjs/scene";
  52580. /**
  52581. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52582. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52583. */
  52584. export class BoneAxesViewer extends AxesViewer {
  52585. /**
  52586. * Gets or sets the target mesh where to display the axes viewer
  52587. */
  52588. mesh: Nullable<Mesh>;
  52589. /**
  52590. * Gets or sets the target bone where to display the axes viewer
  52591. */
  52592. bone: Nullable<Bone>;
  52593. /** Gets current position */
  52594. pos: Vector3;
  52595. /** Gets direction of X axis */
  52596. xaxis: Vector3;
  52597. /** Gets direction of Y axis */
  52598. yaxis: Vector3;
  52599. /** Gets direction of Z axis */
  52600. zaxis: Vector3;
  52601. /**
  52602. * Creates a new BoneAxesViewer
  52603. * @param scene defines the hosting scene
  52604. * @param bone defines the target bone
  52605. * @param mesh defines the target mesh
  52606. * @param scaleLines defines a scaling factor for line length (1 by default)
  52607. */
  52608. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52609. /**
  52610. * Force the viewer to update
  52611. */
  52612. update(): void;
  52613. /** Releases resources */
  52614. dispose(): void;
  52615. }
  52616. }
  52617. declare module "babylonjs/Debug/debugLayer" {
  52618. import { Scene } from "babylonjs/scene";
  52619. /**
  52620. * Interface used to define scene explorer extensibility option
  52621. */
  52622. export interface IExplorerExtensibilityOption {
  52623. /**
  52624. * Define the option label
  52625. */
  52626. label: string;
  52627. /**
  52628. * Defines the action to execute on click
  52629. */
  52630. action: (entity: any) => void;
  52631. }
  52632. /**
  52633. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52634. */
  52635. export interface IExplorerExtensibilityGroup {
  52636. /**
  52637. * Defines a predicate to test if a given type mut be extended
  52638. */
  52639. predicate: (entity: any) => boolean;
  52640. /**
  52641. * Gets the list of options added to a type
  52642. */
  52643. entries: IExplorerExtensibilityOption[];
  52644. }
  52645. /**
  52646. * Interface used to define the options to use to create the Inspector
  52647. */
  52648. export interface IInspectorOptions {
  52649. /**
  52650. * Display in overlay mode (default: false)
  52651. */
  52652. overlay?: boolean;
  52653. /**
  52654. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52655. */
  52656. globalRoot?: HTMLElement;
  52657. /**
  52658. * Display the Scene explorer
  52659. */
  52660. showExplorer?: boolean;
  52661. /**
  52662. * Display the property inspector
  52663. */
  52664. showInspector?: boolean;
  52665. /**
  52666. * Display in embed mode (both panes on the right)
  52667. */
  52668. embedMode?: boolean;
  52669. /**
  52670. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52671. */
  52672. handleResize?: boolean;
  52673. /**
  52674. * Allow the panes to popup (default: true)
  52675. */
  52676. enablePopup?: boolean;
  52677. /**
  52678. * Allow the panes to be closed by users (default: true)
  52679. */
  52680. enableClose?: boolean;
  52681. /**
  52682. * Optional list of extensibility entries
  52683. */
  52684. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52685. /**
  52686. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52687. */
  52688. inspectorURL?: string;
  52689. /**
  52690. * Optional initial tab (default to DebugLayerTab.Properties)
  52691. */
  52692. initialTab?: DebugLayerTab;
  52693. }
  52694. module "babylonjs/scene" {
  52695. interface Scene {
  52696. /**
  52697. * @hidden
  52698. * Backing field
  52699. */
  52700. _debugLayer: DebugLayer;
  52701. /**
  52702. * Gets the debug layer (aka Inspector) associated with the scene
  52703. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52704. */
  52705. debugLayer: DebugLayer;
  52706. }
  52707. }
  52708. /**
  52709. * Enum of inspector action tab
  52710. */
  52711. export enum DebugLayerTab {
  52712. /**
  52713. * Properties tag (default)
  52714. */
  52715. Properties = 0,
  52716. /**
  52717. * Debug tab
  52718. */
  52719. Debug = 1,
  52720. /**
  52721. * Statistics tab
  52722. */
  52723. Statistics = 2,
  52724. /**
  52725. * Tools tab
  52726. */
  52727. Tools = 3,
  52728. /**
  52729. * Settings tab
  52730. */
  52731. Settings = 4
  52732. }
  52733. /**
  52734. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52735. * what is happening in your scene
  52736. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52737. */
  52738. export class DebugLayer {
  52739. /**
  52740. * Define the url to get the inspector script from.
  52741. * By default it uses the babylonjs CDN.
  52742. * @ignoreNaming
  52743. */
  52744. static InspectorURL: string;
  52745. private _scene;
  52746. private BJSINSPECTOR;
  52747. private _onPropertyChangedObservable?;
  52748. /**
  52749. * Observable triggered when a property is changed through the inspector.
  52750. */
  52751. get onPropertyChangedObservable(): any;
  52752. /**
  52753. * Instantiates a new debug layer.
  52754. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52755. * what is happening in your scene
  52756. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52757. * @param scene Defines the scene to inspect
  52758. */
  52759. constructor(scene: Scene);
  52760. /** Creates the inspector window. */
  52761. private _createInspector;
  52762. /**
  52763. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52764. * @param entity defines the entity to select
  52765. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52766. */
  52767. select(entity: any, lineContainerTitles?: string | string[]): void;
  52768. /** Get the inspector from bundle or global */
  52769. private _getGlobalInspector;
  52770. /**
  52771. * Get if the inspector is visible or not.
  52772. * @returns true if visible otherwise, false
  52773. */
  52774. isVisible(): boolean;
  52775. /**
  52776. * Hide the inspector and close its window.
  52777. */
  52778. hide(): void;
  52779. /**
  52780. * Update the scene in the inspector
  52781. */
  52782. setAsActiveScene(): void;
  52783. /**
  52784. * Launch the debugLayer.
  52785. * @param config Define the configuration of the inspector
  52786. * @return a promise fulfilled when the debug layer is visible
  52787. */
  52788. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52789. }
  52790. }
  52791. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52792. import { Nullable } from "babylonjs/types";
  52793. import { Scene } from "babylonjs/scene";
  52794. import { Vector4 } from "babylonjs/Maths/math.vector";
  52795. import { Color4 } from "babylonjs/Maths/math.color";
  52796. import { Mesh } from "babylonjs/Meshes/mesh";
  52797. /**
  52798. * Class containing static functions to help procedurally build meshes
  52799. */
  52800. export class BoxBuilder {
  52801. /**
  52802. * Creates a box mesh
  52803. * * The parameter `size` sets the size (float) of each box side (default 1)
  52804. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52805. * * 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)
  52806. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52807. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52808. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52809. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52810. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52811. * @param name defines the name of the mesh
  52812. * @param options defines the options used to create the mesh
  52813. * @param scene defines the hosting scene
  52814. * @returns the box mesh
  52815. */
  52816. static CreateBox(name: string, options: {
  52817. size?: number;
  52818. width?: number;
  52819. height?: number;
  52820. depth?: number;
  52821. faceUV?: Vector4[];
  52822. faceColors?: Color4[];
  52823. sideOrientation?: number;
  52824. frontUVs?: Vector4;
  52825. backUVs?: Vector4;
  52826. wrap?: boolean;
  52827. topBaseAt?: number;
  52828. bottomBaseAt?: number;
  52829. updatable?: boolean;
  52830. }, scene?: Nullable<Scene>): Mesh;
  52831. }
  52832. }
  52833. declare module "babylonjs/Debug/physicsViewer" {
  52834. import { Nullable } from "babylonjs/types";
  52835. import { Scene } from "babylonjs/scene";
  52836. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52837. import { Mesh } from "babylonjs/Meshes/mesh";
  52838. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52839. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52840. /**
  52841. * Used to show the physics impostor around the specific mesh
  52842. */
  52843. export class PhysicsViewer {
  52844. /** @hidden */
  52845. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52846. /** @hidden */
  52847. protected _meshes: Array<Nullable<AbstractMesh>>;
  52848. /** @hidden */
  52849. protected _scene: Nullable<Scene>;
  52850. /** @hidden */
  52851. protected _numMeshes: number;
  52852. /** @hidden */
  52853. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52854. private _renderFunction;
  52855. private _utilityLayer;
  52856. private _debugBoxMesh;
  52857. private _debugSphereMesh;
  52858. private _debugCylinderMesh;
  52859. private _debugMaterial;
  52860. private _debugMeshMeshes;
  52861. /**
  52862. * Creates a new PhysicsViewer
  52863. * @param scene defines the hosting scene
  52864. */
  52865. constructor(scene: Scene);
  52866. /** @hidden */
  52867. protected _updateDebugMeshes(): void;
  52868. /**
  52869. * Renders a specified physic impostor
  52870. * @param impostor defines the impostor to render
  52871. * @param targetMesh defines the mesh represented by the impostor
  52872. * @returns the new debug mesh used to render the impostor
  52873. */
  52874. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52875. /**
  52876. * Hides a specified physic impostor
  52877. * @param impostor defines the impostor to hide
  52878. */
  52879. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52880. private _getDebugMaterial;
  52881. private _getDebugBoxMesh;
  52882. private _getDebugSphereMesh;
  52883. private _getDebugCylinderMesh;
  52884. private _getDebugMeshMesh;
  52885. private _getDebugMesh;
  52886. /** Releases all resources */
  52887. dispose(): void;
  52888. }
  52889. }
  52890. declare module "babylonjs/Debug/rayHelper" {
  52891. import { Nullable } from "babylonjs/types";
  52892. import { Ray } from "babylonjs/Culling/ray";
  52893. import { Vector3 } from "babylonjs/Maths/math.vector";
  52894. import { Color3 } from "babylonjs/Maths/math.color";
  52895. import { Scene } from "babylonjs/scene";
  52896. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52897. import "babylonjs/Meshes/Builders/linesBuilder";
  52898. /**
  52899. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52900. * in order to better appreciate the issue one might have.
  52901. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52902. */
  52903. export class RayHelper {
  52904. /**
  52905. * Defines the ray we are currently tryin to visualize.
  52906. */
  52907. ray: Nullable<Ray>;
  52908. private _renderPoints;
  52909. private _renderLine;
  52910. private _renderFunction;
  52911. private _scene;
  52912. private _onAfterRenderObserver;
  52913. private _onAfterStepObserver;
  52914. private _attachedToMesh;
  52915. private _meshSpaceDirection;
  52916. private _meshSpaceOrigin;
  52917. /**
  52918. * Helper function to create a colored helper in a scene in one line.
  52919. * @param ray Defines the ray we are currently tryin to visualize
  52920. * @param scene Defines the scene the ray is used in
  52921. * @param color Defines the color we want to see the ray in
  52922. * @returns The newly created ray helper.
  52923. */
  52924. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52925. /**
  52926. * Instantiate a new ray helper.
  52927. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52928. * in order to better appreciate the issue one might have.
  52929. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52930. * @param ray Defines the ray we are currently tryin to visualize
  52931. */
  52932. constructor(ray: Ray);
  52933. /**
  52934. * Shows the ray we are willing to debug.
  52935. * @param scene Defines the scene the ray needs to be rendered in
  52936. * @param color Defines the color the ray needs to be rendered in
  52937. */
  52938. show(scene: Scene, color?: Color3): void;
  52939. /**
  52940. * Hides the ray we are debugging.
  52941. */
  52942. hide(): void;
  52943. private _render;
  52944. /**
  52945. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  52946. * @param mesh Defines the mesh we want the helper attached to
  52947. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  52948. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  52949. * @param length Defines the length of the ray
  52950. */
  52951. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  52952. /**
  52953. * Detach the ray helper from the mesh it has previously been attached to.
  52954. */
  52955. detachFromMesh(): void;
  52956. private _updateToMesh;
  52957. /**
  52958. * Dispose the helper and release its associated resources.
  52959. */
  52960. dispose(): void;
  52961. }
  52962. }
  52963. declare module "babylonjs/Debug/ISkeletonViewer" {
  52964. /**
  52965. * Defines the options associated with the creation of a SkeletonViewer.
  52966. */
  52967. export interface ISkeletonViewerOptions {
  52968. /** Should the system pause animations before building the Viewer? */
  52969. pauseAnimations: boolean;
  52970. /** Should the system return the skeleton to rest before building? */
  52971. returnToRest: boolean;
  52972. /** public Display Mode of the Viewer */
  52973. displayMode: number;
  52974. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  52975. displayOptions: ISkeletonViewerDisplayOptions;
  52976. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  52977. computeBonesUsingShaders: boolean;
  52978. }
  52979. /**
  52980. * Defines how to display the various bone meshes for the viewer.
  52981. */
  52982. export interface ISkeletonViewerDisplayOptions {
  52983. /** How far down to start tapering the bone spurs */
  52984. midStep?: number;
  52985. /** How big is the midStep? */
  52986. midStepFactor?: number;
  52987. /** Base for the Sphere Size */
  52988. sphereBaseSize?: number;
  52989. /** The ratio of the sphere to the longest bone in units */
  52990. sphereScaleUnit?: number;
  52991. /** Ratio for the Sphere Size */
  52992. sphereFactor?: number;
  52993. }
  52994. }
  52995. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  52996. import { Nullable } from "babylonjs/types";
  52997. import { Scene } from "babylonjs/scene";
  52998. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  52999. import { Color4 } from "babylonjs/Maths/math.color";
  53000. import { Mesh } from "babylonjs/Meshes/mesh";
  53001. /**
  53002. * Class containing static functions to help procedurally build meshes
  53003. */
  53004. export class RibbonBuilder {
  53005. /**
  53006. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53007. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53008. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53009. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53010. * * 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
  53011. * * 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
  53012. * * 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
  53013. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53014. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53015. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53016. * * 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
  53017. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53018. * * 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
  53019. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53020. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53021. * @param name defines the name of the mesh
  53022. * @param options defines the options used to create the mesh
  53023. * @param scene defines the hosting scene
  53024. * @returns the ribbon mesh
  53025. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53026. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53027. */
  53028. static CreateRibbon(name: string, options: {
  53029. pathArray: Vector3[][];
  53030. closeArray?: boolean;
  53031. closePath?: boolean;
  53032. offset?: number;
  53033. updatable?: boolean;
  53034. sideOrientation?: number;
  53035. frontUVs?: Vector4;
  53036. backUVs?: Vector4;
  53037. instance?: Mesh;
  53038. invertUV?: boolean;
  53039. uvs?: Vector2[];
  53040. colors?: Color4[];
  53041. }, scene?: Nullable<Scene>): Mesh;
  53042. }
  53043. }
  53044. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53045. import { Nullable } from "babylonjs/types";
  53046. import { Scene } from "babylonjs/scene";
  53047. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53048. import { Mesh } from "babylonjs/Meshes/mesh";
  53049. /**
  53050. * Class containing static functions to help procedurally build meshes
  53051. */
  53052. export class ShapeBuilder {
  53053. /**
  53054. * 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.
  53055. * * 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.
  53056. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53057. * * 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.
  53058. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53059. * * 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
  53060. * * 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
  53061. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53062. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53063. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53064. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53065. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53066. * @param name defines the name of the mesh
  53067. * @param options defines the options used to create the mesh
  53068. * @param scene defines the hosting scene
  53069. * @returns the extruded shape mesh
  53070. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53071. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53072. */
  53073. static ExtrudeShape(name: string, options: {
  53074. shape: Vector3[];
  53075. path: Vector3[];
  53076. scale?: number;
  53077. rotation?: number;
  53078. cap?: number;
  53079. updatable?: boolean;
  53080. sideOrientation?: number;
  53081. frontUVs?: Vector4;
  53082. backUVs?: Vector4;
  53083. instance?: Mesh;
  53084. invertUV?: boolean;
  53085. }, scene?: Nullable<Scene>): Mesh;
  53086. /**
  53087. * Creates an custom extruded shape mesh.
  53088. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53089. * * 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.
  53090. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53091. * * 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
  53092. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53093. * * 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
  53094. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53095. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53096. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53097. * * 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
  53098. * * 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
  53099. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53100. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53101. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53102. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53103. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53104. * @param name defines the name of the mesh
  53105. * @param options defines the options used to create the mesh
  53106. * @param scene defines the hosting scene
  53107. * @returns the custom extruded shape mesh
  53108. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53109. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53110. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53111. */
  53112. static ExtrudeShapeCustom(name: string, options: {
  53113. shape: Vector3[];
  53114. path: Vector3[];
  53115. scaleFunction?: any;
  53116. rotationFunction?: any;
  53117. ribbonCloseArray?: boolean;
  53118. ribbonClosePath?: boolean;
  53119. cap?: number;
  53120. updatable?: boolean;
  53121. sideOrientation?: number;
  53122. frontUVs?: Vector4;
  53123. backUVs?: Vector4;
  53124. instance?: Mesh;
  53125. invertUV?: boolean;
  53126. }, scene?: Nullable<Scene>): Mesh;
  53127. private static _ExtrudeShapeGeneric;
  53128. }
  53129. }
  53130. declare module "babylonjs/Debug/skeletonViewer" {
  53131. import { Color3 } from "babylonjs/Maths/math.color";
  53132. import { Scene } from "babylonjs/scene";
  53133. import { Nullable } from "babylonjs/types";
  53134. import { Skeleton } from "babylonjs/Bones/skeleton";
  53135. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53136. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53137. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53138. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53139. import { ISkeletonViewerOptions } from "babylonjs/Debug/ISkeletonViewer";
  53140. /**
  53141. * Class used to render a debug view of a given skeleton
  53142. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53143. */
  53144. export class SkeletonViewer {
  53145. /** defines the skeleton to render */
  53146. skeleton: Skeleton;
  53147. /** defines the mesh attached to the skeleton */
  53148. mesh: AbstractMesh;
  53149. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53150. autoUpdateBonesMatrices: boolean;
  53151. /** defines the rendering group id to use with the viewer */
  53152. renderingGroupId: number;
  53153. /** is the options for the viewer */
  53154. options: Partial<ISkeletonViewerOptions>;
  53155. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53156. static readonly DISPLAY_LINES: number;
  53157. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53158. static readonly DISPLAY_SPHERES: number;
  53159. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53160. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53161. /** If SkeletonViewer scene scope. */
  53162. private _scene;
  53163. /** Gets or sets the color used to render the skeleton */
  53164. color: Color3;
  53165. /** Array of the points of the skeleton fo the line view. */
  53166. private _debugLines;
  53167. /** The SkeletonViewers Mesh. */
  53168. private _debugMesh;
  53169. /** If SkeletonViewer is enabled. */
  53170. private _isEnabled;
  53171. /** If SkeletonViewer is ready. */
  53172. private _ready;
  53173. /** SkeletonViewer render observable. */
  53174. private _obs;
  53175. /** The Utility Layer to render the gizmos in. */
  53176. private _utilityLayer;
  53177. private _boneIndices;
  53178. /** Gets the Scene. */
  53179. get scene(): Scene;
  53180. /** Gets the utilityLayer. */
  53181. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53182. /** Checks Ready Status. */
  53183. get isReady(): Boolean;
  53184. /** Sets Ready Status. */
  53185. set ready(value: boolean);
  53186. /** Gets the debugMesh */
  53187. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53188. /** Sets the debugMesh */
  53189. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53190. /** Gets the material */
  53191. get material(): StandardMaterial;
  53192. /** Sets the material */
  53193. set material(value: StandardMaterial);
  53194. /** Gets the material */
  53195. get displayMode(): number;
  53196. /** Sets the material */
  53197. set displayMode(value: number);
  53198. /**
  53199. * Creates a new SkeletonViewer
  53200. * @param skeleton defines the skeleton to render
  53201. * @param mesh defines the mesh attached to the skeleton
  53202. * @param scene defines the hosting scene
  53203. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53204. * @param renderingGroupId defines the rendering group id to use with the viewer
  53205. * @param options All of the extra constructor options for the SkeletonViewer
  53206. */
  53207. constructor(
  53208. /** defines the skeleton to render */
  53209. skeleton: Skeleton,
  53210. /** defines the mesh attached to the skeleton */
  53211. mesh: AbstractMesh,
  53212. /** The Scene scope*/
  53213. scene: Scene,
  53214. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53215. autoUpdateBonesMatrices?: boolean,
  53216. /** defines the rendering group id to use with the viewer */
  53217. renderingGroupId?: number,
  53218. /** is the options for the viewer */
  53219. options?: Partial<ISkeletonViewerOptions>);
  53220. /** The Dynamic bindings for the update functions */
  53221. private _bindObs;
  53222. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53223. update(): void;
  53224. /** Gets or sets a boolean indicating if the viewer is enabled */
  53225. set isEnabled(value: boolean);
  53226. get isEnabled(): boolean;
  53227. private _getBonePosition;
  53228. private _getLinesForBonesWithLength;
  53229. private _getLinesForBonesNoLength;
  53230. /** function to revert the mesh and scene back to the initial state. */
  53231. private _revert;
  53232. /** function to build and bind sphere joint points and spur bone representations. */
  53233. private _buildSpheresAndSpurs;
  53234. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53235. private _displayLinesUpdate;
  53236. /** Changes the displayMode of the skeleton viewer
  53237. * @param mode The displayMode numerical value
  53238. */
  53239. changeDisplayMode(mode: number): void;
  53240. /** Changes the displayMode of the skeleton viewer
  53241. * @param option String of the option name
  53242. * @param value The numerical option value
  53243. */
  53244. changeDisplayOptions(option: string, value: number): void;
  53245. /** Release associated resources */
  53246. dispose(): void;
  53247. }
  53248. }
  53249. declare module "babylonjs/Debug/index" {
  53250. export * from "babylonjs/Debug/axesViewer";
  53251. export * from "babylonjs/Debug/boneAxesViewer";
  53252. export * from "babylonjs/Debug/debugLayer";
  53253. export * from "babylonjs/Debug/physicsViewer";
  53254. export * from "babylonjs/Debug/rayHelper";
  53255. export * from "babylonjs/Debug/skeletonViewer";
  53256. export * from "babylonjs/Debug/ISkeletonViewer";
  53257. }
  53258. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53259. /**
  53260. * Enum for Device Types
  53261. */
  53262. export enum DeviceType {
  53263. /** Generic */
  53264. Generic = 0,
  53265. /** Keyboard */
  53266. Keyboard = 1,
  53267. /** Mouse */
  53268. Mouse = 2,
  53269. /** Touch Pointers */
  53270. Touch = 3,
  53271. /** PS4 Dual Shock */
  53272. DualShock = 4,
  53273. /** Xbox */
  53274. Xbox = 5,
  53275. /** Switch Controller */
  53276. Switch = 6
  53277. }
  53278. /**
  53279. * Enum for All Pointers (Touch/Mouse)
  53280. */
  53281. export enum PointerInput {
  53282. /** Horizontal Axis */
  53283. Horizontal = 0,
  53284. /** Vertical Axis */
  53285. Vertical = 1,
  53286. /** Left Click or Touch */
  53287. LeftClick = 2,
  53288. /** Middle Click */
  53289. MiddleClick = 3,
  53290. /** Right Click */
  53291. RightClick = 4,
  53292. /** Browser Back */
  53293. BrowserBack = 5,
  53294. /** Browser Forward */
  53295. BrowserForward = 6
  53296. }
  53297. /**
  53298. * Enum for Dual Shock Gamepad
  53299. */
  53300. export enum DualShockInput {
  53301. /** Cross */
  53302. Cross = 0,
  53303. /** Circle */
  53304. Circle = 1,
  53305. /** Square */
  53306. Square = 2,
  53307. /** Triangle */
  53308. Triangle = 3,
  53309. /** L1 */
  53310. L1 = 4,
  53311. /** R1 */
  53312. R1 = 5,
  53313. /** L2 */
  53314. L2 = 6,
  53315. /** R2 */
  53316. R2 = 7,
  53317. /** Share */
  53318. Share = 8,
  53319. /** Options */
  53320. Options = 9,
  53321. /** L3 */
  53322. L3 = 10,
  53323. /** R3 */
  53324. R3 = 11,
  53325. /** DPadUp */
  53326. DPadUp = 12,
  53327. /** DPadDown */
  53328. DPadDown = 13,
  53329. /** DPadLeft */
  53330. DPadLeft = 14,
  53331. /** DRight */
  53332. DPadRight = 15,
  53333. /** Home */
  53334. Home = 16,
  53335. /** TouchPad */
  53336. TouchPad = 17,
  53337. /** LStickXAxis */
  53338. LStickXAxis = 18,
  53339. /** LStickYAxis */
  53340. LStickYAxis = 19,
  53341. /** RStickXAxis */
  53342. RStickXAxis = 20,
  53343. /** RStickYAxis */
  53344. RStickYAxis = 21
  53345. }
  53346. /**
  53347. * Enum for Xbox Gamepad
  53348. */
  53349. export enum XboxInput {
  53350. /** A */
  53351. A = 0,
  53352. /** B */
  53353. B = 1,
  53354. /** X */
  53355. X = 2,
  53356. /** Y */
  53357. Y = 3,
  53358. /** LB */
  53359. LB = 4,
  53360. /** RB */
  53361. RB = 5,
  53362. /** LT */
  53363. LT = 6,
  53364. /** RT */
  53365. RT = 7,
  53366. /** Back */
  53367. Back = 8,
  53368. /** Start */
  53369. Start = 9,
  53370. /** LS */
  53371. LS = 10,
  53372. /** RS */
  53373. RS = 11,
  53374. /** DPadUp */
  53375. DPadUp = 12,
  53376. /** DPadDown */
  53377. DPadDown = 13,
  53378. /** DPadLeft */
  53379. DPadLeft = 14,
  53380. /** DRight */
  53381. DPadRight = 15,
  53382. /** Home */
  53383. Home = 16,
  53384. /** LStickXAxis */
  53385. LStickXAxis = 17,
  53386. /** LStickYAxis */
  53387. LStickYAxis = 18,
  53388. /** RStickXAxis */
  53389. RStickXAxis = 19,
  53390. /** RStickYAxis */
  53391. RStickYAxis = 20
  53392. }
  53393. /**
  53394. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53395. */
  53396. export enum SwitchInput {
  53397. /** B */
  53398. B = 0,
  53399. /** A */
  53400. A = 1,
  53401. /** Y */
  53402. Y = 2,
  53403. /** X */
  53404. X = 3,
  53405. /** L */
  53406. L = 4,
  53407. /** R */
  53408. R = 5,
  53409. /** ZL */
  53410. ZL = 6,
  53411. /** ZR */
  53412. ZR = 7,
  53413. /** Minus */
  53414. Minus = 8,
  53415. /** Plus */
  53416. Plus = 9,
  53417. /** LS */
  53418. LS = 10,
  53419. /** RS */
  53420. RS = 11,
  53421. /** DPadUp */
  53422. DPadUp = 12,
  53423. /** DPadDown */
  53424. DPadDown = 13,
  53425. /** DPadLeft */
  53426. DPadLeft = 14,
  53427. /** DRight */
  53428. DPadRight = 15,
  53429. /** Home */
  53430. Home = 16,
  53431. /** Capture */
  53432. Capture = 17,
  53433. /** LStickXAxis */
  53434. LStickXAxis = 18,
  53435. /** LStickYAxis */
  53436. LStickYAxis = 19,
  53437. /** RStickXAxis */
  53438. RStickXAxis = 20,
  53439. /** RStickYAxis */
  53440. RStickYAxis = 21
  53441. }
  53442. }
  53443. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53444. import { Engine } from "babylonjs/Engines/engine";
  53445. import { IDisposable } from "babylonjs/scene";
  53446. import { Nullable } from "babylonjs/types";
  53447. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53448. /**
  53449. * This class will take all inputs from Keyboard, Pointer, and
  53450. * any Gamepads and provide a polling system that all devices
  53451. * will use. This class assumes that there will only be one
  53452. * pointer device and one keyboard.
  53453. */
  53454. export class DeviceInputSystem implements IDisposable {
  53455. /**
  53456. * Callback to be triggered when a device is connected
  53457. */
  53458. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53459. /**
  53460. * Callback to be triggered when a device is disconnected
  53461. */
  53462. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53463. /**
  53464. * Callback to be triggered when event driven input is updated
  53465. */
  53466. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53467. private _inputs;
  53468. private _gamepads;
  53469. private _keyboardActive;
  53470. private _pointerActive;
  53471. private _elementToAttachTo;
  53472. private _keyboardDownEvent;
  53473. private _keyboardUpEvent;
  53474. private _pointerMoveEvent;
  53475. private _pointerDownEvent;
  53476. private _pointerUpEvent;
  53477. private _gamepadConnectedEvent;
  53478. private _gamepadDisconnectedEvent;
  53479. private static _MAX_KEYCODES;
  53480. private static _MAX_POINTER_INPUTS;
  53481. private constructor();
  53482. /**
  53483. * Creates a new DeviceInputSystem instance
  53484. * @param engine Engine to pull input element from
  53485. * @returns The new instance
  53486. */
  53487. static Create(engine: Engine): DeviceInputSystem;
  53488. /**
  53489. * Checks for current device input value, given an id and input index
  53490. * @param deviceName Id of connected device
  53491. * @param inputIndex Index of device input
  53492. * @returns Current value of input
  53493. */
  53494. /**
  53495. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53496. * @param deviceType Enum specifiying device type
  53497. * @param deviceSlot "Slot" or index that device is referenced in
  53498. * @param inputIndex Id of input to be checked
  53499. * @returns Current value of input
  53500. */
  53501. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53502. /**
  53503. * Dispose of all the eventlisteners
  53504. */
  53505. dispose(): void;
  53506. /**
  53507. * Add device and inputs to device array
  53508. * @param deviceType Enum specifiying device type
  53509. * @param deviceSlot "Slot" or index that device is referenced in
  53510. * @param numberOfInputs Number of input entries to create for given device
  53511. */
  53512. private _registerDevice;
  53513. /**
  53514. * Given a specific device name, remove that device from the device map
  53515. * @param deviceType Enum specifiying device type
  53516. * @param deviceSlot "Slot" or index that device is referenced in
  53517. */
  53518. private _unregisterDevice;
  53519. /**
  53520. * Handle all actions that come from keyboard interaction
  53521. */
  53522. private _handleKeyActions;
  53523. /**
  53524. * Handle all actions that come from pointer interaction
  53525. */
  53526. private _handlePointerActions;
  53527. /**
  53528. * Handle all actions that come from gamepad interaction
  53529. */
  53530. private _handleGamepadActions;
  53531. /**
  53532. * Update all non-event based devices with each frame
  53533. * @param deviceType Enum specifiying device type
  53534. * @param deviceSlot "Slot" or index that device is referenced in
  53535. * @param inputIndex Id of input to be checked
  53536. */
  53537. private _updateDevice;
  53538. /**
  53539. * Gets DeviceType from the device name
  53540. * @param deviceName Name of Device from DeviceInputSystem
  53541. * @returns DeviceType enum value
  53542. */
  53543. private _getGamepadDeviceType;
  53544. }
  53545. }
  53546. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53547. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53548. /**
  53549. * Type to handle enforcement of inputs
  53550. */
  53551. 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;
  53552. }
  53553. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53554. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53555. import { Engine } from "babylonjs/Engines/engine";
  53556. import { IDisposable } from "babylonjs/scene";
  53557. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53558. import { Nullable } from "babylonjs/types";
  53559. import { Observable } from "babylonjs/Misc/observable";
  53560. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53561. /**
  53562. * Class that handles all input for a specific device
  53563. */
  53564. export class DeviceSource<T extends DeviceType> {
  53565. /** Type of device */
  53566. readonly deviceType: DeviceType;
  53567. /** "Slot" or index that device is referenced in */
  53568. readonly deviceSlot: number;
  53569. /**
  53570. * Observable to handle device input changes per device
  53571. */
  53572. readonly onInputChangedObservable: Observable<{
  53573. inputIndex: DeviceInput<T>;
  53574. previousState: Nullable<number>;
  53575. currentState: Nullable<number>;
  53576. }>;
  53577. private readonly _deviceInputSystem;
  53578. /**
  53579. * Default Constructor
  53580. * @param deviceInputSystem Reference to DeviceInputSystem
  53581. * @param deviceType Type of device
  53582. * @param deviceSlot "Slot" or index that device is referenced in
  53583. */
  53584. constructor(deviceInputSystem: DeviceInputSystem,
  53585. /** Type of device */
  53586. deviceType: DeviceType,
  53587. /** "Slot" or index that device is referenced in */
  53588. deviceSlot?: number);
  53589. /**
  53590. * Get input for specific input
  53591. * @param inputIndex index of specific input on device
  53592. * @returns Input value from DeviceInputSystem
  53593. */
  53594. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  53595. }
  53596. /**
  53597. * Class to keep track of devices
  53598. */
  53599. export class DeviceSourceManager implements IDisposable {
  53600. /**
  53601. * Observable to be triggered when before a device is connected
  53602. */
  53603. readonly onBeforeDeviceConnectedObservable: Observable<{
  53604. deviceType: DeviceType;
  53605. deviceSlot: number;
  53606. }>;
  53607. /**
  53608. * Observable to be triggered when before a device is disconnected
  53609. */
  53610. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53611. deviceType: DeviceType;
  53612. deviceSlot: number;
  53613. }>;
  53614. /**
  53615. * Observable to be triggered when after a device is connected
  53616. */
  53617. readonly onAfterDeviceConnectedObservable: Observable<{
  53618. deviceType: DeviceType;
  53619. deviceSlot: number;
  53620. }>;
  53621. /**
  53622. * Observable to be triggered when after a device is disconnected
  53623. */
  53624. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53625. deviceType: DeviceType;
  53626. deviceSlot: number;
  53627. }>;
  53628. private readonly _devices;
  53629. private readonly _firstDevice;
  53630. private readonly _deviceInputSystem;
  53631. /**
  53632. * Default Constructor
  53633. * @param engine engine to pull input element from
  53634. */
  53635. constructor(engine: Engine);
  53636. /**
  53637. * Gets a DeviceSource, given a type and slot
  53638. * @param deviceType Enum specifying device type
  53639. * @param deviceSlot "Slot" or index that device is referenced in
  53640. * @returns DeviceSource object
  53641. */
  53642. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53643. /**
  53644. * Gets an array of DeviceSource objects for a given device type
  53645. * @param deviceType Enum specifying device type
  53646. * @returns Array of DeviceSource objects
  53647. */
  53648. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53649. /**
  53650. * Dispose of DeviceInputSystem and other parts
  53651. */
  53652. dispose(): void;
  53653. /**
  53654. * Function to add device name to device list
  53655. * @param deviceType Enum specifying device type
  53656. * @param deviceSlot "Slot" or index that device is referenced in
  53657. */
  53658. private _addDevice;
  53659. /**
  53660. * Function to remove device name to device list
  53661. * @param deviceType Enum specifying device type
  53662. * @param deviceSlot "Slot" or index that device is referenced in
  53663. */
  53664. private _removeDevice;
  53665. /**
  53666. * Updates array storing first connected device of each type
  53667. * @param type Type of Device
  53668. */
  53669. private _updateFirstDevices;
  53670. }
  53671. }
  53672. declare module "babylonjs/DeviceInput/index" {
  53673. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53674. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53675. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53676. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53677. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53678. }
  53679. declare module "babylonjs/Engines/nullEngine" {
  53680. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53681. import { Engine } from "babylonjs/Engines/engine";
  53682. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53683. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53684. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53685. import { Effect } from "babylonjs/Materials/effect";
  53686. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53687. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53688. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53689. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53690. /**
  53691. * Options to create the null engine
  53692. */
  53693. export class NullEngineOptions {
  53694. /**
  53695. * Render width (Default: 512)
  53696. */
  53697. renderWidth: number;
  53698. /**
  53699. * Render height (Default: 256)
  53700. */
  53701. renderHeight: number;
  53702. /**
  53703. * Texture size (Default: 512)
  53704. */
  53705. textureSize: number;
  53706. /**
  53707. * If delta time between frames should be constant
  53708. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53709. */
  53710. deterministicLockstep: boolean;
  53711. /**
  53712. * Maximum about of steps between frames (Default: 4)
  53713. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53714. */
  53715. lockstepMaxSteps: number;
  53716. /**
  53717. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53718. */
  53719. useHighPrecisionMatrix?: boolean;
  53720. }
  53721. /**
  53722. * The null engine class provides support for headless version of babylon.js.
  53723. * This can be used in server side scenario or for testing purposes
  53724. */
  53725. export class NullEngine extends Engine {
  53726. private _options;
  53727. /**
  53728. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53729. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53730. * @returns true if engine is in deterministic lock step mode
  53731. */
  53732. isDeterministicLockStep(): boolean;
  53733. /**
  53734. * Gets the max steps when engine is running in deterministic lock step
  53735. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53736. * @returns the max steps
  53737. */
  53738. getLockstepMaxSteps(): number;
  53739. /**
  53740. * Gets the current hardware scaling level.
  53741. * By default the hardware scaling level is computed from the window device ratio.
  53742. * 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.
  53743. * @returns a number indicating the current hardware scaling level
  53744. */
  53745. getHardwareScalingLevel(): number;
  53746. constructor(options?: NullEngineOptions);
  53747. /**
  53748. * Creates a vertex buffer
  53749. * @param vertices the data for the vertex buffer
  53750. * @returns the new WebGL static buffer
  53751. */
  53752. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53753. /**
  53754. * Creates a new index buffer
  53755. * @param indices defines the content of the index buffer
  53756. * @param updatable defines if the index buffer must be updatable
  53757. * @returns a new webGL buffer
  53758. */
  53759. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53760. /**
  53761. * Clear the current render buffer or the current render target (if any is set up)
  53762. * @param color defines the color to use
  53763. * @param backBuffer defines if the back buffer must be cleared
  53764. * @param depth defines if the depth buffer must be cleared
  53765. * @param stencil defines if the stencil buffer must be cleared
  53766. */
  53767. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53768. /**
  53769. * Gets the current render width
  53770. * @param useScreen defines if screen size must be used (or the current render target if any)
  53771. * @returns a number defining the current render width
  53772. */
  53773. getRenderWidth(useScreen?: boolean): number;
  53774. /**
  53775. * Gets the current render height
  53776. * @param useScreen defines if screen size must be used (or the current render target if any)
  53777. * @returns a number defining the current render height
  53778. */
  53779. getRenderHeight(useScreen?: boolean): number;
  53780. /**
  53781. * Set the WebGL's viewport
  53782. * @param viewport defines the viewport element to be used
  53783. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53784. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53785. */
  53786. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53787. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53788. /**
  53789. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53790. * @param pipelineContext defines the pipeline context to use
  53791. * @param uniformsNames defines the list of uniform names
  53792. * @returns an array of webGL uniform locations
  53793. */
  53794. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53795. /**
  53796. * Gets the lsit of active attributes for a given webGL program
  53797. * @param pipelineContext defines the pipeline context to use
  53798. * @param attributesNames defines the list of attribute names to get
  53799. * @returns an array of indices indicating the offset of each attribute
  53800. */
  53801. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53802. /**
  53803. * Binds an effect to the webGL context
  53804. * @param effect defines the effect to bind
  53805. */
  53806. bindSamplers(effect: Effect): void;
  53807. /**
  53808. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53809. * @param effect defines the effect to activate
  53810. */
  53811. enableEffect(effect: Effect): void;
  53812. /**
  53813. * Set various states to the webGL context
  53814. * @param culling defines backface culling state
  53815. * @param zOffset defines the value to apply to zOffset (0 by default)
  53816. * @param force defines if states must be applied even if cache is up to date
  53817. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53818. */
  53819. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53820. /**
  53821. * Set the value of an uniform to an array of int32
  53822. * @param uniform defines the webGL uniform location where to store the value
  53823. * @param array defines the array of int32 to store
  53824. */
  53825. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53826. /**
  53827. * Set the value of an uniform to an array of int32 (stored as vec2)
  53828. * @param uniform defines the webGL uniform location where to store the value
  53829. * @param array defines the array of int32 to store
  53830. */
  53831. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53832. /**
  53833. * Set the value of an uniform to an array of int32 (stored as vec3)
  53834. * @param uniform defines the webGL uniform location where to store the value
  53835. * @param array defines the array of int32 to store
  53836. */
  53837. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53838. /**
  53839. * Set the value of an uniform to an array of int32 (stored as vec4)
  53840. * @param uniform defines the webGL uniform location where to store the value
  53841. * @param array defines the array of int32 to store
  53842. */
  53843. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53844. /**
  53845. * Set the value of an uniform to an array of float32
  53846. * @param uniform defines the webGL uniform location where to store the value
  53847. * @param array defines the array of float32 to store
  53848. */
  53849. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53850. /**
  53851. * Set the value of an uniform to an array of float32 (stored as vec2)
  53852. * @param uniform defines the webGL uniform location where to store the value
  53853. * @param array defines the array of float32 to store
  53854. */
  53855. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53856. /**
  53857. * Set the value of an uniform to an array of float32 (stored as vec3)
  53858. * @param uniform defines the webGL uniform location where to store the value
  53859. * @param array defines the array of float32 to store
  53860. */
  53861. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53862. /**
  53863. * Set the value of an uniform to an array of float32 (stored as vec4)
  53864. * @param uniform defines the webGL uniform location where to store the value
  53865. * @param array defines the array of float32 to store
  53866. */
  53867. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53868. /**
  53869. * Set the value of an uniform to an array of number
  53870. * @param uniform defines the webGL uniform location where to store the value
  53871. * @param array defines the array of number to store
  53872. */
  53873. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53874. /**
  53875. * Set the value of an uniform to an array of number (stored as vec2)
  53876. * @param uniform defines the webGL uniform location where to store the value
  53877. * @param array defines the array of number to store
  53878. */
  53879. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53880. /**
  53881. * Set the value of an uniform to an array of number (stored as vec3)
  53882. * @param uniform defines the webGL uniform location where to store the value
  53883. * @param array defines the array of number to store
  53884. */
  53885. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53886. /**
  53887. * Set the value of an uniform to an array of number (stored as vec4)
  53888. * @param uniform defines the webGL uniform location where to store the value
  53889. * @param array defines the array of number to store
  53890. */
  53891. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53892. /**
  53893. * Set the value of an uniform to an array of float32 (stored as matrices)
  53894. * @param uniform defines the webGL uniform location where to store the value
  53895. * @param matrices defines the array of float32 to store
  53896. */
  53897. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53898. /**
  53899. * Set the value of an uniform to a matrix (3x3)
  53900. * @param uniform defines the webGL uniform location where to store the value
  53901. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53902. */
  53903. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53904. /**
  53905. * Set the value of an uniform to a matrix (2x2)
  53906. * @param uniform defines the webGL uniform location where to store the value
  53907. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53908. */
  53909. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53910. /**
  53911. * Set the value of an uniform to a number (float)
  53912. * @param uniform defines the webGL uniform location where to store the value
  53913. * @param value defines the float number to store
  53914. */
  53915. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53916. /**
  53917. * Set the value of an uniform to a vec2
  53918. * @param uniform defines the webGL uniform location where to store the value
  53919. * @param x defines the 1st component of the value
  53920. * @param y defines the 2nd component of the value
  53921. */
  53922. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53923. /**
  53924. * Set the value of an uniform to a vec3
  53925. * @param uniform defines the webGL uniform location where to store the value
  53926. * @param x defines the 1st component of the value
  53927. * @param y defines the 2nd component of the value
  53928. * @param z defines the 3rd component of the value
  53929. */
  53930. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53931. /**
  53932. * Set the value of an uniform to a boolean
  53933. * @param uniform defines the webGL uniform location where to store the value
  53934. * @param bool defines the boolean to store
  53935. */
  53936. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53937. /**
  53938. * Set the value of an uniform to a vec4
  53939. * @param uniform defines the webGL uniform location where to store the value
  53940. * @param x defines the 1st component of the value
  53941. * @param y defines the 2nd component of the value
  53942. * @param z defines the 3rd component of the value
  53943. * @param w defines the 4th component of the value
  53944. */
  53945. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  53946. /**
  53947. * Sets the current alpha mode
  53948. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  53949. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  53950. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53951. */
  53952. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  53953. /**
  53954. * Bind webGl buffers directly to the webGL context
  53955. * @param vertexBuffers defines the vertex buffer to bind
  53956. * @param indexBuffer defines the index buffer to bind
  53957. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  53958. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  53959. * @param effect defines the effect associated with the vertex buffer
  53960. */
  53961. bindBuffers(vertexBuffers: {
  53962. [key: string]: VertexBuffer;
  53963. }, indexBuffer: DataBuffer, effect: Effect): void;
  53964. /**
  53965. * Force the entire cache to be cleared
  53966. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  53967. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  53968. */
  53969. wipeCaches(bruteForce?: boolean): void;
  53970. /**
  53971. * Send a draw order
  53972. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  53973. * @param indexStart defines the starting index
  53974. * @param indexCount defines the number of index to draw
  53975. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53976. */
  53977. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  53978. /**
  53979. * Draw a list of indexed primitives
  53980. * @param fillMode defines the primitive to use
  53981. * @param indexStart defines the starting index
  53982. * @param indexCount defines the number of index to draw
  53983. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53984. */
  53985. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  53986. /**
  53987. * Draw a list of unindexed primitives
  53988. * @param fillMode defines the primitive to use
  53989. * @param verticesStart defines the index of first vertex to draw
  53990. * @param verticesCount defines the count of vertices to draw
  53991. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53992. */
  53993. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  53994. /** @hidden */
  53995. _createTexture(): WebGLTexture;
  53996. /** @hidden */
  53997. _releaseTexture(texture: InternalTexture): void;
  53998. /**
  53999. * Usually called from Texture.ts.
  54000. * Passed information to create a WebGLTexture
  54001. * @param urlArg defines a value which contains one of the following:
  54002. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54003. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54004. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54005. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54006. * @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)
  54007. * @param scene needed for loading to the correct scene
  54008. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54009. * @param onLoad optional callback to be called upon successful completion
  54010. * @param onError optional callback to be called upon failure
  54011. * @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
  54012. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54013. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54014. * @param forcedExtension defines the extension to use to pick the right loader
  54015. * @param mimeType defines an optional mime type
  54016. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54017. */
  54018. 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;
  54019. /**
  54020. * Creates a new render target texture
  54021. * @param size defines the size of the texture
  54022. * @param options defines the options used to create the texture
  54023. * @returns a new render target texture stored in an InternalTexture
  54024. */
  54025. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54026. /**
  54027. * Update the sampling mode of a given texture
  54028. * @param samplingMode defines the required sampling mode
  54029. * @param texture defines the texture to update
  54030. */
  54031. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54032. /**
  54033. * Binds the frame buffer to the specified texture.
  54034. * @param texture The texture to render to or null for the default canvas
  54035. * @param faceIndex The face of the texture to render to in case of cube texture
  54036. * @param requiredWidth The width of the target to render to
  54037. * @param requiredHeight The height of the target to render to
  54038. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54039. * @param lodLevel defines le lod level to bind to the frame buffer
  54040. */
  54041. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54042. /**
  54043. * Unbind the current render target texture from the webGL context
  54044. * @param texture defines the render target texture to unbind
  54045. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54046. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54047. */
  54048. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54049. /**
  54050. * Creates a dynamic vertex buffer
  54051. * @param vertices the data for the dynamic vertex buffer
  54052. * @returns the new WebGL dynamic buffer
  54053. */
  54054. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54055. /**
  54056. * Update the content of a dynamic texture
  54057. * @param texture defines the texture to update
  54058. * @param canvas defines the canvas containing the source
  54059. * @param invertY defines if data must be stored with Y axis inverted
  54060. * @param premulAlpha defines if alpha is stored as premultiplied
  54061. * @param format defines the format of the data
  54062. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54063. */
  54064. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54065. /**
  54066. * Gets a boolean indicating if all created effects are ready
  54067. * @returns true if all effects are ready
  54068. */
  54069. areAllEffectsReady(): boolean;
  54070. /**
  54071. * @hidden
  54072. * Get the current error code of the webGL context
  54073. * @returns the error code
  54074. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54075. */
  54076. getError(): number;
  54077. /** @hidden */
  54078. _getUnpackAlignement(): number;
  54079. /** @hidden */
  54080. _unpackFlipY(value: boolean): void;
  54081. /**
  54082. * Update a dynamic index buffer
  54083. * @param indexBuffer defines the target index buffer
  54084. * @param indices defines the data to update
  54085. * @param offset defines the offset in the target index buffer where update should start
  54086. */
  54087. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54088. /**
  54089. * Updates a dynamic vertex buffer.
  54090. * @param vertexBuffer the vertex buffer to update
  54091. * @param vertices the data used to update the vertex buffer
  54092. * @param byteOffset the byte offset of the data (optional)
  54093. * @param byteLength the byte length of the data (optional)
  54094. */
  54095. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54096. /** @hidden */
  54097. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54098. /** @hidden */
  54099. _bindTexture(channel: number, texture: InternalTexture): void;
  54100. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54101. /**
  54102. * 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
  54103. */
  54104. releaseEffects(): void;
  54105. displayLoadingUI(): void;
  54106. hideLoadingUI(): void;
  54107. /** @hidden */
  54108. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54109. /** @hidden */
  54110. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54111. /** @hidden */
  54112. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54113. /** @hidden */
  54114. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54115. }
  54116. }
  54117. declare module "babylonjs/Instrumentation/timeToken" {
  54118. import { Nullable } from "babylonjs/types";
  54119. /**
  54120. * @hidden
  54121. **/
  54122. export class _TimeToken {
  54123. _startTimeQuery: Nullable<WebGLQuery>;
  54124. _endTimeQuery: Nullable<WebGLQuery>;
  54125. _timeElapsedQuery: Nullable<WebGLQuery>;
  54126. _timeElapsedQueryEnded: boolean;
  54127. }
  54128. }
  54129. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54130. import { Nullable, int } from "babylonjs/types";
  54131. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54132. /** @hidden */
  54133. export class _OcclusionDataStorage {
  54134. /** @hidden */
  54135. occlusionInternalRetryCounter: number;
  54136. /** @hidden */
  54137. isOcclusionQueryInProgress: boolean;
  54138. /** @hidden */
  54139. isOccluded: boolean;
  54140. /** @hidden */
  54141. occlusionRetryCount: number;
  54142. /** @hidden */
  54143. occlusionType: number;
  54144. /** @hidden */
  54145. occlusionQueryAlgorithmType: number;
  54146. }
  54147. module "babylonjs/Engines/engine" {
  54148. interface Engine {
  54149. /**
  54150. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54151. * @return the new query
  54152. */
  54153. createQuery(): WebGLQuery;
  54154. /**
  54155. * Delete and release a webGL query
  54156. * @param query defines the query to delete
  54157. * @return the current engine
  54158. */
  54159. deleteQuery(query: WebGLQuery): Engine;
  54160. /**
  54161. * Check if a given query has resolved and got its value
  54162. * @param query defines the query to check
  54163. * @returns true if the query got its value
  54164. */
  54165. isQueryResultAvailable(query: WebGLQuery): boolean;
  54166. /**
  54167. * Gets the value of a given query
  54168. * @param query defines the query to check
  54169. * @returns the value of the query
  54170. */
  54171. getQueryResult(query: WebGLQuery): number;
  54172. /**
  54173. * Initiates an occlusion query
  54174. * @param algorithmType defines the algorithm to use
  54175. * @param query defines the query to use
  54176. * @returns the current engine
  54177. * @see https://doc.babylonjs.com/features/occlusionquery
  54178. */
  54179. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54180. /**
  54181. * Ends an occlusion query
  54182. * @see https://doc.babylonjs.com/features/occlusionquery
  54183. * @param algorithmType defines the algorithm to use
  54184. * @returns the current engine
  54185. */
  54186. endOcclusionQuery(algorithmType: number): Engine;
  54187. /**
  54188. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54189. * Please note that only one query can be issued at a time
  54190. * @returns a time token used to track the time span
  54191. */
  54192. startTimeQuery(): Nullable<_TimeToken>;
  54193. /**
  54194. * Ends a time query
  54195. * @param token defines the token used to measure the time span
  54196. * @returns the time spent (in ns)
  54197. */
  54198. endTimeQuery(token: _TimeToken): int;
  54199. /** @hidden */
  54200. _currentNonTimestampToken: Nullable<_TimeToken>;
  54201. /** @hidden */
  54202. _createTimeQuery(): WebGLQuery;
  54203. /** @hidden */
  54204. _deleteTimeQuery(query: WebGLQuery): void;
  54205. /** @hidden */
  54206. _getGlAlgorithmType(algorithmType: number): number;
  54207. /** @hidden */
  54208. _getTimeQueryResult(query: WebGLQuery): any;
  54209. /** @hidden */
  54210. _getTimeQueryAvailability(query: WebGLQuery): any;
  54211. }
  54212. }
  54213. module "babylonjs/Meshes/abstractMesh" {
  54214. interface AbstractMesh {
  54215. /**
  54216. * Backing filed
  54217. * @hidden
  54218. */
  54219. __occlusionDataStorage: _OcclusionDataStorage;
  54220. /**
  54221. * Access property
  54222. * @hidden
  54223. */
  54224. _occlusionDataStorage: _OcclusionDataStorage;
  54225. /**
  54226. * 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.
  54227. * The default value is -1 which means don't break the query and wait till the result
  54228. * @see https://doc.babylonjs.com/features/occlusionquery
  54229. */
  54230. occlusionRetryCount: number;
  54231. /**
  54232. * 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:
  54233. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54234. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54235. * * 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.
  54236. * @see https://doc.babylonjs.com/features/occlusionquery
  54237. */
  54238. occlusionType: number;
  54239. /**
  54240. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54241. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54242. * * 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.
  54243. * @see https://doc.babylonjs.com/features/occlusionquery
  54244. */
  54245. occlusionQueryAlgorithmType: number;
  54246. /**
  54247. * 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
  54248. * @see https://doc.babylonjs.com/features/occlusionquery
  54249. */
  54250. isOccluded: boolean;
  54251. /**
  54252. * Flag to check the progress status of the query
  54253. * @see https://doc.babylonjs.com/features/occlusionquery
  54254. */
  54255. isOcclusionQueryInProgress: boolean;
  54256. }
  54257. }
  54258. }
  54259. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54260. import { Nullable } from "babylonjs/types";
  54261. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54262. /** @hidden */
  54263. export var _forceTransformFeedbackToBundle: boolean;
  54264. module "babylonjs/Engines/engine" {
  54265. interface Engine {
  54266. /**
  54267. * Creates a webGL transform feedback object
  54268. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54269. * @returns the webGL transform feedback object
  54270. */
  54271. createTransformFeedback(): WebGLTransformFeedback;
  54272. /**
  54273. * Delete a webGL transform feedback object
  54274. * @param value defines the webGL transform feedback object to delete
  54275. */
  54276. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54277. /**
  54278. * Bind a webGL transform feedback object to the webgl context
  54279. * @param value defines the webGL transform feedback object to bind
  54280. */
  54281. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54282. /**
  54283. * Begins a transform feedback operation
  54284. * @param usePoints defines if points or triangles must be used
  54285. */
  54286. beginTransformFeedback(usePoints: boolean): void;
  54287. /**
  54288. * Ends a transform feedback operation
  54289. */
  54290. endTransformFeedback(): void;
  54291. /**
  54292. * Specify the varyings to use with transform feedback
  54293. * @param program defines the associated webGL program
  54294. * @param value defines the list of strings representing the varying names
  54295. */
  54296. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54297. /**
  54298. * Bind a webGL buffer for a transform feedback operation
  54299. * @param value defines the webGL buffer to bind
  54300. */
  54301. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54302. }
  54303. }
  54304. }
  54305. declare module "babylonjs/Engines/Extensions/engine.views" {
  54306. import { Camera } from "babylonjs/Cameras/camera";
  54307. import { Nullable } from "babylonjs/types";
  54308. /**
  54309. * Class used to define an additional view for the engine
  54310. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54311. */
  54312. export class EngineView {
  54313. /** Defines the canvas where to render the view */
  54314. target: HTMLCanvasElement;
  54315. /** Defines an optional camera used to render the view (will use active camera else) */
  54316. camera?: Camera;
  54317. }
  54318. module "babylonjs/Engines/engine" {
  54319. interface Engine {
  54320. /**
  54321. * Gets or sets the HTML element to use for attaching events
  54322. */
  54323. inputElement: Nullable<HTMLElement>;
  54324. /**
  54325. * Gets the current engine view
  54326. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54327. */
  54328. activeView: Nullable<EngineView>;
  54329. /** Gets or sets the list of views */
  54330. views: EngineView[];
  54331. /**
  54332. * Register a new child canvas
  54333. * @param canvas defines the canvas to register
  54334. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54335. * @returns the associated view
  54336. */
  54337. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54338. /**
  54339. * Remove a registered child canvas
  54340. * @param canvas defines the canvas to remove
  54341. * @returns the current engine
  54342. */
  54343. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54344. }
  54345. }
  54346. }
  54347. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54348. import { Nullable } from "babylonjs/types";
  54349. module "babylonjs/Engines/engine" {
  54350. interface Engine {
  54351. /** @hidden */
  54352. _excludedCompressedTextures: string[];
  54353. /** @hidden */
  54354. _textureFormatInUse: string;
  54355. /**
  54356. * Gets the list of texture formats supported
  54357. */
  54358. readonly texturesSupported: Array<string>;
  54359. /**
  54360. * Gets the texture format in use
  54361. */
  54362. readonly textureFormatInUse: Nullable<string>;
  54363. /**
  54364. * Set the compressed texture extensions or file names to skip.
  54365. *
  54366. * @param skippedFiles defines the list of those texture files you want to skip
  54367. * Example: [".dds", ".env", "myfile.png"]
  54368. */
  54369. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54370. /**
  54371. * Set the compressed texture format to use, based on the formats you have, and the formats
  54372. * supported by the hardware / browser.
  54373. *
  54374. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54375. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54376. * to API arguments needed to compressed textures. This puts the burden on the container
  54377. * generator to house the arcane code for determining these for current & future formats.
  54378. *
  54379. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54380. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54381. *
  54382. * Note: The result of this call is not taken into account when a texture is base64.
  54383. *
  54384. * @param formatsAvailable defines the list of those format families you have created
  54385. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54386. *
  54387. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54388. * @returns The extension selected.
  54389. */
  54390. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54391. }
  54392. }
  54393. }
  54394. declare module "babylonjs/Engines/Extensions/index" {
  54395. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54396. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54397. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54398. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54399. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54400. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54401. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54402. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54403. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54404. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54405. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54406. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54407. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54408. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54409. export * from "babylonjs/Engines/Extensions/engine.views";
  54410. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54411. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54412. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54413. }
  54414. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54415. import { Nullable } from "babylonjs/types";
  54416. /**
  54417. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54418. */
  54419. export interface CubeMapInfo {
  54420. /**
  54421. * The pixel array for the front face.
  54422. * This is stored in format, left to right, up to down format.
  54423. */
  54424. front: Nullable<ArrayBufferView>;
  54425. /**
  54426. * The pixel array for the back face.
  54427. * This is stored in format, left to right, up to down format.
  54428. */
  54429. back: Nullable<ArrayBufferView>;
  54430. /**
  54431. * The pixel array for the left face.
  54432. * This is stored in format, left to right, up to down format.
  54433. */
  54434. left: Nullable<ArrayBufferView>;
  54435. /**
  54436. * The pixel array for the right face.
  54437. * This is stored in format, left to right, up to down format.
  54438. */
  54439. right: Nullable<ArrayBufferView>;
  54440. /**
  54441. * The pixel array for the up face.
  54442. * This is stored in format, left to right, up to down format.
  54443. */
  54444. up: Nullable<ArrayBufferView>;
  54445. /**
  54446. * The pixel array for the down face.
  54447. * This is stored in format, left to right, up to down format.
  54448. */
  54449. down: Nullable<ArrayBufferView>;
  54450. /**
  54451. * The size of the cubemap stored.
  54452. *
  54453. * Each faces will be size * size pixels.
  54454. */
  54455. size: number;
  54456. /**
  54457. * The format of the texture.
  54458. *
  54459. * RGBA, RGB.
  54460. */
  54461. format: number;
  54462. /**
  54463. * The type of the texture data.
  54464. *
  54465. * UNSIGNED_INT, FLOAT.
  54466. */
  54467. type: number;
  54468. /**
  54469. * Specifies whether the texture is in gamma space.
  54470. */
  54471. gammaSpace: boolean;
  54472. }
  54473. /**
  54474. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54475. */
  54476. export class PanoramaToCubeMapTools {
  54477. private static FACE_LEFT;
  54478. private static FACE_RIGHT;
  54479. private static FACE_FRONT;
  54480. private static FACE_BACK;
  54481. private static FACE_DOWN;
  54482. private static FACE_UP;
  54483. /**
  54484. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54485. *
  54486. * @param float32Array The source data.
  54487. * @param inputWidth The width of the input panorama.
  54488. * @param inputHeight The height of the input panorama.
  54489. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54490. * @return The cubemap data
  54491. */
  54492. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54493. private static CreateCubemapTexture;
  54494. private static CalcProjectionSpherical;
  54495. }
  54496. }
  54497. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54498. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54499. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54500. import { Nullable } from "babylonjs/types";
  54501. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54502. /**
  54503. * Helper class dealing with the extraction of spherical polynomial dataArray
  54504. * from a cube map.
  54505. */
  54506. export class CubeMapToSphericalPolynomialTools {
  54507. private static FileFaces;
  54508. /**
  54509. * Converts a texture to the according Spherical Polynomial data.
  54510. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54511. *
  54512. * @param texture The texture to extract the information from.
  54513. * @return The Spherical Polynomial data.
  54514. */
  54515. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54516. /**
  54517. * Converts a cubemap to the according Spherical Polynomial data.
  54518. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54519. *
  54520. * @param cubeInfo The Cube map to extract the information from.
  54521. * @return The Spherical Polynomial data.
  54522. */
  54523. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54524. }
  54525. }
  54526. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54527. import { Nullable } from "babylonjs/types";
  54528. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54529. module "babylonjs/Materials/Textures/baseTexture" {
  54530. interface BaseTexture {
  54531. /**
  54532. * Get the polynomial representation of the texture data.
  54533. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54534. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54535. */
  54536. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54537. }
  54538. }
  54539. }
  54540. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54541. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54542. /** @hidden */
  54543. export var rgbdEncodePixelShader: {
  54544. name: string;
  54545. shader: string;
  54546. };
  54547. }
  54548. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54549. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54550. /** @hidden */
  54551. export var rgbdDecodePixelShader: {
  54552. name: string;
  54553. shader: string;
  54554. };
  54555. }
  54556. declare module "babylonjs/Misc/environmentTextureTools" {
  54557. import { Nullable } from "babylonjs/types";
  54558. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54559. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54560. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54561. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54562. import "babylonjs/Engines/Extensions/engine.readTexture";
  54563. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54564. import "babylonjs/Shaders/rgbdEncode.fragment";
  54565. import "babylonjs/Shaders/rgbdDecode.fragment";
  54566. /**
  54567. * Raw texture data and descriptor sufficient for WebGL texture upload
  54568. */
  54569. export interface EnvironmentTextureInfo {
  54570. /**
  54571. * Version of the environment map
  54572. */
  54573. version: number;
  54574. /**
  54575. * Width of image
  54576. */
  54577. width: number;
  54578. /**
  54579. * Irradiance information stored in the file.
  54580. */
  54581. irradiance: any;
  54582. /**
  54583. * Specular information stored in the file.
  54584. */
  54585. specular: any;
  54586. }
  54587. /**
  54588. * Defines One Image in the file. It requires only the position in the file
  54589. * as well as the length.
  54590. */
  54591. interface BufferImageData {
  54592. /**
  54593. * Length of the image data.
  54594. */
  54595. length: number;
  54596. /**
  54597. * Position of the data from the null terminator delimiting the end of the JSON.
  54598. */
  54599. position: number;
  54600. }
  54601. /**
  54602. * Defines the specular data enclosed in the file.
  54603. * This corresponds to the version 1 of the data.
  54604. */
  54605. export interface EnvironmentTextureSpecularInfoV1 {
  54606. /**
  54607. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54608. */
  54609. specularDataPosition?: number;
  54610. /**
  54611. * This contains all the images data needed to reconstruct the cubemap.
  54612. */
  54613. mipmaps: Array<BufferImageData>;
  54614. /**
  54615. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54616. */
  54617. lodGenerationScale: number;
  54618. }
  54619. /**
  54620. * Sets of helpers addressing the serialization and deserialization of environment texture
  54621. * stored in a BabylonJS env file.
  54622. * Those files are usually stored as .env files.
  54623. */
  54624. export class EnvironmentTextureTools {
  54625. /**
  54626. * Magic number identifying the env file.
  54627. */
  54628. private static _MagicBytes;
  54629. /**
  54630. * Gets the environment info from an env file.
  54631. * @param data The array buffer containing the .env bytes.
  54632. * @returns the environment file info (the json header) if successfully parsed.
  54633. */
  54634. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54635. /**
  54636. * Creates an environment texture from a loaded cube texture.
  54637. * @param texture defines the cube texture to convert in env file
  54638. * @return a promise containing the environment data if succesfull.
  54639. */
  54640. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54641. /**
  54642. * Creates a JSON representation of the spherical data.
  54643. * @param texture defines the texture containing the polynomials
  54644. * @return the JSON representation of the spherical info
  54645. */
  54646. private static _CreateEnvTextureIrradiance;
  54647. /**
  54648. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54649. * @param data the image data
  54650. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54651. * @return the views described by info providing access to the underlying buffer
  54652. */
  54653. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54654. /**
  54655. * Uploads the texture info contained in the env file to the GPU.
  54656. * @param texture defines the internal texture to upload to
  54657. * @param data defines the data to load
  54658. * @param info defines the texture info retrieved through the GetEnvInfo method
  54659. * @returns a promise
  54660. */
  54661. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54662. private static _OnImageReadyAsync;
  54663. /**
  54664. * Uploads the levels of image data to the GPU.
  54665. * @param texture defines the internal texture to upload to
  54666. * @param imageData defines the array buffer views of image data [mipmap][face]
  54667. * @returns a promise
  54668. */
  54669. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54670. /**
  54671. * Uploads spherical polynomials information to the texture.
  54672. * @param texture defines the texture we are trying to upload the information to
  54673. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54674. */
  54675. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54676. /** @hidden */
  54677. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54678. }
  54679. }
  54680. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54681. /**
  54682. * Class used to inline functions in shader code
  54683. */
  54684. export class ShaderCodeInliner {
  54685. private static readonly _RegexpFindFunctionNameAndType;
  54686. private _sourceCode;
  54687. private _functionDescr;
  54688. private _numMaxIterations;
  54689. /** Gets or sets the token used to mark the functions to inline */
  54690. inlineToken: string;
  54691. /** Gets or sets the debug mode */
  54692. debug: boolean;
  54693. /** Gets the code after the inlining process */
  54694. get code(): string;
  54695. /**
  54696. * Initializes the inliner
  54697. * @param sourceCode shader code source to inline
  54698. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54699. */
  54700. constructor(sourceCode: string, numMaxIterations?: number);
  54701. /**
  54702. * Start the processing of the shader code
  54703. */
  54704. processCode(): void;
  54705. private _collectFunctions;
  54706. private _processInlining;
  54707. private _extractBetweenMarkers;
  54708. private _skipWhitespaces;
  54709. private _removeComments;
  54710. private _replaceFunctionCallsByCode;
  54711. private _findBackward;
  54712. private _escapeRegExp;
  54713. private _replaceNames;
  54714. }
  54715. }
  54716. declare module "babylonjs/Engines/nativeEngine" {
  54717. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54718. import { Engine } from "babylonjs/Engines/engine";
  54719. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54720. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54721. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54722. import { Effect } from "babylonjs/Materials/effect";
  54723. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54724. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54725. import { IColor4Like } from "babylonjs/Maths/math.like";
  54726. import { Scene } from "babylonjs/scene";
  54727. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54728. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54729. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54730. /**
  54731. * Container for accessors for natively-stored mesh data buffers.
  54732. */
  54733. class NativeDataBuffer extends DataBuffer {
  54734. /**
  54735. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54736. */
  54737. nativeIndexBuffer?: any;
  54738. /**
  54739. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54740. */
  54741. nativeVertexBuffer?: any;
  54742. }
  54743. /** @hidden */
  54744. class NativeTexture extends InternalTexture {
  54745. getInternalTexture(): InternalTexture;
  54746. getViewCount(): number;
  54747. }
  54748. /** @hidden */
  54749. export class NativeEngine extends Engine {
  54750. private readonly _native;
  54751. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54752. private readonly INVALID_HANDLE;
  54753. private _boundBuffersVertexArray;
  54754. getHardwareScalingLevel(): number;
  54755. constructor();
  54756. dispose(): void;
  54757. /**
  54758. * Can be used to override the current requestAnimationFrame requester.
  54759. * @hidden
  54760. */
  54761. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54762. /**
  54763. * Override default engine behavior.
  54764. * @param color
  54765. * @param backBuffer
  54766. * @param depth
  54767. * @param stencil
  54768. */
  54769. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54770. /**
  54771. * Gets host document
  54772. * @returns the host document object
  54773. */
  54774. getHostDocument(): Nullable<Document>;
  54775. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54776. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54777. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54778. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54779. [key: string]: VertexBuffer;
  54780. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54781. bindBuffers(vertexBuffers: {
  54782. [key: string]: VertexBuffer;
  54783. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54784. recordVertexArrayObject(vertexBuffers: {
  54785. [key: string]: VertexBuffer;
  54786. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54787. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54788. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54789. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54790. /**
  54791. * Draw a list of indexed primitives
  54792. * @param fillMode defines the primitive to use
  54793. * @param indexStart defines the starting index
  54794. * @param indexCount defines the number of index to draw
  54795. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54796. */
  54797. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54798. /**
  54799. * Draw a list of unindexed primitives
  54800. * @param fillMode defines the primitive to use
  54801. * @param verticesStart defines the index of first vertex to draw
  54802. * @param verticesCount defines the count of vertices to draw
  54803. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54804. */
  54805. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54806. createPipelineContext(): IPipelineContext;
  54807. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54808. /** @hidden */
  54809. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54810. /** @hidden */
  54811. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54812. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54813. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54814. protected _setProgram(program: WebGLProgram): void;
  54815. _releaseEffect(effect: Effect): void;
  54816. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54817. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54818. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54819. bindSamplers(effect: Effect): void;
  54820. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54821. getRenderWidth(useScreen?: boolean): number;
  54822. getRenderHeight(useScreen?: boolean): number;
  54823. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54824. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54825. /**
  54826. * Set the z offset to apply to current rendering
  54827. * @param value defines the offset to apply
  54828. */
  54829. setZOffset(value: number): void;
  54830. /**
  54831. * Gets the current value of the zOffset
  54832. * @returns the current zOffset state
  54833. */
  54834. getZOffset(): number;
  54835. /**
  54836. * Enable or disable depth buffering
  54837. * @param enable defines the state to set
  54838. */
  54839. setDepthBuffer(enable: boolean): void;
  54840. /**
  54841. * Gets a boolean indicating if depth writing is enabled
  54842. * @returns the current depth writing state
  54843. */
  54844. getDepthWrite(): boolean;
  54845. /**
  54846. * Enable or disable depth writing
  54847. * @param enable defines the state to set
  54848. */
  54849. setDepthWrite(enable: boolean): void;
  54850. /**
  54851. * Enable or disable color writing
  54852. * @param enable defines the state to set
  54853. */
  54854. setColorWrite(enable: boolean): void;
  54855. /**
  54856. * Gets a boolean indicating if color writing is enabled
  54857. * @returns the current color writing state
  54858. */
  54859. getColorWrite(): boolean;
  54860. /**
  54861. * Sets alpha constants used by some alpha blending modes
  54862. * @param r defines the red component
  54863. * @param g defines the green component
  54864. * @param b defines the blue component
  54865. * @param a defines the alpha component
  54866. */
  54867. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54868. /**
  54869. * Sets the current alpha mode
  54870. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54871. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54872. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54873. */
  54874. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54875. /**
  54876. * Gets the current alpha mode
  54877. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54878. * @returns the current alpha mode
  54879. */
  54880. getAlphaMode(): number;
  54881. setInt(uniform: WebGLUniformLocation, int: number): void;
  54882. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54883. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54884. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54885. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54886. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54887. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54888. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54889. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54890. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54891. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54892. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54893. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54894. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54895. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54896. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54897. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54898. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54899. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54900. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54901. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54902. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54903. wipeCaches(bruteForce?: boolean): void;
  54904. _createTexture(): WebGLTexture;
  54905. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54906. /**
  54907. * Usually called from Texture.ts.
  54908. * Passed information to create a WebGLTexture
  54909. * @param url defines a value which contains one of the following:
  54910. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54911. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54912. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54913. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54914. * @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)
  54915. * @param scene needed for loading to the correct scene
  54916. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54917. * @param onLoad optional callback to be called upon successful completion
  54918. * @param onError optional callback to be called upon failure
  54919. * @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
  54920. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54921. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54922. * @param forcedExtension defines the extension to use to pick the right loader
  54923. * @param mimeType defines an optional mime type
  54924. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54925. */
  54926. 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;
  54927. /**
  54928. * Creates a cube texture
  54929. * @param rootUrl defines the url where the files to load is located
  54930. * @param scene defines the current scene
  54931. * @param files defines the list of files to load (1 per face)
  54932. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54933. * @param onLoad defines an optional callback raised when the texture is loaded
  54934. * @param onError defines an optional callback raised if there is an issue to load the texture
  54935. * @param format defines the format of the data
  54936. * @param forcedExtension defines the extension to use to pick the right loader
  54937. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54938. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54939. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54940. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  54941. * @returns the cube texture as an InternalTexture
  54942. */
  54943. 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;
  54944. private _getSamplingFilter;
  54945. private static _GetNativeTextureFormat;
  54946. createRenderTargetTexture(size: number | {
  54947. width: number;
  54948. height: number;
  54949. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  54950. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54951. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54952. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54953. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  54954. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  54955. /**
  54956. * Updates a dynamic vertex buffer.
  54957. * @param vertexBuffer the vertex buffer to update
  54958. * @param data the data used to update the vertex buffer
  54959. * @param byteOffset the byte offset of the data (optional)
  54960. * @param byteLength the byte length of the data (optional)
  54961. */
  54962. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  54963. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  54964. private _updateAnisotropicLevel;
  54965. private _getAddressMode;
  54966. /** @hidden */
  54967. _bindTexture(channel: number, texture: InternalTexture): void;
  54968. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  54969. releaseEffects(): void;
  54970. /** @hidden */
  54971. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54972. /** @hidden */
  54973. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54974. /** @hidden */
  54975. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54976. /** @hidden */
  54977. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54978. }
  54979. }
  54980. declare module "babylonjs/Engines/index" {
  54981. export * from "babylonjs/Engines/constants";
  54982. export * from "babylonjs/Engines/engineCapabilities";
  54983. export * from "babylonjs/Engines/instancingAttributeInfo";
  54984. export * from "babylonjs/Engines/thinEngine";
  54985. export * from "babylonjs/Engines/engine";
  54986. export * from "babylonjs/Engines/engineStore";
  54987. export * from "babylonjs/Engines/nullEngine";
  54988. export * from "babylonjs/Engines/Extensions/index";
  54989. export * from "babylonjs/Engines/IPipelineContext";
  54990. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  54991. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  54992. export * from "babylonjs/Engines/nativeEngine";
  54993. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  54994. export * from "babylonjs/Engines/performanceConfigurator";
  54995. }
  54996. declare module "babylonjs/Events/clipboardEvents" {
  54997. /**
  54998. * Gather the list of clipboard event types as constants.
  54999. */
  55000. export class ClipboardEventTypes {
  55001. /**
  55002. * The clipboard event is fired when a copy command is active (pressed).
  55003. */
  55004. static readonly COPY: number;
  55005. /**
  55006. * The clipboard event is fired when a cut command is active (pressed).
  55007. */
  55008. static readonly CUT: number;
  55009. /**
  55010. * The clipboard event is fired when a paste command is active (pressed).
  55011. */
  55012. static readonly PASTE: number;
  55013. }
  55014. /**
  55015. * This class is used to store clipboard related info for the onClipboardObservable event.
  55016. */
  55017. export class ClipboardInfo {
  55018. /**
  55019. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55020. */
  55021. type: number;
  55022. /**
  55023. * Defines the related dom event
  55024. */
  55025. event: ClipboardEvent;
  55026. /**
  55027. *Creates an instance of ClipboardInfo.
  55028. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55029. * @param event Defines the related dom event
  55030. */
  55031. constructor(
  55032. /**
  55033. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55034. */
  55035. type: number,
  55036. /**
  55037. * Defines the related dom event
  55038. */
  55039. event: ClipboardEvent);
  55040. /**
  55041. * Get the clipboard event's type from the keycode.
  55042. * @param keyCode Defines the keyCode for the current keyboard event.
  55043. * @return {number}
  55044. */
  55045. static GetTypeFromCharacter(keyCode: number): number;
  55046. }
  55047. }
  55048. declare module "babylonjs/Events/index" {
  55049. export * from "babylonjs/Events/keyboardEvents";
  55050. export * from "babylonjs/Events/pointerEvents";
  55051. export * from "babylonjs/Events/clipboardEvents";
  55052. }
  55053. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55054. import { Scene } from "babylonjs/scene";
  55055. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55056. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55057. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55058. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55059. /**
  55060. * Google Daydream controller
  55061. */
  55062. export class DaydreamController extends WebVRController {
  55063. /**
  55064. * Base Url for the controller model.
  55065. */
  55066. static MODEL_BASE_URL: string;
  55067. /**
  55068. * File name for the controller model.
  55069. */
  55070. static MODEL_FILENAME: string;
  55071. /**
  55072. * Gamepad Id prefix used to identify Daydream Controller.
  55073. */
  55074. static readonly GAMEPAD_ID_PREFIX: string;
  55075. /**
  55076. * Creates a new DaydreamController from a gamepad
  55077. * @param vrGamepad the gamepad that the controller should be created from
  55078. */
  55079. constructor(vrGamepad: any);
  55080. /**
  55081. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55082. * @param scene scene in which to add meshes
  55083. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55084. */
  55085. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55086. /**
  55087. * Called once for each button that changed state since the last frame
  55088. * @param buttonIdx Which button index changed
  55089. * @param state New state of the button
  55090. * @param changes Which properties on the state changed since last frame
  55091. */
  55092. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55093. }
  55094. }
  55095. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55096. import { Scene } from "babylonjs/scene";
  55097. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55098. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55099. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55100. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55101. /**
  55102. * Gear VR Controller
  55103. */
  55104. export class GearVRController extends WebVRController {
  55105. /**
  55106. * Base Url for the controller model.
  55107. */
  55108. static MODEL_BASE_URL: string;
  55109. /**
  55110. * File name for the controller model.
  55111. */
  55112. static MODEL_FILENAME: string;
  55113. /**
  55114. * Gamepad Id prefix used to identify this controller.
  55115. */
  55116. static readonly GAMEPAD_ID_PREFIX: string;
  55117. private readonly _buttonIndexToObservableNameMap;
  55118. /**
  55119. * Creates a new GearVRController from a gamepad
  55120. * @param vrGamepad the gamepad that the controller should be created from
  55121. */
  55122. constructor(vrGamepad: any);
  55123. /**
  55124. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55125. * @param scene scene in which to add meshes
  55126. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55127. */
  55128. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55129. /**
  55130. * Called once for each button that changed state since the last frame
  55131. * @param buttonIdx Which button index changed
  55132. * @param state New state of the button
  55133. * @param changes Which properties on the state changed since last frame
  55134. */
  55135. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55136. }
  55137. }
  55138. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55139. import { Scene } from "babylonjs/scene";
  55140. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55141. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55142. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55143. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55144. /**
  55145. * Generic Controller
  55146. */
  55147. export class GenericController extends WebVRController {
  55148. /**
  55149. * Base Url for the controller model.
  55150. */
  55151. static readonly MODEL_BASE_URL: string;
  55152. /**
  55153. * File name for the controller model.
  55154. */
  55155. static readonly MODEL_FILENAME: string;
  55156. /**
  55157. * Creates a new GenericController from a gamepad
  55158. * @param vrGamepad the gamepad that the controller should be created from
  55159. */
  55160. constructor(vrGamepad: any);
  55161. /**
  55162. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55163. * @param scene scene in which to add meshes
  55164. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55165. */
  55166. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55167. /**
  55168. * Called once for each button that changed state since the last frame
  55169. * @param buttonIdx Which button index changed
  55170. * @param state New state of the button
  55171. * @param changes Which properties on the state changed since last frame
  55172. */
  55173. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55174. }
  55175. }
  55176. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55177. import { Observable } from "babylonjs/Misc/observable";
  55178. import { Scene } from "babylonjs/scene";
  55179. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55180. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55181. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55182. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55183. /**
  55184. * Oculus Touch Controller
  55185. */
  55186. export class OculusTouchController extends WebVRController {
  55187. /**
  55188. * Base Url for the controller model.
  55189. */
  55190. static MODEL_BASE_URL: string;
  55191. /**
  55192. * File name for the left controller model.
  55193. */
  55194. static MODEL_LEFT_FILENAME: string;
  55195. /**
  55196. * File name for the right controller model.
  55197. */
  55198. static MODEL_RIGHT_FILENAME: string;
  55199. /**
  55200. * Base Url for the Quest controller model.
  55201. */
  55202. static QUEST_MODEL_BASE_URL: string;
  55203. /**
  55204. * @hidden
  55205. * If the controllers are running on a device that needs the updated Quest controller models
  55206. */
  55207. static _IsQuest: boolean;
  55208. /**
  55209. * Fired when the secondary trigger on this controller is modified
  55210. */
  55211. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55212. /**
  55213. * Fired when the thumb rest on this controller is modified
  55214. */
  55215. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55216. /**
  55217. * Creates a new OculusTouchController from a gamepad
  55218. * @param vrGamepad the gamepad that the controller should be created from
  55219. */
  55220. constructor(vrGamepad: any);
  55221. /**
  55222. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55223. * @param scene scene in which to add meshes
  55224. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55225. */
  55226. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55227. /**
  55228. * Fired when the A button on this controller is modified
  55229. */
  55230. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55231. /**
  55232. * Fired when the B button on this controller is modified
  55233. */
  55234. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55235. /**
  55236. * Fired when the X button on this controller is modified
  55237. */
  55238. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55239. /**
  55240. * Fired when the Y button on this controller is modified
  55241. */
  55242. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55243. /**
  55244. * Called once for each button that changed state since the last frame
  55245. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55246. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55247. * 2) secondary trigger (same)
  55248. * 3) A (right) X (left), touch, pressed = value
  55249. * 4) B / Y
  55250. * 5) thumb rest
  55251. * @param buttonIdx Which button index changed
  55252. * @param state New state of the button
  55253. * @param changes Which properties on the state changed since last frame
  55254. */
  55255. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55256. }
  55257. }
  55258. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55259. import { Scene } from "babylonjs/scene";
  55260. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55261. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55262. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55263. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55264. import { Observable } from "babylonjs/Misc/observable";
  55265. /**
  55266. * Vive Controller
  55267. */
  55268. export class ViveController extends WebVRController {
  55269. /**
  55270. * Base Url for the controller model.
  55271. */
  55272. static MODEL_BASE_URL: string;
  55273. /**
  55274. * File name for the controller model.
  55275. */
  55276. static MODEL_FILENAME: string;
  55277. /**
  55278. * Creates a new ViveController from a gamepad
  55279. * @param vrGamepad the gamepad that the controller should be created from
  55280. */
  55281. constructor(vrGamepad: any);
  55282. /**
  55283. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55284. * @param scene scene in which to add meshes
  55285. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55286. */
  55287. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55288. /**
  55289. * Fired when the left button on this controller is modified
  55290. */
  55291. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55292. /**
  55293. * Fired when the right button on this controller is modified
  55294. */
  55295. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55296. /**
  55297. * Fired when the menu button on this controller is modified
  55298. */
  55299. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55300. /**
  55301. * Called once for each button that changed state since the last frame
  55302. * Vive mapping:
  55303. * 0: touchpad
  55304. * 1: trigger
  55305. * 2: left AND right buttons
  55306. * 3: menu button
  55307. * @param buttonIdx Which button index changed
  55308. * @param state New state of the button
  55309. * @param changes Which properties on the state changed since last frame
  55310. */
  55311. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55312. }
  55313. }
  55314. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55315. import { Observable } from "babylonjs/Misc/observable";
  55316. import { Scene } from "babylonjs/scene";
  55317. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55318. import { Ray } from "babylonjs/Culling/ray";
  55319. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55320. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55321. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55322. /**
  55323. * Defines the WindowsMotionController object that the state of the windows motion controller
  55324. */
  55325. export class WindowsMotionController extends WebVRController {
  55326. /**
  55327. * The base url used to load the left and right controller models
  55328. */
  55329. static MODEL_BASE_URL: string;
  55330. /**
  55331. * The name of the left controller model file
  55332. */
  55333. static MODEL_LEFT_FILENAME: string;
  55334. /**
  55335. * The name of the right controller model file
  55336. */
  55337. static MODEL_RIGHT_FILENAME: string;
  55338. /**
  55339. * The controller name prefix for this controller type
  55340. */
  55341. static readonly GAMEPAD_ID_PREFIX: string;
  55342. /**
  55343. * The controller id pattern for this controller type
  55344. */
  55345. private static readonly GAMEPAD_ID_PATTERN;
  55346. private _loadedMeshInfo;
  55347. protected readonly _mapping: {
  55348. buttons: string[];
  55349. buttonMeshNames: {
  55350. trigger: string;
  55351. menu: string;
  55352. grip: string;
  55353. thumbstick: string;
  55354. trackpad: string;
  55355. };
  55356. buttonObservableNames: {
  55357. trigger: string;
  55358. menu: string;
  55359. grip: string;
  55360. thumbstick: string;
  55361. trackpad: string;
  55362. };
  55363. axisMeshNames: string[];
  55364. pointingPoseMeshName: string;
  55365. };
  55366. /**
  55367. * Fired when the trackpad on this controller is clicked
  55368. */
  55369. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55370. /**
  55371. * Fired when the trackpad on this controller is modified
  55372. */
  55373. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55374. /**
  55375. * The current x and y values of this controller's trackpad
  55376. */
  55377. trackpad: StickValues;
  55378. /**
  55379. * Creates a new WindowsMotionController from a gamepad
  55380. * @param vrGamepad the gamepad that the controller should be created from
  55381. */
  55382. constructor(vrGamepad: any);
  55383. /**
  55384. * Fired when the trigger on this controller is modified
  55385. */
  55386. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55387. /**
  55388. * Fired when the menu button on this controller is modified
  55389. */
  55390. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55391. /**
  55392. * Fired when the grip button on this controller is modified
  55393. */
  55394. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55395. /**
  55396. * Fired when the thumbstick button on this controller is modified
  55397. */
  55398. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55399. /**
  55400. * Fired when the touchpad button on this controller is modified
  55401. */
  55402. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55403. /**
  55404. * Fired when the touchpad values on this controller are modified
  55405. */
  55406. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55407. protected _updateTrackpad(): void;
  55408. /**
  55409. * Called once per frame by the engine.
  55410. */
  55411. update(): void;
  55412. /**
  55413. * Called once for each button that changed state since the last frame
  55414. * @param buttonIdx Which button index changed
  55415. * @param state New state of the button
  55416. * @param changes Which properties on the state changed since last frame
  55417. */
  55418. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55419. /**
  55420. * Moves the buttons on the controller mesh based on their current state
  55421. * @param buttonName the name of the button to move
  55422. * @param buttonValue the value of the button which determines the buttons new position
  55423. */
  55424. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55425. /**
  55426. * Moves the axis on the controller mesh based on its current state
  55427. * @param axis the index of the axis
  55428. * @param axisValue the value of the axis which determines the meshes new position
  55429. * @hidden
  55430. */
  55431. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55432. /**
  55433. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55434. * @param scene scene in which to add meshes
  55435. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55436. */
  55437. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55438. /**
  55439. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55440. * can be transformed by button presses and axes values, based on this._mapping.
  55441. *
  55442. * @param scene scene in which the meshes exist
  55443. * @param meshes list of meshes that make up the controller model to process
  55444. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55445. */
  55446. private processModel;
  55447. private createMeshInfo;
  55448. /**
  55449. * Gets the ray of the controller in the direction the controller is pointing
  55450. * @param length the length the resulting ray should be
  55451. * @returns a ray in the direction the controller is pointing
  55452. */
  55453. getForwardRay(length?: number): Ray;
  55454. /**
  55455. * Disposes of the controller
  55456. */
  55457. dispose(): void;
  55458. }
  55459. /**
  55460. * This class represents a new windows motion controller in XR.
  55461. */
  55462. export class XRWindowsMotionController extends WindowsMotionController {
  55463. /**
  55464. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55465. */
  55466. protected readonly _mapping: {
  55467. buttons: string[];
  55468. buttonMeshNames: {
  55469. trigger: string;
  55470. menu: string;
  55471. grip: string;
  55472. thumbstick: string;
  55473. trackpad: string;
  55474. };
  55475. buttonObservableNames: {
  55476. trigger: string;
  55477. menu: string;
  55478. grip: string;
  55479. thumbstick: string;
  55480. trackpad: string;
  55481. };
  55482. axisMeshNames: string[];
  55483. pointingPoseMeshName: string;
  55484. };
  55485. /**
  55486. * Construct a new XR-Based windows motion controller
  55487. *
  55488. * @param gamepadInfo the gamepad object from the browser
  55489. */
  55490. constructor(gamepadInfo: any);
  55491. /**
  55492. * holds the thumbstick values (X,Y)
  55493. */
  55494. thumbstickValues: StickValues;
  55495. /**
  55496. * Fired when the thumbstick on this controller is clicked
  55497. */
  55498. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55499. /**
  55500. * Fired when the thumbstick on this controller is modified
  55501. */
  55502. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55503. /**
  55504. * Fired when the touchpad button on this controller is modified
  55505. */
  55506. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55507. /**
  55508. * Fired when the touchpad values on this controller are modified
  55509. */
  55510. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55511. /**
  55512. * Fired when the thumbstick button on this controller is modified
  55513. * here to prevent breaking changes
  55514. */
  55515. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55516. /**
  55517. * updating the thumbstick(!) and not the trackpad.
  55518. * This is named this way due to the difference between WebVR and XR and to avoid
  55519. * changing the parent class.
  55520. */
  55521. protected _updateTrackpad(): void;
  55522. /**
  55523. * Disposes the class with joy
  55524. */
  55525. dispose(): void;
  55526. }
  55527. }
  55528. declare module "babylonjs/Gamepads/Controllers/index" {
  55529. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55530. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55531. export * from "babylonjs/Gamepads/Controllers/genericController";
  55532. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55533. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55534. export * from "babylonjs/Gamepads/Controllers/viveController";
  55535. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55536. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55537. }
  55538. declare module "babylonjs/Gamepads/index" {
  55539. export * from "babylonjs/Gamepads/Controllers/index";
  55540. export * from "babylonjs/Gamepads/gamepad";
  55541. export * from "babylonjs/Gamepads/gamepadManager";
  55542. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55543. export * from "babylonjs/Gamepads/xboxGamepad";
  55544. export * from "babylonjs/Gamepads/dualShockGamepad";
  55545. }
  55546. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55547. import { Scene } from "babylonjs/scene";
  55548. import { Vector4 } from "babylonjs/Maths/math.vector";
  55549. import { Color4 } from "babylonjs/Maths/math.color";
  55550. import { Mesh } from "babylonjs/Meshes/mesh";
  55551. import { Nullable } from "babylonjs/types";
  55552. /**
  55553. * Class containing static functions to help procedurally build meshes
  55554. */
  55555. export class PolyhedronBuilder {
  55556. /**
  55557. * Creates a polyhedron mesh
  55558. * * 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
  55559. * * The parameter `size` (positive float, default 1) sets the polygon size
  55560. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55561. * * 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`
  55562. * * 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
  55563. * * 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)`)
  55564. * * 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
  55565. * * 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
  55566. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55567. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55568. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55569. * @param name defines the name of the mesh
  55570. * @param options defines the options used to create the mesh
  55571. * @param scene defines the hosting scene
  55572. * @returns the polyhedron mesh
  55573. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55574. */
  55575. static CreatePolyhedron(name: string, options: {
  55576. type?: number;
  55577. size?: number;
  55578. sizeX?: number;
  55579. sizeY?: number;
  55580. sizeZ?: number;
  55581. custom?: any;
  55582. faceUV?: Vector4[];
  55583. faceColors?: Color4[];
  55584. flat?: boolean;
  55585. updatable?: boolean;
  55586. sideOrientation?: number;
  55587. frontUVs?: Vector4;
  55588. backUVs?: Vector4;
  55589. }, scene?: Nullable<Scene>): Mesh;
  55590. }
  55591. }
  55592. declare module "babylonjs/Gizmos/scaleGizmo" {
  55593. import { Observable } from "babylonjs/Misc/observable";
  55594. import { Nullable } from "babylonjs/types";
  55595. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55596. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55597. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55598. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55599. import { Node } from "babylonjs/node";
  55600. /**
  55601. * Gizmo that enables scaling a mesh along 3 axis
  55602. */
  55603. export class ScaleGizmo extends Gizmo {
  55604. /**
  55605. * Internal gizmo used for interactions on the x axis
  55606. */
  55607. xGizmo: AxisScaleGizmo;
  55608. /**
  55609. * Internal gizmo used for interactions on the y axis
  55610. */
  55611. yGizmo: AxisScaleGizmo;
  55612. /**
  55613. * Internal gizmo used for interactions on the z axis
  55614. */
  55615. zGizmo: AxisScaleGizmo;
  55616. /**
  55617. * Internal gizmo used to scale all axis equally
  55618. */
  55619. uniformScaleGizmo: AxisScaleGizmo;
  55620. private _meshAttached;
  55621. private _nodeAttached;
  55622. private _updateGizmoRotationToMatchAttachedMesh;
  55623. private _snapDistance;
  55624. private _scaleRatio;
  55625. private _uniformScalingMesh;
  55626. private _octahedron;
  55627. private _sensitivity;
  55628. /** Fires an event when any of it's sub gizmos are dragged */
  55629. onDragStartObservable: Observable<unknown>;
  55630. /** Fires an event when any of it's sub gizmos are released from dragging */
  55631. onDragEndObservable: Observable<unknown>;
  55632. get attachedMesh(): Nullable<AbstractMesh>;
  55633. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55634. get attachedNode(): Nullable<Node>;
  55635. set attachedNode(node: Nullable<Node>);
  55636. /**
  55637. * Creates a ScaleGizmo
  55638. * @param gizmoLayer The utility layer the gizmo will be added to
  55639. * @param thickness display gizmo axis thickness
  55640. */
  55641. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55642. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55643. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55644. /**
  55645. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55646. */
  55647. set snapDistance(value: number);
  55648. get snapDistance(): number;
  55649. /**
  55650. * Ratio for the scale of the gizmo (Default: 1)
  55651. */
  55652. set scaleRatio(value: number);
  55653. get scaleRatio(): number;
  55654. /**
  55655. * Sensitivity factor for dragging (Default: 1)
  55656. */
  55657. set sensitivity(value: number);
  55658. get sensitivity(): number;
  55659. /**
  55660. * Disposes of the gizmo
  55661. */
  55662. dispose(): void;
  55663. }
  55664. }
  55665. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55666. import { Observable } from "babylonjs/Misc/observable";
  55667. import { Nullable } from "babylonjs/types";
  55668. import { Vector3 } from "babylonjs/Maths/math.vector";
  55669. import { Node } from "babylonjs/node";
  55670. import { Mesh } from "babylonjs/Meshes/mesh";
  55671. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55672. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55673. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55674. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55675. import { Color3 } from "babylonjs/Maths/math.color";
  55676. /**
  55677. * Single axis scale gizmo
  55678. */
  55679. export class AxisScaleGizmo extends Gizmo {
  55680. /**
  55681. * Drag behavior responsible for the gizmos dragging interactions
  55682. */
  55683. dragBehavior: PointerDragBehavior;
  55684. private _pointerObserver;
  55685. /**
  55686. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55687. */
  55688. snapDistance: number;
  55689. /**
  55690. * Event that fires each time the gizmo snaps to a new location.
  55691. * * snapDistance is the the change in distance
  55692. */
  55693. onSnapObservable: Observable<{
  55694. snapDistance: number;
  55695. }>;
  55696. /**
  55697. * If the scaling operation should be done on all axis (default: false)
  55698. */
  55699. uniformScaling: boolean;
  55700. /**
  55701. * Custom sensitivity value for the drag strength
  55702. */
  55703. sensitivity: number;
  55704. private _isEnabled;
  55705. private _parent;
  55706. private _arrow;
  55707. private _coloredMaterial;
  55708. private _hoverMaterial;
  55709. /**
  55710. * Creates an AxisScaleGizmo
  55711. * @param gizmoLayer The utility layer the gizmo will be added to
  55712. * @param dragAxis The axis which the gizmo will be able to scale on
  55713. * @param color The color of the gizmo
  55714. * @param thickness display gizmo axis thickness
  55715. */
  55716. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55717. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55718. /**
  55719. * If the gizmo is enabled
  55720. */
  55721. set isEnabled(value: boolean);
  55722. get isEnabled(): boolean;
  55723. /**
  55724. * Disposes of the gizmo
  55725. */
  55726. dispose(): void;
  55727. /**
  55728. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55729. * @param mesh The mesh to replace the default mesh of the gizmo
  55730. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55731. */
  55732. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55733. }
  55734. }
  55735. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55736. import { Observable } from "babylonjs/Misc/observable";
  55737. import { Nullable } from "babylonjs/types";
  55738. import { Vector3 } from "babylonjs/Maths/math.vector";
  55739. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55740. import { Mesh } from "babylonjs/Meshes/mesh";
  55741. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55742. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55743. import { Color3 } from "babylonjs/Maths/math.color";
  55744. import "babylonjs/Meshes/Builders/boxBuilder";
  55745. /**
  55746. * Bounding box gizmo
  55747. */
  55748. export class BoundingBoxGizmo extends Gizmo {
  55749. private _lineBoundingBox;
  55750. private _rotateSpheresParent;
  55751. private _scaleBoxesParent;
  55752. private _boundingDimensions;
  55753. private _renderObserver;
  55754. private _pointerObserver;
  55755. private _scaleDragSpeed;
  55756. private _tmpQuaternion;
  55757. private _tmpVector;
  55758. private _tmpRotationMatrix;
  55759. /**
  55760. * 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)
  55761. */
  55762. ignoreChildren: boolean;
  55763. /**
  55764. * 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)
  55765. */
  55766. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55767. /**
  55768. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55769. */
  55770. rotationSphereSize: number;
  55771. /**
  55772. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55773. */
  55774. scaleBoxSize: number;
  55775. /**
  55776. * 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)
  55777. */
  55778. fixedDragMeshScreenSize: boolean;
  55779. /**
  55780. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55781. */
  55782. fixedDragMeshScreenSizeDistanceFactor: number;
  55783. /**
  55784. * Fired when a rotation sphere or scale box is dragged
  55785. */
  55786. onDragStartObservable: Observable<{}>;
  55787. /**
  55788. * Fired when a scale box is dragged
  55789. */
  55790. onScaleBoxDragObservable: Observable<{}>;
  55791. /**
  55792. * Fired when a scale box drag is ended
  55793. */
  55794. onScaleBoxDragEndObservable: Observable<{}>;
  55795. /**
  55796. * Fired when a rotation sphere is dragged
  55797. */
  55798. onRotationSphereDragObservable: Observable<{}>;
  55799. /**
  55800. * Fired when a rotation sphere drag is ended
  55801. */
  55802. onRotationSphereDragEndObservable: Observable<{}>;
  55803. /**
  55804. * 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)
  55805. */
  55806. scalePivot: Nullable<Vector3>;
  55807. /**
  55808. * Mesh used as a pivot to rotate the attached node
  55809. */
  55810. private _anchorMesh;
  55811. private _existingMeshScale;
  55812. private _dragMesh;
  55813. private pointerDragBehavior;
  55814. private coloredMaterial;
  55815. private hoverColoredMaterial;
  55816. /**
  55817. * Sets the color of the bounding box gizmo
  55818. * @param color the color to set
  55819. */
  55820. setColor(color: Color3): void;
  55821. /**
  55822. * Creates an BoundingBoxGizmo
  55823. * @param gizmoLayer The utility layer the gizmo will be added to
  55824. * @param color The color of the gizmo
  55825. */
  55826. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55827. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55828. private _selectNode;
  55829. /**
  55830. * Updates the bounding box information for the Gizmo
  55831. */
  55832. updateBoundingBox(): void;
  55833. private _updateRotationSpheres;
  55834. private _updateScaleBoxes;
  55835. /**
  55836. * Enables rotation on the specified axis and disables rotation on the others
  55837. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55838. */
  55839. setEnabledRotationAxis(axis: string): void;
  55840. /**
  55841. * Enables/disables scaling
  55842. * @param enable if scaling should be enabled
  55843. * @param homogeneousScaling defines if scaling should only be homogeneous
  55844. */
  55845. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55846. private _updateDummy;
  55847. /**
  55848. * Enables a pointer drag behavior on the bounding box of the gizmo
  55849. */
  55850. enableDragBehavior(): void;
  55851. /**
  55852. * Disposes of the gizmo
  55853. */
  55854. dispose(): void;
  55855. /**
  55856. * 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)
  55857. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55858. * @returns the bounding box mesh with the passed in mesh as a child
  55859. */
  55860. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55861. /**
  55862. * CustomMeshes are not supported by this gizmo
  55863. * @param mesh The mesh to replace the default mesh of the gizmo
  55864. */
  55865. setCustomMesh(mesh: Mesh): void;
  55866. }
  55867. }
  55868. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55869. import { Observable } from "babylonjs/Misc/observable";
  55870. import { Nullable } from "babylonjs/types";
  55871. import { Vector3 } from "babylonjs/Maths/math.vector";
  55872. import { Color3 } from "babylonjs/Maths/math.color";
  55873. import { Node } from "babylonjs/node";
  55874. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55875. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55876. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55877. import "babylonjs/Meshes/Builders/linesBuilder";
  55878. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55879. /**
  55880. * Single plane rotation gizmo
  55881. */
  55882. export class PlaneRotationGizmo extends Gizmo {
  55883. /**
  55884. * Drag behavior responsible for the gizmos dragging interactions
  55885. */
  55886. dragBehavior: PointerDragBehavior;
  55887. private _pointerObserver;
  55888. /**
  55889. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55890. */
  55891. snapDistance: number;
  55892. /**
  55893. * Event that fires each time the gizmo snaps to a new location.
  55894. * * snapDistance is the the change in distance
  55895. */
  55896. onSnapObservable: Observable<{
  55897. snapDistance: number;
  55898. }>;
  55899. private _isEnabled;
  55900. private _parent;
  55901. /**
  55902. * Creates a PlaneRotationGizmo
  55903. * @param gizmoLayer The utility layer the gizmo will be added to
  55904. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55905. * @param color The color of the gizmo
  55906. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55907. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55908. * @param thickness display gizmo axis thickness
  55909. */
  55910. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55911. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55912. /**
  55913. * If the gizmo is enabled
  55914. */
  55915. set isEnabled(value: boolean);
  55916. get isEnabled(): boolean;
  55917. /**
  55918. * Disposes of the gizmo
  55919. */
  55920. dispose(): void;
  55921. }
  55922. }
  55923. declare module "babylonjs/Gizmos/rotationGizmo" {
  55924. import { Observable } from "babylonjs/Misc/observable";
  55925. import { Nullable } from "babylonjs/types";
  55926. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55927. import { Mesh } from "babylonjs/Meshes/mesh";
  55928. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55929. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55930. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55931. import { Node } from "babylonjs/node";
  55932. /**
  55933. * Gizmo that enables rotating a mesh along 3 axis
  55934. */
  55935. export class RotationGizmo extends Gizmo {
  55936. /**
  55937. * Internal gizmo used for interactions on the x axis
  55938. */
  55939. xGizmo: PlaneRotationGizmo;
  55940. /**
  55941. * Internal gizmo used for interactions on the y axis
  55942. */
  55943. yGizmo: PlaneRotationGizmo;
  55944. /**
  55945. * Internal gizmo used for interactions on the z axis
  55946. */
  55947. zGizmo: PlaneRotationGizmo;
  55948. /** Fires an event when any of it's sub gizmos are dragged */
  55949. onDragStartObservable: Observable<unknown>;
  55950. /** Fires an event when any of it's sub gizmos are released from dragging */
  55951. onDragEndObservable: Observable<unknown>;
  55952. private _meshAttached;
  55953. private _nodeAttached;
  55954. get attachedMesh(): Nullable<AbstractMesh>;
  55955. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55956. get attachedNode(): Nullable<Node>;
  55957. set attachedNode(node: Nullable<Node>);
  55958. /**
  55959. * Creates a RotationGizmo
  55960. * @param gizmoLayer The utility layer the gizmo will be added to
  55961. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55962. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55963. * @param thickness display gizmo axis thickness
  55964. */
  55965. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  55966. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55967. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55968. /**
  55969. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55970. */
  55971. set snapDistance(value: number);
  55972. get snapDistance(): number;
  55973. /**
  55974. * Ratio for the scale of the gizmo (Default: 1)
  55975. */
  55976. set scaleRatio(value: number);
  55977. get scaleRatio(): number;
  55978. /**
  55979. * Disposes of the gizmo
  55980. */
  55981. dispose(): void;
  55982. /**
  55983. * CustomMeshes are not supported by this gizmo
  55984. * @param mesh The mesh to replace the default mesh of the gizmo
  55985. */
  55986. setCustomMesh(mesh: Mesh): void;
  55987. }
  55988. }
  55989. declare module "babylonjs/Gizmos/gizmoManager" {
  55990. import { Observable } from "babylonjs/Misc/observable";
  55991. import { Nullable } from "babylonjs/types";
  55992. import { Scene, IDisposable } from "babylonjs/scene";
  55993. import { Node } from "babylonjs/node";
  55994. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55995. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55996. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  55997. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55998. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  55999. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56000. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56001. /**
  56002. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56003. */
  56004. export class GizmoManager implements IDisposable {
  56005. private scene;
  56006. /**
  56007. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56008. */
  56009. gizmos: {
  56010. positionGizmo: Nullable<PositionGizmo>;
  56011. rotationGizmo: Nullable<RotationGizmo>;
  56012. scaleGizmo: Nullable<ScaleGizmo>;
  56013. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56014. };
  56015. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56016. clearGizmoOnEmptyPointerEvent: boolean;
  56017. /** Fires an event when the manager is attached to a mesh */
  56018. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56019. /** Fires an event when the manager is attached to a node */
  56020. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56021. private _gizmosEnabled;
  56022. private _pointerObserver;
  56023. private _attachedMesh;
  56024. private _attachedNode;
  56025. private _boundingBoxColor;
  56026. private _defaultUtilityLayer;
  56027. private _defaultKeepDepthUtilityLayer;
  56028. private _thickness;
  56029. /**
  56030. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56031. */
  56032. boundingBoxDragBehavior: SixDofDragBehavior;
  56033. /**
  56034. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56035. */
  56036. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56037. /**
  56038. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56039. */
  56040. attachableNodes: Nullable<Array<Node>>;
  56041. /**
  56042. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56043. */
  56044. usePointerToAttachGizmos: boolean;
  56045. /**
  56046. * Utility layer that the bounding box gizmo belongs to
  56047. */
  56048. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56049. /**
  56050. * Utility layer that all gizmos besides bounding box belong to
  56051. */
  56052. get utilityLayer(): UtilityLayerRenderer;
  56053. /**
  56054. * Instatiates a gizmo manager
  56055. * @param scene the scene to overlay the gizmos on top of
  56056. * @param thickness display gizmo axis thickness
  56057. */
  56058. constructor(scene: Scene, thickness?: number);
  56059. /**
  56060. * Attaches a set of gizmos to the specified mesh
  56061. * @param mesh The mesh the gizmo's should be attached to
  56062. */
  56063. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56064. /**
  56065. * Attaches a set of gizmos to the specified node
  56066. * @param node The node the gizmo's should be attached to
  56067. */
  56068. attachToNode(node: Nullable<Node>): void;
  56069. /**
  56070. * If the position gizmo is enabled
  56071. */
  56072. set positionGizmoEnabled(value: boolean);
  56073. get positionGizmoEnabled(): boolean;
  56074. /**
  56075. * If the rotation gizmo is enabled
  56076. */
  56077. set rotationGizmoEnabled(value: boolean);
  56078. get rotationGizmoEnabled(): boolean;
  56079. /**
  56080. * If the scale gizmo is enabled
  56081. */
  56082. set scaleGizmoEnabled(value: boolean);
  56083. get scaleGizmoEnabled(): boolean;
  56084. /**
  56085. * If the boundingBox gizmo is enabled
  56086. */
  56087. set boundingBoxGizmoEnabled(value: boolean);
  56088. get boundingBoxGizmoEnabled(): boolean;
  56089. /**
  56090. * Disposes of the gizmo manager
  56091. */
  56092. dispose(): void;
  56093. }
  56094. }
  56095. declare module "babylonjs/Lights/directionalLight" {
  56096. import { Camera } from "babylonjs/Cameras/camera";
  56097. import { Scene } from "babylonjs/scene";
  56098. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56099. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56100. import { Light } from "babylonjs/Lights/light";
  56101. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56102. import { Effect } from "babylonjs/Materials/effect";
  56103. /**
  56104. * A directional light is defined by a direction (what a surprise!).
  56105. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56106. * 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.
  56107. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56108. */
  56109. export class DirectionalLight extends ShadowLight {
  56110. private _shadowFrustumSize;
  56111. /**
  56112. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56113. */
  56114. get shadowFrustumSize(): number;
  56115. /**
  56116. * Specifies a fix frustum size for the shadow generation.
  56117. */
  56118. set shadowFrustumSize(value: number);
  56119. private _shadowOrthoScale;
  56120. /**
  56121. * Gets the shadow projection scale against the optimal computed one.
  56122. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56123. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56124. */
  56125. get shadowOrthoScale(): number;
  56126. /**
  56127. * Sets the shadow projection scale against the optimal computed one.
  56128. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56129. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56130. */
  56131. set shadowOrthoScale(value: number);
  56132. /**
  56133. * Automatically compute the projection matrix to best fit (including all the casters)
  56134. * on each frame.
  56135. */
  56136. autoUpdateExtends: boolean;
  56137. /**
  56138. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56139. * on each frame. autoUpdateExtends must be set to true for this to work
  56140. */
  56141. autoCalcShadowZBounds: boolean;
  56142. private _orthoLeft;
  56143. private _orthoRight;
  56144. private _orthoTop;
  56145. private _orthoBottom;
  56146. /**
  56147. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56148. * The directional light is emitted from everywhere in the given direction.
  56149. * It can cast shadows.
  56150. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56151. * @param name The friendly name of the light
  56152. * @param direction The direction of the light
  56153. * @param scene The scene the light belongs to
  56154. */
  56155. constructor(name: string, direction: Vector3, scene: Scene);
  56156. /**
  56157. * Returns the string "DirectionalLight".
  56158. * @return The class name
  56159. */
  56160. getClassName(): string;
  56161. /**
  56162. * Returns the integer 1.
  56163. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56164. */
  56165. getTypeID(): number;
  56166. /**
  56167. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56168. * Returns the DirectionalLight Shadow projection matrix.
  56169. */
  56170. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56171. /**
  56172. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56173. * Returns the DirectionalLight Shadow projection matrix.
  56174. */
  56175. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56176. /**
  56177. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56178. * Returns the DirectionalLight Shadow projection matrix.
  56179. */
  56180. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56181. protected _buildUniformLayout(): void;
  56182. /**
  56183. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56184. * @param effect The effect to update
  56185. * @param lightIndex The index of the light in the effect to update
  56186. * @returns The directional light
  56187. */
  56188. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56189. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56190. /**
  56191. * Gets the minZ used for shadow according to both the scene and the light.
  56192. *
  56193. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56194. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56195. * @param activeCamera The camera we are returning the min for
  56196. * @returns the depth min z
  56197. */
  56198. getDepthMinZ(activeCamera: Camera): number;
  56199. /**
  56200. * Gets the maxZ used for shadow according to both the scene and the light.
  56201. *
  56202. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56203. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56204. * @param activeCamera The camera we are returning the max for
  56205. * @returns the depth max z
  56206. */
  56207. getDepthMaxZ(activeCamera: Camera): number;
  56208. /**
  56209. * Prepares the list of defines specific to the light type.
  56210. * @param defines the list of defines
  56211. * @param lightIndex defines the index of the light for the effect
  56212. */
  56213. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56214. }
  56215. }
  56216. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56217. import { Mesh } from "babylonjs/Meshes/mesh";
  56218. /**
  56219. * Class containing static functions to help procedurally build meshes
  56220. */
  56221. export class HemisphereBuilder {
  56222. /**
  56223. * Creates a hemisphere mesh
  56224. * @param name defines the name of the mesh
  56225. * @param options defines the options used to create the mesh
  56226. * @param scene defines the hosting scene
  56227. * @returns the hemisphere mesh
  56228. */
  56229. static CreateHemisphere(name: string, options: {
  56230. segments?: number;
  56231. diameter?: number;
  56232. sideOrientation?: number;
  56233. }, scene: any): Mesh;
  56234. }
  56235. }
  56236. declare module "babylonjs/Lights/spotLight" {
  56237. import { Nullable } from "babylonjs/types";
  56238. import { Scene } from "babylonjs/scene";
  56239. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56240. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56241. import { Effect } from "babylonjs/Materials/effect";
  56242. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56243. import { Light } from "babylonjs/Lights/light";
  56244. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56245. /**
  56246. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56247. * These values define a cone of light starting from the position, emitting toward the direction.
  56248. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56249. * and the exponent defines the speed of the decay of the light with distance (reach).
  56250. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56251. */
  56252. export class SpotLight extends ShadowLight {
  56253. private _angle;
  56254. private _innerAngle;
  56255. private _cosHalfAngle;
  56256. private _lightAngleScale;
  56257. private _lightAngleOffset;
  56258. /**
  56259. * Gets the cone angle of the spot light in Radians.
  56260. */
  56261. get angle(): number;
  56262. /**
  56263. * Sets the cone angle of the spot light in Radians.
  56264. */
  56265. set angle(value: number);
  56266. /**
  56267. * Only used in gltf falloff mode, this defines the angle where
  56268. * the directional falloff will start before cutting at angle which could be seen
  56269. * as outer angle.
  56270. */
  56271. get innerAngle(): number;
  56272. /**
  56273. * Only used in gltf falloff mode, this defines the angle where
  56274. * the directional falloff will start before cutting at angle which could be seen
  56275. * as outer angle.
  56276. */
  56277. set innerAngle(value: number);
  56278. private _shadowAngleScale;
  56279. /**
  56280. * Allows scaling the angle of the light for shadow generation only.
  56281. */
  56282. get shadowAngleScale(): number;
  56283. /**
  56284. * Allows scaling the angle of the light for shadow generation only.
  56285. */
  56286. set shadowAngleScale(value: number);
  56287. /**
  56288. * The light decay speed with the distance from the emission spot.
  56289. */
  56290. exponent: number;
  56291. private _projectionTextureMatrix;
  56292. /**
  56293. * Allows reading the projecton texture
  56294. */
  56295. get projectionTextureMatrix(): Matrix;
  56296. protected _projectionTextureLightNear: number;
  56297. /**
  56298. * Gets the near clip of the Spotlight for texture projection.
  56299. */
  56300. get projectionTextureLightNear(): number;
  56301. /**
  56302. * Sets the near clip of the Spotlight for texture projection.
  56303. */
  56304. set projectionTextureLightNear(value: number);
  56305. protected _projectionTextureLightFar: number;
  56306. /**
  56307. * Gets the far clip of the Spotlight for texture projection.
  56308. */
  56309. get projectionTextureLightFar(): number;
  56310. /**
  56311. * Sets the far clip of the Spotlight for texture projection.
  56312. */
  56313. set projectionTextureLightFar(value: number);
  56314. protected _projectionTextureUpDirection: Vector3;
  56315. /**
  56316. * Gets the Up vector of the Spotlight for texture projection.
  56317. */
  56318. get projectionTextureUpDirection(): Vector3;
  56319. /**
  56320. * Sets the Up vector of the Spotlight for texture projection.
  56321. */
  56322. set projectionTextureUpDirection(value: Vector3);
  56323. private _projectionTexture;
  56324. /**
  56325. * Gets the projection texture of the light.
  56326. */
  56327. get projectionTexture(): Nullable<BaseTexture>;
  56328. /**
  56329. * Sets the projection texture of the light.
  56330. */
  56331. set projectionTexture(value: Nullable<BaseTexture>);
  56332. private _projectionTextureViewLightDirty;
  56333. private _projectionTextureProjectionLightDirty;
  56334. private _projectionTextureDirty;
  56335. private _projectionTextureViewTargetVector;
  56336. private _projectionTextureViewLightMatrix;
  56337. private _projectionTextureProjectionLightMatrix;
  56338. private _projectionTextureScalingMatrix;
  56339. /**
  56340. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56341. * It can cast shadows.
  56342. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56343. * @param name The light friendly name
  56344. * @param position The position of the spot light in the scene
  56345. * @param direction The direction of the light in the scene
  56346. * @param angle The cone angle of the light in Radians
  56347. * @param exponent The light decay speed with the distance from the emission spot
  56348. * @param scene The scene the lights belongs to
  56349. */
  56350. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56351. /**
  56352. * Returns the string "SpotLight".
  56353. * @returns the class name
  56354. */
  56355. getClassName(): string;
  56356. /**
  56357. * Returns the integer 2.
  56358. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56359. */
  56360. getTypeID(): number;
  56361. /**
  56362. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56363. */
  56364. protected _setDirection(value: Vector3): void;
  56365. /**
  56366. * Overrides the position setter to recompute the projection texture view light Matrix.
  56367. */
  56368. protected _setPosition(value: Vector3): void;
  56369. /**
  56370. * 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.
  56371. * Returns the SpotLight.
  56372. */
  56373. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56374. protected _computeProjectionTextureViewLightMatrix(): void;
  56375. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56376. /**
  56377. * Main function for light texture projection matrix computing.
  56378. */
  56379. protected _computeProjectionTextureMatrix(): void;
  56380. protected _buildUniformLayout(): void;
  56381. private _computeAngleValues;
  56382. /**
  56383. * Sets the passed Effect "effect" with the Light textures.
  56384. * @param effect The effect to update
  56385. * @param lightIndex The index of the light in the effect to update
  56386. * @returns The light
  56387. */
  56388. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56389. /**
  56390. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56391. * @param effect The effect to update
  56392. * @param lightIndex The index of the light in the effect to update
  56393. * @returns The spot light
  56394. */
  56395. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56396. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56397. /**
  56398. * Disposes the light and the associated resources.
  56399. */
  56400. dispose(): void;
  56401. /**
  56402. * Prepares the list of defines specific to the light type.
  56403. * @param defines the list of defines
  56404. * @param lightIndex defines the index of the light for the effect
  56405. */
  56406. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56407. }
  56408. }
  56409. declare module "babylonjs/Gizmos/lightGizmo" {
  56410. import { Nullable } from "babylonjs/types";
  56411. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56412. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56413. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56414. import { Light } from "babylonjs/Lights/light";
  56415. /**
  56416. * Gizmo that enables viewing a light
  56417. */
  56418. export class LightGizmo extends Gizmo {
  56419. private _lightMesh;
  56420. private _material;
  56421. private _cachedPosition;
  56422. private _cachedForward;
  56423. private _attachedMeshParent;
  56424. /**
  56425. * Creates a LightGizmo
  56426. * @param gizmoLayer The utility layer the gizmo will be added to
  56427. */
  56428. constructor(gizmoLayer?: UtilityLayerRenderer);
  56429. private _light;
  56430. /**
  56431. * The light that the gizmo is attached to
  56432. */
  56433. set light(light: Nullable<Light>);
  56434. get light(): Nullable<Light>;
  56435. /**
  56436. * Gets the material used to render the light gizmo
  56437. */
  56438. get material(): StandardMaterial;
  56439. /**
  56440. * @hidden
  56441. * Updates the gizmo to match the attached mesh's position/rotation
  56442. */
  56443. protected _update(): void;
  56444. private static _Scale;
  56445. /**
  56446. * Creates the lines for a light mesh
  56447. */
  56448. private static _CreateLightLines;
  56449. /**
  56450. * Disposes of the light gizmo
  56451. */
  56452. dispose(): void;
  56453. private static _CreateHemisphericLightMesh;
  56454. private static _CreatePointLightMesh;
  56455. private static _CreateSpotLightMesh;
  56456. private static _CreateDirectionalLightMesh;
  56457. }
  56458. }
  56459. declare module "babylonjs/Gizmos/cameraGizmo" {
  56460. import { Nullable } from "babylonjs/types";
  56461. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56462. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56463. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56464. import { Camera } from "babylonjs/Cameras/camera";
  56465. /**
  56466. * Gizmo that enables viewing a camera
  56467. */
  56468. export class CameraGizmo extends Gizmo {
  56469. private _cameraMesh;
  56470. private _cameraLinesMesh;
  56471. private _material;
  56472. /**
  56473. * Creates a CameraGizmo
  56474. * @param gizmoLayer The utility layer the gizmo will be added to
  56475. */
  56476. constructor(gizmoLayer?: UtilityLayerRenderer);
  56477. private _camera;
  56478. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56479. get displayFrustum(): boolean;
  56480. set displayFrustum(value: boolean);
  56481. /**
  56482. * The camera that the gizmo is attached to
  56483. */
  56484. set camera(camera: Nullable<Camera>);
  56485. get camera(): Nullable<Camera>;
  56486. /**
  56487. * Gets the material used to render the camera gizmo
  56488. */
  56489. get material(): StandardMaterial;
  56490. /**
  56491. * @hidden
  56492. * Updates the gizmo to match the attached mesh's position/rotation
  56493. */
  56494. protected _update(): void;
  56495. private static _Scale;
  56496. private _invProjection;
  56497. /**
  56498. * Disposes of the camera gizmo
  56499. */
  56500. dispose(): void;
  56501. private static _CreateCameraMesh;
  56502. private static _CreateCameraFrustum;
  56503. }
  56504. }
  56505. declare module "babylonjs/Gizmos/index" {
  56506. export * from "babylonjs/Gizmos/axisDragGizmo";
  56507. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56508. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56509. export * from "babylonjs/Gizmos/gizmo";
  56510. export * from "babylonjs/Gizmos/gizmoManager";
  56511. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56512. export * from "babylonjs/Gizmos/positionGizmo";
  56513. export * from "babylonjs/Gizmos/rotationGizmo";
  56514. export * from "babylonjs/Gizmos/scaleGizmo";
  56515. export * from "babylonjs/Gizmos/lightGizmo";
  56516. export * from "babylonjs/Gizmos/cameraGizmo";
  56517. export * from "babylonjs/Gizmos/planeDragGizmo";
  56518. }
  56519. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56520. /** @hidden */
  56521. export var backgroundFragmentDeclaration: {
  56522. name: string;
  56523. shader: string;
  56524. };
  56525. }
  56526. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56527. /** @hidden */
  56528. export var backgroundUboDeclaration: {
  56529. name: string;
  56530. shader: string;
  56531. };
  56532. }
  56533. declare module "babylonjs/Shaders/background.fragment" {
  56534. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56535. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56536. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56537. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56538. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56539. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56540. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56541. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56542. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56543. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56544. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56545. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56546. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56547. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56548. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56549. /** @hidden */
  56550. export var backgroundPixelShader: {
  56551. name: string;
  56552. shader: string;
  56553. };
  56554. }
  56555. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56556. /** @hidden */
  56557. export var backgroundVertexDeclaration: {
  56558. name: string;
  56559. shader: string;
  56560. };
  56561. }
  56562. declare module "babylonjs/Shaders/background.vertex" {
  56563. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56564. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56565. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56566. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56567. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56568. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56569. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56570. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56571. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56572. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56573. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56574. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56575. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56576. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56577. /** @hidden */
  56578. export var backgroundVertexShader: {
  56579. name: string;
  56580. shader: string;
  56581. };
  56582. }
  56583. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56584. import { Nullable, int, float } from "babylonjs/types";
  56585. import { Scene } from "babylonjs/scene";
  56586. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56587. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56588. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56589. import { Mesh } from "babylonjs/Meshes/mesh";
  56590. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56591. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56592. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56593. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56594. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56595. import { Color3 } from "babylonjs/Maths/math.color";
  56596. import "babylonjs/Shaders/background.fragment";
  56597. import "babylonjs/Shaders/background.vertex";
  56598. /**
  56599. * Background material used to create an efficient environement around your scene.
  56600. */
  56601. export class BackgroundMaterial extends PushMaterial {
  56602. /**
  56603. * Standard reflectance value at parallel view angle.
  56604. */
  56605. static StandardReflectance0: number;
  56606. /**
  56607. * Standard reflectance value at grazing angle.
  56608. */
  56609. static StandardReflectance90: number;
  56610. protected _primaryColor: Color3;
  56611. /**
  56612. * Key light Color (multiply against the environement texture)
  56613. */
  56614. primaryColor: Color3;
  56615. protected __perceptualColor: Nullable<Color3>;
  56616. /**
  56617. * Experimental Internal Use Only.
  56618. *
  56619. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56620. * This acts as a helper to set the primary color to a more "human friendly" value.
  56621. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56622. * output color as close as possible from the chosen value.
  56623. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56624. * part of lighting setup.)
  56625. */
  56626. get _perceptualColor(): Nullable<Color3>;
  56627. set _perceptualColor(value: Nullable<Color3>);
  56628. protected _primaryColorShadowLevel: float;
  56629. /**
  56630. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56631. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56632. */
  56633. get primaryColorShadowLevel(): float;
  56634. set primaryColorShadowLevel(value: float);
  56635. protected _primaryColorHighlightLevel: float;
  56636. /**
  56637. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56638. * The primary color is used at the level chosen to define what the white area would look.
  56639. */
  56640. get primaryColorHighlightLevel(): float;
  56641. set primaryColorHighlightLevel(value: float);
  56642. protected _reflectionTexture: Nullable<BaseTexture>;
  56643. /**
  56644. * Reflection Texture used in the material.
  56645. * Should be author in a specific way for the best result (refer to the documentation).
  56646. */
  56647. reflectionTexture: Nullable<BaseTexture>;
  56648. protected _reflectionBlur: float;
  56649. /**
  56650. * Reflection Texture level of blur.
  56651. *
  56652. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56653. * texture twice.
  56654. */
  56655. reflectionBlur: float;
  56656. protected _diffuseTexture: Nullable<BaseTexture>;
  56657. /**
  56658. * Diffuse Texture used in the material.
  56659. * Should be author in a specific way for the best result (refer to the documentation).
  56660. */
  56661. diffuseTexture: Nullable<BaseTexture>;
  56662. protected _shadowLights: Nullable<IShadowLight[]>;
  56663. /**
  56664. * Specify the list of lights casting shadow on the material.
  56665. * All scene shadow lights will be included if null.
  56666. */
  56667. shadowLights: Nullable<IShadowLight[]>;
  56668. protected _shadowLevel: float;
  56669. /**
  56670. * Helps adjusting the shadow to a softer level if required.
  56671. * 0 means black shadows and 1 means no shadows.
  56672. */
  56673. shadowLevel: float;
  56674. protected _sceneCenter: Vector3;
  56675. /**
  56676. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56677. * It is usually zero but might be interesting to modify according to your setup.
  56678. */
  56679. sceneCenter: Vector3;
  56680. protected _opacityFresnel: boolean;
  56681. /**
  56682. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56683. * This helps ensuring a nice transition when the camera goes under the ground.
  56684. */
  56685. opacityFresnel: boolean;
  56686. protected _reflectionFresnel: boolean;
  56687. /**
  56688. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56689. * This helps adding a mirror texture on the ground.
  56690. */
  56691. reflectionFresnel: boolean;
  56692. protected _reflectionFalloffDistance: number;
  56693. /**
  56694. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56695. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56696. */
  56697. reflectionFalloffDistance: number;
  56698. protected _reflectionAmount: number;
  56699. /**
  56700. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56701. */
  56702. reflectionAmount: number;
  56703. protected _reflectionReflectance0: number;
  56704. /**
  56705. * This specifies the weight of the reflection at grazing angle.
  56706. */
  56707. reflectionReflectance0: number;
  56708. protected _reflectionReflectance90: number;
  56709. /**
  56710. * This specifies the weight of the reflection at a perpendicular point of view.
  56711. */
  56712. reflectionReflectance90: number;
  56713. /**
  56714. * Sets the reflection reflectance fresnel values according to the default standard
  56715. * empirically know to work well :-)
  56716. */
  56717. set reflectionStandardFresnelWeight(value: number);
  56718. protected _useRGBColor: boolean;
  56719. /**
  56720. * Helps to directly use the maps channels instead of their level.
  56721. */
  56722. useRGBColor: boolean;
  56723. protected _enableNoise: boolean;
  56724. /**
  56725. * This helps reducing the banding effect that could occur on the background.
  56726. */
  56727. enableNoise: boolean;
  56728. /**
  56729. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56730. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56731. * Recommended to be keep at 1.0 except for special cases.
  56732. */
  56733. get fovMultiplier(): number;
  56734. set fovMultiplier(value: number);
  56735. private _fovMultiplier;
  56736. /**
  56737. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56738. */
  56739. useEquirectangularFOV: boolean;
  56740. private _maxSimultaneousLights;
  56741. /**
  56742. * Number of Simultaneous lights allowed on the material.
  56743. */
  56744. maxSimultaneousLights: int;
  56745. private _shadowOnly;
  56746. /**
  56747. * Make the material only render shadows
  56748. */
  56749. shadowOnly: boolean;
  56750. /**
  56751. * Default configuration related to image processing available in the Background Material.
  56752. */
  56753. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56754. /**
  56755. * Keep track of the image processing observer to allow dispose and replace.
  56756. */
  56757. private _imageProcessingObserver;
  56758. /**
  56759. * Attaches a new image processing configuration to the PBR Material.
  56760. * @param configuration (if null the scene configuration will be use)
  56761. */
  56762. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56763. /**
  56764. * Gets the image processing configuration used either in this material.
  56765. */
  56766. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56767. /**
  56768. * Sets the Default image processing configuration used either in the this material.
  56769. *
  56770. * If sets to null, the scene one is in use.
  56771. */
  56772. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56773. /**
  56774. * Gets wether the color curves effect is enabled.
  56775. */
  56776. get cameraColorCurvesEnabled(): boolean;
  56777. /**
  56778. * Sets wether the color curves effect is enabled.
  56779. */
  56780. set cameraColorCurvesEnabled(value: boolean);
  56781. /**
  56782. * Gets wether the color grading effect is enabled.
  56783. */
  56784. get cameraColorGradingEnabled(): boolean;
  56785. /**
  56786. * Gets wether the color grading effect is enabled.
  56787. */
  56788. set cameraColorGradingEnabled(value: boolean);
  56789. /**
  56790. * Gets wether tonemapping is enabled or not.
  56791. */
  56792. get cameraToneMappingEnabled(): boolean;
  56793. /**
  56794. * Sets wether tonemapping is enabled or not
  56795. */
  56796. set cameraToneMappingEnabled(value: boolean);
  56797. /**
  56798. * The camera exposure used on this material.
  56799. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56800. * This corresponds to a photographic exposure.
  56801. */
  56802. get cameraExposure(): float;
  56803. /**
  56804. * The camera exposure used on this material.
  56805. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56806. * This corresponds to a photographic exposure.
  56807. */
  56808. set cameraExposure(value: float);
  56809. /**
  56810. * Gets The camera contrast used on this material.
  56811. */
  56812. get cameraContrast(): float;
  56813. /**
  56814. * Sets The camera contrast used on this material.
  56815. */
  56816. set cameraContrast(value: float);
  56817. /**
  56818. * Gets the Color Grading 2D Lookup Texture.
  56819. */
  56820. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56821. /**
  56822. * Sets the Color Grading 2D Lookup Texture.
  56823. */
  56824. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56825. /**
  56826. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56827. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56828. * 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;
  56829. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56830. */
  56831. get cameraColorCurves(): Nullable<ColorCurves>;
  56832. /**
  56833. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56834. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56835. * 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;
  56836. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56837. */
  56838. set cameraColorCurves(value: Nullable<ColorCurves>);
  56839. /**
  56840. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56841. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56842. */
  56843. switchToBGR: boolean;
  56844. private _renderTargets;
  56845. private _reflectionControls;
  56846. private _white;
  56847. private _primaryShadowColor;
  56848. private _primaryHighlightColor;
  56849. /**
  56850. * Instantiates a Background Material in the given scene
  56851. * @param name The friendly name of the material
  56852. * @param scene The scene to add the material to
  56853. */
  56854. constructor(name: string, scene: Scene);
  56855. /**
  56856. * Gets a boolean indicating that current material needs to register RTT
  56857. */
  56858. get hasRenderTargetTextures(): boolean;
  56859. /**
  56860. * The entire material has been created in order to prevent overdraw.
  56861. * @returns false
  56862. */
  56863. needAlphaTesting(): boolean;
  56864. /**
  56865. * The entire material has been created in order to prevent overdraw.
  56866. * @returns true if blending is enable
  56867. */
  56868. needAlphaBlending(): boolean;
  56869. /**
  56870. * Checks wether the material is ready to be rendered for a given mesh.
  56871. * @param mesh The mesh to render
  56872. * @param subMesh The submesh to check against
  56873. * @param useInstances Specify wether or not the material is used with instances
  56874. * @returns true if all the dependencies are ready (Textures, Effects...)
  56875. */
  56876. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56877. /**
  56878. * Compute the primary color according to the chosen perceptual color.
  56879. */
  56880. private _computePrimaryColorFromPerceptualColor;
  56881. /**
  56882. * Compute the highlights and shadow colors according to their chosen levels.
  56883. */
  56884. private _computePrimaryColors;
  56885. /**
  56886. * Build the uniform buffer used in the material.
  56887. */
  56888. buildUniformLayout(): void;
  56889. /**
  56890. * Unbind the material.
  56891. */
  56892. unbind(): void;
  56893. /**
  56894. * Bind only the world matrix to the material.
  56895. * @param world The world matrix to bind.
  56896. */
  56897. bindOnlyWorldMatrix(world: Matrix): void;
  56898. /**
  56899. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56900. * @param world The world matrix to bind.
  56901. * @param subMesh The submesh to bind for.
  56902. */
  56903. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56904. /**
  56905. * Checks to see if a texture is used in the material.
  56906. * @param texture - Base texture to use.
  56907. * @returns - Boolean specifying if a texture is used in the material.
  56908. */
  56909. hasTexture(texture: BaseTexture): boolean;
  56910. /**
  56911. * Dispose the material.
  56912. * @param forceDisposeEffect Force disposal of the associated effect.
  56913. * @param forceDisposeTextures Force disposal of the associated textures.
  56914. */
  56915. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56916. /**
  56917. * Clones the material.
  56918. * @param name The cloned name.
  56919. * @returns The cloned material.
  56920. */
  56921. clone(name: string): BackgroundMaterial;
  56922. /**
  56923. * Serializes the current material to its JSON representation.
  56924. * @returns The JSON representation.
  56925. */
  56926. serialize(): any;
  56927. /**
  56928. * Gets the class name of the material
  56929. * @returns "BackgroundMaterial"
  56930. */
  56931. getClassName(): string;
  56932. /**
  56933. * Parse a JSON input to create back a background material.
  56934. * @param source The JSON data to parse
  56935. * @param scene The scene to create the parsed material in
  56936. * @param rootUrl The root url of the assets the material depends upon
  56937. * @returns the instantiated BackgroundMaterial.
  56938. */
  56939. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56940. }
  56941. }
  56942. declare module "babylonjs/Helpers/environmentHelper" {
  56943. import { Observable } from "babylonjs/Misc/observable";
  56944. import { Nullable } from "babylonjs/types";
  56945. import { Scene } from "babylonjs/scene";
  56946. import { Vector3 } from "babylonjs/Maths/math.vector";
  56947. import { Color3 } from "babylonjs/Maths/math.color";
  56948. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56949. import { Mesh } from "babylonjs/Meshes/mesh";
  56950. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56951. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  56952. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56953. import "babylonjs/Meshes/Builders/planeBuilder";
  56954. import "babylonjs/Meshes/Builders/boxBuilder";
  56955. /**
  56956. * Represents the different options available during the creation of
  56957. * a Environment helper.
  56958. *
  56959. * This can control the default ground, skybox and image processing setup of your scene.
  56960. */
  56961. export interface IEnvironmentHelperOptions {
  56962. /**
  56963. * Specifies whether or not to create a ground.
  56964. * True by default.
  56965. */
  56966. createGround: boolean;
  56967. /**
  56968. * Specifies the ground size.
  56969. * 15 by default.
  56970. */
  56971. groundSize: number;
  56972. /**
  56973. * The texture used on the ground for the main color.
  56974. * Comes from the BabylonJS CDN by default.
  56975. *
  56976. * Remarks: Can be either a texture or a url.
  56977. */
  56978. groundTexture: string | BaseTexture;
  56979. /**
  56980. * The color mixed in the ground texture by default.
  56981. * BabylonJS clearColor by default.
  56982. */
  56983. groundColor: Color3;
  56984. /**
  56985. * Specifies the ground opacity.
  56986. * 1 by default.
  56987. */
  56988. groundOpacity: number;
  56989. /**
  56990. * Enables the ground to receive shadows.
  56991. * True by default.
  56992. */
  56993. enableGroundShadow: boolean;
  56994. /**
  56995. * Helps preventing the shadow to be fully black on the ground.
  56996. * 0.5 by default.
  56997. */
  56998. groundShadowLevel: number;
  56999. /**
  57000. * Creates a mirror texture attach to the ground.
  57001. * false by default.
  57002. */
  57003. enableGroundMirror: boolean;
  57004. /**
  57005. * Specifies the ground mirror size ratio.
  57006. * 0.3 by default as the default kernel is 64.
  57007. */
  57008. groundMirrorSizeRatio: number;
  57009. /**
  57010. * Specifies the ground mirror blur kernel size.
  57011. * 64 by default.
  57012. */
  57013. groundMirrorBlurKernel: number;
  57014. /**
  57015. * Specifies the ground mirror visibility amount.
  57016. * 1 by default
  57017. */
  57018. groundMirrorAmount: number;
  57019. /**
  57020. * Specifies the ground mirror reflectance weight.
  57021. * This uses the standard weight of the background material to setup the fresnel effect
  57022. * of the mirror.
  57023. * 1 by default.
  57024. */
  57025. groundMirrorFresnelWeight: number;
  57026. /**
  57027. * Specifies the ground mirror Falloff distance.
  57028. * This can helps reducing the size of the reflection.
  57029. * 0 by Default.
  57030. */
  57031. groundMirrorFallOffDistance: number;
  57032. /**
  57033. * Specifies the ground mirror texture type.
  57034. * Unsigned Int by Default.
  57035. */
  57036. groundMirrorTextureType: number;
  57037. /**
  57038. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57039. * the shown objects.
  57040. */
  57041. groundYBias: number;
  57042. /**
  57043. * Specifies whether or not to create a skybox.
  57044. * True by default.
  57045. */
  57046. createSkybox: boolean;
  57047. /**
  57048. * Specifies the skybox size.
  57049. * 20 by default.
  57050. */
  57051. skyboxSize: number;
  57052. /**
  57053. * The texture used on the skybox for the main color.
  57054. * Comes from the BabylonJS CDN by default.
  57055. *
  57056. * Remarks: Can be either a texture or a url.
  57057. */
  57058. skyboxTexture: string | BaseTexture;
  57059. /**
  57060. * The color mixed in the skybox texture by default.
  57061. * BabylonJS clearColor by default.
  57062. */
  57063. skyboxColor: Color3;
  57064. /**
  57065. * The background rotation around the Y axis of the scene.
  57066. * This helps aligning the key lights of your scene with the background.
  57067. * 0 by default.
  57068. */
  57069. backgroundYRotation: number;
  57070. /**
  57071. * Compute automatically the size of the elements to best fit with the scene.
  57072. */
  57073. sizeAuto: boolean;
  57074. /**
  57075. * Default position of the rootMesh if autoSize is not true.
  57076. */
  57077. rootPosition: Vector3;
  57078. /**
  57079. * Sets up the image processing in the scene.
  57080. * true by default.
  57081. */
  57082. setupImageProcessing: boolean;
  57083. /**
  57084. * The texture used as your environment texture in the scene.
  57085. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57086. *
  57087. * Remarks: Can be either a texture or a url.
  57088. */
  57089. environmentTexture: string | BaseTexture;
  57090. /**
  57091. * The value of the exposure to apply to the scene.
  57092. * 0.6 by default if setupImageProcessing is true.
  57093. */
  57094. cameraExposure: number;
  57095. /**
  57096. * The value of the contrast to apply to the scene.
  57097. * 1.6 by default if setupImageProcessing is true.
  57098. */
  57099. cameraContrast: number;
  57100. /**
  57101. * Specifies whether or not tonemapping should be enabled in the scene.
  57102. * true by default if setupImageProcessing is true.
  57103. */
  57104. toneMappingEnabled: boolean;
  57105. }
  57106. /**
  57107. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57108. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57109. * It also helps with the default setup of your imageProcessing configuration.
  57110. */
  57111. export class EnvironmentHelper {
  57112. /**
  57113. * Default ground texture URL.
  57114. */
  57115. private static _groundTextureCDNUrl;
  57116. /**
  57117. * Default skybox texture URL.
  57118. */
  57119. private static _skyboxTextureCDNUrl;
  57120. /**
  57121. * Default environment texture URL.
  57122. */
  57123. private static _environmentTextureCDNUrl;
  57124. /**
  57125. * Creates the default options for the helper.
  57126. */
  57127. private static _getDefaultOptions;
  57128. private _rootMesh;
  57129. /**
  57130. * Gets the root mesh created by the helper.
  57131. */
  57132. get rootMesh(): Mesh;
  57133. private _skybox;
  57134. /**
  57135. * Gets the skybox created by the helper.
  57136. */
  57137. get skybox(): Nullable<Mesh>;
  57138. private _skyboxTexture;
  57139. /**
  57140. * Gets the skybox texture created by the helper.
  57141. */
  57142. get skyboxTexture(): Nullable<BaseTexture>;
  57143. private _skyboxMaterial;
  57144. /**
  57145. * Gets the skybox material created by the helper.
  57146. */
  57147. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57148. private _ground;
  57149. /**
  57150. * Gets the ground mesh created by the helper.
  57151. */
  57152. get ground(): Nullable<Mesh>;
  57153. private _groundTexture;
  57154. /**
  57155. * Gets the ground texture created by the helper.
  57156. */
  57157. get groundTexture(): Nullable<BaseTexture>;
  57158. private _groundMirror;
  57159. /**
  57160. * Gets the ground mirror created by the helper.
  57161. */
  57162. get groundMirror(): Nullable<MirrorTexture>;
  57163. /**
  57164. * Gets the ground mirror render list to helps pushing the meshes
  57165. * you wish in the ground reflection.
  57166. */
  57167. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57168. private _groundMaterial;
  57169. /**
  57170. * Gets the ground material created by the helper.
  57171. */
  57172. get groundMaterial(): Nullable<BackgroundMaterial>;
  57173. /**
  57174. * Stores the creation options.
  57175. */
  57176. private readonly _scene;
  57177. private _options;
  57178. /**
  57179. * This observable will be notified with any error during the creation of the environment,
  57180. * mainly texture creation errors.
  57181. */
  57182. onErrorObservable: Observable<{
  57183. message?: string;
  57184. exception?: any;
  57185. }>;
  57186. /**
  57187. * constructor
  57188. * @param options Defines the options we want to customize the helper
  57189. * @param scene The scene to add the material to
  57190. */
  57191. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57192. /**
  57193. * Updates the background according to the new options
  57194. * @param options
  57195. */
  57196. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57197. /**
  57198. * Sets the primary color of all the available elements.
  57199. * @param color the main color to affect to the ground and the background
  57200. */
  57201. setMainColor(color: Color3): void;
  57202. /**
  57203. * Setup the image processing according to the specified options.
  57204. */
  57205. private _setupImageProcessing;
  57206. /**
  57207. * Setup the environment texture according to the specified options.
  57208. */
  57209. private _setupEnvironmentTexture;
  57210. /**
  57211. * Setup the background according to the specified options.
  57212. */
  57213. private _setupBackground;
  57214. /**
  57215. * Get the scene sizes according to the setup.
  57216. */
  57217. private _getSceneSize;
  57218. /**
  57219. * Setup the ground according to the specified options.
  57220. */
  57221. private _setupGround;
  57222. /**
  57223. * Setup the ground material according to the specified options.
  57224. */
  57225. private _setupGroundMaterial;
  57226. /**
  57227. * Setup the ground diffuse texture according to the specified options.
  57228. */
  57229. private _setupGroundDiffuseTexture;
  57230. /**
  57231. * Setup the ground mirror texture according to the specified options.
  57232. */
  57233. private _setupGroundMirrorTexture;
  57234. /**
  57235. * Setup the ground to receive the mirror texture.
  57236. */
  57237. private _setupMirrorInGroundMaterial;
  57238. /**
  57239. * Setup the skybox according to the specified options.
  57240. */
  57241. private _setupSkybox;
  57242. /**
  57243. * Setup the skybox material according to the specified options.
  57244. */
  57245. private _setupSkyboxMaterial;
  57246. /**
  57247. * Setup the skybox reflection texture according to the specified options.
  57248. */
  57249. private _setupSkyboxReflectionTexture;
  57250. private _errorHandler;
  57251. /**
  57252. * Dispose all the elements created by the Helper.
  57253. */
  57254. dispose(): void;
  57255. }
  57256. }
  57257. declare module "babylonjs/Helpers/photoDome" {
  57258. import { Observable } from "babylonjs/Misc/observable";
  57259. import { Nullable } from "babylonjs/types";
  57260. import { Scene } from "babylonjs/scene";
  57261. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57262. import { Mesh } from "babylonjs/Meshes/mesh";
  57263. import { Texture } from "babylonjs/Materials/Textures/texture";
  57264. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57265. import "babylonjs/Meshes/Builders/sphereBuilder";
  57266. /**
  57267. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57268. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57269. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57270. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57271. */
  57272. export class PhotoDome extends TransformNode {
  57273. /**
  57274. * Define the image as a Monoscopic panoramic 360 image.
  57275. */
  57276. static readonly MODE_MONOSCOPIC: number;
  57277. /**
  57278. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57279. */
  57280. static readonly MODE_TOPBOTTOM: number;
  57281. /**
  57282. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57283. */
  57284. static readonly MODE_SIDEBYSIDE: number;
  57285. private _useDirectMapping;
  57286. /**
  57287. * The texture being displayed on the sphere
  57288. */
  57289. protected _photoTexture: Texture;
  57290. /**
  57291. * Gets or sets the texture being displayed on the sphere
  57292. */
  57293. get photoTexture(): Texture;
  57294. set photoTexture(value: Texture);
  57295. /**
  57296. * Observable raised when an error occured while loading the 360 image
  57297. */
  57298. onLoadErrorObservable: Observable<string>;
  57299. /**
  57300. * The skybox material
  57301. */
  57302. protected _material: BackgroundMaterial;
  57303. /**
  57304. * The surface used for the skybox
  57305. */
  57306. protected _mesh: Mesh;
  57307. /**
  57308. * Gets the mesh used for the skybox.
  57309. */
  57310. get mesh(): Mesh;
  57311. /**
  57312. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57313. * Also see the options.resolution property.
  57314. */
  57315. get fovMultiplier(): number;
  57316. set fovMultiplier(value: number);
  57317. private _imageMode;
  57318. /**
  57319. * Gets or set the current video mode for the video. It can be:
  57320. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  57321. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57322. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57323. */
  57324. get imageMode(): number;
  57325. set imageMode(value: number);
  57326. /**
  57327. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  57328. * @param name Element's name, child elements will append suffixes for their own names.
  57329. * @param urlsOfPhoto defines the url of the photo to display
  57330. * @param options defines an object containing optional or exposed sub element properties
  57331. * @param onError defines a callback called when an error occured while loading the texture
  57332. */
  57333. constructor(name: string, urlOfPhoto: string, options: {
  57334. resolution?: number;
  57335. size?: number;
  57336. useDirectMapping?: boolean;
  57337. faceForward?: boolean;
  57338. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57339. private _onBeforeCameraRenderObserver;
  57340. private _changeImageMode;
  57341. /**
  57342. * Releases resources associated with this node.
  57343. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57344. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57345. */
  57346. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57347. }
  57348. }
  57349. declare module "babylonjs/Misc/rgbdTextureTools" {
  57350. import "babylonjs/Shaders/rgbdDecode.fragment";
  57351. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57352. import { Texture } from "babylonjs/Materials/Textures/texture";
  57353. /**
  57354. * Class used to host RGBD texture specific utilities
  57355. */
  57356. export class RGBDTextureTools {
  57357. /**
  57358. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57359. * @param texture the texture to expand.
  57360. */
  57361. static ExpandRGBDTexture(texture: Texture): void;
  57362. }
  57363. }
  57364. declare module "babylonjs/Misc/brdfTextureTools" {
  57365. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57366. import { Scene } from "babylonjs/scene";
  57367. /**
  57368. * Class used to host texture specific utilities
  57369. */
  57370. export class BRDFTextureTools {
  57371. /**
  57372. * Prevents texture cache collision
  57373. */
  57374. private static _instanceNumber;
  57375. /**
  57376. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57377. * @param scene defines the hosting scene
  57378. * @returns the environment BRDF texture
  57379. */
  57380. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57381. private static _environmentBRDFBase64Texture;
  57382. }
  57383. }
  57384. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57385. import { Nullable } from "babylonjs/types";
  57386. import { Color3 } from "babylonjs/Maths/math.color";
  57387. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57388. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57389. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57390. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57391. import { Engine } from "babylonjs/Engines/engine";
  57392. import { Scene } from "babylonjs/scene";
  57393. /**
  57394. * @hidden
  57395. */
  57396. export interface IMaterialClearCoatDefines {
  57397. CLEARCOAT: boolean;
  57398. CLEARCOAT_DEFAULTIOR: boolean;
  57399. CLEARCOAT_TEXTURE: boolean;
  57400. CLEARCOAT_TEXTUREDIRECTUV: number;
  57401. CLEARCOAT_BUMP: boolean;
  57402. CLEARCOAT_BUMPDIRECTUV: number;
  57403. CLEARCOAT_TINT: boolean;
  57404. CLEARCOAT_TINT_TEXTURE: boolean;
  57405. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57406. /** @hidden */
  57407. _areTexturesDirty: boolean;
  57408. }
  57409. /**
  57410. * Define the code related to the clear coat parameters of the pbr material.
  57411. */
  57412. export class PBRClearCoatConfiguration {
  57413. /**
  57414. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57415. * The default fits with a polyurethane material.
  57416. */
  57417. private static readonly _DefaultIndexOfRefraction;
  57418. private _isEnabled;
  57419. /**
  57420. * Defines if the clear coat is enabled in the material.
  57421. */
  57422. isEnabled: boolean;
  57423. /**
  57424. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57425. */
  57426. intensity: number;
  57427. /**
  57428. * Defines the clear coat layer roughness.
  57429. */
  57430. roughness: number;
  57431. private _indexOfRefraction;
  57432. /**
  57433. * Defines the index of refraction of the clear coat.
  57434. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57435. * The default fits with a polyurethane material.
  57436. * Changing the default value is more performance intensive.
  57437. */
  57438. indexOfRefraction: number;
  57439. private _texture;
  57440. /**
  57441. * Stores the clear coat values in a texture.
  57442. */
  57443. texture: Nullable<BaseTexture>;
  57444. private _bumpTexture;
  57445. /**
  57446. * Define the clear coat specific bump texture.
  57447. */
  57448. bumpTexture: Nullable<BaseTexture>;
  57449. private _isTintEnabled;
  57450. /**
  57451. * Defines if the clear coat tint is enabled in the material.
  57452. */
  57453. isTintEnabled: boolean;
  57454. /**
  57455. * Defines the clear coat tint of the material.
  57456. * This is only use if tint is enabled
  57457. */
  57458. tintColor: Color3;
  57459. /**
  57460. * Defines the distance at which the tint color should be found in the
  57461. * clear coat media.
  57462. * This is only use if tint is enabled
  57463. */
  57464. tintColorAtDistance: number;
  57465. /**
  57466. * Defines the clear coat layer thickness.
  57467. * This is only use if tint is enabled
  57468. */
  57469. tintThickness: number;
  57470. private _tintTexture;
  57471. /**
  57472. * Stores the clear tint values in a texture.
  57473. * rgb is tint
  57474. * a is a thickness factor
  57475. */
  57476. tintTexture: Nullable<BaseTexture>;
  57477. /** @hidden */
  57478. private _internalMarkAllSubMeshesAsTexturesDirty;
  57479. /** @hidden */
  57480. _markAllSubMeshesAsTexturesDirty(): void;
  57481. /**
  57482. * Instantiate a new istance of clear coat configuration.
  57483. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57484. */
  57485. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57486. /**
  57487. * Gets wehter the submesh is ready to be used or not.
  57488. * @param defines the list of "defines" to update.
  57489. * @param scene defines the scene the material belongs to.
  57490. * @param engine defines the engine the material belongs to.
  57491. * @param disableBumpMap defines wether the material disables bump or not.
  57492. * @returns - boolean indicating that the submesh is ready or not.
  57493. */
  57494. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57495. /**
  57496. * Checks to see if a texture is used in the material.
  57497. * @param defines the list of "defines" to update.
  57498. * @param scene defines the scene to the material belongs to.
  57499. */
  57500. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57501. /**
  57502. * Binds the material data.
  57503. * @param uniformBuffer defines the Uniform buffer to fill in.
  57504. * @param scene defines the scene the material belongs to.
  57505. * @param engine defines the engine the material belongs to.
  57506. * @param disableBumpMap defines wether the material disables bump or not.
  57507. * @param isFrozen defines wether the material is frozen or not.
  57508. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57509. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57510. */
  57511. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57512. /**
  57513. * Checks to see if a texture is used in the material.
  57514. * @param texture - Base texture to use.
  57515. * @returns - Boolean specifying if a texture is used in the material.
  57516. */
  57517. hasTexture(texture: BaseTexture): boolean;
  57518. /**
  57519. * Returns an array of the actively used textures.
  57520. * @param activeTextures Array of BaseTextures
  57521. */
  57522. getActiveTextures(activeTextures: BaseTexture[]): void;
  57523. /**
  57524. * Returns the animatable textures.
  57525. * @param animatables Array of animatable textures.
  57526. */
  57527. getAnimatables(animatables: IAnimatable[]): void;
  57528. /**
  57529. * Disposes the resources of the material.
  57530. * @param forceDisposeTextures - Forces the disposal of all textures.
  57531. */
  57532. dispose(forceDisposeTextures?: boolean): void;
  57533. /**
  57534. * Get the current class name of the texture useful for serialization or dynamic coding.
  57535. * @returns "PBRClearCoatConfiguration"
  57536. */
  57537. getClassName(): string;
  57538. /**
  57539. * Add fallbacks to the effect fallbacks list.
  57540. * @param defines defines the Base texture to use.
  57541. * @param fallbacks defines the current fallback list.
  57542. * @param currentRank defines the current fallback rank.
  57543. * @returns the new fallback rank.
  57544. */
  57545. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57546. /**
  57547. * Add the required uniforms to the current list.
  57548. * @param uniforms defines the current uniform list.
  57549. */
  57550. static AddUniforms(uniforms: string[]): void;
  57551. /**
  57552. * Add the required samplers to the current list.
  57553. * @param samplers defines the current sampler list.
  57554. */
  57555. static AddSamplers(samplers: string[]): void;
  57556. /**
  57557. * Add the required uniforms to the current buffer.
  57558. * @param uniformBuffer defines the current uniform buffer.
  57559. */
  57560. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57561. /**
  57562. * Makes a duplicate of the current configuration into another one.
  57563. * @param clearCoatConfiguration define the config where to copy the info
  57564. */
  57565. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57566. /**
  57567. * Serializes this clear coat configuration.
  57568. * @returns - An object with the serialized config.
  57569. */
  57570. serialize(): any;
  57571. /**
  57572. * Parses a anisotropy Configuration from a serialized object.
  57573. * @param source - Serialized object.
  57574. * @param scene Defines the scene we are parsing for
  57575. * @param rootUrl Defines the rootUrl to load from
  57576. */
  57577. parse(source: any, scene: Scene, rootUrl: string): void;
  57578. }
  57579. }
  57580. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57581. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57582. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57583. import { Vector2 } from "babylonjs/Maths/math.vector";
  57584. import { Scene } from "babylonjs/scene";
  57585. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57586. import { Nullable } from "babylonjs/types";
  57587. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57588. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57589. /**
  57590. * @hidden
  57591. */
  57592. export interface IMaterialAnisotropicDefines {
  57593. ANISOTROPIC: boolean;
  57594. ANISOTROPIC_TEXTURE: boolean;
  57595. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57596. MAINUV1: boolean;
  57597. _areTexturesDirty: boolean;
  57598. _needUVs: boolean;
  57599. }
  57600. /**
  57601. * Define the code related to the anisotropic parameters of the pbr material.
  57602. */
  57603. export class PBRAnisotropicConfiguration {
  57604. private _isEnabled;
  57605. /**
  57606. * Defines if the anisotropy is enabled in the material.
  57607. */
  57608. isEnabled: boolean;
  57609. /**
  57610. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57611. */
  57612. intensity: number;
  57613. /**
  57614. * Defines if the effect is along the tangents, bitangents or in between.
  57615. * By default, the effect is "strectching" the highlights along the tangents.
  57616. */
  57617. direction: Vector2;
  57618. private _texture;
  57619. /**
  57620. * Stores the anisotropy values in a texture.
  57621. * rg is direction (like normal from -1 to 1)
  57622. * b is a intensity
  57623. */
  57624. texture: Nullable<BaseTexture>;
  57625. /** @hidden */
  57626. private _internalMarkAllSubMeshesAsTexturesDirty;
  57627. /** @hidden */
  57628. _markAllSubMeshesAsTexturesDirty(): void;
  57629. /**
  57630. * Instantiate a new istance of anisotropy configuration.
  57631. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57632. */
  57633. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57634. /**
  57635. * Specifies that the submesh is ready to be used.
  57636. * @param defines the list of "defines" to update.
  57637. * @param scene defines the scene the material belongs to.
  57638. * @returns - boolean indicating that the submesh is ready or not.
  57639. */
  57640. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57641. /**
  57642. * Checks to see if a texture is used in the material.
  57643. * @param defines the list of "defines" to update.
  57644. * @param mesh the mesh we are preparing the defines for.
  57645. * @param scene defines the scene the material belongs to.
  57646. */
  57647. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57648. /**
  57649. * Binds the material data.
  57650. * @param uniformBuffer defines the Uniform buffer to fill in.
  57651. * @param scene defines the scene the material belongs to.
  57652. * @param isFrozen defines wether the material is frozen or not.
  57653. */
  57654. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57655. /**
  57656. * Checks to see if a texture is used in the material.
  57657. * @param texture - Base texture to use.
  57658. * @returns - Boolean specifying if a texture is used in the material.
  57659. */
  57660. hasTexture(texture: BaseTexture): boolean;
  57661. /**
  57662. * Returns an array of the actively used textures.
  57663. * @param activeTextures Array of BaseTextures
  57664. */
  57665. getActiveTextures(activeTextures: BaseTexture[]): void;
  57666. /**
  57667. * Returns the animatable textures.
  57668. * @param animatables Array of animatable textures.
  57669. */
  57670. getAnimatables(animatables: IAnimatable[]): void;
  57671. /**
  57672. * Disposes the resources of the material.
  57673. * @param forceDisposeTextures - Forces the disposal of all textures.
  57674. */
  57675. dispose(forceDisposeTextures?: boolean): void;
  57676. /**
  57677. * Get the current class name of the texture useful for serialization or dynamic coding.
  57678. * @returns "PBRAnisotropicConfiguration"
  57679. */
  57680. getClassName(): string;
  57681. /**
  57682. * Add fallbacks to the effect fallbacks list.
  57683. * @param defines defines the Base texture to use.
  57684. * @param fallbacks defines the current fallback list.
  57685. * @param currentRank defines the current fallback rank.
  57686. * @returns the new fallback rank.
  57687. */
  57688. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57689. /**
  57690. * Add the required uniforms to the current list.
  57691. * @param uniforms defines the current uniform list.
  57692. */
  57693. static AddUniforms(uniforms: string[]): void;
  57694. /**
  57695. * Add the required uniforms to the current buffer.
  57696. * @param uniformBuffer defines the current uniform buffer.
  57697. */
  57698. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57699. /**
  57700. * Add the required samplers to the current list.
  57701. * @param samplers defines the current sampler list.
  57702. */
  57703. static AddSamplers(samplers: string[]): void;
  57704. /**
  57705. * Makes a duplicate of the current configuration into another one.
  57706. * @param anisotropicConfiguration define the config where to copy the info
  57707. */
  57708. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57709. /**
  57710. * Serializes this anisotropy configuration.
  57711. * @returns - An object with the serialized config.
  57712. */
  57713. serialize(): any;
  57714. /**
  57715. * Parses a anisotropy Configuration from a serialized object.
  57716. * @param source - Serialized object.
  57717. * @param scene Defines the scene we are parsing for
  57718. * @param rootUrl Defines the rootUrl to load from
  57719. */
  57720. parse(source: any, scene: Scene, rootUrl: string): void;
  57721. }
  57722. }
  57723. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57724. import { Scene } from "babylonjs/scene";
  57725. /**
  57726. * @hidden
  57727. */
  57728. export interface IMaterialBRDFDefines {
  57729. BRDF_V_HEIGHT_CORRELATED: boolean;
  57730. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57731. SPHERICAL_HARMONICS: boolean;
  57732. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57733. /** @hidden */
  57734. _areMiscDirty: boolean;
  57735. }
  57736. /**
  57737. * Define the code related to the BRDF parameters of the pbr material.
  57738. */
  57739. export class PBRBRDFConfiguration {
  57740. /**
  57741. * Default value used for the energy conservation.
  57742. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57743. */
  57744. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57745. /**
  57746. * Default value used for the Smith Visibility Height Correlated mode.
  57747. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57748. */
  57749. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57750. /**
  57751. * Default value used for the IBL diffuse part.
  57752. * This can help switching back to the polynomials mode globally which is a tiny bit
  57753. * less GPU intensive at the drawback of a lower quality.
  57754. */
  57755. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57756. /**
  57757. * Default value used for activating energy conservation for the specular workflow.
  57758. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57759. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57760. */
  57761. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57762. private _useEnergyConservation;
  57763. /**
  57764. * Defines if the material uses energy conservation.
  57765. */
  57766. useEnergyConservation: boolean;
  57767. private _useSmithVisibilityHeightCorrelated;
  57768. /**
  57769. * LEGACY Mode set to false
  57770. * Defines if the material uses height smith correlated visibility term.
  57771. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57772. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57773. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57774. * Not relying on height correlated will also disable energy conservation.
  57775. */
  57776. useSmithVisibilityHeightCorrelated: boolean;
  57777. private _useSphericalHarmonics;
  57778. /**
  57779. * LEGACY Mode set to false
  57780. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57781. * diffuse part of the IBL.
  57782. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57783. * to the ground truth.
  57784. */
  57785. useSphericalHarmonics: boolean;
  57786. private _useSpecularGlossinessInputEnergyConservation;
  57787. /**
  57788. * Defines if the material uses energy conservation, when the specular workflow is active.
  57789. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57790. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57791. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57792. */
  57793. useSpecularGlossinessInputEnergyConservation: boolean;
  57794. /** @hidden */
  57795. private _internalMarkAllSubMeshesAsMiscDirty;
  57796. /** @hidden */
  57797. _markAllSubMeshesAsMiscDirty(): void;
  57798. /**
  57799. * Instantiate a new istance of clear coat configuration.
  57800. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57801. */
  57802. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57803. /**
  57804. * Checks to see if a texture is used in the material.
  57805. * @param defines the list of "defines" to update.
  57806. */
  57807. prepareDefines(defines: IMaterialBRDFDefines): void;
  57808. /**
  57809. * Get the current class name of the texture useful for serialization or dynamic coding.
  57810. * @returns "PBRClearCoatConfiguration"
  57811. */
  57812. getClassName(): string;
  57813. /**
  57814. * Makes a duplicate of the current configuration into another one.
  57815. * @param brdfConfiguration define the config where to copy the info
  57816. */
  57817. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57818. /**
  57819. * Serializes this BRDF configuration.
  57820. * @returns - An object with the serialized config.
  57821. */
  57822. serialize(): any;
  57823. /**
  57824. * Parses a anisotropy Configuration from a serialized object.
  57825. * @param source - Serialized object.
  57826. * @param scene Defines the scene we are parsing for
  57827. * @param rootUrl Defines the rootUrl to load from
  57828. */
  57829. parse(source: any, scene: Scene, rootUrl: string): void;
  57830. }
  57831. }
  57832. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57833. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57834. import { Color3 } from "babylonjs/Maths/math.color";
  57835. import { Scene } from "babylonjs/scene";
  57836. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57837. import { Nullable } from "babylonjs/types";
  57838. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57839. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57840. /**
  57841. * @hidden
  57842. */
  57843. export interface IMaterialSheenDefines {
  57844. SHEEN: boolean;
  57845. SHEEN_TEXTURE: boolean;
  57846. SHEEN_TEXTUREDIRECTUV: number;
  57847. SHEEN_LINKWITHALBEDO: boolean;
  57848. SHEEN_ROUGHNESS: boolean;
  57849. SHEEN_ALBEDOSCALING: boolean;
  57850. /** @hidden */
  57851. _areTexturesDirty: boolean;
  57852. }
  57853. /**
  57854. * Define the code related to the Sheen parameters of the pbr material.
  57855. */
  57856. export class PBRSheenConfiguration {
  57857. private _isEnabled;
  57858. /**
  57859. * Defines if the material uses sheen.
  57860. */
  57861. isEnabled: boolean;
  57862. private _linkSheenWithAlbedo;
  57863. /**
  57864. * Defines if the sheen is linked to the sheen color.
  57865. */
  57866. linkSheenWithAlbedo: boolean;
  57867. /**
  57868. * Defines the sheen intensity.
  57869. */
  57870. intensity: number;
  57871. /**
  57872. * Defines the sheen color.
  57873. */
  57874. color: Color3;
  57875. private _texture;
  57876. /**
  57877. * Stores the sheen tint values in a texture.
  57878. * rgb is tint
  57879. * a is a intensity or roughness if roughness has been defined
  57880. */
  57881. texture: Nullable<BaseTexture>;
  57882. private _roughness;
  57883. /**
  57884. * Defines the sheen roughness.
  57885. * It is not taken into account if linkSheenWithAlbedo is true.
  57886. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  57887. */
  57888. roughness: Nullable<number>;
  57889. private _albedoScaling;
  57890. /**
  57891. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  57892. * It allows the strength of the sheen effect to not depend on the base color of the material,
  57893. * making it easier to setup and tweak the effect
  57894. */
  57895. albedoScaling: boolean;
  57896. /** @hidden */
  57897. private _internalMarkAllSubMeshesAsTexturesDirty;
  57898. /** @hidden */
  57899. _markAllSubMeshesAsTexturesDirty(): void;
  57900. /**
  57901. * Instantiate a new istance of clear coat configuration.
  57902. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57903. */
  57904. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57905. /**
  57906. * Specifies that the submesh is ready to be used.
  57907. * @param defines the list of "defines" to update.
  57908. * @param scene defines the scene the material belongs to.
  57909. * @returns - boolean indicating that the submesh is ready or not.
  57910. */
  57911. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  57912. /**
  57913. * Checks to see if a texture is used in the material.
  57914. * @param defines the list of "defines" to update.
  57915. * @param scene defines the scene the material belongs to.
  57916. */
  57917. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  57918. /**
  57919. * Binds the material data.
  57920. * @param uniformBuffer defines the Uniform buffer to fill in.
  57921. * @param scene defines the scene the material belongs to.
  57922. * @param isFrozen defines wether the material is frozen or not.
  57923. */
  57924. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57925. /**
  57926. * Checks to see if a texture is used in the material.
  57927. * @param texture - Base texture to use.
  57928. * @returns - Boolean specifying if a texture is used in the material.
  57929. */
  57930. hasTexture(texture: BaseTexture): boolean;
  57931. /**
  57932. * Returns an array of the actively used textures.
  57933. * @param activeTextures Array of BaseTextures
  57934. */
  57935. getActiveTextures(activeTextures: BaseTexture[]): void;
  57936. /**
  57937. * Returns the animatable textures.
  57938. * @param animatables Array of animatable textures.
  57939. */
  57940. getAnimatables(animatables: IAnimatable[]): void;
  57941. /**
  57942. * Disposes the resources of the material.
  57943. * @param forceDisposeTextures - Forces the disposal of all textures.
  57944. */
  57945. dispose(forceDisposeTextures?: boolean): void;
  57946. /**
  57947. * Get the current class name of the texture useful for serialization or dynamic coding.
  57948. * @returns "PBRSheenConfiguration"
  57949. */
  57950. getClassName(): string;
  57951. /**
  57952. * Add fallbacks to the effect fallbacks list.
  57953. * @param defines defines the Base texture to use.
  57954. * @param fallbacks defines the current fallback list.
  57955. * @param currentRank defines the current fallback rank.
  57956. * @returns the new fallback rank.
  57957. */
  57958. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57959. /**
  57960. * Add the required uniforms to the current list.
  57961. * @param uniforms defines the current uniform list.
  57962. */
  57963. static AddUniforms(uniforms: string[]): void;
  57964. /**
  57965. * Add the required uniforms to the current buffer.
  57966. * @param uniformBuffer defines the current uniform buffer.
  57967. */
  57968. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57969. /**
  57970. * Add the required samplers to the current list.
  57971. * @param samplers defines the current sampler list.
  57972. */
  57973. static AddSamplers(samplers: string[]): void;
  57974. /**
  57975. * Makes a duplicate of the current configuration into another one.
  57976. * @param sheenConfiguration define the config where to copy the info
  57977. */
  57978. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  57979. /**
  57980. * Serializes this BRDF configuration.
  57981. * @returns - An object with the serialized config.
  57982. */
  57983. serialize(): any;
  57984. /**
  57985. * Parses a anisotropy Configuration from a serialized object.
  57986. * @param source - Serialized object.
  57987. * @param scene Defines the scene we are parsing for
  57988. * @param rootUrl Defines the rootUrl to load from
  57989. */
  57990. parse(source: any, scene: Scene, rootUrl: string): void;
  57991. }
  57992. }
  57993. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  57994. import { Nullable } from "babylonjs/types";
  57995. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57996. import { Color3 } from "babylonjs/Maths/math.color";
  57997. import { SmartArray } from "babylonjs/Misc/smartArray";
  57998. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57999. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58000. import { Effect } from "babylonjs/Materials/effect";
  58001. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58002. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58003. import { Engine } from "babylonjs/Engines/engine";
  58004. import { Scene } from "babylonjs/scene";
  58005. /**
  58006. * @hidden
  58007. */
  58008. export interface IMaterialSubSurfaceDefines {
  58009. SUBSURFACE: boolean;
  58010. SS_REFRACTION: boolean;
  58011. SS_TRANSLUCENCY: boolean;
  58012. SS_SCATTERING: boolean;
  58013. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58014. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58015. SS_REFRACTIONMAP_3D: boolean;
  58016. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58017. SS_LODINREFRACTIONALPHA: boolean;
  58018. SS_GAMMAREFRACTION: boolean;
  58019. SS_RGBDREFRACTION: boolean;
  58020. SS_LINEARSPECULARREFRACTION: boolean;
  58021. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58022. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58023. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58024. /** @hidden */
  58025. _areTexturesDirty: boolean;
  58026. }
  58027. /**
  58028. * Define the code related to the sub surface parameters of the pbr material.
  58029. */
  58030. export class PBRSubSurfaceConfiguration {
  58031. private _isRefractionEnabled;
  58032. /**
  58033. * Defines if the refraction is enabled in the material.
  58034. */
  58035. isRefractionEnabled: boolean;
  58036. private _isTranslucencyEnabled;
  58037. /**
  58038. * Defines if the translucency is enabled in the material.
  58039. */
  58040. isTranslucencyEnabled: boolean;
  58041. private _isScatteringEnabled;
  58042. /**
  58043. * Defines if the sub surface scattering is enabled in the material.
  58044. */
  58045. isScatteringEnabled: boolean;
  58046. private _scatteringDiffusionProfileIndex;
  58047. /**
  58048. * Diffusion profile for subsurface scattering.
  58049. * Useful for better scattering in the skins or foliages.
  58050. */
  58051. get scatteringDiffusionProfile(): Nullable<Color3>;
  58052. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58053. /**
  58054. * Defines the refraction intensity of the material.
  58055. * The refraction when enabled replaces the Diffuse part of the material.
  58056. * The intensity helps transitionning between diffuse and refraction.
  58057. */
  58058. refractionIntensity: number;
  58059. /**
  58060. * Defines the translucency intensity of the material.
  58061. * When translucency has been enabled, this defines how much of the "translucency"
  58062. * is addded to the diffuse part of the material.
  58063. */
  58064. translucencyIntensity: number;
  58065. /**
  58066. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58067. */
  58068. useAlbedoToTintRefraction: boolean;
  58069. private _thicknessTexture;
  58070. /**
  58071. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58072. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58073. * 0 would mean minimumThickness
  58074. * 1 would mean maximumThickness
  58075. * The other channels might be use as a mask to vary the different effects intensity.
  58076. */
  58077. thicknessTexture: Nullable<BaseTexture>;
  58078. private _refractionTexture;
  58079. /**
  58080. * Defines the texture to use for refraction.
  58081. */
  58082. refractionTexture: Nullable<BaseTexture>;
  58083. private _indexOfRefraction;
  58084. /**
  58085. * Index of refraction of the material base layer.
  58086. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58087. *
  58088. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58089. *
  58090. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58091. */
  58092. indexOfRefraction: number;
  58093. private _volumeIndexOfRefraction;
  58094. /**
  58095. * Index of refraction of the material's volume.
  58096. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58097. *
  58098. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58099. * the volume will use the same IOR as the surface.
  58100. */
  58101. get volumeIndexOfRefraction(): number;
  58102. set volumeIndexOfRefraction(value: number);
  58103. private _invertRefractionY;
  58104. /**
  58105. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58106. */
  58107. invertRefractionY: boolean;
  58108. private _linkRefractionWithTransparency;
  58109. /**
  58110. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58111. * Materials half opaque for instance using refraction could benefit from this control.
  58112. */
  58113. linkRefractionWithTransparency: boolean;
  58114. /**
  58115. * Defines the minimum thickness stored in the thickness map.
  58116. * If no thickness map is defined, this value will be used to simulate thickness.
  58117. */
  58118. minimumThickness: number;
  58119. /**
  58120. * Defines the maximum thickness stored in the thickness map.
  58121. */
  58122. maximumThickness: number;
  58123. /**
  58124. * Defines the volume tint of the material.
  58125. * This is used for both translucency and scattering.
  58126. */
  58127. tintColor: Color3;
  58128. /**
  58129. * Defines the distance at which the tint color should be found in the media.
  58130. * This is used for refraction only.
  58131. */
  58132. tintColorAtDistance: number;
  58133. /**
  58134. * Defines how far each channel transmit through the media.
  58135. * It is defined as a color to simplify it selection.
  58136. */
  58137. diffusionDistance: Color3;
  58138. private _useMaskFromThicknessTexture;
  58139. /**
  58140. * Stores the intensity of the different subsurface effects in the thickness texture.
  58141. * * the green channel is the translucency intensity.
  58142. * * the blue channel is the scattering intensity.
  58143. * * the alpha channel is the refraction intensity.
  58144. */
  58145. useMaskFromThicknessTexture: boolean;
  58146. private _scene;
  58147. /** @hidden */
  58148. private _internalMarkAllSubMeshesAsTexturesDirty;
  58149. private _internalMarkScenePrePassDirty;
  58150. /** @hidden */
  58151. _markAllSubMeshesAsTexturesDirty(): void;
  58152. /** @hidden */
  58153. _markScenePrePassDirty(): void;
  58154. /**
  58155. * Instantiate a new istance of sub surface configuration.
  58156. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58157. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58158. * @param scene The scene
  58159. */
  58160. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58161. /**
  58162. * Gets wehter the submesh is ready to be used or not.
  58163. * @param defines the list of "defines" to update.
  58164. * @param scene defines the scene the material belongs to.
  58165. * @returns - boolean indicating that the submesh is ready or not.
  58166. */
  58167. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58168. /**
  58169. * Checks to see if a texture is used in the material.
  58170. * @param defines the list of "defines" to update.
  58171. * @param scene defines the scene to the material belongs to.
  58172. */
  58173. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58174. /**
  58175. * Binds the material data.
  58176. * @param uniformBuffer defines the Uniform buffer to fill in.
  58177. * @param scene defines the scene the material belongs to.
  58178. * @param engine defines the engine the material belongs to.
  58179. * @param isFrozen defines whether the material is frozen or not.
  58180. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58181. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58182. */
  58183. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58184. /**
  58185. * Unbinds the material from the mesh.
  58186. * @param activeEffect defines the effect that should be unbound from.
  58187. * @returns true if unbound, otherwise false
  58188. */
  58189. unbind(activeEffect: Effect): boolean;
  58190. /**
  58191. * Returns the texture used for refraction or null if none is used.
  58192. * @param scene defines the scene the material belongs to.
  58193. * @returns - Refraction texture if present. If no refraction texture and refraction
  58194. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58195. */
  58196. private _getRefractionTexture;
  58197. /**
  58198. * Returns true if alpha blending should be disabled.
  58199. */
  58200. get disableAlphaBlending(): boolean;
  58201. /**
  58202. * Fills the list of render target textures.
  58203. * @param renderTargets the list of render targets to update
  58204. */
  58205. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58206. /**
  58207. * Checks to see if a texture is used in the material.
  58208. * @param texture - Base texture to use.
  58209. * @returns - Boolean specifying if a texture is used in the material.
  58210. */
  58211. hasTexture(texture: BaseTexture): boolean;
  58212. /**
  58213. * Gets a boolean indicating that current material needs to register RTT
  58214. * @returns true if this uses a render target otherwise false.
  58215. */
  58216. hasRenderTargetTextures(): boolean;
  58217. /**
  58218. * Returns an array of the actively used textures.
  58219. * @param activeTextures Array of BaseTextures
  58220. */
  58221. getActiveTextures(activeTextures: BaseTexture[]): void;
  58222. /**
  58223. * Returns the animatable textures.
  58224. * @param animatables Array of animatable textures.
  58225. */
  58226. getAnimatables(animatables: IAnimatable[]): void;
  58227. /**
  58228. * Disposes the resources of the material.
  58229. * @param forceDisposeTextures - Forces the disposal of all textures.
  58230. */
  58231. dispose(forceDisposeTextures?: boolean): void;
  58232. /**
  58233. * Get the current class name of the texture useful for serialization or dynamic coding.
  58234. * @returns "PBRSubSurfaceConfiguration"
  58235. */
  58236. getClassName(): string;
  58237. /**
  58238. * Add fallbacks to the effect fallbacks list.
  58239. * @param defines defines the Base texture to use.
  58240. * @param fallbacks defines the current fallback list.
  58241. * @param currentRank defines the current fallback rank.
  58242. * @returns the new fallback rank.
  58243. */
  58244. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58245. /**
  58246. * Add the required uniforms to the current list.
  58247. * @param uniforms defines the current uniform list.
  58248. */
  58249. static AddUniforms(uniforms: string[]): void;
  58250. /**
  58251. * Add the required samplers to the current list.
  58252. * @param samplers defines the current sampler list.
  58253. */
  58254. static AddSamplers(samplers: string[]): void;
  58255. /**
  58256. * Add the required uniforms to the current buffer.
  58257. * @param uniformBuffer defines the current uniform buffer.
  58258. */
  58259. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58260. /**
  58261. * Makes a duplicate of the current configuration into another one.
  58262. * @param configuration define the config where to copy the info
  58263. */
  58264. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58265. /**
  58266. * Serializes this Sub Surface configuration.
  58267. * @returns - An object with the serialized config.
  58268. */
  58269. serialize(): any;
  58270. /**
  58271. * Parses a anisotropy Configuration from a serialized object.
  58272. * @param source - Serialized object.
  58273. * @param scene Defines the scene we are parsing for
  58274. * @param rootUrl Defines the rootUrl to load from
  58275. */
  58276. parse(source: any, scene: Scene, rootUrl: string): void;
  58277. }
  58278. }
  58279. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58280. /** @hidden */
  58281. export var pbrFragmentDeclaration: {
  58282. name: string;
  58283. shader: string;
  58284. };
  58285. }
  58286. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58287. /** @hidden */
  58288. export var pbrUboDeclaration: {
  58289. name: string;
  58290. shader: string;
  58291. };
  58292. }
  58293. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58294. /** @hidden */
  58295. export var pbrFragmentExtraDeclaration: {
  58296. name: string;
  58297. shader: string;
  58298. };
  58299. }
  58300. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58301. /** @hidden */
  58302. export var pbrFragmentSamplersDeclaration: {
  58303. name: string;
  58304. shader: string;
  58305. };
  58306. }
  58307. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58308. /** @hidden */
  58309. export var importanceSampling: {
  58310. name: string;
  58311. shader: string;
  58312. };
  58313. }
  58314. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58315. /** @hidden */
  58316. export var pbrHelperFunctions: {
  58317. name: string;
  58318. shader: string;
  58319. };
  58320. }
  58321. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58322. /** @hidden */
  58323. export var harmonicsFunctions: {
  58324. name: string;
  58325. shader: string;
  58326. };
  58327. }
  58328. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58329. /** @hidden */
  58330. export var pbrDirectLightingSetupFunctions: {
  58331. name: string;
  58332. shader: string;
  58333. };
  58334. }
  58335. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58336. /** @hidden */
  58337. export var pbrDirectLightingFalloffFunctions: {
  58338. name: string;
  58339. shader: string;
  58340. };
  58341. }
  58342. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58343. /** @hidden */
  58344. export var pbrBRDFFunctions: {
  58345. name: string;
  58346. shader: string;
  58347. };
  58348. }
  58349. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58350. /** @hidden */
  58351. export var hdrFilteringFunctions: {
  58352. name: string;
  58353. shader: string;
  58354. };
  58355. }
  58356. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58357. /** @hidden */
  58358. export var pbrDirectLightingFunctions: {
  58359. name: string;
  58360. shader: string;
  58361. };
  58362. }
  58363. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58364. /** @hidden */
  58365. export var pbrIBLFunctions: {
  58366. name: string;
  58367. shader: string;
  58368. };
  58369. }
  58370. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58371. /** @hidden */
  58372. export var pbrBlockAlbedoOpacity: {
  58373. name: string;
  58374. shader: string;
  58375. };
  58376. }
  58377. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58378. /** @hidden */
  58379. export var pbrBlockReflectivity: {
  58380. name: string;
  58381. shader: string;
  58382. };
  58383. }
  58384. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58385. /** @hidden */
  58386. export var pbrBlockAmbientOcclusion: {
  58387. name: string;
  58388. shader: string;
  58389. };
  58390. }
  58391. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58392. /** @hidden */
  58393. export var pbrBlockAlphaFresnel: {
  58394. name: string;
  58395. shader: string;
  58396. };
  58397. }
  58398. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58399. /** @hidden */
  58400. export var pbrBlockAnisotropic: {
  58401. name: string;
  58402. shader: string;
  58403. };
  58404. }
  58405. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58406. /** @hidden */
  58407. export var pbrBlockReflection: {
  58408. name: string;
  58409. shader: string;
  58410. };
  58411. }
  58412. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58413. /** @hidden */
  58414. export var pbrBlockSheen: {
  58415. name: string;
  58416. shader: string;
  58417. };
  58418. }
  58419. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58420. /** @hidden */
  58421. export var pbrBlockClearcoat: {
  58422. name: string;
  58423. shader: string;
  58424. };
  58425. }
  58426. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58427. /** @hidden */
  58428. export var pbrBlockSubSurface: {
  58429. name: string;
  58430. shader: string;
  58431. };
  58432. }
  58433. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58434. /** @hidden */
  58435. export var pbrBlockNormalGeometric: {
  58436. name: string;
  58437. shader: string;
  58438. };
  58439. }
  58440. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58441. /** @hidden */
  58442. export var pbrBlockNormalFinal: {
  58443. name: string;
  58444. shader: string;
  58445. };
  58446. }
  58447. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58448. /** @hidden */
  58449. export var pbrBlockLightmapInit: {
  58450. name: string;
  58451. shader: string;
  58452. };
  58453. }
  58454. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58455. /** @hidden */
  58456. export var pbrBlockGeometryInfo: {
  58457. name: string;
  58458. shader: string;
  58459. };
  58460. }
  58461. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58462. /** @hidden */
  58463. export var pbrBlockReflectance0: {
  58464. name: string;
  58465. shader: string;
  58466. };
  58467. }
  58468. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58469. /** @hidden */
  58470. export var pbrBlockReflectance: {
  58471. name: string;
  58472. shader: string;
  58473. };
  58474. }
  58475. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58476. /** @hidden */
  58477. export var pbrBlockDirectLighting: {
  58478. name: string;
  58479. shader: string;
  58480. };
  58481. }
  58482. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58483. /** @hidden */
  58484. export var pbrBlockFinalLitComponents: {
  58485. name: string;
  58486. shader: string;
  58487. };
  58488. }
  58489. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58490. /** @hidden */
  58491. export var pbrBlockFinalUnlitComponents: {
  58492. name: string;
  58493. shader: string;
  58494. };
  58495. }
  58496. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58497. /** @hidden */
  58498. export var pbrBlockFinalColorComposition: {
  58499. name: string;
  58500. shader: string;
  58501. };
  58502. }
  58503. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58504. /** @hidden */
  58505. export var pbrBlockImageProcessing: {
  58506. name: string;
  58507. shader: string;
  58508. };
  58509. }
  58510. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58511. /** @hidden */
  58512. export var pbrDebug: {
  58513. name: string;
  58514. shader: string;
  58515. };
  58516. }
  58517. declare module "babylonjs/Shaders/pbr.fragment" {
  58518. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58519. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58520. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58521. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58522. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58523. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58524. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58525. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58526. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58527. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58528. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58529. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58530. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58531. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58532. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58533. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58534. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58535. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58536. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58537. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58538. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58539. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58540. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58541. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58542. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58543. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58544. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58545. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58546. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58547. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58548. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58549. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58550. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58551. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58552. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58553. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58554. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58555. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58556. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58557. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58558. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58559. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58560. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58561. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58562. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58563. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58564. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58565. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58566. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58567. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58568. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58569. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58570. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58571. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58572. /** @hidden */
  58573. export var pbrPixelShader: {
  58574. name: string;
  58575. shader: string;
  58576. };
  58577. }
  58578. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58579. /** @hidden */
  58580. export var pbrVertexDeclaration: {
  58581. name: string;
  58582. shader: string;
  58583. };
  58584. }
  58585. declare module "babylonjs/Shaders/pbr.vertex" {
  58586. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58587. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58588. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58589. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58590. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58591. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58592. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58593. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58594. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58595. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58596. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58597. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58598. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58599. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58600. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58601. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58602. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58603. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58604. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58605. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58606. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58607. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58608. /** @hidden */
  58609. export var pbrVertexShader: {
  58610. name: string;
  58611. shader: string;
  58612. };
  58613. }
  58614. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58615. import { Nullable } from "babylonjs/types";
  58616. import { Scene } from "babylonjs/scene";
  58617. import { Matrix } from "babylonjs/Maths/math.vector";
  58618. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58619. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58620. import { Mesh } from "babylonjs/Meshes/mesh";
  58621. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58622. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58623. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58624. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58625. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58626. import { Color3 } from "babylonjs/Maths/math.color";
  58627. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58628. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58629. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58630. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58631. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58632. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58633. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58634. import "babylonjs/Shaders/pbr.fragment";
  58635. import "babylonjs/Shaders/pbr.vertex";
  58636. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58637. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58638. /**
  58639. * Manages the defines for the PBR Material.
  58640. * @hidden
  58641. */
  58642. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58643. PBR: boolean;
  58644. NUM_SAMPLES: string;
  58645. REALTIME_FILTERING: boolean;
  58646. MAINUV1: boolean;
  58647. MAINUV2: boolean;
  58648. UV1: boolean;
  58649. UV2: boolean;
  58650. ALBEDO: boolean;
  58651. GAMMAALBEDO: boolean;
  58652. ALBEDODIRECTUV: number;
  58653. VERTEXCOLOR: boolean;
  58654. DETAIL: boolean;
  58655. DETAILDIRECTUV: number;
  58656. DETAIL_NORMALBLENDMETHOD: number;
  58657. AMBIENT: boolean;
  58658. AMBIENTDIRECTUV: number;
  58659. AMBIENTINGRAYSCALE: boolean;
  58660. OPACITY: boolean;
  58661. VERTEXALPHA: boolean;
  58662. OPACITYDIRECTUV: number;
  58663. OPACITYRGB: boolean;
  58664. ALPHATEST: boolean;
  58665. DEPTHPREPASS: boolean;
  58666. ALPHABLEND: boolean;
  58667. ALPHAFROMALBEDO: boolean;
  58668. ALPHATESTVALUE: string;
  58669. SPECULAROVERALPHA: boolean;
  58670. RADIANCEOVERALPHA: boolean;
  58671. ALPHAFRESNEL: boolean;
  58672. LINEARALPHAFRESNEL: boolean;
  58673. PREMULTIPLYALPHA: boolean;
  58674. EMISSIVE: boolean;
  58675. EMISSIVEDIRECTUV: number;
  58676. REFLECTIVITY: boolean;
  58677. REFLECTIVITYDIRECTUV: number;
  58678. SPECULARTERM: boolean;
  58679. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58680. MICROSURFACEAUTOMATIC: boolean;
  58681. LODBASEDMICROSFURACE: boolean;
  58682. MICROSURFACEMAP: boolean;
  58683. MICROSURFACEMAPDIRECTUV: number;
  58684. METALLICWORKFLOW: boolean;
  58685. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58686. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58687. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58688. AOSTOREINMETALMAPRED: boolean;
  58689. METALLIC_REFLECTANCE: boolean;
  58690. METALLIC_REFLECTANCEDIRECTUV: number;
  58691. ENVIRONMENTBRDF: boolean;
  58692. ENVIRONMENTBRDF_RGBD: boolean;
  58693. NORMAL: boolean;
  58694. TANGENT: boolean;
  58695. BUMP: boolean;
  58696. BUMPDIRECTUV: number;
  58697. OBJECTSPACE_NORMALMAP: boolean;
  58698. PARALLAX: boolean;
  58699. PARALLAXOCCLUSION: boolean;
  58700. NORMALXYSCALE: boolean;
  58701. LIGHTMAP: boolean;
  58702. LIGHTMAPDIRECTUV: number;
  58703. USELIGHTMAPASSHADOWMAP: boolean;
  58704. GAMMALIGHTMAP: boolean;
  58705. RGBDLIGHTMAP: boolean;
  58706. REFLECTION: boolean;
  58707. REFLECTIONMAP_3D: boolean;
  58708. REFLECTIONMAP_SPHERICAL: boolean;
  58709. REFLECTIONMAP_PLANAR: boolean;
  58710. REFLECTIONMAP_CUBIC: boolean;
  58711. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58712. REFLECTIONMAP_PROJECTION: boolean;
  58713. REFLECTIONMAP_SKYBOX: boolean;
  58714. REFLECTIONMAP_EXPLICIT: boolean;
  58715. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58716. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58717. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58718. INVERTCUBICMAP: boolean;
  58719. USESPHERICALFROMREFLECTIONMAP: boolean;
  58720. USEIRRADIANCEMAP: boolean;
  58721. SPHERICAL_HARMONICS: boolean;
  58722. USESPHERICALINVERTEX: boolean;
  58723. REFLECTIONMAP_OPPOSITEZ: boolean;
  58724. LODINREFLECTIONALPHA: boolean;
  58725. GAMMAREFLECTION: boolean;
  58726. RGBDREFLECTION: boolean;
  58727. LINEARSPECULARREFLECTION: boolean;
  58728. RADIANCEOCCLUSION: boolean;
  58729. HORIZONOCCLUSION: boolean;
  58730. INSTANCES: boolean;
  58731. THIN_INSTANCES: boolean;
  58732. PREPASS: boolean;
  58733. SCENE_MRT_COUNT: number;
  58734. NUM_BONE_INFLUENCERS: number;
  58735. BonesPerMesh: number;
  58736. BONETEXTURE: boolean;
  58737. NONUNIFORMSCALING: boolean;
  58738. MORPHTARGETS: boolean;
  58739. MORPHTARGETS_NORMAL: boolean;
  58740. MORPHTARGETS_TANGENT: boolean;
  58741. MORPHTARGETS_UV: boolean;
  58742. NUM_MORPH_INFLUENCERS: number;
  58743. IMAGEPROCESSING: boolean;
  58744. VIGNETTE: boolean;
  58745. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58746. VIGNETTEBLENDMODEOPAQUE: boolean;
  58747. TONEMAPPING: boolean;
  58748. TONEMAPPING_ACES: boolean;
  58749. CONTRAST: boolean;
  58750. COLORCURVES: boolean;
  58751. COLORGRADING: boolean;
  58752. COLORGRADING3D: boolean;
  58753. SAMPLER3DGREENDEPTH: boolean;
  58754. SAMPLER3DBGRMAP: boolean;
  58755. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58756. EXPOSURE: boolean;
  58757. MULTIVIEW: boolean;
  58758. USEPHYSICALLIGHTFALLOFF: boolean;
  58759. USEGLTFLIGHTFALLOFF: boolean;
  58760. TWOSIDEDLIGHTING: boolean;
  58761. SHADOWFLOAT: boolean;
  58762. CLIPPLANE: boolean;
  58763. CLIPPLANE2: boolean;
  58764. CLIPPLANE3: boolean;
  58765. CLIPPLANE4: boolean;
  58766. CLIPPLANE5: boolean;
  58767. CLIPPLANE6: boolean;
  58768. POINTSIZE: boolean;
  58769. FOG: boolean;
  58770. LOGARITHMICDEPTH: boolean;
  58771. FORCENORMALFORWARD: boolean;
  58772. SPECULARAA: boolean;
  58773. CLEARCOAT: boolean;
  58774. CLEARCOAT_DEFAULTIOR: boolean;
  58775. CLEARCOAT_TEXTURE: boolean;
  58776. CLEARCOAT_TEXTUREDIRECTUV: number;
  58777. CLEARCOAT_BUMP: boolean;
  58778. CLEARCOAT_BUMPDIRECTUV: number;
  58779. CLEARCOAT_TINT: boolean;
  58780. CLEARCOAT_TINT_TEXTURE: boolean;
  58781. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58782. ANISOTROPIC: boolean;
  58783. ANISOTROPIC_TEXTURE: boolean;
  58784. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58785. BRDF_V_HEIGHT_CORRELATED: boolean;
  58786. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58787. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58788. SHEEN: boolean;
  58789. SHEEN_TEXTURE: boolean;
  58790. SHEEN_TEXTUREDIRECTUV: number;
  58791. SHEEN_LINKWITHALBEDO: boolean;
  58792. SHEEN_ROUGHNESS: boolean;
  58793. SHEEN_ALBEDOSCALING: boolean;
  58794. SUBSURFACE: boolean;
  58795. SS_REFRACTION: boolean;
  58796. SS_TRANSLUCENCY: boolean;
  58797. SS_SCATTERING: boolean;
  58798. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58799. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58800. SS_REFRACTIONMAP_3D: boolean;
  58801. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58802. SS_LODINREFRACTIONALPHA: boolean;
  58803. SS_GAMMAREFRACTION: boolean;
  58804. SS_RGBDREFRACTION: boolean;
  58805. SS_LINEARSPECULARREFRACTION: boolean;
  58806. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58807. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58808. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58809. UNLIT: boolean;
  58810. DEBUGMODE: number;
  58811. /**
  58812. * Initializes the PBR Material defines.
  58813. */
  58814. constructor();
  58815. /**
  58816. * Resets the PBR Material defines.
  58817. */
  58818. reset(): void;
  58819. }
  58820. /**
  58821. * The Physically based material base class of BJS.
  58822. *
  58823. * This offers the main features of a standard PBR material.
  58824. * For more information, please refer to the documentation :
  58825. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58826. */
  58827. export abstract class PBRBaseMaterial extends PushMaterial {
  58828. /**
  58829. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58830. */
  58831. static readonly PBRMATERIAL_OPAQUE: number;
  58832. /**
  58833. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58834. */
  58835. static readonly PBRMATERIAL_ALPHATEST: number;
  58836. /**
  58837. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58838. */
  58839. static readonly PBRMATERIAL_ALPHABLEND: number;
  58840. /**
  58841. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58842. * They are also discarded below the alpha cutoff threshold to improve performances.
  58843. */
  58844. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58845. /**
  58846. * Defines the default value of how much AO map is occluding the analytical lights
  58847. * (point spot...).
  58848. */
  58849. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58850. /**
  58851. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58852. */
  58853. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58854. /**
  58855. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58856. * to enhance interoperability with other engines.
  58857. */
  58858. static readonly LIGHTFALLOFF_GLTF: number;
  58859. /**
  58860. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58861. * to enhance interoperability with other materials.
  58862. */
  58863. static readonly LIGHTFALLOFF_STANDARD: number;
  58864. /**
  58865. * Intensity of the direct lights e.g. the four lights available in your scene.
  58866. * This impacts both the direct diffuse and specular highlights.
  58867. */
  58868. protected _directIntensity: number;
  58869. /**
  58870. * Intensity of the emissive part of the material.
  58871. * This helps controlling the emissive effect without modifying the emissive color.
  58872. */
  58873. protected _emissiveIntensity: number;
  58874. /**
  58875. * Intensity of the environment e.g. how much the environment will light the object
  58876. * either through harmonics for rough material or through the refelction for shiny ones.
  58877. */
  58878. protected _environmentIntensity: number;
  58879. /**
  58880. * This is a special control allowing the reduction of the specular highlights coming from the
  58881. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58882. */
  58883. protected _specularIntensity: number;
  58884. /**
  58885. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  58886. */
  58887. private _lightingInfos;
  58888. /**
  58889. * Debug Control allowing disabling the bump map on this material.
  58890. */
  58891. protected _disableBumpMap: boolean;
  58892. /**
  58893. * AKA Diffuse Texture in standard nomenclature.
  58894. */
  58895. protected _albedoTexture: Nullable<BaseTexture>;
  58896. /**
  58897. * AKA Occlusion Texture in other nomenclature.
  58898. */
  58899. protected _ambientTexture: Nullable<BaseTexture>;
  58900. /**
  58901. * AKA Occlusion Texture Intensity in other nomenclature.
  58902. */
  58903. protected _ambientTextureStrength: number;
  58904. /**
  58905. * Defines how much the AO map is occluding the analytical lights (point spot...).
  58906. * 1 means it completely occludes it
  58907. * 0 mean it has no impact
  58908. */
  58909. protected _ambientTextureImpactOnAnalyticalLights: number;
  58910. /**
  58911. * Stores the alpha values in a texture.
  58912. */
  58913. protected _opacityTexture: Nullable<BaseTexture>;
  58914. /**
  58915. * Stores the reflection values in a texture.
  58916. */
  58917. protected _reflectionTexture: Nullable<BaseTexture>;
  58918. /**
  58919. * Stores the emissive values in a texture.
  58920. */
  58921. protected _emissiveTexture: Nullable<BaseTexture>;
  58922. /**
  58923. * AKA Specular texture in other nomenclature.
  58924. */
  58925. protected _reflectivityTexture: Nullable<BaseTexture>;
  58926. /**
  58927. * Used to switch from specular/glossiness to metallic/roughness workflow.
  58928. */
  58929. protected _metallicTexture: Nullable<BaseTexture>;
  58930. /**
  58931. * Specifies the metallic scalar of the metallic/roughness workflow.
  58932. * Can also be used to scale the metalness values of the metallic texture.
  58933. */
  58934. protected _metallic: Nullable<number>;
  58935. /**
  58936. * Specifies the roughness scalar of the metallic/roughness workflow.
  58937. * Can also be used to scale the roughness values of the metallic texture.
  58938. */
  58939. protected _roughness: Nullable<number>;
  58940. /**
  58941. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  58942. * By default the indexOfrefraction is used to compute F0;
  58943. *
  58944. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  58945. *
  58946. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  58947. * F90 = metallicReflectanceColor;
  58948. */
  58949. protected _metallicF0Factor: number;
  58950. /**
  58951. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  58952. * By default the F90 is always 1;
  58953. *
  58954. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  58955. *
  58956. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  58957. * F90 = metallicReflectanceColor;
  58958. */
  58959. protected _metallicReflectanceColor: Color3;
  58960. /**
  58961. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  58962. * This is multiply against the scalar values defined in the material.
  58963. */
  58964. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  58965. /**
  58966. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  58967. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  58968. */
  58969. protected _microSurfaceTexture: Nullable<BaseTexture>;
  58970. /**
  58971. * Stores surface normal data used to displace a mesh in a texture.
  58972. */
  58973. protected _bumpTexture: Nullable<BaseTexture>;
  58974. /**
  58975. * Stores the pre-calculated light information of a mesh in a texture.
  58976. */
  58977. protected _lightmapTexture: Nullable<BaseTexture>;
  58978. /**
  58979. * The color of a material in ambient lighting.
  58980. */
  58981. protected _ambientColor: Color3;
  58982. /**
  58983. * AKA Diffuse Color in other nomenclature.
  58984. */
  58985. protected _albedoColor: Color3;
  58986. /**
  58987. * AKA Specular Color in other nomenclature.
  58988. */
  58989. protected _reflectivityColor: Color3;
  58990. /**
  58991. * The color applied when light is reflected from a material.
  58992. */
  58993. protected _reflectionColor: Color3;
  58994. /**
  58995. * The color applied when light is emitted from a material.
  58996. */
  58997. protected _emissiveColor: Color3;
  58998. /**
  58999. * AKA Glossiness in other nomenclature.
  59000. */
  59001. protected _microSurface: number;
  59002. /**
  59003. * Specifies that the material will use the light map as a show map.
  59004. */
  59005. protected _useLightmapAsShadowmap: boolean;
  59006. /**
  59007. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59008. * makes the reflect vector face the model (under horizon).
  59009. */
  59010. protected _useHorizonOcclusion: boolean;
  59011. /**
  59012. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59013. * too much the area relying on ambient texture to define their ambient occlusion.
  59014. */
  59015. protected _useRadianceOcclusion: boolean;
  59016. /**
  59017. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59018. */
  59019. protected _useAlphaFromAlbedoTexture: boolean;
  59020. /**
  59021. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59022. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59023. */
  59024. protected _useSpecularOverAlpha: boolean;
  59025. /**
  59026. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59027. */
  59028. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59029. /**
  59030. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59031. */
  59032. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59033. /**
  59034. * Specifies if the metallic texture contains the roughness information in its green channel.
  59035. */
  59036. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59037. /**
  59038. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59039. */
  59040. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59041. /**
  59042. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59043. */
  59044. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59045. /**
  59046. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59047. */
  59048. protected _useAmbientInGrayScale: boolean;
  59049. /**
  59050. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59051. * The material will try to infer what glossiness each pixel should be.
  59052. */
  59053. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59054. /**
  59055. * Defines the falloff type used in this material.
  59056. * It by default is Physical.
  59057. */
  59058. protected _lightFalloff: number;
  59059. /**
  59060. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59061. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59062. */
  59063. protected _useRadianceOverAlpha: boolean;
  59064. /**
  59065. * Allows using an object space normal map (instead of tangent space).
  59066. */
  59067. protected _useObjectSpaceNormalMap: boolean;
  59068. /**
  59069. * Allows using the bump map in parallax mode.
  59070. */
  59071. protected _useParallax: boolean;
  59072. /**
  59073. * Allows using the bump map in parallax occlusion mode.
  59074. */
  59075. protected _useParallaxOcclusion: boolean;
  59076. /**
  59077. * Controls the scale bias of the parallax mode.
  59078. */
  59079. protected _parallaxScaleBias: number;
  59080. /**
  59081. * If sets to true, disables all the lights affecting the material.
  59082. */
  59083. protected _disableLighting: boolean;
  59084. /**
  59085. * Number of Simultaneous lights allowed on the material.
  59086. */
  59087. protected _maxSimultaneousLights: number;
  59088. /**
  59089. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59090. */
  59091. protected _invertNormalMapX: boolean;
  59092. /**
  59093. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59094. */
  59095. protected _invertNormalMapY: boolean;
  59096. /**
  59097. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59098. */
  59099. protected _twoSidedLighting: boolean;
  59100. /**
  59101. * Defines the alpha limits in alpha test mode.
  59102. */
  59103. protected _alphaCutOff: number;
  59104. /**
  59105. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59106. */
  59107. protected _forceAlphaTest: boolean;
  59108. /**
  59109. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59110. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59111. */
  59112. protected _useAlphaFresnel: boolean;
  59113. /**
  59114. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59115. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59116. */
  59117. protected _useLinearAlphaFresnel: boolean;
  59118. /**
  59119. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59120. * from cos thetav and roughness:
  59121. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59122. */
  59123. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59124. /**
  59125. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59126. */
  59127. protected _forceIrradianceInFragment: boolean;
  59128. private _realTimeFiltering;
  59129. /**
  59130. * Enables realtime filtering on the texture.
  59131. */
  59132. get realTimeFiltering(): boolean;
  59133. set realTimeFiltering(b: boolean);
  59134. private _realTimeFilteringQuality;
  59135. /**
  59136. * Quality switch for realtime filtering
  59137. */
  59138. get realTimeFilteringQuality(): number;
  59139. set realTimeFilteringQuality(n: number);
  59140. /**
  59141. * Can this material render to several textures at once
  59142. */
  59143. get canRenderToMRT(): boolean;
  59144. /**
  59145. * Force normal to face away from face.
  59146. */
  59147. protected _forceNormalForward: boolean;
  59148. /**
  59149. * Enables specular anti aliasing in the PBR shader.
  59150. * It will both interacts on the Geometry for analytical and IBL lighting.
  59151. * It also prefilter the roughness map based on the bump values.
  59152. */
  59153. protected _enableSpecularAntiAliasing: boolean;
  59154. /**
  59155. * Default configuration related to image processing available in the PBR Material.
  59156. */
  59157. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59158. /**
  59159. * Keep track of the image processing observer to allow dispose and replace.
  59160. */
  59161. private _imageProcessingObserver;
  59162. /**
  59163. * Attaches a new image processing configuration to the PBR Material.
  59164. * @param configuration
  59165. */
  59166. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59167. /**
  59168. * Stores the available render targets.
  59169. */
  59170. private _renderTargets;
  59171. /**
  59172. * Sets the global ambient color for the material used in lighting calculations.
  59173. */
  59174. private _globalAmbientColor;
  59175. /**
  59176. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59177. */
  59178. private _useLogarithmicDepth;
  59179. /**
  59180. * If set to true, no lighting calculations will be applied.
  59181. */
  59182. private _unlit;
  59183. private _debugMode;
  59184. /**
  59185. * @hidden
  59186. * This is reserved for the inspector.
  59187. * Defines the material debug mode.
  59188. * It helps seeing only some components of the material while troubleshooting.
  59189. */
  59190. debugMode: number;
  59191. /**
  59192. * @hidden
  59193. * This is reserved for the inspector.
  59194. * Specify from where on screen the debug mode should start.
  59195. * The value goes from -1 (full screen) to 1 (not visible)
  59196. * It helps with side by side comparison against the final render
  59197. * This defaults to -1
  59198. */
  59199. private debugLimit;
  59200. /**
  59201. * @hidden
  59202. * This is reserved for the inspector.
  59203. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59204. * You can use the factor to better multiply the final value.
  59205. */
  59206. private debugFactor;
  59207. /**
  59208. * Defines the clear coat layer parameters for the material.
  59209. */
  59210. readonly clearCoat: PBRClearCoatConfiguration;
  59211. /**
  59212. * Defines the anisotropic parameters for the material.
  59213. */
  59214. readonly anisotropy: PBRAnisotropicConfiguration;
  59215. /**
  59216. * Defines the BRDF parameters for the material.
  59217. */
  59218. readonly brdf: PBRBRDFConfiguration;
  59219. /**
  59220. * Defines the Sheen parameters for the material.
  59221. */
  59222. readonly sheen: PBRSheenConfiguration;
  59223. /**
  59224. * Defines the SubSurface parameters for the material.
  59225. */
  59226. readonly subSurface: PBRSubSurfaceConfiguration;
  59227. /**
  59228. * Defines the detail map parameters for the material.
  59229. */
  59230. readonly detailMap: DetailMapConfiguration;
  59231. protected _rebuildInParallel: boolean;
  59232. /**
  59233. * Instantiates a new PBRMaterial instance.
  59234. *
  59235. * @param name The material name
  59236. * @param scene The scene the material will be use in.
  59237. */
  59238. constructor(name: string, scene: Scene);
  59239. /**
  59240. * Gets a boolean indicating that current material needs to register RTT
  59241. */
  59242. get hasRenderTargetTextures(): boolean;
  59243. /**
  59244. * Gets the name of the material class.
  59245. */
  59246. getClassName(): string;
  59247. /**
  59248. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59249. */
  59250. get useLogarithmicDepth(): boolean;
  59251. /**
  59252. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59253. */
  59254. set useLogarithmicDepth(value: boolean);
  59255. /**
  59256. * Returns true if alpha blending should be disabled.
  59257. */
  59258. protected get _disableAlphaBlending(): boolean;
  59259. /**
  59260. * Specifies whether or not this material should be rendered in alpha blend mode.
  59261. */
  59262. needAlphaBlending(): boolean;
  59263. /**
  59264. * Specifies whether or not this material should be rendered in alpha test mode.
  59265. */
  59266. needAlphaTesting(): boolean;
  59267. /**
  59268. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59269. */
  59270. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59271. /**
  59272. * Gets the texture used for the alpha test.
  59273. */
  59274. getAlphaTestTexture(): Nullable<BaseTexture>;
  59275. /**
  59276. * Specifies that the submesh is ready to be used.
  59277. * @param mesh - BJS mesh.
  59278. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59279. * @param useInstances - Specifies that instances should be used.
  59280. * @returns - boolean indicating that the submesh is ready or not.
  59281. */
  59282. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59283. /**
  59284. * Specifies if the material uses metallic roughness workflow.
  59285. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59286. */
  59287. isMetallicWorkflow(): boolean;
  59288. private _prepareEffect;
  59289. private _prepareDefines;
  59290. /**
  59291. * Force shader compilation
  59292. */
  59293. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59294. /**
  59295. * Initializes the uniform buffer layout for the shader.
  59296. */
  59297. buildUniformLayout(): void;
  59298. /**
  59299. * Unbinds the material from the mesh
  59300. */
  59301. unbind(): void;
  59302. /**
  59303. * Binds the submesh data.
  59304. * @param world - The world matrix.
  59305. * @param mesh - The BJS mesh.
  59306. * @param subMesh - A submesh of the BJS mesh.
  59307. */
  59308. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59309. /**
  59310. * Returns the animatable textures.
  59311. * @returns - Array of animatable textures.
  59312. */
  59313. getAnimatables(): IAnimatable[];
  59314. /**
  59315. * Returns the texture used for reflections.
  59316. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59317. */
  59318. private _getReflectionTexture;
  59319. /**
  59320. * Returns an array of the actively used textures.
  59321. * @returns - Array of BaseTextures
  59322. */
  59323. getActiveTextures(): BaseTexture[];
  59324. /**
  59325. * Checks to see if a texture is used in the material.
  59326. * @param texture - Base texture to use.
  59327. * @returns - Boolean specifying if a texture is used in the material.
  59328. */
  59329. hasTexture(texture: BaseTexture): boolean;
  59330. /**
  59331. * Sets the required values to the prepass renderer.
  59332. * @param prePassRenderer defines the prepass renderer to setup
  59333. */
  59334. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59335. /**
  59336. * Disposes the resources of the material.
  59337. * @param forceDisposeEffect - Forces the disposal of effects.
  59338. * @param forceDisposeTextures - Forces the disposal of all textures.
  59339. */
  59340. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59341. }
  59342. }
  59343. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59344. import { Nullable } from "babylonjs/types";
  59345. import { Scene } from "babylonjs/scene";
  59346. import { Color3 } from "babylonjs/Maths/math.color";
  59347. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59348. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59349. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59350. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59351. /**
  59352. * The Physically based material of BJS.
  59353. *
  59354. * This offers the main features of a standard PBR material.
  59355. * For more information, please refer to the documentation :
  59356. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59357. */
  59358. export class PBRMaterial extends PBRBaseMaterial {
  59359. /**
  59360. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59361. */
  59362. static readonly PBRMATERIAL_OPAQUE: number;
  59363. /**
  59364. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59365. */
  59366. static readonly PBRMATERIAL_ALPHATEST: number;
  59367. /**
  59368. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59369. */
  59370. static readonly PBRMATERIAL_ALPHABLEND: number;
  59371. /**
  59372. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59373. * They are also discarded below the alpha cutoff threshold to improve performances.
  59374. */
  59375. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59376. /**
  59377. * Defines the default value of how much AO map is occluding the analytical lights
  59378. * (point spot...).
  59379. */
  59380. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59381. /**
  59382. * Intensity of the direct lights e.g. the four lights available in your scene.
  59383. * This impacts both the direct diffuse and specular highlights.
  59384. */
  59385. directIntensity: number;
  59386. /**
  59387. * Intensity of the emissive part of the material.
  59388. * This helps controlling the emissive effect without modifying the emissive color.
  59389. */
  59390. emissiveIntensity: number;
  59391. /**
  59392. * Intensity of the environment e.g. how much the environment will light the object
  59393. * either through harmonics for rough material or through the refelction for shiny ones.
  59394. */
  59395. environmentIntensity: number;
  59396. /**
  59397. * This is a special control allowing the reduction of the specular highlights coming from the
  59398. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59399. */
  59400. specularIntensity: number;
  59401. /**
  59402. * Debug Control allowing disabling the bump map on this material.
  59403. */
  59404. disableBumpMap: boolean;
  59405. /**
  59406. * AKA Diffuse Texture in standard nomenclature.
  59407. */
  59408. albedoTexture: BaseTexture;
  59409. /**
  59410. * AKA Occlusion Texture in other nomenclature.
  59411. */
  59412. ambientTexture: BaseTexture;
  59413. /**
  59414. * AKA Occlusion Texture Intensity in other nomenclature.
  59415. */
  59416. ambientTextureStrength: number;
  59417. /**
  59418. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59419. * 1 means it completely occludes it
  59420. * 0 mean it has no impact
  59421. */
  59422. ambientTextureImpactOnAnalyticalLights: number;
  59423. /**
  59424. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59425. */
  59426. opacityTexture: BaseTexture;
  59427. /**
  59428. * Stores the reflection values in a texture.
  59429. */
  59430. reflectionTexture: Nullable<BaseTexture>;
  59431. /**
  59432. * Stores the emissive values in a texture.
  59433. */
  59434. emissiveTexture: BaseTexture;
  59435. /**
  59436. * AKA Specular texture in other nomenclature.
  59437. */
  59438. reflectivityTexture: BaseTexture;
  59439. /**
  59440. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59441. */
  59442. metallicTexture: BaseTexture;
  59443. /**
  59444. * Specifies the metallic scalar of the metallic/roughness workflow.
  59445. * Can also be used to scale the metalness values of the metallic texture.
  59446. */
  59447. metallic: Nullable<number>;
  59448. /**
  59449. * Specifies the roughness scalar of the metallic/roughness workflow.
  59450. * Can also be used to scale the roughness values of the metallic texture.
  59451. */
  59452. roughness: Nullable<number>;
  59453. /**
  59454. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59455. * By default the indexOfrefraction is used to compute F0;
  59456. *
  59457. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59458. *
  59459. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59460. * F90 = metallicReflectanceColor;
  59461. */
  59462. metallicF0Factor: number;
  59463. /**
  59464. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59465. * By default the F90 is always 1;
  59466. *
  59467. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59468. *
  59469. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59470. * F90 = metallicReflectanceColor;
  59471. */
  59472. metallicReflectanceColor: Color3;
  59473. /**
  59474. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59475. * This is multiply against the scalar values defined in the material.
  59476. */
  59477. metallicReflectanceTexture: Nullable<BaseTexture>;
  59478. /**
  59479. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59480. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59481. */
  59482. microSurfaceTexture: BaseTexture;
  59483. /**
  59484. * Stores surface normal data used to displace a mesh in a texture.
  59485. */
  59486. bumpTexture: BaseTexture;
  59487. /**
  59488. * Stores the pre-calculated light information of a mesh in a texture.
  59489. */
  59490. lightmapTexture: BaseTexture;
  59491. /**
  59492. * Stores the refracted light information in a texture.
  59493. */
  59494. get refractionTexture(): Nullable<BaseTexture>;
  59495. set refractionTexture(value: Nullable<BaseTexture>);
  59496. /**
  59497. * The color of a material in ambient lighting.
  59498. */
  59499. ambientColor: Color3;
  59500. /**
  59501. * AKA Diffuse Color in other nomenclature.
  59502. */
  59503. albedoColor: Color3;
  59504. /**
  59505. * AKA Specular Color in other nomenclature.
  59506. */
  59507. reflectivityColor: Color3;
  59508. /**
  59509. * The color reflected from the material.
  59510. */
  59511. reflectionColor: Color3;
  59512. /**
  59513. * The color emitted from the material.
  59514. */
  59515. emissiveColor: Color3;
  59516. /**
  59517. * AKA Glossiness in other nomenclature.
  59518. */
  59519. microSurface: number;
  59520. /**
  59521. * Index of refraction of the material base layer.
  59522. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59523. *
  59524. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59525. *
  59526. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59527. */
  59528. get indexOfRefraction(): number;
  59529. set indexOfRefraction(value: number);
  59530. /**
  59531. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59532. */
  59533. get invertRefractionY(): boolean;
  59534. set invertRefractionY(value: boolean);
  59535. /**
  59536. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59537. * Materials half opaque for instance using refraction could benefit from this control.
  59538. */
  59539. get linkRefractionWithTransparency(): boolean;
  59540. set linkRefractionWithTransparency(value: boolean);
  59541. /**
  59542. * If true, the light map contains occlusion information instead of lighting info.
  59543. */
  59544. useLightmapAsShadowmap: boolean;
  59545. /**
  59546. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59547. */
  59548. useAlphaFromAlbedoTexture: boolean;
  59549. /**
  59550. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59551. */
  59552. forceAlphaTest: boolean;
  59553. /**
  59554. * Defines the alpha limits in alpha test mode.
  59555. */
  59556. alphaCutOff: number;
  59557. /**
  59558. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59559. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59560. */
  59561. useSpecularOverAlpha: boolean;
  59562. /**
  59563. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59564. */
  59565. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59566. /**
  59567. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59568. */
  59569. useRoughnessFromMetallicTextureAlpha: boolean;
  59570. /**
  59571. * Specifies if the metallic texture contains the roughness information in its green channel.
  59572. */
  59573. useRoughnessFromMetallicTextureGreen: boolean;
  59574. /**
  59575. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59576. */
  59577. useMetallnessFromMetallicTextureBlue: boolean;
  59578. /**
  59579. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59580. */
  59581. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59582. /**
  59583. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59584. */
  59585. useAmbientInGrayScale: boolean;
  59586. /**
  59587. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59588. * The material will try to infer what glossiness each pixel should be.
  59589. */
  59590. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59591. /**
  59592. * BJS is using an harcoded light falloff based on a manually sets up range.
  59593. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59594. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59595. */
  59596. get usePhysicalLightFalloff(): boolean;
  59597. /**
  59598. * BJS is using an harcoded light falloff based on a manually sets up range.
  59599. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59600. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59601. */
  59602. set usePhysicalLightFalloff(value: boolean);
  59603. /**
  59604. * In order to support the falloff compatibility with gltf, a special mode has been added
  59605. * to reproduce the gltf light falloff.
  59606. */
  59607. get useGLTFLightFalloff(): boolean;
  59608. /**
  59609. * In order to support the falloff compatibility with gltf, a special mode has been added
  59610. * to reproduce the gltf light falloff.
  59611. */
  59612. set useGLTFLightFalloff(value: boolean);
  59613. /**
  59614. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59615. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59616. */
  59617. useRadianceOverAlpha: boolean;
  59618. /**
  59619. * Allows using an object space normal map (instead of tangent space).
  59620. */
  59621. useObjectSpaceNormalMap: boolean;
  59622. /**
  59623. * Allows using the bump map in parallax mode.
  59624. */
  59625. useParallax: boolean;
  59626. /**
  59627. * Allows using the bump map in parallax occlusion mode.
  59628. */
  59629. useParallaxOcclusion: boolean;
  59630. /**
  59631. * Controls the scale bias of the parallax mode.
  59632. */
  59633. parallaxScaleBias: number;
  59634. /**
  59635. * If sets to true, disables all the lights affecting the material.
  59636. */
  59637. disableLighting: boolean;
  59638. /**
  59639. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59640. */
  59641. forceIrradianceInFragment: boolean;
  59642. /**
  59643. * Number of Simultaneous lights allowed on the material.
  59644. */
  59645. maxSimultaneousLights: number;
  59646. /**
  59647. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59648. */
  59649. invertNormalMapX: boolean;
  59650. /**
  59651. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59652. */
  59653. invertNormalMapY: boolean;
  59654. /**
  59655. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59656. */
  59657. twoSidedLighting: boolean;
  59658. /**
  59659. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59660. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59661. */
  59662. useAlphaFresnel: boolean;
  59663. /**
  59664. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59665. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59666. */
  59667. useLinearAlphaFresnel: boolean;
  59668. /**
  59669. * Let user defines the brdf lookup texture used for IBL.
  59670. * A default 8bit version is embedded but you could point at :
  59671. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59672. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59673. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59674. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59675. */
  59676. environmentBRDFTexture: Nullable<BaseTexture>;
  59677. /**
  59678. * Force normal to face away from face.
  59679. */
  59680. forceNormalForward: boolean;
  59681. /**
  59682. * Enables specular anti aliasing in the PBR shader.
  59683. * It will both interacts on the Geometry for analytical and IBL lighting.
  59684. * It also prefilter the roughness map based on the bump values.
  59685. */
  59686. enableSpecularAntiAliasing: boolean;
  59687. /**
  59688. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59689. * makes the reflect vector face the model (under horizon).
  59690. */
  59691. useHorizonOcclusion: boolean;
  59692. /**
  59693. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59694. * too much the area relying on ambient texture to define their ambient occlusion.
  59695. */
  59696. useRadianceOcclusion: boolean;
  59697. /**
  59698. * If set to true, no lighting calculations will be applied.
  59699. */
  59700. unlit: boolean;
  59701. /**
  59702. * Gets the image processing configuration used either in this material.
  59703. */
  59704. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59705. /**
  59706. * Sets the Default image processing configuration used either in the this material.
  59707. *
  59708. * If sets to null, the scene one is in use.
  59709. */
  59710. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59711. /**
  59712. * Gets wether the color curves effect is enabled.
  59713. */
  59714. get cameraColorCurvesEnabled(): boolean;
  59715. /**
  59716. * Sets wether the color curves effect is enabled.
  59717. */
  59718. set cameraColorCurvesEnabled(value: boolean);
  59719. /**
  59720. * Gets wether the color grading effect is enabled.
  59721. */
  59722. get cameraColorGradingEnabled(): boolean;
  59723. /**
  59724. * Gets wether the color grading effect is enabled.
  59725. */
  59726. set cameraColorGradingEnabled(value: boolean);
  59727. /**
  59728. * Gets wether tonemapping is enabled or not.
  59729. */
  59730. get cameraToneMappingEnabled(): boolean;
  59731. /**
  59732. * Sets wether tonemapping is enabled or not
  59733. */
  59734. set cameraToneMappingEnabled(value: boolean);
  59735. /**
  59736. * The camera exposure used on this material.
  59737. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59738. * This corresponds to a photographic exposure.
  59739. */
  59740. get cameraExposure(): number;
  59741. /**
  59742. * The camera exposure used on this material.
  59743. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59744. * This corresponds to a photographic exposure.
  59745. */
  59746. set cameraExposure(value: number);
  59747. /**
  59748. * Gets The camera contrast used on this material.
  59749. */
  59750. get cameraContrast(): number;
  59751. /**
  59752. * Sets The camera contrast used on this material.
  59753. */
  59754. set cameraContrast(value: number);
  59755. /**
  59756. * Gets the Color Grading 2D Lookup Texture.
  59757. */
  59758. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59759. /**
  59760. * Sets the Color Grading 2D Lookup Texture.
  59761. */
  59762. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59763. /**
  59764. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59765. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59766. * 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;
  59767. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59768. */
  59769. get cameraColorCurves(): Nullable<ColorCurves>;
  59770. /**
  59771. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59772. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59773. * 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;
  59774. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59775. */
  59776. set cameraColorCurves(value: Nullable<ColorCurves>);
  59777. /**
  59778. * Instantiates a new PBRMaterial instance.
  59779. *
  59780. * @param name The material name
  59781. * @param scene The scene the material will be use in.
  59782. */
  59783. constructor(name: string, scene: Scene);
  59784. /**
  59785. * Returns the name of this material class.
  59786. */
  59787. getClassName(): string;
  59788. /**
  59789. * Makes a duplicate of the current material.
  59790. * @param name - name to use for the new material.
  59791. */
  59792. clone(name: string): PBRMaterial;
  59793. /**
  59794. * Serializes this PBR Material.
  59795. * @returns - An object with the serialized material.
  59796. */
  59797. serialize(): any;
  59798. /**
  59799. * Parses a PBR Material from a serialized object.
  59800. * @param source - Serialized object.
  59801. * @param scene - BJS scene instance.
  59802. * @param rootUrl - url for the scene object
  59803. * @returns - PBRMaterial
  59804. */
  59805. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59806. }
  59807. }
  59808. declare module "babylonjs/Misc/dds" {
  59809. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59810. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59811. import { Nullable } from "babylonjs/types";
  59812. import { Scene } from "babylonjs/scene";
  59813. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59814. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59815. /**
  59816. * Direct draw surface info
  59817. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59818. */
  59819. export interface DDSInfo {
  59820. /**
  59821. * Width of the texture
  59822. */
  59823. width: number;
  59824. /**
  59825. * Width of the texture
  59826. */
  59827. height: number;
  59828. /**
  59829. * Number of Mipmaps for the texture
  59830. * @see https://en.wikipedia.org/wiki/Mipmap
  59831. */
  59832. mipmapCount: number;
  59833. /**
  59834. * If the textures format is a known fourCC format
  59835. * @see https://www.fourcc.org/
  59836. */
  59837. isFourCC: boolean;
  59838. /**
  59839. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59840. */
  59841. isRGB: boolean;
  59842. /**
  59843. * If the texture is a lumincance format
  59844. */
  59845. isLuminance: boolean;
  59846. /**
  59847. * If this is a cube texture
  59848. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59849. */
  59850. isCube: boolean;
  59851. /**
  59852. * If the texture is a compressed format eg. FOURCC_DXT1
  59853. */
  59854. isCompressed: boolean;
  59855. /**
  59856. * The dxgiFormat of the texture
  59857. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59858. */
  59859. dxgiFormat: number;
  59860. /**
  59861. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59862. */
  59863. textureType: number;
  59864. /**
  59865. * Sphericle polynomial created for the dds texture
  59866. */
  59867. sphericalPolynomial?: SphericalPolynomial;
  59868. }
  59869. /**
  59870. * Class used to provide DDS decompression tools
  59871. */
  59872. export class DDSTools {
  59873. /**
  59874. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  59875. */
  59876. static StoreLODInAlphaChannel: boolean;
  59877. /**
  59878. * Gets DDS information from an array buffer
  59879. * @param data defines the array buffer view to read data from
  59880. * @returns the DDS information
  59881. */
  59882. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  59883. private static _FloatView;
  59884. private static _Int32View;
  59885. private static _ToHalfFloat;
  59886. private static _FromHalfFloat;
  59887. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  59888. private static _GetHalfFloatRGBAArrayBuffer;
  59889. private static _GetFloatRGBAArrayBuffer;
  59890. private static _GetFloatAsUIntRGBAArrayBuffer;
  59891. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  59892. private static _GetRGBAArrayBuffer;
  59893. private static _ExtractLongWordOrder;
  59894. private static _GetRGBArrayBuffer;
  59895. private static _GetLuminanceArrayBuffer;
  59896. /**
  59897. * Uploads DDS Levels to a Babylon Texture
  59898. * @hidden
  59899. */
  59900. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  59901. }
  59902. module "babylonjs/Engines/thinEngine" {
  59903. interface ThinEngine {
  59904. /**
  59905. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  59906. * @param rootUrl defines the url where the file to load is located
  59907. * @param scene defines the current scene
  59908. * @param lodScale defines scale to apply to the mip map selection
  59909. * @param lodOffset defines offset to apply to the mip map selection
  59910. * @param onLoad defines an optional callback raised when the texture is loaded
  59911. * @param onError defines an optional callback raised if there is an issue to load the texture
  59912. * @param format defines the format of the data
  59913. * @param forcedExtension defines the extension to use to pick the right loader
  59914. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  59915. * @returns the cube texture as an InternalTexture
  59916. */
  59917. 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;
  59918. }
  59919. }
  59920. }
  59921. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  59922. import { Nullable } from "babylonjs/types";
  59923. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59924. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59925. /**
  59926. * Implementation of the DDS Texture Loader.
  59927. * @hidden
  59928. */
  59929. export class _DDSTextureLoader implements IInternalTextureLoader {
  59930. /**
  59931. * Defines wether the loader supports cascade loading the different faces.
  59932. */
  59933. readonly supportCascades: boolean;
  59934. /**
  59935. * This returns if the loader support the current file information.
  59936. * @param extension defines the file extension of the file being loaded
  59937. * @returns true if the loader can load the specified file
  59938. */
  59939. canLoad(extension: string): boolean;
  59940. /**
  59941. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59942. * @param data contains the texture data
  59943. * @param texture defines the BabylonJS internal texture
  59944. * @param createPolynomials will be true if polynomials have been requested
  59945. * @param onLoad defines the callback to trigger once the texture is ready
  59946. * @param onError defines the callback to trigger in case of error
  59947. */
  59948. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59949. /**
  59950. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59951. * @param data contains the texture data
  59952. * @param texture defines the BabylonJS internal texture
  59953. * @param callback defines the method to call once ready to upload
  59954. */
  59955. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59956. }
  59957. }
  59958. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  59959. import { Nullable } from "babylonjs/types";
  59960. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59961. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59962. /**
  59963. * Implementation of the ENV Texture Loader.
  59964. * @hidden
  59965. */
  59966. export class _ENVTextureLoader implements IInternalTextureLoader {
  59967. /**
  59968. * Defines wether the loader supports cascade loading the different faces.
  59969. */
  59970. readonly supportCascades: boolean;
  59971. /**
  59972. * This returns if the loader support the current file information.
  59973. * @param extension defines the file extension of the file being loaded
  59974. * @returns true if the loader can load the specified file
  59975. */
  59976. canLoad(extension: string): boolean;
  59977. /**
  59978. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59979. * @param data contains the texture data
  59980. * @param texture defines the BabylonJS internal texture
  59981. * @param createPolynomials will be true if polynomials have been requested
  59982. * @param onLoad defines the callback to trigger once the texture is ready
  59983. * @param onError defines the callback to trigger in case of error
  59984. */
  59985. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59986. /**
  59987. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59988. * @param data contains the texture data
  59989. * @param texture defines the BabylonJS internal texture
  59990. * @param callback defines the method to call once ready to upload
  59991. */
  59992. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59993. }
  59994. }
  59995. declare module "babylonjs/Misc/khronosTextureContainer" {
  59996. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59997. /**
  59998. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  59999. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60000. */
  60001. export class KhronosTextureContainer {
  60002. /** contents of the KTX container file */
  60003. data: ArrayBufferView;
  60004. private static HEADER_LEN;
  60005. private static COMPRESSED_2D;
  60006. private static COMPRESSED_3D;
  60007. private static TEX_2D;
  60008. private static TEX_3D;
  60009. /**
  60010. * Gets the openGL type
  60011. */
  60012. glType: number;
  60013. /**
  60014. * Gets the openGL type size
  60015. */
  60016. glTypeSize: number;
  60017. /**
  60018. * Gets the openGL format
  60019. */
  60020. glFormat: number;
  60021. /**
  60022. * Gets the openGL internal format
  60023. */
  60024. glInternalFormat: number;
  60025. /**
  60026. * Gets the base internal format
  60027. */
  60028. glBaseInternalFormat: number;
  60029. /**
  60030. * Gets image width in pixel
  60031. */
  60032. pixelWidth: number;
  60033. /**
  60034. * Gets image height in pixel
  60035. */
  60036. pixelHeight: number;
  60037. /**
  60038. * Gets image depth in pixels
  60039. */
  60040. pixelDepth: number;
  60041. /**
  60042. * Gets the number of array elements
  60043. */
  60044. numberOfArrayElements: number;
  60045. /**
  60046. * Gets the number of faces
  60047. */
  60048. numberOfFaces: number;
  60049. /**
  60050. * Gets the number of mipmap levels
  60051. */
  60052. numberOfMipmapLevels: number;
  60053. /**
  60054. * Gets the bytes of key value data
  60055. */
  60056. bytesOfKeyValueData: number;
  60057. /**
  60058. * Gets the load type
  60059. */
  60060. loadType: number;
  60061. /**
  60062. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60063. */
  60064. isInvalid: boolean;
  60065. /**
  60066. * Creates a new KhronosTextureContainer
  60067. * @param data contents of the KTX container file
  60068. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60069. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60070. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60071. */
  60072. constructor(
  60073. /** contents of the KTX container file */
  60074. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60075. /**
  60076. * Uploads KTX content to a Babylon Texture.
  60077. * It is assumed that the texture has already been created & is currently bound
  60078. * @hidden
  60079. */
  60080. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60081. private _upload2DCompressedLevels;
  60082. /**
  60083. * Checks if the given data starts with a KTX file identifier.
  60084. * @param data the data to check
  60085. * @returns true if the data is a KTX file or false otherwise
  60086. */
  60087. static IsValid(data: ArrayBufferView): boolean;
  60088. }
  60089. }
  60090. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60091. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60092. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60093. /**
  60094. * Class for loading KTX2 files
  60095. * !!! Experimental Extension Subject to Changes !!!
  60096. * @hidden
  60097. */
  60098. export class KhronosTextureContainer2 {
  60099. private static _ModulePromise;
  60100. private static _TranscodeFormat;
  60101. constructor(engine: ThinEngine);
  60102. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60103. private _determineTranscodeFormat;
  60104. /**
  60105. * Checks if the given data starts with a KTX2 file identifier.
  60106. * @param data the data to check
  60107. * @returns true if the data is a KTX2 file or false otherwise
  60108. */
  60109. static IsValid(data: ArrayBufferView): boolean;
  60110. }
  60111. }
  60112. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60113. import { Nullable } from "babylonjs/types";
  60114. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60115. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60116. /**
  60117. * Implementation of the KTX Texture Loader.
  60118. * @hidden
  60119. */
  60120. export class _KTXTextureLoader implements IInternalTextureLoader {
  60121. /**
  60122. * Defines wether the loader supports cascade loading the different faces.
  60123. */
  60124. readonly supportCascades: boolean;
  60125. /**
  60126. * This returns if the loader support the current file information.
  60127. * @param extension defines the file extension of the file being loaded
  60128. * @param mimeType defines the optional mime type of the file being loaded
  60129. * @returns true if the loader can load the specified file
  60130. */
  60131. canLoad(extension: string, mimeType?: string): boolean;
  60132. /**
  60133. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60134. * @param data contains the texture data
  60135. * @param texture defines the BabylonJS internal texture
  60136. * @param createPolynomials will be true if polynomials have been requested
  60137. * @param onLoad defines the callback to trigger once the texture is ready
  60138. * @param onError defines the callback to trigger in case of error
  60139. */
  60140. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60141. /**
  60142. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60143. * @param data contains the texture data
  60144. * @param texture defines the BabylonJS internal texture
  60145. * @param callback defines the method to call once ready to upload
  60146. */
  60147. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60148. }
  60149. }
  60150. declare module "babylonjs/Helpers/sceneHelpers" {
  60151. import { Nullable } from "babylonjs/types";
  60152. import { Mesh } from "babylonjs/Meshes/mesh";
  60153. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60154. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60155. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60156. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60157. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60158. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60159. import "babylonjs/Meshes/Builders/boxBuilder";
  60160. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60161. /** @hidden */
  60162. export var _forceSceneHelpersToBundle: boolean;
  60163. module "babylonjs/scene" {
  60164. interface Scene {
  60165. /**
  60166. * Creates a default light for the scene.
  60167. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60168. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60169. */
  60170. createDefaultLight(replace?: boolean): void;
  60171. /**
  60172. * Creates a default camera for the scene.
  60173. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60174. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60175. * @param replace has default false, when true replaces the active camera in the scene
  60176. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60177. */
  60178. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60179. /**
  60180. * Creates a default camera and a default light.
  60181. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60182. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60183. * @param replace has the default false, when true replaces the active camera/light in the scene
  60184. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60185. */
  60186. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60187. /**
  60188. * Creates a new sky box
  60189. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60190. * @param environmentTexture defines the texture to use as environment texture
  60191. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60192. * @param scale defines the overall scale of the skybox
  60193. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60194. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60195. * @returns a new mesh holding the sky box
  60196. */
  60197. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60198. /**
  60199. * Creates a new environment
  60200. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60201. * @param options defines the options you can use to configure the environment
  60202. * @returns the new EnvironmentHelper
  60203. */
  60204. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60205. /**
  60206. * Creates a new VREXperienceHelper
  60207. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60208. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60209. * @returns a new VREXperienceHelper
  60210. */
  60211. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60212. /**
  60213. * Creates a new WebXRDefaultExperience
  60214. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60215. * @param options experience options
  60216. * @returns a promise for a new WebXRDefaultExperience
  60217. */
  60218. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60219. }
  60220. }
  60221. }
  60222. declare module "babylonjs/Helpers/videoDome" {
  60223. import { Scene } from "babylonjs/scene";
  60224. import { TransformNode } from "babylonjs/Meshes/transformNode";
  60225. import { Mesh } from "babylonjs/Meshes/mesh";
  60226. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60227. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  60228. import "babylonjs/Meshes/Builders/sphereBuilder";
  60229. /**
  60230. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60231. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60232. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60233. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60234. */
  60235. export class VideoDome extends TransformNode {
  60236. /**
  60237. * Define the video source as a Monoscopic panoramic 360 video.
  60238. */
  60239. static readonly MODE_MONOSCOPIC: number;
  60240. /**
  60241. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60242. */
  60243. static readonly MODE_TOPBOTTOM: number;
  60244. /**
  60245. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60246. */
  60247. static readonly MODE_SIDEBYSIDE: number;
  60248. private _halfDome;
  60249. private _useDirectMapping;
  60250. /**
  60251. * The video texture being displayed on the sphere
  60252. */
  60253. protected _videoTexture: VideoTexture;
  60254. /**
  60255. * Gets the video texture being displayed on the sphere
  60256. */
  60257. get videoTexture(): VideoTexture;
  60258. /**
  60259. * The skybox material
  60260. */
  60261. protected _material: BackgroundMaterial;
  60262. /**
  60263. * The surface used for the video dome
  60264. */
  60265. protected _mesh: Mesh;
  60266. /**
  60267. * Gets the mesh used for the video dome.
  60268. */
  60269. get mesh(): Mesh;
  60270. /**
  60271. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  60272. */
  60273. private _halfDomeMask;
  60274. /**
  60275. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  60276. * Also see the options.resolution property.
  60277. */
  60278. get fovMultiplier(): number;
  60279. set fovMultiplier(value: number);
  60280. private _videoMode;
  60281. /**
  60282. * Gets or set the current video mode for the video. It can be:
  60283. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  60284. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60285. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60286. */
  60287. get videoMode(): number;
  60288. set videoMode(value: number);
  60289. /**
  60290. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  60291. *
  60292. */
  60293. get halfDome(): boolean;
  60294. /**
  60295. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  60296. */
  60297. set halfDome(enabled: boolean);
  60298. /**
  60299. * Oberserver used in Stereoscopic VR Mode.
  60300. */
  60301. private _onBeforeCameraRenderObserver;
  60302. /**
  60303. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  60304. * @param name Element's name, child elements will append suffixes for their own names.
  60305. * @param urlsOrVideo defines the url(s) or the video element to use
  60306. * @param options An object containing optional or exposed sub element properties
  60307. */
  60308. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  60309. resolution?: number;
  60310. clickToPlay?: boolean;
  60311. autoPlay?: boolean;
  60312. loop?: boolean;
  60313. size?: number;
  60314. poster?: string;
  60315. faceForward?: boolean;
  60316. useDirectMapping?: boolean;
  60317. halfDomeMode?: boolean;
  60318. }, scene: Scene);
  60319. private _changeVideoMode;
  60320. /**
  60321. * Releases resources associated with this node.
  60322. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  60323. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  60324. */
  60325. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  60326. }
  60327. }
  60328. declare module "babylonjs/Helpers/index" {
  60329. export * from "babylonjs/Helpers/environmentHelper";
  60330. export * from "babylonjs/Helpers/photoDome";
  60331. export * from "babylonjs/Helpers/sceneHelpers";
  60332. export * from "babylonjs/Helpers/videoDome";
  60333. }
  60334. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60335. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60336. import { IDisposable } from "babylonjs/scene";
  60337. import { Engine } from "babylonjs/Engines/engine";
  60338. /**
  60339. * This class can be used to get instrumentation data from a Babylon engine
  60340. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60341. */
  60342. export class EngineInstrumentation implements IDisposable {
  60343. /**
  60344. * Define the instrumented engine.
  60345. */
  60346. engine: Engine;
  60347. private _captureGPUFrameTime;
  60348. private _gpuFrameTimeToken;
  60349. private _gpuFrameTime;
  60350. private _captureShaderCompilationTime;
  60351. private _shaderCompilationTime;
  60352. private _onBeginFrameObserver;
  60353. private _onEndFrameObserver;
  60354. private _onBeforeShaderCompilationObserver;
  60355. private _onAfterShaderCompilationObserver;
  60356. /**
  60357. * Gets the perf counter used for GPU frame time
  60358. */
  60359. get gpuFrameTimeCounter(): PerfCounter;
  60360. /**
  60361. * Gets the GPU frame time capture status
  60362. */
  60363. get captureGPUFrameTime(): boolean;
  60364. /**
  60365. * Enable or disable the GPU frame time capture
  60366. */
  60367. set captureGPUFrameTime(value: boolean);
  60368. /**
  60369. * Gets the perf counter used for shader compilation time
  60370. */
  60371. get shaderCompilationTimeCounter(): PerfCounter;
  60372. /**
  60373. * Gets the shader compilation time capture status
  60374. */
  60375. get captureShaderCompilationTime(): boolean;
  60376. /**
  60377. * Enable or disable the shader compilation time capture
  60378. */
  60379. set captureShaderCompilationTime(value: boolean);
  60380. /**
  60381. * Instantiates a new engine instrumentation.
  60382. * This class can be used to get instrumentation data from a Babylon engine
  60383. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60384. * @param engine Defines the engine to instrument
  60385. */
  60386. constructor(
  60387. /**
  60388. * Define the instrumented engine.
  60389. */
  60390. engine: Engine);
  60391. /**
  60392. * Dispose and release associated resources.
  60393. */
  60394. dispose(): void;
  60395. }
  60396. }
  60397. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60398. import { Scene, IDisposable } from "babylonjs/scene";
  60399. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60400. /**
  60401. * This class can be used to get instrumentation data from a Babylon engine
  60402. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60403. */
  60404. export class SceneInstrumentation implements IDisposable {
  60405. /**
  60406. * Defines the scene to instrument
  60407. */
  60408. scene: Scene;
  60409. private _captureActiveMeshesEvaluationTime;
  60410. private _activeMeshesEvaluationTime;
  60411. private _captureRenderTargetsRenderTime;
  60412. private _renderTargetsRenderTime;
  60413. private _captureFrameTime;
  60414. private _frameTime;
  60415. private _captureRenderTime;
  60416. private _renderTime;
  60417. private _captureInterFrameTime;
  60418. private _interFrameTime;
  60419. private _captureParticlesRenderTime;
  60420. private _particlesRenderTime;
  60421. private _captureSpritesRenderTime;
  60422. private _spritesRenderTime;
  60423. private _capturePhysicsTime;
  60424. private _physicsTime;
  60425. private _captureAnimationsTime;
  60426. private _animationsTime;
  60427. private _captureCameraRenderTime;
  60428. private _cameraRenderTime;
  60429. private _onBeforeActiveMeshesEvaluationObserver;
  60430. private _onAfterActiveMeshesEvaluationObserver;
  60431. private _onBeforeRenderTargetsRenderObserver;
  60432. private _onAfterRenderTargetsRenderObserver;
  60433. private _onAfterRenderObserver;
  60434. private _onBeforeDrawPhaseObserver;
  60435. private _onAfterDrawPhaseObserver;
  60436. private _onBeforeAnimationsObserver;
  60437. private _onBeforeParticlesRenderingObserver;
  60438. private _onAfterParticlesRenderingObserver;
  60439. private _onBeforeSpritesRenderingObserver;
  60440. private _onAfterSpritesRenderingObserver;
  60441. private _onBeforePhysicsObserver;
  60442. private _onAfterPhysicsObserver;
  60443. private _onAfterAnimationsObserver;
  60444. private _onBeforeCameraRenderObserver;
  60445. private _onAfterCameraRenderObserver;
  60446. /**
  60447. * Gets the perf counter used for active meshes evaluation time
  60448. */
  60449. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60450. /**
  60451. * Gets the active meshes evaluation time capture status
  60452. */
  60453. get captureActiveMeshesEvaluationTime(): boolean;
  60454. /**
  60455. * Enable or disable the active meshes evaluation time capture
  60456. */
  60457. set captureActiveMeshesEvaluationTime(value: boolean);
  60458. /**
  60459. * Gets the perf counter used for render targets render time
  60460. */
  60461. get renderTargetsRenderTimeCounter(): PerfCounter;
  60462. /**
  60463. * Gets the render targets render time capture status
  60464. */
  60465. get captureRenderTargetsRenderTime(): boolean;
  60466. /**
  60467. * Enable or disable the render targets render time capture
  60468. */
  60469. set captureRenderTargetsRenderTime(value: boolean);
  60470. /**
  60471. * Gets the perf counter used for particles render time
  60472. */
  60473. get particlesRenderTimeCounter(): PerfCounter;
  60474. /**
  60475. * Gets the particles render time capture status
  60476. */
  60477. get captureParticlesRenderTime(): boolean;
  60478. /**
  60479. * Enable or disable the particles render time capture
  60480. */
  60481. set captureParticlesRenderTime(value: boolean);
  60482. /**
  60483. * Gets the perf counter used for sprites render time
  60484. */
  60485. get spritesRenderTimeCounter(): PerfCounter;
  60486. /**
  60487. * Gets the sprites render time capture status
  60488. */
  60489. get captureSpritesRenderTime(): boolean;
  60490. /**
  60491. * Enable or disable the sprites render time capture
  60492. */
  60493. set captureSpritesRenderTime(value: boolean);
  60494. /**
  60495. * Gets the perf counter used for physics time
  60496. */
  60497. get physicsTimeCounter(): PerfCounter;
  60498. /**
  60499. * Gets the physics time capture status
  60500. */
  60501. get capturePhysicsTime(): boolean;
  60502. /**
  60503. * Enable or disable the physics time capture
  60504. */
  60505. set capturePhysicsTime(value: boolean);
  60506. /**
  60507. * Gets the perf counter used for animations time
  60508. */
  60509. get animationsTimeCounter(): PerfCounter;
  60510. /**
  60511. * Gets the animations time capture status
  60512. */
  60513. get captureAnimationsTime(): boolean;
  60514. /**
  60515. * Enable or disable the animations time capture
  60516. */
  60517. set captureAnimationsTime(value: boolean);
  60518. /**
  60519. * Gets the perf counter used for frame time capture
  60520. */
  60521. get frameTimeCounter(): PerfCounter;
  60522. /**
  60523. * Gets the frame time capture status
  60524. */
  60525. get captureFrameTime(): boolean;
  60526. /**
  60527. * Enable or disable the frame time capture
  60528. */
  60529. set captureFrameTime(value: boolean);
  60530. /**
  60531. * Gets the perf counter used for inter-frames time capture
  60532. */
  60533. get interFrameTimeCounter(): PerfCounter;
  60534. /**
  60535. * Gets the inter-frames time capture status
  60536. */
  60537. get captureInterFrameTime(): boolean;
  60538. /**
  60539. * Enable or disable the inter-frames time capture
  60540. */
  60541. set captureInterFrameTime(value: boolean);
  60542. /**
  60543. * Gets the perf counter used for render time capture
  60544. */
  60545. get renderTimeCounter(): PerfCounter;
  60546. /**
  60547. * Gets the render time capture status
  60548. */
  60549. get captureRenderTime(): boolean;
  60550. /**
  60551. * Enable or disable the render time capture
  60552. */
  60553. set captureRenderTime(value: boolean);
  60554. /**
  60555. * Gets the perf counter used for camera render time capture
  60556. */
  60557. get cameraRenderTimeCounter(): PerfCounter;
  60558. /**
  60559. * Gets the camera render time capture status
  60560. */
  60561. get captureCameraRenderTime(): boolean;
  60562. /**
  60563. * Enable or disable the camera render time capture
  60564. */
  60565. set captureCameraRenderTime(value: boolean);
  60566. /**
  60567. * Gets the perf counter used for draw calls
  60568. */
  60569. get drawCallsCounter(): PerfCounter;
  60570. /**
  60571. * Instantiates a new scene instrumentation.
  60572. * This class can be used to get instrumentation data from a Babylon engine
  60573. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60574. * @param scene Defines the scene to instrument
  60575. */
  60576. constructor(
  60577. /**
  60578. * Defines the scene to instrument
  60579. */
  60580. scene: Scene);
  60581. /**
  60582. * Dispose and release associated resources.
  60583. */
  60584. dispose(): void;
  60585. }
  60586. }
  60587. declare module "babylonjs/Instrumentation/index" {
  60588. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60589. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60590. export * from "babylonjs/Instrumentation/timeToken";
  60591. }
  60592. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60593. /** @hidden */
  60594. export var glowMapGenerationPixelShader: {
  60595. name: string;
  60596. shader: string;
  60597. };
  60598. }
  60599. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60600. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60601. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60602. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60603. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60604. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60605. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60606. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60607. /** @hidden */
  60608. export var glowMapGenerationVertexShader: {
  60609. name: string;
  60610. shader: string;
  60611. };
  60612. }
  60613. declare module "babylonjs/Layers/effectLayer" {
  60614. import { Observable } from "babylonjs/Misc/observable";
  60615. import { Nullable } from "babylonjs/types";
  60616. import { Camera } from "babylonjs/Cameras/camera";
  60617. import { Scene } from "babylonjs/scene";
  60618. import { ISize } from "babylonjs/Maths/math.size";
  60619. import { Color4 } from "babylonjs/Maths/math.color";
  60620. import { Engine } from "babylonjs/Engines/engine";
  60621. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60622. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60623. import { Mesh } from "babylonjs/Meshes/mesh";
  60624. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60625. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60626. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60627. import { Effect } from "babylonjs/Materials/effect";
  60628. import { Material } from "babylonjs/Materials/material";
  60629. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60630. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60631. /**
  60632. * Effect layer options. This helps customizing the behaviour
  60633. * of the effect layer.
  60634. */
  60635. export interface IEffectLayerOptions {
  60636. /**
  60637. * Multiplication factor apply to the canvas size to compute the render target size
  60638. * used to generated the objects (the smaller the faster).
  60639. */
  60640. mainTextureRatio: number;
  60641. /**
  60642. * Enforces a fixed size texture to ensure effect stability across devices.
  60643. */
  60644. mainTextureFixedSize?: number;
  60645. /**
  60646. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60647. */
  60648. alphaBlendingMode: number;
  60649. /**
  60650. * The camera attached to the layer.
  60651. */
  60652. camera: Nullable<Camera>;
  60653. /**
  60654. * The rendering group to draw the layer in.
  60655. */
  60656. renderingGroupId: number;
  60657. }
  60658. /**
  60659. * The effect layer Helps adding post process effect blended with the main pass.
  60660. *
  60661. * This can be for instance use to generate glow or higlight effects on the scene.
  60662. *
  60663. * The effect layer class can not be used directly and is intented to inherited from to be
  60664. * customized per effects.
  60665. */
  60666. export abstract class EffectLayer {
  60667. private _vertexBuffers;
  60668. private _indexBuffer;
  60669. private _cachedDefines;
  60670. private _effectLayerMapGenerationEffect;
  60671. private _effectLayerOptions;
  60672. private _mergeEffect;
  60673. protected _scene: Scene;
  60674. protected _engine: Engine;
  60675. protected _maxSize: number;
  60676. protected _mainTextureDesiredSize: ISize;
  60677. protected _mainTexture: RenderTargetTexture;
  60678. protected _shouldRender: boolean;
  60679. protected _postProcesses: PostProcess[];
  60680. protected _textures: BaseTexture[];
  60681. protected _emissiveTextureAndColor: {
  60682. texture: Nullable<BaseTexture>;
  60683. color: Color4;
  60684. };
  60685. /**
  60686. * The name of the layer
  60687. */
  60688. name: string;
  60689. /**
  60690. * The clear color of the texture used to generate the glow map.
  60691. */
  60692. neutralColor: Color4;
  60693. /**
  60694. * Specifies whether the highlight layer is enabled or not.
  60695. */
  60696. isEnabled: boolean;
  60697. /**
  60698. * Gets the camera attached to the layer.
  60699. */
  60700. get camera(): Nullable<Camera>;
  60701. /**
  60702. * Gets the rendering group id the layer should render in.
  60703. */
  60704. get renderingGroupId(): number;
  60705. set renderingGroupId(renderingGroupId: number);
  60706. /**
  60707. * An event triggered when the effect layer has been disposed.
  60708. */
  60709. onDisposeObservable: Observable<EffectLayer>;
  60710. /**
  60711. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60712. */
  60713. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60714. /**
  60715. * An event triggered when the generated texture is being merged in the scene.
  60716. */
  60717. onBeforeComposeObservable: Observable<EffectLayer>;
  60718. /**
  60719. * An event triggered when the mesh is rendered into the effect render target.
  60720. */
  60721. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60722. /**
  60723. * An event triggered after the mesh has been rendered into the effect render target.
  60724. */
  60725. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60726. /**
  60727. * An event triggered when the generated texture has been merged in the scene.
  60728. */
  60729. onAfterComposeObservable: Observable<EffectLayer>;
  60730. /**
  60731. * An event triggered when the efffect layer changes its size.
  60732. */
  60733. onSizeChangedObservable: Observable<EffectLayer>;
  60734. /** @hidden */
  60735. static _SceneComponentInitialization: (scene: Scene) => void;
  60736. /**
  60737. * Instantiates a new effect Layer and references it in the scene.
  60738. * @param name The name of the layer
  60739. * @param scene The scene to use the layer in
  60740. */
  60741. constructor(
  60742. /** The Friendly of the effect in the scene */
  60743. name: string, scene: Scene);
  60744. /**
  60745. * Get the effect name of the layer.
  60746. * @return The effect name
  60747. */
  60748. abstract getEffectName(): string;
  60749. /**
  60750. * Checks for the readiness of the element composing the layer.
  60751. * @param subMesh the mesh to check for
  60752. * @param useInstances specify whether or not to use instances to render the mesh
  60753. * @return true if ready otherwise, false
  60754. */
  60755. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60756. /**
  60757. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60758. * @returns true if the effect requires stencil during the main canvas render pass.
  60759. */
  60760. abstract needStencil(): boolean;
  60761. /**
  60762. * Create the merge effect. This is the shader use to blit the information back
  60763. * to the main canvas at the end of the scene rendering.
  60764. * @returns The effect containing the shader used to merge the effect on the main canvas
  60765. */
  60766. protected abstract _createMergeEffect(): Effect;
  60767. /**
  60768. * Creates the render target textures and post processes used in the effect layer.
  60769. */
  60770. protected abstract _createTextureAndPostProcesses(): void;
  60771. /**
  60772. * Implementation specific of rendering the generating effect on the main canvas.
  60773. * @param effect The effect used to render through
  60774. */
  60775. protected abstract _internalRender(effect: Effect): void;
  60776. /**
  60777. * Sets the required values for both the emissive texture and and the main color.
  60778. */
  60779. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60780. /**
  60781. * Free any resources and references associated to a mesh.
  60782. * Internal use
  60783. * @param mesh The mesh to free.
  60784. */
  60785. abstract _disposeMesh(mesh: Mesh): void;
  60786. /**
  60787. * Serializes this layer (Glow or Highlight for example)
  60788. * @returns a serialized layer object
  60789. */
  60790. abstract serialize?(): any;
  60791. /**
  60792. * Initializes the effect layer with the required options.
  60793. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60794. */
  60795. protected _init(options: Partial<IEffectLayerOptions>): void;
  60796. /**
  60797. * Generates the index buffer of the full screen quad blending to the main canvas.
  60798. */
  60799. private _generateIndexBuffer;
  60800. /**
  60801. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60802. */
  60803. private _generateVertexBuffer;
  60804. /**
  60805. * Sets the main texture desired size which is the closest power of two
  60806. * of the engine canvas size.
  60807. */
  60808. private _setMainTextureSize;
  60809. /**
  60810. * Creates the main texture for the effect layer.
  60811. */
  60812. protected _createMainTexture(): void;
  60813. /**
  60814. * Adds specific effects defines.
  60815. * @param defines The defines to add specifics to.
  60816. */
  60817. protected _addCustomEffectDefines(defines: string[]): void;
  60818. /**
  60819. * Checks for the readiness of the element composing the layer.
  60820. * @param subMesh the mesh to check for
  60821. * @param useInstances specify whether or not to use instances to render the mesh
  60822. * @param emissiveTexture the associated emissive texture used to generate the glow
  60823. * @return true if ready otherwise, false
  60824. */
  60825. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60826. /**
  60827. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60828. */
  60829. render(): void;
  60830. /**
  60831. * Determine if a given mesh will be used in the current effect.
  60832. * @param mesh mesh to test
  60833. * @returns true if the mesh will be used
  60834. */
  60835. hasMesh(mesh: AbstractMesh): boolean;
  60836. /**
  60837. * Returns true if the layer contains information to display, otherwise false.
  60838. * @returns true if the glow layer should be rendered
  60839. */
  60840. shouldRender(): boolean;
  60841. /**
  60842. * Returns true if the mesh should render, otherwise false.
  60843. * @param mesh The mesh to render
  60844. * @returns true if it should render otherwise false
  60845. */
  60846. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60847. /**
  60848. * Returns true if the mesh can be rendered, otherwise false.
  60849. * @param mesh The mesh to render
  60850. * @param material The material used on the mesh
  60851. * @returns true if it can be rendered otherwise false
  60852. */
  60853. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60854. /**
  60855. * Returns true if the mesh should render, otherwise false.
  60856. * @param mesh The mesh to render
  60857. * @returns true if it should render otherwise false
  60858. */
  60859. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60860. /**
  60861. * Renders the submesh passed in parameter to the generation map.
  60862. */
  60863. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60864. /**
  60865. * Defines whether the current material of the mesh should be use to render the effect.
  60866. * @param mesh defines the current mesh to render
  60867. */
  60868. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60869. /**
  60870. * Rebuild the required buffers.
  60871. * @hidden Internal use only.
  60872. */
  60873. _rebuild(): void;
  60874. /**
  60875. * Dispose only the render target textures and post process.
  60876. */
  60877. private _disposeTextureAndPostProcesses;
  60878. /**
  60879. * Dispose the highlight layer and free resources.
  60880. */
  60881. dispose(): void;
  60882. /**
  60883. * Gets the class name of the effect layer
  60884. * @returns the string with the class name of the effect layer
  60885. */
  60886. getClassName(): string;
  60887. /**
  60888. * Creates an effect layer from parsed effect layer data
  60889. * @param parsedEffectLayer defines effect layer data
  60890. * @param scene defines the current scene
  60891. * @param rootUrl defines the root URL containing the effect layer information
  60892. * @returns a parsed effect Layer
  60893. */
  60894. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60895. }
  60896. }
  60897. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60898. import { Scene } from "babylonjs/scene";
  60899. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60900. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60901. import { AbstractScene } from "babylonjs/abstractScene";
  60902. module "babylonjs/abstractScene" {
  60903. interface AbstractScene {
  60904. /**
  60905. * The list of effect layers (highlights/glow) added to the scene
  60906. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60907. * @see https://doc.babylonjs.com/how_to/glow_layer
  60908. */
  60909. effectLayers: Array<EffectLayer>;
  60910. /**
  60911. * Removes the given effect layer from this scene.
  60912. * @param toRemove defines the effect layer to remove
  60913. * @returns the index of the removed effect layer
  60914. */
  60915. removeEffectLayer(toRemove: EffectLayer): number;
  60916. /**
  60917. * Adds the given effect layer to this scene
  60918. * @param newEffectLayer defines the effect layer to add
  60919. */
  60920. addEffectLayer(newEffectLayer: EffectLayer): void;
  60921. }
  60922. }
  60923. /**
  60924. * Defines the layer scene component responsible to manage any effect layers
  60925. * in a given scene.
  60926. */
  60927. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60928. /**
  60929. * The component name helpfull to identify the component in the list of scene components.
  60930. */
  60931. readonly name: string;
  60932. /**
  60933. * The scene the component belongs to.
  60934. */
  60935. scene: Scene;
  60936. private _engine;
  60937. private _renderEffects;
  60938. private _needStencil;
  60939. private _previousStencilState;
  60940. /**
  60941. * Creates a new instance of the component for the given scene
  60942. * @param scene Defines the scene to register the component in
  60943. */
  60944. constructor(scene: Scene);
  60945. /**
  60946. * Registers the component in a given scene
  60947. */
  60948. register(): void;
  60949. /**
  60950. * Rebuilds the elements related to this component in case of
  60951. * context lost for instance.
  60952. */
  60953. rebuild(): void;
  60954. /**
  60955. * Serializes the component data to the specified json object
  60956. * @param serializationObject The object to serialize to
  60957. */
  60958. serialize(serializationObject: any): void;
  60959. /**
  60960. * Adds all the elements from the container to the scene
  60961. * @param container the container holding the elements
  60962. */
  60963. addFromContainer(container: AbstractScene): void;
  60964. /**
  60965. * Removes all the elements in the container from the scene
  60966. * @param container contains the elements to remove
  60967. * @param dispose if the removed element should be disposed (default: false)
  60968. */
  60969. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60970. /**
  60971. * Disposes the component and the associated ressources.
  60972. */
  60973. dispose(): void;
  60974. private _isReadyForMesh;
  60975. private _renderMainTexture;
  60976. private _setStencil;
  60977. private _setStencilBack;
  60978. private _draw;
  60979. private _drawCamera;
  60980. private _drawRenderingGroup;
  60981. }
  60982. }
  60983. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  60984. /** @hidden */
  60985. export var glowMapMergePixelShader: {
  60986. name: string;
  60987. shader: string;
  60988. };
  60989. }
  60990. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  60991. /** @hidden */
  60992. export var glowMapMergeVertexShader: {
  60993. name: string;
  60994. shader: string;
  60995. };
  60996. }
  60997. declare module "babylonjs/Layers/glowLayer" {
  60998. import { Nullable } from "babylonjs/types";
  60999. import { Camera } from "babylonjs/Cameras/camera";
  61000. import { Scene } from "babylonjs/scene";
  61001. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61002. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61003. import { Mesh } from "babylonjs/Meshes/mesh";
  61004. import { Texture } from "babylonjs/Materials/Textures/texture";
  61005. import { Effect } from "babylonjs/Materials/effect";
  61006. import { Material } from "babylonjs/Materials/material";
  61007. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61008. import { Color4 } from "babylonjs/Maths/math.color";
  61009. import "babylonjs/Shaders/glowMapMerge.fragment";
  61010. import "babylonjs/Shaders/glowMapMerge.vertex";
  61011. import "babylonjs/Layers/effectLayerSceneComponent";
  61012. module "babylonjs/abstractScene" {
  61013. interface AbstractScene {
  61014. /**
  61015. * Return a the first highlight layer of the scene with a given name.
  61016. * @param name The name of the highlight layer to look for.
  61017. * @return The highlight layer if found otherwise null.
  61018. */
  61019. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61020. }
  61021. }
  61022. /**
  61023. * Glow layer options. This helps customizing the behaviour
  61024. * of the glow layer.
  61025. */
  61026. export interface IGlowLayerOptions {
  61027. /**
  61028. * Multiplication factor apply to the canvas size to compute the render target size
  61029. * used to generated the glowing objects (the smaller the faster).
  61030. */
  61031. mainTextureRatio: number;
  61032. /**
  61033. * Enforces a fixed size texture to ensure resize independant blur.
  61034. */
  61035. mainTextureFixedSize?: number;
  61036. /**
  61037. * How big is the kernel of the blur texture.
  61038. */
  61039. blurKernelSize: number;
  61040. /**
  61041. * The camera attached to the layer.
  61042. */
  61043. camera: Nullable<Camera>;
  61044. /**
  61045. * Enable MSAA by chosing the number of samples.
  61046. */
  61047. mainTextureSamples?: number;
  61048. /**
  61049. * The rendering group to draw the layer in.
  61050. */
  61051. renderingGroupId: number;
  61052. }
  61053. /**
  61054. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61055. *
  61056. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61057. *
  61058. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61059. */
  61060. export class GlowLayer extends EffectLayer {
  61061. /**
  61062. * Effect Name of the layer.
  61063. */
  61064. static readonly EffectName: string;
  61065. /**
  61066. * The default blur kernel size used for the glow.
  61067. */
  61068. static DefaultBlurKernelSize: number;
  61069. /**
  61070. * The default texture size ratio used for the glow.
  61071. */
  61072. static DefaultTextureRatio: number;
  61073. /**
  61074. * Sets the kernel size of the blur.
  61075. */
  61076. set blurKernelSize(value: number);
  61077. /**
  61078. * Gets the kernel size of the blur.
  61079. */
  61080. get blurKernelSize(): number;
  61081. /**
  61082. * Sets the glow intensity.
  61083. */
  61084. set intensity(value: number);
  61085. /**
  61086. * Gets the glow intensity.
  61087. */
  61088. get intensity(): number;
  61089. private _options;
  61090. private _intensity;
  61091. private _horizontalBlurPostprocess1;
  61092. private _verticalBlurPostprocess1;
  61093. private _horizontalBlurPostprocess2;
  61094. private _verticalBlurPostprocess2;
  61095. private _blurTexture1;
  61096. private _blurTexture2;
  61097. private _postProcesses1;
  61098. private _postProcesses2;
  61099. private _includedOnlyMeshes;
  61100. private _excludedMeshes;
  61101. private _meshesUsingTheirOwnMaterials;
  61102. /**
  61103. * Callback used to let the user override the color selection on a per mesh basis
  61104. */
  61105. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61106. /**
  61107. * Callback used to let the user override the texture selection on a per mesh basis
  61108. */
  61109. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61110. /**
  61111. * Instantiates a new glow Layer and references it to the scene.
  61112. * @param name The name of the layer
  61113. * @param scene The scene to use the layer in
  61114. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61115. */
  61116. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61117. /**
  61118. * Get the effect name of the layer.
  61119. * @return The effect name
  61120. */
  61121. getEffectName(): string;
  61122. /**
  61123. * Create the merge effect. This is the shader use to blit the information back
  61124. * to the main canvas at the end of the scene rendering.
  61125. */
  61126. protected _createMergeEffect(): Effect;
  61127. /**
  61128. * Creates the render target textures and post processes used in the glow layer.
  61129. */
  61130. protected _createTextureAndPostProcesses(): void;
  61131. /**
  61132. * Checks for the readiness of the element composing the layer.
  61133. * @param subMesh the mesh to check for
  61134. * @param useInstances specify wether or not to use instances to render the mesh
  61135. * @param emissiveTexture the associated emissive texture used to generate the glow
  61136. * @return true if ready otherwise, false
  61137. */
  61138. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61139. /**
  61140. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61141. */
  61142. needStencil(): boolean;
  61143. /**
  61144. * Returns true if the mesh can be rendered, otherwise false.
  61145. * @param mesh The mesh to render
  61146. * @param material The material used on the mesh
  61147. * @returns true if it can be rendered otherwise false
  61148. */
  61149. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61150. /**
  61151. * Implementation specific of rendering the generating effect on the main canvas.
  61152. * @param effect The effect used to render through
  61153. */
  61154. protected _internalRender(effect: Effect): void;
  61155. /**
  61156. * Sets the required values for both the emissive texture and and the main color.
  61157. */
  61158. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61159. /**
  61160. * Returns true if the mesh should render, otherwise false.
  61161. * @param mesh The mesh to render
  61162. * @returns true if it should render otherwise false
  61163. */
  61164. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61165. /**
  61166. * Adds specific effects defines.
  61167. * @param defines The defines to add specifics to.
  61168. */
  61169. protected _addCustomEffectDefines(defines: string[]): void;
  61170. /**
  61171. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61172. * @param mesh The mesh to exclude from the glow layer
  61173. */
  61174. addExcludedMesh(mesh: Mesh): void;
  61175. /**
  61176. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61177. * @param mesh The mesh to remove
  61178. */
  61179. removeExcludedMesh(mesh: Mesh): void;
  61180. /**
  61181. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61182. * @param mesh The mesh to include in the glow layer
  61183. */
  61184. addIncludedOnlyMesh(mesh: Mesh): void;
  61185. /**
  61186. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61187. * @param mesh The mesh to remove
  61188. */
  61189. removeIncludedOnlyMesh(mesh: Mesh): void;
  61190. /**
  61191. * Determine if a given mesh will be used in the glow layer
  61192. * @param mesh The mesh to test
  61193. * @returns true if the mesh will be highlighted by the current glow layer
  61194. */
  61195. hasMesh(mesh: AbstractMesh): boolean;
  61196. /**
  61197. * Defines whether the current material of the mesh should be use to render the effect.
  61198. * @param mesh defines the current mesh to render
  61199. */
  61200. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61201. /**
  61202. * Add a mesh to be rendered through its own material and not with emissive only.
  61203. * @param mesh The mesh for which we need to use its material
  61204. */
  61205. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61206. /**
  61207. * Remove a mesh from being rendered through its own material and not with emissive only.
  61208. * @param mesh The mesh for which we need to not use its material
  61209. */
  61210. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61211. /**
  61212. * Free any resources and references associated to a mesh.
  61213. * Internal use
  61214. * @param mesh The mesh to free.
  61215. * @hidden
  61216. */
  61217. _disposeMesh(mesh: Mesh): void;
  61218. /**
  61219. * Gets the class name of the effect layer
  61220. * @returns the string with the class name of the effect layer
  61221. */
  61222. getClassName(): string;
  61223. /**
  61224. * Serializes this glow layer
  61225. * @returns a serialized glow layer object
  61226. */
  61227. serialize(): any;
  61228. /**
  61229. * Creates a Glow Layer from parsed glow layer data
  61230. * @param parsedGlowLayer defines glow layer data
  61231. * @param scene defines the current scene
  61232. * @param rootUrl defines the root URL containing the glow layer information
  61233. * @returns a parsed Glow Layer
  61234. */
  61235. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61236. }
  61237. }
  61238. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61239. /** @hidden */
  61240. export var glowBlurPostProcessPixelShader: {
  61241. name: string;
  61242. shader: string;
  61243. };
  61244. }
  61245. declare module "babylonjs/Layers/highlightLayer" {
  61246. import { Observable } from "babylonjs/Misc/observable";
  61247. import { Nullable } from "babylonjs/types";
  61248. import { Camera } from "babylonjs/Cameras/camera";
  61249. import { Scene } from "babylonjs/scene";
  61250. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61252. import { Mesh } from "babylonjs/Meshes/mesh";
  61253. import { Effect } from "babylonjs/Materials/effect";
  61254. import { Material } from "babylonjs/Materials/material";
  61255. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61256. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61257. import "babylonjs/Shaders/glowMapMerge.fragment";
  61258. import "babylonjs/Shaders/glowMapMerge.vertex";
  61259. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61260. module "babylonjs/abstractScene" {
  61261. interface AbstractScene {
  61262. /**
  61263. * Return a the first highlight layer of the scene with a given name.
  61264. * @param name The name of the highlight layer to look for.
  61265. * @return The highlight layer if found otherwise null.
  61266. */
  61267. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61268. }
  61269. }
  61270. /**
  61271. * Highlight layer options. This helps customizing the behaviour
  61272. * of the highlight layer.
  61273. */
  61274. export interface IHighlightLayerOptions {
  61275. /**
  61276. * Multiplication factor apply to the canvas size to compute the render target size
  61277. * used to generated the glowing objects (the smaller the faster).
  61278. */
  61279. mainTextureRatio: number;
  61280. /**
  61281. * Enforces a fixed size texture to ensure resize independant blur.
  61282. */
  61283. mainTextureFixedSize?: number;
  61284. /**
  61285. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61286. * of the picture to blur (the smaller the faster).
  61287. */
  61288. blurTextureSizeRatio: number;
  61289. /**
  61290. * How big in texel of the blur texture is the vertical blur.
  61291. */
  61292. blurVerticalSize: number;
  61293. /**
  61294. * How big in texel of the blur texture is the horizontal blur.
  61295. */
  61296. blurHorizontalSize: number;
  61297. /**
  61298. * Alpha blending mode used to apply the blur. Default is combine.
  61299. */
  61300. alphaBlendingMode: number;
  61301. /**
  61302. * The camera attached to the layer.
  61303. */
  61304. camera: Nullable<Camera>;
  61305. /**
  61306. * Should we display highlight as a solid stroke?
  61307. */
  61308. isStroke?: boolean;
  61309. /**
  61310. * The rendering group to draw the layer in.
  61311. */
  61312. renderingGroupId: number;
  61313. }
  61314. /**
  61315. * The highlight layer Helps adding a glow effect around a mesh.
  61316. *
  61317. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61318. * glowy meshes to your scene.
  61319. *
  61320. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61321. */
  61322. export class HighlightLayer extends EffectLayer {
  61323. name: string;
  61324. /**
  61325. * Effect Name of the highlight layer.
  61326. */
  61327. static readonly EffectName: string;
  61328. /**
  61329. * The neutral color used during the preparation of the glow effect.
  61330. * This is black by default as the blend operation is a blend operation.
  61331. */
  61332. static NeutralColor: Color4;
  61333. /**
  61334. * Stencil value used for glowing meshes.
  61335. */
  61336. static GlowingMeshStencilReference: number;
  61337. /**
  61338. * Stencil value used for the other meshes in the scene.
  61339. */
  61340. static NormalMeshStencilReference: number;
  61341. /**
  61342. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61343. */
  61344. innerGlow: boolean;
  61345. /**
  61346. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61347. */
  61348. outerGlow: boolean;
  61349. /**
  61350. * Specifies the horizontal size of the blur.
  61351. */
  61352. set blurHorizontalSize(value: number);
  61353. /**
  61354. * Specifies the vertical size of the blur.
  61355. */
  61356. set blurVerticalSize(value: number);
  61357. /**
  61358. * Gets the horizontal size of the blur.
  61359. */
  61360. get blurHorizontalSize(): number;
  61361. /**
  61362. * Gets the vertical size of the blur.
  61363. */
  61364. get blurVerticalSize(): number;
  61365. /**
  61366. * An event triggered when the highlight layer is being blurred.
  61367. */
  61368. onBeforeBlurObservable: Observable<HighlightLayer>;
  61369. /**
  61370. * An event triggered when the highlight layer has been blurred.
  61371. */
  61372. onAfterBlurObservable: Observable<HighlightLayer>;
  61373. private _instanceGlowingMeshStencilReference;
  61374. private _options;
  61375. private _downSamplePostprocess;
  61376. private _horizontalBlurPostprocess;
  61377. private _verticalBlurPostprocess;
  61378. private _blurTexture;
  61379. private _meshes;
  61380. private _excludedMeshes;
  61381. /**
  61382. * Instantiates a new highlight Layer and references it to the scene..
  61383. * @param name The name of the layer
  61384. * @param scene The scene to use the layer in
  61385. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61386. */
  61387. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61388. /**
  61389. * Get the effect name of the layer.
  61390. * @return The effect name
  61391. */
  61392. getEffectName(): string;
  61393. /**
  61394. * Create the merge effect. This is the shader use to blit the information back
  61395. * to the main canvas at the end of the scene rendering.
  61396. */
  61397. protected _createMergeEffect(): Effect;
  61398. /**
  61399. * Creates the render target textures and post processes used in the highlight layer.
  61400. */
  61401. protected _createTextureAndPostProcesses(): void;
  61402. /**
  61403. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61404. */
  61405. needStencil(): boolean;
  61406. /**
  61407. * Checks for the readiness of the element composing the layer.
  61408. * @param subMesh the mesh to check for
  61409. * @param useInstances specify wether or not to use instances to render the mesh
  61410. * @param emissiveTexture the associated emissive texture used to generate the glow
  61411. * @return true if ready otherwise, false
  61412. */
  61413. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61414. /**
  61415. * Implementation specific of rendering the generating effect on the main canvas.
  61416. * @param effect The effect used to render through
  61417. */
  61418. protected _internalRender(effect: Effect): void;
  61419. /**
  61420. * Returns true if the layer contains information to display, otherwise false.
  61421. */
  61422. shouldRender(): boolean;
  61423. /**
  61424. * Returns true if the mesh should render, otherwise false.
  61425. * @param mesh The mesh to render
  61426. * @returns true if it should render otherwise false
  61427. */
  61428. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61429. /**
  61430. * Returns true if the mesh can be rendered, otherwise false.
  61431. * @param mesh The mesh to render
  61432. * @param material The material used on the mesh
  61433. * @returns true if it can be rendered otherwise false
  61434. */
  61435. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61436. /**
  61437. * Adds specific effects defines.
  61438. * @param defines The defines to add specifics to.
  61439. */
  61440. protected _addCustomEffectDefines(defines: string[]): void;
  61441. /**
  61442. * Sets the required values for both the emissive texture and and the main color.
  61443. */
  61444. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61445. /**
  61446. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61447. * @param mesh The mesh to exclude from the highlight layer
  61448. */
  61449. addExcludedMesh(mesh: Mesh): void;
  61450. /**
  61451. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61452. * @param mesh The mesh to highlight
  61453. */
  61454. removeExcludedMesh(mesh: Mesh): void;
  61455. /**
  61456. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61457. * @param mesh mesh to test
  61458. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61459. */
  61460. hasMesh(mesh: AbstractMesh): boolean;
  61461. /**
  61462. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61463. * @param mesh The mesh to highlight
  61464. * @param color The color of the highlight
  61465. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61466. */
  61467. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61468. /**
  61469. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61470. * @param mesh The mesh to highlight
  61471. */
  61472. removeMesh(mesh: Mesh): void;
  61473. /**
  61474. * Remove all the meshes currently referenced in the highlight layer
  61475. */
  61476. removeAllMeshes(): void;
  61477. /**
  61478. * Force the stencil to the normal expected value for none glowing parts
  61479. */
  61480. private _defaultStencilReference;
  61481. /**
  61482. * Free any resources and references associated to a mesh.
  61483. * Internal use
  61484. * @param mesh The mesh to free.
  61485. * @hidden
  61486. */
  61487. _disposeMesh(mesh: Mesh): void;
  61488. /**
  61489. * Dispose the highlight layer and free resources.
  61490. */
  61491. dispose(): void;
  61492. /**
  61493. * Gets the class name of the effect layer
  61494. * @returns the string with the class name of the effect layer
  61495. */
  61496. getClassName(): string;
  61497. /**
  61498. * Serializes this Highlight layer
  61499. * @returns a serialized Highlight layer object
  61500. */
  61501. serialize(): any;
  61502. /**
  61503. * Creates a Highlight layer from parsed Highlight layer data
  61504. * @param parsedHightlightLayer defines the Highlight layer data
  61505. * @param scene defines the current scene
  61506. * @param rootUrl defines the root URL containing the Highlight layer information
  61507. * @returns a parsed Highlight layer
  61508. */
  61509. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61510. }
  61511. }
  61512. declare module "babylonjs/Layers/layerSceneComponent" {
  61513. import { Scene } from "babylonjs/scene";
  61514. import { ISceneComponent } from "babylonjs/sceneComponent";
  61515. import { Layer } from "babylonjs/Layers/layer";
  61516. import { AbstractScene } from "babylonjs/abstractScene";
  61517. module "babylonjs/abstractScene" {
  61518. interface AbstractScene {
  61519. /**
  61520. * The list of layers (background and foreground) of the scene
  61521. */
  61522. layers: Array<Layer>;
  61523. }
  61524. }
  61525. /**
  61526. * Defines the layer scene component responsible to manage any layers
  61527. * in a given scene.
  61528. */
  61529. export class LayerSceneComponent implements ISceneComponent {
  61530. /**
  61531. * The component name helpfull to identify the component in the list of scene components.
  61532. */
  61533. readonly name: string;
  61534. /**
  61535. * The scene the component belongs to.
  61536. */
  61537. scene: Scene;
  61538. private _engine;
  61539. /**
  61540. * Creates a new instance of the component for the given scene
  61541. * @param scene Defines the scene to register the component in
  61542. */
  61543. constructor(scene: Scene);
  61544. /**
  61545. * Registers the component in a given scene
  61546. */
  61547. register(): void;
  61548. /**
  61549. * Rebuilds the elements related to this component in case of
  61550. * context lost for instance.
  61551. */
  61552. rebuild(): void;
  61553. /**
  61554. * Disposes the component and the associated ressources.
  61555. */
  61556. dispose(): void;
  61557. private _draw;
  61558. private _drawCameraPredicate;
  61559. private _drawCameraBackground;
  61560. private _drawCameraForeground;
  61561. private _drawRenderTargetPredicate;
  61562. private _drawRenderTargetBackground;
  61563. private _drawRenderTargetForeground;
  61564. /**
  61565. * Adds all the elements from the container to the scene
  61566. * @param container the container holding the elements
  61567. */
  61568. addFromContainer(container: AbstractScene): void;
  61569. /**
  61570. * Removes all the elements in the container from the scene
  61571. * @param container contains the elements to remove
  61572. * @param dispose if the removed element should be disposed (default: false)
  61573. */
  61574. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61575. }
  61576. }
  61577. declare module "babylonjs/Shaders/layer.fragment" {
  61578. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61579. /** @hidden */
  61580. export var layerPixelShader: {
  61581. name: string;
  61582. shader: string;
  61583. };
  61584. }
  61585. declare module "babylonjs/Shaders/layer.vertex" {
  61586. /** @hidden */
  61587. export var layerVertexShader: {
  61588. name: string;
  61589. shader: string;
  61590. };
  61591. }
  61592. declare module "babylonjs/Layers/layer" {
  61593. import { Observable } from "babylonjs/Misc/observable";
  61594. import { Nullable } from "babylonjs/types";
  61595. import { Scene } from "babylonjs/scene";
  61596. import { Vector2 } from "babylonjs/Maths/math.vector";
  61597. import { Color4 } from "babylonjs/Maths/math.color";
  61598. import { Texture } from "babylonjs/Materials/Textures/texture";
  61599. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61600. import "babylonjs/Shaders/layer.fragment";
  61601. import "babylonjs/Shaders/layer.vertex";
  61602. /**
  61603. * This represents a full screen 2d layer.
  61604. * This can be useful to display a picture in the background of your scene for instance.
  61605. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61606. */
  61607. export class Layer {
  61608. /**
  61609. * Define the name of the layer.
  61610. */
  61611. name: string;
  61612. /**
  61613. * Define the texture the layer should display.
  61614. */
  61615. texture: Nullable<Texture>;
  61616. /**
  61617. * Is the layer in background or foreground.
  61618. */
  61619. isBackground: boolean;
  61620. /**
  61621. * Define the color of the layer (instead of texture).
  61622. */
  61623. color: Color4;
  61624. /**
  61625. * Define the scale of the layer in order to zoom in out of the texture.
  61626. */
  61627. scale: Vector2;
  61628. /**
  61629. * Define an offset for the layer in order to shift the texture.
  61630. */
  61631. offset: Vector2;
  61632. /**
  61633. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61634. */
  61635. alphaBlendingMode: number;
  61636. /**
  61637. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61638. * Alpha test will not mix with the background color in case of transparency.
  61639. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61640. */
  61641. alphaTest: boolean;
  61642. /**
  61643. * Define a mask to restrict the layer to only some of the scene cameras.
  61644. */
  61645. layerMask: number;
  61646. /**
  61647. * Define the list of render target the layer is visible into.
  61648. */
  61649. renderTargetTextures: RenderTargetTexture[];
  61650. /**
  61651. * Define if the layer is only used in renderTarget or if it also
  61652. * renders in the main frame buffer of the canvas.
  61653. */
  61654. renderOnlyInRenderTargetTextures: boolean;
  61655. private _scene;
  61656. private _vertexBuffers;
  61657. private _indexBuffer;
  61658. private _effect;
  61659. private _previousDefines;
  61660. /**
  61661. * An event triggered when the layer is disposed.
  61662. */
  61663. onDisposeObservable: Observable<Layer>;
  61664. private _onDisposeObserver;
  61665. /**
  61666. * Back compatibility with callback before the onDisposeObservable existed.
  61667. * The set callback will be triggered when the layer has been disposed.
  61668. */
  61669. set onDispose(callback: () => void);
  61670. /**
  61671. * An event triggered before rendering the scene
  61672. */
  61673. onBeforeRenderObservable: Observable<Layer>;
  61674. private _onBeforeRenderObserver;
  61675. /**
  61676. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61677. * The set callback will be triggered just before rendering the layer.
  61678. */
  61679. set onBeforeRender(callback: () => void);
  61680. /**
  61681. * An event triggered after rendering the scene
  61682. */
  61683. onAfterRenderObservable: Observable<Layer>;
  61684. private _onAfterRenderObserver;
  61685. /**
  61686. * Back compatibility with callback before the onAfterRenderObservable existed.
  61687. * The set callback will be triggered just after rendering the layer.
  61688. */
  61689. set onAfterRender(callback: () => void);
  61690. /**
  61691. * Instantiates a new layer.
  61692. * This represents a full screen 2d layer.
  61693. * This can be useful to display a picture in the background of your scene for instance.
  61694. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61695. * @param name Define the name of the layer in the scene
  61696. * @param imgUrl Define the url of the texture to display in the layer
  61697. * @param scene Define the scene the layer belongs to
  61698. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61699. * @param color Defines a color for the layer
  61700. */
  61701. constructor(
  61702. /**
  61703. * Define the name of the layer.
  61704. */
  61705. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61706. private _createIndexBuffer;
  61707. /** @hidden */
  61708. _rebuild(): void;
  61709. /**
  61710. * Renders the layer in the scene.
  61711. */
  61712. render(): void;
  61713. /**
  61714. * Disposes and releases the associated ressources.
  61715. */
  61716. dispose(): void;
  61717. }
  61718. }
  61719. declare module "babylonjs/Layers/index" {
  61720. export * from "babylonjs/Layers/effectLayer";
  61721. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61722. export * from "babylonjs/Layers/glowLayer";
  61723. export * from "babylonjs/Layers/highlightLayer";
  61724. export * from "babylonjs/Layers/layer";
  61725. export * from "babylonjs/Layers/layerSceneComponent";
  61726. }
  61727. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61728. /** @hidden */
  61729. export var lensFlarePixelShader: {
  61730. name: string;
  61731. shader: string;
  61732. };
  61733. }
  61734. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61735. /** @hidden */
  61736. export var lensFlareVertexShader: {
  61737. name: string;
  61738. shader: string;
  61739. };
  61740. }
  61741. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61742. import { Scene } from "babylonjs/scene";
  61743. import { Vector3 } from "babylonjs/Maths/math.vector";
  61744. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61745. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61746. import "babylonjs/Shaders/lensFlare.fragment";
  61747. import "babylonjs/Shaders/lensFlare.vertex";
  61748. import { Viewport } from "babylonjs/Maths/math.viewport";
  61749. /**
  61750. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61751. * It is usually composed of several `lensFlare`.
  61752. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61753. */
  61754. export class LensFlareSystem {
  61755. /**
  61756. * Define the name of the lens flare system
  61757. */
  61758. name: string;
  61759. /**
  61760. * List of lens flares used in this system.
  61761. */
  61762. lensFlares: LensFlare[];
  61763. /**
  61764. * Define a limit from the border the lens flare can be visible.
  61765. */
  61766. borderLimit: number;
  61767. /**
  61768. * Define a viewport border we do not want to see the lens flare in.
  61769. */
  61770. viewportBorder: number;
  61771. /**
  61772. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61773. */
  61774. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61775. /**
  61776. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61777. */
  61778. layerMask: number;
  61779. /**
  61780. * Define the id of the lens flare system in the scene.
  61781. * (equal to name by default)
  61782. */
  61783. id: string;
  61784. private _scene;
  61785. private _emitter;
  61786. private _vertexBuffers;
  61787. private _indexBuffer;
  61788. private _effect;
  61789. private _positionX;
  61790. private _positionY;
  61791. private _isEnabled;
  61792. /** @hidden */
  61793. static _SceneComponentInitialization: (scene: Scene) => void;
  61794. /**
  61795. * Instantiates a lens flare system.
  61796. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61797. * It is usually composed of several `lensFlare`.
  61798. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61799. * @param name Define the name of the lens flare system in the scene
  61800. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61801. * @param scene Define the scene the lens flare system belongs to
  61802. */
  61803. constructor(
  61804. /**
  61805. * Define the name of the lens flare system
  61806. */
  61807. name: string, emitter: any, scene: Scene);
  61808. /**
  61809. * Define if the lens flare system is enabled.
  61810. */
  61811. get isEnabled(): boolean;
  61812. set isEnabled(value: boolean);
  61813. /**
  61814. * Get the scene the effects belongs to.
  61815. * @returns the scene holding the lens flare system
  61816. */
  61817. getScene(): Scene;
  61818. /**
  61819. * Get the emitter of the lens flare system.
  61820. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61821. * @returns the emitter of the lens flare system
  61822. */
  61823. getEmitter(): any;
  61824. /**
  61825. * Set the emitter of the lens flare system.
  61826. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61827. * @param newEmitter Define the new emitter of the system
  61828. */
  61829. setEmitter(newEmitter: any): void;
  61830. /**
  61831. * Get the lens flare system emitter position.
  61832. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61833. * @returns the position
  61834. */
  61835. getEmitterPosition(): Vector3;
  61836. /**
  61837. * @hidden
  61838. */
  61839. computeEffectivePosition(globalViewport: Viewport): boolean;
  61840. /** @hidden */
  61841. _isVisible(): boolean;
  61842. /**
  61843. * @hidden
  61844. */
  61845. render(): boolean;
  61846. /**
  61847. * Dispose and release the lens flare with its associated resources.
  61848. */
  61849. dispose(): void;
  61850. /**
  61851. * Parse a lens flare system from a JSON repressentation
  61852. * @param parsedLensFlareSystem Define the JSON to parse
  61853. * @param scene Define the scene the parsed system should be instantiated in
  61854. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61855. * @returns the parsed system
  61856. */
  61857. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61858. /**
  61859. * Serialize the current Lens Flare System into a JSON representation.
  61860. * @returns the serialized JSON
  61861. */
  61862. serialize(): any;
  61863. }
  61864. }
  61865. declare module "babylonjs/LensFlares/lensFlare" {
  61866. import { Nullable } from "babylonjs/types";
  61867. import { Color3 } from "babylonjs/Maths/math.color";
  61868. import { Texture } from "babylonjs/Materials/Textures/texture";
  61869. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61870. /**
  61871. * This represents one of the lens effect in a `lensFlareSystem`.
  61872. * It controls one of the indiviual texture used in the effect.
  61873. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61874. */
  61875. export class LensFlare {
  61876. /**
  61877. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61878. */
  61879. size: number;
  61880. /**
  61881. * 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.
  61882. */
  61883. position: number;
  61884. /**
  61885. * Define the lens color.
  61886. */
  61887. color: Color3;
  61888. /**
  61889. * Define the lens texture.
  61890. */
  61891. texture: Nullable<Texture>;
  61892. /**
  61893. * Define the alpha mode to render this particular lens.
  61894. */
  61895. alphaMode: number;
  61896. private _system;
  61897. /**
  61898. * Creates a new Lens Flare.
  61899. * This represents one of the lens effect in a `lensFlareSystem`.
  61900. * It controls one of the indiviual texture used in the effect.
  61901. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61902. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61903. * @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.
  61904. * @param color Define the lens color
  61905. * @param imgUrl Define the lens texture url
  61906. * @param system Define the `lensFlareSystem` this flare is part of
  61907. * @returns The newly created Lens Flare
  61908. */
  61909. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61910. /**
  61911. * Instantiates a new Lens Flare.
  61912. * This represents one of the lens effect in a `lensFlareSystem`.
  61913. * It controls one of the indiviual texture used in the effect.
  61914. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61915. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61916. * @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.
  61917. * @param color Define the lens color
  61918. * @param imgUrl Define the lens texture url
  61919. * @param system Define the `lensFlareSystem` this flare is part of
  61920. */
  61921. constructor(
  61922. /**
  61923. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61924. */
  61925. size: number,
  61926. /**
  61927. * 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.
  61928. */
  61929. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  61930. /**
  61931. * Dispose and release the lens flare with its associated resources.
  61932. */
  61933. dispose(): void;
  61934. }
  61935. }
  61936. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  61937. import { Nullable } from "babylonjs/types";
  61938. import { Scene } from "babylonjs/scene";
  61939. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61940. import { AbstractScene } from "babylonjs/abstractScene";
  61941. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61942. module "babylonjs/abstractScene" {
  61943. interface AbstractScene {
  61944. /**
  61945. * The list of lens flare system added to the scene
  61946. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61947. */
  61948. lensFlareSystems: Array<LensFlareSystem>;
  61949. /**
  61950. * Removes the given lens flare system from this scene.
  61951. * @param toRemove The lens flare system to remove
  61952. * @returns The index of the removed lens flare system
  61953. */
  61954. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  61955. /**
  61956. * Adds the given lens flare system to this scene
  61957. * @param newLensFlareSystem The lens flare system to add
  61958. */
  61959. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  61960. /**
  61961. * Gets a lens flare system using its name
  61962. * @param name defines the name to look for
  61963. * @returns the lens flare system or null if not found
  61964. */
  61965. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  61966. /**
  61967. * Gets a lens flare system using its id
  61968. * @param id defines the id to look for
  61969. * @returns the lens flare system or null if not found
  61970. */
  61971. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  61972. }
  61973. }
  61974. /**
  61975. * Defines the lens flare scene component responsible to manage any lens flares
  61976. * in a given scene.
  61977. */
  61978. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  61979. /**
  61980. * The component name helpfull to identify the component in the list of scene components.
  61981. */
  61982. readonly name: string;
  61983. /**
  61984. * The scene the component belongs to.
  61985. */
  61986. scene: Scene;
  61987. /**
  61988. * Creates a new instance of the component for the given scene
  61989. * @param scene Defines the scene to register the component in
  61990. */
  61991. constructor(scene: Scene);
  61992. /**
  61993. * Registers the component in a given scene
  61994. */
  61995. register(): void;
  61996. /**
  61997. * Rebuilds the elements related to this component in case of
  61998. * context lost for instance.
  61999. */
  62000. rebuild(): void;
  62001. /**
  62002. * Adds all the elements from the container to the scene
  62003. * @param container the container holding the elements
  62004. */
  62005. addFromContainer(container: AbstractScene): void;
  62006. /**
  62007. * Removes all the elements in the container from the scene
  62008. * @param container contains the elements to remove
  62009. * @param dispose if the removed element should be disposed (default: false)
  62010. */
  62011. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62012. /**
  62013. * Serializes the component data to the specified json object
  62014. * @param serializationObject The object to serialize to
  62015. */
  62016. serialize(serializationObject: any): void;
  62017. /**
  62018. * Disposes the component and the associated ressources.
  62019. */
  62020. dispose(): void;
  62021. private _draw;
  62022. }
  62023. }
  62024. declare module "babylonjs/LensFlares/index" {
  62025. export * from "babylonjs/LensFlares/lensFlare";
  62026. export * from "babylonjs/LensFlares/lensFlareSystem";
  62027. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62028. }
  62029. declare module "babylonjs/Shaders/depth.fragment" {
  62030. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62031. /** @hidden */
  62032. export var depthPixelShader: {
  62033. name: string;
  62034. shader: string;
  62035. };
  62036. }
  62037. declare module "babylonjs/Shaders/depth.vertex" {
  62038. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62039. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62040. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62041. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62042. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62043. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62044. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62045. /** @hidden */
  62046. export var depthVertexShader: {
  62047. name: string;
  62048. shader: string;
  62049. };
  62050. }
  62051. declare module "babylonjs/Rendering/depthRenderer" {
  62052. import { Nullable } from "babylonjs/types";
  62053. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62054. import { Scene } from "babylonjs/scene";
  62055. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62056. import { Camera } from "babylonjs/Cameras/camera";
  62057. import "babylonjs/Shaders/depth.fragment";
  62058. import "babylonjs/Shaders/depth.vertex";
  62059. /**
  62060. * This represents a depth renderer in Babylon.
  62061. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62062. */
  62063. export class DepthRenderer {
  62064. private _scene;
  62065. private _depthMap;
  62066. private _effect;
  62067. private readonly _storeNonLinearDepth;
  62068. private readonly _clearColor;
  62069. /** Get if the depth renderer is using packed depth or not */
  62070. readonly isPacked: boolean;
  62071. private _cachedDefines;
  62072. private _camera;
  62073. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62074. enabled: boolean;
  62075. /**
  62076. * Specifiess that the depth renderer will only be used within
  62077. * the camera it is created for.
  62078. * This can help forcing its rendering during the camera processing.
  62079. */
  62080. useOnlyInActiveCamera: boolean;
  62081. /** @hidden */
  62082. static _SceneComponentInitialization: (scene: Scene) => void;
  62083. /**
  62084. * Instantiates a depth renderer
  62085. * @param scene The scene the renderer belongs to
  62086. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62087. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62088. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62089. */
  62090. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62091. /**
  62092. * Creates the depth rendering effect and checks if the effect is ready.
  62093. * @param subMesh The submesh to be used to render the depth map of
  62094. * @param useInstances If multiple world instances should be used
  62095. * @returns if the depth renderer is ready to render the depth map
  62096. */
  62097. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62098. /**
  62099. * Gets the texture which the depth map will be written to.
  62100. * @returns The depth map texture
  62101. */
  62102. getDepthMap(): RenderTargetTexture;
  62103. /**
  62104. * Disposes of the depth renderer.
  62105. */
  62106. dispose(): void;
  62107. }
  62108. }
  62109. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62110. /** @hidden */
  62111. export var minmaxReduxPixelShader: {
  62112. name: string;
  62113. shader: string;
  62114. };
  62115. }
  62116. declare module "babylonjs/Misc/minMaxReducer" {
  62117. import { Nullable } from "babylonjs/types";
  62118. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62119. import { Camera } from "babylonjs/Cameras/camera";
  62120. import { Observer } from "babylonjs/Misc/observable";
  62121. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62122. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62123. import { Observable } from "babylonjs/Misc/observable";
  62124. import "babylonjs/Shaders/minmaxRedux.fragment";
  62125. /**
  62126. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62127. * and maximum values from all values of the texture.
  62128. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62129. * The source values are read from the red channel of the texture.
  62130. */
  62131. export class MinMaxReducer {
  62132. /**
  62133. * Observable triggered when the computation has been performed
  62134. */
  62135. onAfterReductionPerformed: Observable<{
  62136. min: number;
  62137. max: number;
  62138. }>;
  62139. protected _camera: Camera;
  62140. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62141. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62142. protected _postProcessManager: PostProcessManager;
  62143. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62144. protected _forceFullscreenViewport: boolean;
  62145. /**
  62146. * Creates a min/max reducer
  62147. * @param camera The camera to use for the post processes
  62148. */
  62149. constructor(camera: Camera);
  62150. /**
  62151. * Gets the texture used to read the values from.
  62152. */
  62153. get sourceTexture(): Nullable<RenderTargetTexture>;
  62154. /**
  62155. * Sets the source texture to read the values from.
  62156. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62157. * because in such textures '1' value must not be taken into account to compute the maximum
  62158. * as this value is used to clear the texture.
  62159. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62160. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62161. * @param depthRedux Indicates if the texture is a depth texture or not
  62162. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62163. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62164. */
  62165. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62166. /**
  62167. * Defines the refresh rate of the computation.
  62168. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62169. */
  62170. get refreshRate(): number;
  62171. set refreshRate(value: number);
  62172. protected _activated: boolean;
  62173. /**
  62174. * Gets the activation status of the reducer
  62175. */
  62176. get activated(): boolean;
  62177. /**
  62178. * Activates the reduction computation.
  62179. * When activated, the observers registered in onAfterReductionPerformed are
  62180. * called after the compuation is performed
  62181. */
  62182. activate(): void;
  62183. /**
  62184. * Deactivates the reduction computation.
  62185. */
  62186. deactivate(): void;
  62187. /**
  62188. * Disposes the min/max reducer
  62189. * @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.
  62190. */
  62191. dispose(disposeAll?: boolean): void;
  62192. }
  62193. }
  62194. declare module "babylonjs/Misc/depthReducer" {
  62195. import { Nullable } from "babylonjs/types";
  62196. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62197. import { Camera } from "babylonjs/Cameras/camera";
  62198. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62199. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62200. /**
  62201. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62202. */
  62203. export class DepthReducer extends MinMaxReducer {
  62204. private _depthRenderer;
  62205. private _depthRendererId;
  62206. /**
  62207. * Gets the depth renderer used for the computation.
  62208. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62209. */
  62210. get depthRenderer(): Nullable<DepthRenderer>;
  62211. /**
  62212. * Creates a depth reducer
  62213. * @param camera The camera used to render the depth texture
  62214. */
  62215. constructor(camera: Camera);
  62216. /**
  62217. * Sets the depth renderer to use to generate the depth map
  62218. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62219. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62220. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62221. */
  62222. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62223. /** @hidden */
  62224. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62225. /**
  62226. * Activates the reduction computation.
  62227. * When activated, the observers registered in onAfterReductionPerformed are
  62228. * called after the compuation is performed
  62229. */
  62230. activate(): void;
  62231. /**
  62232. * Deactivates the reduction computation.
  62233. */
  62234. deactivate(): void;
  62235. /**
  62236. * Disposes the depth reducer
  62237. * @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.
  62238. */
  62239. dispose(disposeAll?: boolean): void;
  62240. }
  62241. }
  62242. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62243. import { Nullable } from "babylonjs/types";
  62244. import { Scene } from "babylonjs/scene";
  62245. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62246. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62247. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62248. import { Effect } from "babylonjs/Materials/effect";
  62249. import "babylonjs/Shaders/shadowMap.fragment";
  62250. import "babylonjs/Shaders/shadowMap.vertex";
  62251. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62252. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62253. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62254. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62255. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62256. /**
  62257. * A CSM implementation allowing casting shadows on large scenes.
  62258. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62259. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62260. */
  62261. export class CascadedShadowGenerator extends ShadowGenerator {
  62262. private static readonly frustumCornersNDCSpace;
  62263. /**
  62264. * Name of the CSM class
  62265. */
  62266. static CLASSNAME: string;
  62267. /**
  62268. * Defines the default number of cascades used by the CSM.
  62269. */
  62270. static readonly DEFAULT_CASCADES_COUNT: number;
  62271. /**
  62272. * Defines the minimum number of cascades used by the CSM.
  62273. */
  62274. static readonly MIN_CASCADES_COUNT: number;
  62275. /**
  62276. * Defines the maximum number of cascades used by the CSM.
  62277. */
  62278. static readonly MAX_CASCADES_COUNT: number;
  62279. protected _validateFilter(filter: number): number;
  62280. /**
  62281. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62282. */
  62283. penumbraDarkness: number;
  62284. private _numCascades;
  62285. /**
  62286. * Gets or set the number of cascades used by the CSM.
  62287. */
  62288. get numCascades(): number;
  62289. set numCascades(value: number);
  62290. /**
  62291. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62292. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62293. */
  62294. stabilizeCascades: boolean;
  62295. private _freezeShadowCastersBoundingInfo;
  62296. private _freezeShadowCastersBoundingInfoObservable;
  62297. /**
  62298. * Enables or disables the shadow casters bounding info computation.
  62299. * If your shadow casters don't move, you can disable this feature.
  62300. * If it is enabled, the bounding box computation is done every frame.
  62301. */
  62302. get freezeShadowCastersBoundingInfo(): boolean;
  62303. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62304. private _scbiMin;
  62305. private _scbiMax;
  62306. protected _computeShadowCastersBoundingInfo(): void;
  62307. protected _shadowCastersBoundingInfo: BoundingInfo;
  62308. /**
  62309. * Gets or sets the shadow casters bounding info.
  62310. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62311. * so that the system won't overwrite the bounds you provide
  62312. */
  62313. get shadowCastersBoundingInfo(): BoundingInfo;
  62314. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62315. protected _breaksAreDirty: boolean;
  62316. protected _minDistance: number;
  62317. protected _maxDistance: number;
  62318. /**
  62319. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62320. *
  62321. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62322. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62323. * @param min minimal distance for the breaks (default to 0.)
  62324. * @param max maximal distance for the breaks (default to 1.)
  62325. */
  62326. setMinMaxDistance(min: number, max: number): void;
  62327. /** Gets the minimal distance used in the cascade break computation */
  62328. get minDistance(): number;
  62329. /** Gets the maximal distance used in the cascade break computation */
  62330. get maxDistance(): number;
  62331. /**
  62332. * Gets the class name of that object
  62333. * @returns "CascadedShadowGenerator"
  62334. */
  62335. getClassName(): string;
  62336. private _cascadeMinExtents;
  62337. private _cascadeMaxExtents;
  62338. /**
  62339. * Gets a cascade minimum extents
  62340. * @param cascadeIndex index of the cascade
  62341. * @returns the minimum cascade extents
  62342. */
  62343. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62344. /**
  62345. * Gets a cascade maximum extents
  62346. * @param cascadeIndex index of the cascade
  62347. * @returns the maximum cascade extents
  62348. */
  62349. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62350. private _cascades;
  62351. private _currentLayer;
  62352. private _viewSpaceFrustumsZ;
  62353. private _viewMatrices;
  62354. private _projectionMatrices;
  62355. private _transformMatrices;
  62356. private _transformMatricesAsArray;
  62357. private _frustumLengths;
  62358. private _lightSizeUVCorrection;
  62359. private _depthCorrection;
  62360. private _frustumCornersWorldSpace;
  62361. private _frustumCenter;
  62362. private _shadowCameraPos;
  62363. private _shadowMaxZ;
  62364. /**
  62365. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62366. * It defaults to camera.maxZ
  62367. */
  62368. get shadowMaxZ(): number;
  62369. /**
  62370. * Sets the shadow max z distance.
  62371. */
  62372. set shadowMaxZ(value: number);
  62373. protected _debug: boolean;
  62374. /**
  62375. * Gets or sets the debug flag.
  62376. * When enabled, the cascades are materialized by different colors on the screen.
  62377. */
  62378. get debug(): boolean;
  62379. set debug(dbg: boolean);
  62380. private _depthClamp;
  62381. /**
  62382. * Gets or sets the depth clamping value.
  62383. *
  62384. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62385. * to account for the shadow casters far away.
  62386. *
  62387. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62388. */
  62389. get depthClamp(): boolean;
  62390. set depthClamp(value: boolean);
  62391. private _cascadeBlendPercentage;
  62392. /**
  62393. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62394. * It defaults to 0.1 (10% blending).
  62395. */
  62396. get cascadeBlendPercentage(): number;
  62397. set cascadeBlendPercentage(value: number);
  62398. private _lambda;
  62399. /**
  62400. * Gets or set the lambda parameter.
  62401. * This parameter is used to split the camera frustum and create the cascades.
  62402. * 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.
  62403. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62404. */
  62405. get lambda(): number;
  62406. set lambda(value: number);
  62407. /**
  62408. * Gets the view matrix corresponding to a given cascade
  62409. * @param cascadeNum cascade to retrieve the view matrix from
  62410. * @returns the cascade view matrix
  62411. */
  62412. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62413. /**
  62414. * Gets the projection matrix corresponding to a given cascade
  62415. * @param cascadeNum cascade to retrieve the projection matrix from
  62416. * @returns the cascade projection matrix
  62417. */
  62418. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62419. /**
  62420. * Gets the transformation matrix corresponding to a given cascade
  62421. * @param cascadeNum cascade to retrieve the transformation matrix from
  62422. * @returns the cascade transformation matrix
  62423. */
  62424. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62425. private _depthRenderer;
  62426. /**
  62427. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62428. *
  62429. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62430. *
  62431. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62432. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62433. * @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
  62434. */
  62435. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62436. private _depthReducer;
  62437. private _autoCalcDepthBounds;
  62438. /**
  62439. * Gets or sets the autoCalcDepthBounds property.
  62440. *
  62441. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62442. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62443. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62444. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62445. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62446. */
  62447. get autoCalcDepthBounds(): boolean;
  62448. set autoCalcDepthBounds(value: boolean);
  62449. /**
  62450. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62451. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62452. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62453. * for setting the refresh rate on the renderer yourself!
  62454. */
  62455. get autoCalcDepthBoundsRefreshRate(): number;
  62456. set autoCalcDepthBoundsRefreshRate(value: number);
  62457. /**
  62458. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62459. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62460. * you change the camera near/far planes!
  62461. */
  62462. splitFrustum(): void;
  62463. private _splitFrustum;
  62464. private _computeMatrices;
  62465. private _computeFrustumInWorldSpace;
  62466. private _computeCascadeFrustum;
  62467. /**
  62468. * Support test.
  62469. */
  62470. static get IsSupported(): boolean;
  62471. /** @hidden */
  62472. static _SceneComponentInitialization: (scene: Scene) => void;
  62473. /**
  62474. * Creates a Cascaded Shadow Generator object.
  62475. * A ShadowGenerator is the required tool to use the shadows.
  62476. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62477. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62478. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62479. * @param light The directional light object generating the shadows.
  62480. * @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.
  62481. */
  62482. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62483. protected _initializeGenerator(): void;
  62484. protected _createTargetRenderTexture(): void;
  62485. protected _initializeShadowMap(): void;
  62486. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62487. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62488. /**
  62489. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62490. * @param defines Defines of the material we want to update
  62491. * @param lightIndex Index of the light in the enabled light list of the material
  62492. */
  62493. prepareDefines(defines: any, lightIndex: number): void;
  62494. /**
  62495. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62496. * defined in the generator but impacting the effect).
  62497. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62498. * @param effect The effect we are binfing the information for
  62499. */
  62500. bindShadowLight(lightIndex: string, effect: Effect): void;
  62501. /**
  62502. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62503. * (eq to view projection * shadow projection matrices)
  62504. * @returns The transform matrix used to create the shadow map
  62505. */
  62506. getTransformMatrix(): Matrix;
  62507. /**
  62508. * Disposes the ShadowGenerator.
  62509. * Returns nothing.
  62510. */
  62511. dispose(): void;
  62512. /**
  62513. * Serializes the shadow generator setup to a json object.
  62514. * @returns The serialized JSON object
  62515. */
  62516. serialize(): any;
  62517. /**
  62518. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62519. * @param parsedShadowGenerator The JSON object to parse
  62520. * @param scene The scene to create the shadow map for
  62521. * @returns The parsed shadow generator
  62522. */
  62523. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62524. }
  62525. }
  62526. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62527. import { Scene } from "babylonjs/scene";
  62528. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62529. import { AbstractScene } from "babylonjs/abstractScene";
  62530. /**
  62531. * Defines the shadow generator component responsible to manage any shadow generators
  62532. * in a given scene.
  62533. */
  62534. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62535. /**
  62536. * The component name helpfull to identify the component in the list of scene components.
  62537. */
  62538. readonly name: string;
  62539. /**
  62540. * The scene the component belongs to.
  62541. */
  62542. scene: Scene;
  62543. /**
  62544. * Creates a new instance of the component for the given scene
  62545. * @param scene Defines the scene to register the component in
  62546. */
  62547. constructor(scene: Scene);
  62548. /**
  62549. * Registers the component in a given scene
  62550. */
  62551. register(): void;
  62552. /**
  62553. * Rebuilds the elements related to this component in case of
  62554. * context lost for instance.
  62555. */
  62556. rebuild(): void;
  62557. /**
  62558. * Serializes the component data to the specified json object
  62559. * @param serializationObject The object to serialize to
  62560. */
  62561. serialize(serializationObject: any): void;
  62562. /**
  62563. * Adds all the elements from the container to the scene
  62564. * @param container the container holding the elements
  62565. */
  62566. addFromContainer(container: AbstractScene): void;
  62567. /**
  62568. * Removes all the elements in the container from the scene
  62569. * @param container contains the elements to remove
  62570. * @param dispose if the removed element should be disposed (default: false)
  62571. */
  62572. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62573. /**
  62574. * Rebuilds the elements related to this component in case of
  62575. * context lost for instance.
  62576. */
  62577. dispose(): void;
  62578. private _gatherRenderTargets;
  62579. }
  62580. }
  62581. declare module "babylonjs/Lights/Shadows/index" {
  62582. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62583. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62584. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62585. }
  62586. declare module "babylonjs/Lights/pointLight" {
  62587. import { Scene } from "babylonjs/scene";
  62588. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62589. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62590. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62591. import { Effect } from "babylonjs/Materials/effect";
  62592. /**
  62593. * A point light is a light defined by an unique point in world space.
  62594. * The light is emitted in every direction from this point.
  62595. * A good example of a point light is a standard light bulb.
  62596. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62597. */
  62598. export class PointLight extends ShadowLight {
  62599. private _shadowAngle;
  62600. /**
  62601. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62602. * This specifies what angle the shadow will use to be created.
  62603. *
  62604. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62605. */
  62606. get shadowAngle(): number;
  62607. /**
  62608. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62609. * This specifies what angle the shadow will use to be created.
  62610. *
  62611. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62612. */
  62613. set shadowAngle(value: number);
  62614. /**
  62615. * Gets the direction if it has been set.
  62616. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62617. */
  62618. get direction(): Vector3;
  62619. /**
  62620. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62621. */
  62622. set direction(value: Vector3);
  62623. /**
  62624. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62625. * A PointLight emits the light in every direction.
  62626. * It can cast shadows.
  62627. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62628. * ```javascript
  62629. * var pointLight = new PointLight("pl", camera.position, scene);
  62630. * ```
  62631. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62632. * @param name The light friendly name
  62633. * @param position The position of the point light in the scene
  62634. * @param scene The scene the lights belongs to
  62635. */
  62636. constructor(name: string, position: Vector3, scene: Scene);
  62637. /**
  62638. * Returns the string "PointLight"
  62639. * @returns the class name
  62640. */
  62641. getClassName(): string;
  62642. /**
  62643. * Returns the integer 0.
  62644. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62645. */
  62646. getTypeID(): number;
  62647. /**
  62648. * Specifies wether or not the shadowmap should be a cube texture.
  62649. * @returns true if the shadowmap needs to be a cube texture.
  62650. */
  62651. needCube(): boolean;
  62652. /**
  62653. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62654. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62655. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62656. */
  62657. getShadowDirection(faceIndex?: number): Vector3;
  62658. /**
  62659. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62660. * - fov = PI / 2
  62661. * - aspect ratio : 1.0
  62662. * - z-near and far equal to the active camera minZ and maxZ.
  62663. * Returns the PointLight.
  62664. */
  62665. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62666. protected _buildUniformLayout(): void;
  62667. /**
  62668. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62669. * @param effect The effect to update
  62670. * @param lightIndex The index of the light in the effect to update
  62671. * @returns The point light
  62672. */
  62673. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62674. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62675. /**
  62676. * Prepares the list of defines specific to the light type.
  62677. * @param defines the list of defines
  62678. * @param lightIndex defines the index of the light for the effect
  62679. */
  62680. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62681. }
  62682. }
  62683. declare module "babylonjs/Lights/index" {
  62684. export * from "babylonjs/Lights/light";
  62685. export * from "babylonjs/Lights/shadowLight";
  62686. export * from "babylonjs/Lights/Shadows/index";
  62687. export * from "babylonjs/Lights/directionalLight";
  62688. export * from "babylonjs/Lights/hemisphericLight";
  62689. export * from "babylonjs/Lights/pointLight";
  62690. export * from "babylonjs/Lights/spotLight";
  62691. }
  62692. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62693. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62694. /**
  62695. * Header information of HDR texture files.
  62696. */
  62697. export interface HDRInfo {
  62698. /**
  62699. * The height of the texture in pixels.
  62700. */
  62701. height: number;
  62702. /**
  62703. * The width of the texture in pixels.
  62704. */
  62705. width: number;
  62706. /**
  62707. * The index of the beginning of the data in the binary file.
  62708. */
  62709. dataPosition: number;
  62710. }
  62711. /**
  62712. * This groups tools to convert HDR texture to native colors array.
  62713. */
  62714. export class HDRTools {
  62715. private static Ldexp;
  62716. private static Rgbe2float;
  62717. private static readStringLine;
  62718. /**
  62719. * Reads header information from an RGBE texture stored in a native array.
  62720. * More information on this format are available here:
  62721. * https://en.wikipedia.org/wiki/RGBE_image_format
  62722. *
  62723. * @param uint8array The binary file stored in native array.
  62724. * @return The header information.
  62725. */
  62726. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62727. /**
  62728. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62729. * This RGBE texture needs to store the information as a panorama.
  62730. *
  62731. * More information on this format are available here:
  62732. * https://en.wikipedia.org/wiki/RGBE_image_format
  62733. *
  62734. * @param buffer The binary file stored in an array buffer.
  62735. * @param size The expected size of the extracted cubemap.
  62736. * @return The Cube Map information.
  62737. */
  62738. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62739. /**
  62740. * Returns the pixels data extracted from an RGBE texture.
  62741. * This pixels will be stored left to right up to down in the R G B order in one array.
  62742. *
  62743. * More information on this format are available here:
  62744. * https://en.wikipedia.org/wiki/RGBE_image_format
  62745. *
  62746. * @param uint8array The binary file stored in an array buffer.
  62747. * @param hdrInfo The header information of the file.
  62748. * @return The pixels data in RGB right to left up to down order.
  62749. */
  62750. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62751. private static RGBE_ReadPixels_RLE;
  62752. private static RGBE_ReadPixels_NOT_RLE;
  62753. }
  62754. }
  62755. declare module "babylonjs/Materials/effectRenderer" {
  62756. import { Nullable } from "babylonjs/types";
  62757. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62758. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62759. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62760. import { Viewport } from "babylonjs/Maths/math.viewport";
  62761. import { Observable } from "babylonjs/Misc/observable";
  62762. import { Effect } from "babylonjs/Materials/effect";
  62763. import "babylonjs/Shaders/postprocess.vertex";
  62764. /**
  62765. * Effect Render Options
  62766. */
  62767. export interface IEffectRendererOptions {
  62768. /**
  62769. * Defines the vertices positions.
  62770. */
  62771. positions?: number[];
  62772. /**
  62773. * Defines the indices.
  62774. */
  62775. indices?: number[];
  62776. }
  62777. /**
  62778. * Helper class to render one or more effects.
  62779. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62780. */
  62781. export class EffectRenderer {
  62782. private engine;
  62783. private static _DefaultOptions;
  62784. private _vertexBuffers;
  62785. private _indexBuffer;
  62786. private _fullscreenViewport;
  62787. /**
  62788. * Creates an effect renderer
  62789. * @param engine the engine to use for rendering
  62790. * @param options defines the options of the effect renderer
  62791. */
  62792. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62793. /**
  62794. * Sets the current viewport in normalized coordinates 0-1
  62795. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62796. */
  62797. setViewport(viewport?: Viewport): void;
  62798. /**
  62799. * Binds the embedded attributes buffer to the effect.
  62800. * @param effect Defines the effect to bind the attributes for
  62801. */
  62802. bindBuffers(effect: Effect): void;
  62803. /**
  62804. * Sets the current effect wrapper to use during draw.
  62805. * The effect needs to be ready before calling this api.
  62806. * This also sets the default full screen position attribute.
  62807. * @param effectWrapper Defines the effect to draw with
  62808. */
  62809. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62810. /**
  62811. * Restores engine states
  62812. */
  62813. restoreStates(): void;
  62814. /**
  62815. * Draws a full screen quad.
  62816. */
  62817. draw(): void;
  62818. private isRenderTargetTexture;
  62819. /**
  62820. * renders one or more effects to a specified texture
  62821. * @param effectWrapper the effect to renderer
  62822. * @param outputTexture texture to draw to, if null it will render to the screen.
  62823. */
  62824. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62825. /**
  62826. * Disposes of the effect renderer
  62827. */
  62828. dispose(): void;
  62829. }
  62830. /**
  62831. * Options to create an EffectWrapper
  62832. */
  62833. interface EffectWrapperCreationOptions {
  62834. /**
  62835. * Engine to use to create the effect
  62836. */
  62837. engine: ThinEngine;
  62838. /**
  62839. * Fragment shader for the effect
  62840. */
  62841. fragmentShader: string;
  62842. /**
  62843. * Use the shader store instead of direct source code
  62844. */
  62845. useShaderStore?: boolean;
  62846. /**
  62847. * Vertex shader for the effect
  62848. */
  62849. vertexShader?: string;
  62850. /**
  62851. * Attributes to use in the shader
  62852. */
  62853. attributeNames?: Array<string>;
  62854. /**
  62855. * Uniforms to use in the shader
  62856. */
  62857. uniformNames?: Array<string>;
  62858. /**
  62859. * Texture sampler names to use in the shader
  62860. */
  62861. samplerNames?: Array<string>;
  62862. /**
  62863. * Defines to use in the shader
  62864. */
  62865. defines?: Array<string>;
  62866. /**
  62867. * Callback when effect is compiled
  62868. */
  62869. onCompiled?: Nullable<(effect: Effect) => void>;
  62870. /**
  62871. * The friendly name of the effect displayed in Spector.
  62872. */
  62873. name?: string;
  62874. }
  62875. /**
  62876. * Wraps an effect to be used for rendering
  62877. */
  62878. export class EffectWrapper {
  62879. /**
  62880. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62881. */
  62882. onApplyObservable: Observable<{}>;
  62883. /**
  62884. * The underlying effect
  62885. */
  62886. effect: Effect;
  62887. /**
  62888. * Creates an effect to be renderer
  62889. * @param creationOptions options to create the effect
  62890. */
  62891. constructor(creationOptions: EffectWrapperCreationOptions);
  62892. /**
  62893. * Disposes of the effect wrapper
  62894. */
  62895. dispose(): void;
  62896. }
  62897. }
  62898. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62899. /** @hidden */
  62900. export var hdrFilteringVertexShader: {
  62901. name: string;
  62902. shader: string;
  62903. };
  62904. }
  62905. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62906. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62907. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62908. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62909. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62910. /** @hidden */
  62911. export var hdrFilteringPixelShader: {
  62912. name: string;
  62913. shader: string;
  62914. };
  62915. }
  62916. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62917. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62918. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62919. import { Nullable } from "babylonjs/types";
  62920. import "babylonjs/Shaders/hdrFiltering.vertex";
  62921. import "babylonjs/Shaders/hdrFiltering.fragment";
  62922. /**
  62923. * Options for texture filtering
  62924. */
  62925. interface IHDRFilteringOptions {
  62926. /**
  62927. * Scales pixel intensity for the input HDR map.
  62928. */
  62929. hdrScale?: number;
  62930. /**
  62931. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  62932. */
  62933. quality?: number;
  62934. }
  62935. /**
  62936. * Filters HDR maps to get correct renderings of PBR reflections
  62937. */
  62938. export class HDRFiltering {
  62939. private _engine;
  62940. private _effectRenderer;
  62941. private _effectWrapper;
  62942. private _lodGenerationOffset;
  62943. private _lodGenerationScale;
  62944. /**
  62945. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  62946. * you care about baking speed.
  62947. */
  62948. quality: number;
  62949. /**
  62950. * Scales pixel intensity for the input HDR map.
  62951. */
  62952. hdrScale: number;
  62953. /**
  62954. * Instantiates HDR filter for reflection maps
  62955. *
  62956. * @param engine Thin engine
  62957. * @param options Options
  62958. */
  62959. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  62960. private _createRenderTarget;
  62961. private _prefilterInternal;
  62962. private _createEffect;
  62963. /**
  62964. * Get a value indicating if the filter is ready to be used
  62965. * @param texture Texture to filter
  62966. * @returns true if the filter is ready
  62967. */
  62968. isReady(texture: BaseTexture): boolean;
  62969. /**
  62970. * Prefilters a cube texture to have mipmap levels representing roughness values.
  62971. * Prefiltering will be invoked at the end of next rendering pass.
  62972. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  62973. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  62974. * @param texture Texture to filter
  62975. * @param onFinished Callback when filtering is done
  62976. * @return Promise called when prefiltering is done
  62977. */
  62978. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  62979. }
  62980. }
  62981. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  62982. import { Nullable } from "babylonjs/types";
  62983. import { Scene } from "babylonjs/scene";
  62984. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62985. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62986. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62987. import "babylonjs/Engines/Extensions/engine.rawTexture";
  62988. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  62989. /**
  62990. * This represents a texture coming from an HDR input.
  62991. *
  62992. * The only supported format is currently panorama picture stored in RGBE format.
  62993. * Example of such files can be found on HDRLib: http://hdrlib.com/
  62994. */
  62995. export class HDRCubeTexture extends BaseTexture {
  62996. private static _facesMapping;
  62997. private _generateHarmonics;
  62998. private _noMipmap;
  62999. private _prefilterOnLoad;
  63000. private _textureMatrix;
  63001. private _size;
  63002. private _onLoad;
  63003. private _onError;
  63004. /**
  63005. * The texture URL.
  63006. */
  63007. url: string;
  63008. /**
  63009. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  63010. */
  63011. coordinatesMode: number;
  63012. protected _isBlocking: boolean;
  63013. /**
  63014. * Sets wether or not the texture is blocking during loading.
  63015. */
  63016. set isBlocking(value: boolean);
  63017. /**
  63018. * Gets wether or not the texture is blocking during loading.
  63019. */
  63020. get isBlocking(): boolean;
  63021. protected _rotationY: number;
  63022. /**
  63023. * Sets texture matrix rotation angle around Y axis in radians.
  63024. */
  63025. set rotationY(value: number);
  63026. /**
  63027. * Gets texture matrix rotation angle around Y axis radians.
  63028. */
  63029. get rotationY(): number;
  63030. /**
  63031. * Gets or sets the center of the bounding box associated with the cube texture
  63032. * It must define where the camera used to render the texture was set
  63033. */
  63034. boundingBoxPosition: Vector3;
  63035. private _boundingBoxSize;
  63036. /**
  63037. * Gets or sets the size of the bounding box associated with the cube texture
  63038. * When defined, the cubemap will switch to local mode
  63039. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63040. * @example https://www.babylonjs-playground.com/#RNASML
  63041. */
  63042. set boundingBoxSize(value: Vector3);
  63043. get boundingBoxSize(): Vector3;
  63044. /**
  63045. * Instantiates an HDRTexture from the following parameters.
  63046. *
  63047. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63048. * @param sceneOrEngine The scene or engine the texture will be used in
  63049. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63050. * @param noMipmap Forces to not generate the mipmap if true
  63051. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63052. * @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)
  63053. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63054. */
  63055. 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>);
  63056. /**
  63057. * Get the current class name of the texture useful for serialization or dynamic coding.
  63058. * @returns "HDRCubeTexture"
  63059. */
  63060. getClassName(): string;
  63061. /**
  63062. * Occurs when the file is raw .hdr file.
  63063. */
  63064. private loadTexture;
  63065. clone(): HDRCubeTexture;
  63066. delayLoad(): void;
  63067. /**
  63068. * Get the texture reflection matrix used to rotate/transform the reflection.
  63069. * @returns the reflection matrix
  63070. */
  63071. getReflectionTextureMatrix(): Matrix;
  63072. /**
  63073. * Set the texture reflection matrix used to rotate/transform the reflection.
  63074. * @param value Define the reflection matrix to set
  63075. */
  63076. setReflectionTextureMatrix(value: Matrix): void;
  63077. /**
  63078. * Parses a JSON representation of an HDR Texture in order to create the texture
  63079. * @param parsedTexture Define the JSON representation
  63080. * @param scene Define the scene the texture should be created in
  63081. * @param rootUrl Define the root url in case we need to load relative dependencies
  63082. * @returns the newly created texture after parsing
  63083. */
  63084. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63085. serialize(): any;
  63086. }
  63087. }
  63088. declare module "babylonjs/Physics/physicsEngine" {
  63089. import { Nullable } from "babylonjs/types";
  63090. import { Vector3 } from "babylonjs/Maths/math.vector";
  63091. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63092. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63093. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63094. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63095. /**
  63096. * Class used to control physics engine
  63097. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63098. */
  63099. export class PhysicsEngine implements IPhysicsEngine {
  63100. private _physicsPlugin;
  63101. /**
  63102. * Global value used to control the smallest number supported by the simulation
  63103. */
  63104. static Epsilon: number;
  63105. private _impostors;
  63106. private _joints;
  63107. private _subTimeStep;
  63108. /**
  63109. * Gets the gravity vector used by the simulation
  63110. */
  63111. gravity: Vector3;
  63112. /**
  63113. * Factory used to create the default physics plugin.
  63114. * @returns The default physics plugin
  63115. */
  63116. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63117. /**
  63118. * Creates a new Physics Engine
  63119. * @param gravity defines the gravity vector used by the simulation
  63120. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63121. */
  63122. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63123. /**
  63124. * Sets the gravity vector used by the simulation
  63125. * @param gravity defines the gravity vector to use
  63126. */
  63127. setGravity(gravity: Vector3): void;
  63128. /**
  63129. * Set the time step of the physics engine.
  63130. * Default is 1/60.
  63131. * To slow it down, enter 1/600 for example.
  63132. * To speed it up, 1/30
  63133. * @param newTimeStep defines the new timestep to apply to this world.
  63134. */
  63135. setTimeStep(newTimeStep?: number): void;
  63136. /**
  63137. * Get the time step of the physics engine.
  63138. * @returns the current time step
  63139. */
  63140. getTimeStep(): number;
  63141. /**
  63142. * Set the sub time step of the physics engine.
  63143. * Default is 0 meaning there is no sub steps
  63144. * To increase physics resolution precision, set a small value (like 1 ms)
  63145. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63146. */
  63147. setSubTimeStep(subTimeStep?: number): void;
  63148. /**
  63149. * Get the sub time step of the physics engine.
  63150. * @returns the current sub time step
  63151. */
  63152. getSubTimeStep(): number;
  63153. /**
  63154. * Release all resources
  63155. */
  63156. dispose(): void;
  63157. /**
  63158. * Gets the name of the current physics plugin
  63159. * @returns the name of the plugin
  63160. */
  63161. getPhysicsPluginName(): string;
  63162. /**
  63163. * Adding a new impostor for the impostor tracking.
  63164. * This will be done by the impostor itself.
  63165. * @param impostor the impostor to add
  63166. */
  63167. addImpostor(impostor: PhysicsImpostor): void;
  63168. /**
  63169. * Remove an impostor from the engine.
  63170. * This impostor and its mesh will not longer be updated by the physics engine.
  63171. * @param impostor the impostor to remove
  63172. */
  63173. removeImpostor(impostor: PhysicsImpostor): void;
  63174. /**
  63175. * Add a joint to the physics engine
  63176. * @param mainImpostor defines the main impostor to which the joint is added.
  63177. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63178. * @param joint defines the joint that will connect both impostors.
  63179. */
  63180. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63181. /**
  63182. * Removes a joint from the simulation
  63183. * @param mainImpostor defines the impostor used with the joint
  63184. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63185. * @param joint defines the joint to remove
  63186. */
  63187. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63188. /**
  63189. * Called by the scene. No need to call it.
  63190. * @param delta defines the timespam between frames
  63191. */
  63192. _step(delta: number): void;
  63193. /**
  63194. * Gets the current plugin used to run the simulation
  63195. * @returns current plugin
  63196. */
  63197. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63198. /**
  63199. * Gets the list of physic impostors
  63200. * @returns an array of PhysicsImpostor
  63201. */
  63202. getImpostors(): Array<PhysicsImpostor>;
  63203. /**
  63204. * Gets the impostor for a physics enabled object
  63205. * @param object defines the object impersonated by the impostor
  63206. * @returns the PhysicsImpostor or null if not found
  63207. */
  63208. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63209. /**
  63210. * Gets the impostor for a physics body object
  63211. * @param body defines physics body used by the impostor
  63212. * @returns the PhysicsImpostor or null if not found
  63213. */
  63214. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63215. /**
  63216. * Does a raycast in the physics world
  63217. * @param from when should the ray start?
  63218. * @param to when should the ray end?
  63219. * @returns PhysicsRaycastResult
  63220. */
  63221. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63222. }
  63223. }
  63224. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63225. import { Nullable } from "babylonjs/types";
  63226. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63227. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63228. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63229. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63230. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63231. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63232. /** @hidden */
  63233. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63234. private _useDeltaForWorldStep;
  63235. world: any;
  63236. name: string;
  63237. private _physicsMaterials;
  63238. private _fixedTimeStep;
  63239. private _cannonRaycastResult;
  63240. private _raycastResult;
  63241. private _physicsBodysToRemoveAfterStep;
  63242. private _firstFrame;
  63243. BJSCANNON: any;
  63244. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63245. setGravity(gravity: Vector3): void;
  63246. setTimeStep(timeStep: number): void;
  63247. getTimeStep(): number;
  63248. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63249. private _removeMarkedPhysicsBodiesFromWorld;
  63250. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63251. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63252. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63253. private _processChildMeshes;
  63254. removePhysicsBody(impostor: PhysicsImpostor): void;
  63255. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63256. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63257. private _addMaterial;
  63258. private _checkWithEpsilon;
  63259. private _createShape;
  63260. private _createHeightmap;
  63261. private _minus90X;
  63262. private _plus90X;
  63263. private _tmpPosition;
  63264. private _tmpDeltaPosition;
  63265. private _tmpUnityRotation;
  63266. private _updatePhysicsBodyTransformation;
  63267. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63268. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63269. isSupported(): boolean;
  63270. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63271. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63272. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63273. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63274. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63275. getBodyMass(impostor: PhysicsImpostor): number;
  63276. getBodyFriction(impostor: PhysicsImpostor): number;
  63277. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63278. getBodyRestitution(impostor: PhysicsImpostor): number;
  63279. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63280. sleepBody(impostor: PhysicsImpostor): void;
  63281. wakeUpBody(impostor: PhysicsImpostor): void;
  63282. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63283. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63284. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63285. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63286. getRadius(impostor: PhysicsImpostor): number;
  63287. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63288. dispose(): void;
  63289. private _extendNamespace;
  63290. /**
  63291. * Does a raycast in the physics world
  63292. * @param from when should the ray start?
  63293. * @param to when should the ray end?
  63294. * @returns PhysicsRaycastResult
  63295. */
  63296. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63297. }
  63298. }
  63299. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63300. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63301. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63302. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63303. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63304. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63305. import { Nullable } from "babylonjs/types";
  63306. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63307. /** @hidden */
  63308. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63309. private _useDeltaForWorldStep;
  63310. world: any;
  63311. name: string;
  63312. BJSOIMO: any;
  63313. private _raycastResult;
  63314. private _fixedTimeStep;
  63315. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63316. setGravity(gravity: Vector3): void;
  63317. setTimeStep(timeStep: number): void;
  63318. getTimeStep(): number;
  63319. private _tmpImpostorsArray;
  63320. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63321. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63322. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63323. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63324. private _tmpPositionVector;
  63325. removePhysicsBody(impostor: PhysicsImpostor): void;
  63326. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63327. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63328. isSupported(): boolean;
  63329. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63330. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63331. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63332. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63333. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63334. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63335. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63336. getBodyMass(impostor: PhysicsImpostor): number;
  63337. getBodyFriction(impostor: PhysicsImpostor): number;
  63338. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63339. getBodyRestitution(impostor: PhysicsImpostor): number;
  63340. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63341. sleepBody(impostor: PhysicsImpostor): void;
  63342. wakeUpBody(impostor: PhysicsImpostor): void;
  63343. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63344. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63345. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63346. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63347. getRadius(impostor: PhysicsImpostor): number;
  63348. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63349. dispose(): void;
  63350. /**
  63351. * Does a raycast in the physics world
  63352. * @param from when should the ray start?
  63353. * @param to when should the ray end?
  63354. * @returns PhysicsRaycastResult
  63355. */
  63356. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63357. }
  63358. }
  63359. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63360. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63361. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63362. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63363. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63364. import { Nullable } from "babylonjs/types";
  63365. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63366. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63367. /**
  63368. * AmmoJS Physics plugin
  63369. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63370. * @see https://github.com/kripken/ammo.js/
  63371. */
  63372. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63373. private _useDeltaForWorldStep;
  63374. /**
  63375. * Reference to the Ammo library
  63376. */
  63377. bjsAMMO: any;
  63378. /**
  63379. * Created ammoJS world which physics bodies are added to
  63380. */
  63381. world: any;
  63382. /**
  63383. * Name of the plugin
  63384. */
  63385. name: string;
  63386. private _timeStep;
  63387. private _fixedTimeStep;
  63388. private _maxSteps;
  63389. private _tmpQuaternion;
  63390. private _tmpAmmoTransform;
  63391. private _tmpAmmoQuaternion;
  63392. private _tmpAmmoConcreteContactResultCallback;
  63393. private _collisionConfiguration;
  63394. private _dispatcher;
  63395. private _overlappingPairCache;
  63396. private _solver;
  63397. private _softBodySolver;
  63398. private _tmpAmmoVectorA;
  63399. private _tmpAmmoVectorB;
  63400. private _tmpAmmoVectorC;
  63401. private _tmpAmmoVectorD;
  63402. private _tmpContactCallbackResult;
  63403. private _tmpAmmoVectorRCA;
  63404. private _tmpAmmoVectorRCB;
  63405. private _raycastResult;
  63406. private static readonly DISABLE_COLLISION_FLAG;
  63407. private static readonly KINEMATIC_FLAG;
  63408. private static readonly DISABLE_DEACTIVATION_FLAG;
  63409. /**
  63410. * Initializes the ammoJS plugin
  63411. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63412. * @param ammoInjection can be used to inject your own ammo reference
  63413. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63414. */
  63415. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63416. /**
  63417. * Sets the gravity of the physics world (m/(s^2))
  63418. * @param gravity Gravity to set
  63419. */
  63420. setGravity(gravity: Vector3): void;
  63421. /**
  63422. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63423. * @param timeStep timestep to use in seconds
  63424. */
  63425. setTimeStep(timeStep: number): void;
  63426. /**
  63427. * 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)
  63428. * @param fixedTimeStep fixedTimeStep to use in seconds
  63429. */
  63430. setFixedTimeStep(fixedTimeStep: number): void;
  63431. /**
  63432. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63433. * @param maxSteps the maximum number of steps by the physics engine per frame
  63434. */
  63435. setMaxSteps(maxSteps: number): void;
  63436. /**
  63437. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63438. * @returns the current timestep in seconds
  63439. */
  63440. getTimeStep(): number;
  63441. /**
  63442. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63443. */
  63444. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63445. private _isImpostorInContact;
  63446. private _isImpostorPairInContact;
  63447. private _stepSimulation;
  63448. /**
  63449. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63450. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63451. * After the step the babylon meshes are set to the position of the physics imposters
  63452. * @param delta amount of time to step forward
  63453. * @param impostors array of imposters to update before/after the step
  63454. */
  63455. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63456. /**
  63457. * Update babylon mesh to match physics world object
  63458. * @param impostor imposter to match
  63459. */
  63460. private _afterSoftStep;
  63461. /**
  63462. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63463. * @param impostor imposter to match
  63464. */
  63465. private _ropeStep;
  63466. /**
  63467. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63468. * @param impostor imposter to match
  63469. */
  63470. private _softbodyOrClothStep;
  63471. private _tmpMatrix;
  63472. /**
  63473. * Applies an impulse on the imposter
  63474. * @param impostor imposter to apply impulse to
  63475. * @param force amount of force to be applied to the imposter
  63476. * @param contactPoint the location to apply the impulse on the imposter
  63477. */
  63478. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63479. /**
  63480. * Applies a force on the imposter
  63481. * @param impostor imposter to apply force
  63482. * @param force amount of force to be applied to the imposter
  63483. * @param contactPoint the location to apply the force on the imposter
  63484. */
  63485. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63486. /**
  63487. * Creates a physics body using the plugin
  63488. * @param impostor the imposter to create the physics body on
  63489. */
  63490. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63491. /**
  63492. * Removes the physics body from the imposter and disposes of the body's memory
  63493. * @param impostor imposter to remove the physics body from
  63494. */
  63495. removePhysicsBody(impostor: PhysicsImpostor): void;
  63496. /**
  63497. * Generates a joint
  63498. * @param impostorJoint the imposter joint to create the joint with
  63499. */
  63500. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63501. /**
  63502. * Removes a joint
  63503. * @param impostorJoint the imposter joint to remove the joint from
  63504. */
  63505. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63506. private _addMeshVerts;
  63507. /**
  63508. * Initialise the soft body vertices to match its object's (mesh) vertices
  63509. * Softbody vertices (nodes) are in world space and to match this
  63510. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63511. * @param impostor to create the softbody for
  63512. */
  63513. private _softVertexData;
  63514. /**
  63515. * Create an impostor's soft body
  63516. * @param impostor to create the softbody for
  63517. */
  63518. private _createSoftbody;
  63519. /**
  63520. * Create cloth for an impostor
  63521. * @param impostor to create the softbody for
  63522. */
  63523. private _createCloth;
  63524. /**
  63525. * Create rope for an impostor
  63526. * @param impostor to create the softbody for
  63527. */
  63528. private _createRope;
  63529. /**
  63530. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63531. * @param impostor to create the custom physics shape for
  63532. */
  63533. private _createCustom;
  63534. private _addHullVerts;
  63535. private _createShape;
  63536. /**
  63537. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63538. * @param impostor imposter containing the physics body and babylon object
  63539. */
  63540. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63541. /**
  63542. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63543. * @param impostor imposter containing the physics body and babylon object
  63544. * @param newPosition new position
  63545. * @param newRotation new rotation
  63546. */
  63547. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63548. /**
  63549. * If this plugin is supported
  63550. * @returns true if its supported
  63551. */
  63552. isSupported(): boolean;
  63553. /**
  63554. * Sets the linear velocity of the physics body
  63555. * @param impostor imposter to set the velocity on
  63556. * @param velocity velocity to set
  63557. */
  63558. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63559. /**
  63560. * Sets the angular velocity of the physics body
  63561. * @param impostor imposter to set the velocity on
  63562. * @param velocity velocity to set
  63563. */
  63564. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63565. /**
  63566. * gets the linear velocity
  63567. * @param impostor imposter to get linear velocity from
  63568. * @returns linear velocity
  63569. */
  63570. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63571. /**
  63572. * gets the angular velocity
  63573. * @param impostor imposter to get angular velocity from
  63574. * @returns angular velocity
  63575. */
  63576. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63577. /**
  63578. * Sets the mass of physics body
  63579. * @param impostor imposter to set the mass on
  63580. * @param mass mass to set
  63581. */
  63582. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63583. /**
  63584. * Gets the mass of the physics body
  63585. * @param impostor imposter to get the mass from
  63586. * @returns mass
  63587. */
  63588. getBodyMass(impostor: PhysicsImpostor): number;
  63589. /**
  63590. * Gets friction of the impostor
  63591. * @param impostor impostor to get friction from
  63592. * @returns friction value
  63593. */
  63594. getBodyFriction(impostor: PhysicsImpostor): number;
  63595. /**
  63596. * Sets friction of the impostor
  63597. * @param impostor impostor to set friction on
  63598. * @param friction friction value
  63599. */
  63600. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63601. /**
  63602. * Gets restitution of the impostor
  63603. * @param impostor impostor to get restitution from
  63604. * @returns restitution value
  63605. */
  63606. getBodyRestitution(impostor: PhysicsImpostor): number;
  63607. /**
  63608. * Sets resitution of the impostor
  63609. * @param impostor impostor to set resitution on
  63610. * @param restitution resitution value
  63611. */
  63612. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63613. /**
  63614. * Gets pressure inside the impostor
  63615. * @param impostor impostor to get pressure from
  63616. * @returns pressure value
  63617. */
  63618. getBodyPressure(impostor: PhysicsImpostor): number;
  63619. /**
  63620. * Sets pressure inside a soft body impostor
  63621. * Cloth and rope must remain 0 pressure
  63622. * @param impostor impostor to set pressure on
  63623. * @param pressure pressure value
  63624. */
  63625. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63626. /**
  63627. * Gets stiffness of the impostor
  63628. * @param impostor impostor to get stiffness from
  63629. * @returns pressure value
  63630. */
  63631. getBodyStiffness(impostor: PhysicsImpostor): number;
  63632. /**
  63633. * Sets stiffness of the impostor
  63634. * @param impostor impostor to set stiffness on
  63635. * @param stiffness stiffness value from 0 to 1
  63636. */
  63637. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63638. /**
  63639. * Gets velocityIterations of the impostor
  63640. * @param impostor impostor to get velocity iterations from
  63641. * @returns velocityIterations value
  63642. */
  63643. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63644. /**
  63645. * Sets velocityIterations of the impostor
  63646. * @param impostor impostor to set velocity iterations on
  63647. * @param velocityIterations velocityIterations value
  63648. */
  63649. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63650. /**
  63651. * Gets positionIterations of the impostor
  63652. * @param impostor impostor to get position iterations from
  63653. * @returns positionIterations value
  63654. */
  63655. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63656. /**
  63657. * Sets positionIterations of the impostor
  63658. * @param impostor impostor to set position on
  63659. * @param positionIterations positionIterations value
  63660. */
  63661. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63662. /**
  63663. * Append an anchor to a cloth object
  63664. * @param impostor is the cloth impostor to add anchor to
  63665. * @param otherImpostor is the rigid impostor to anchor to
  63666. * @param width ratio across width from 0 to 1
  63667. * @param height ratio up height from 0 to 1
  63668. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63669. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63670. */
  63671. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63672. /**
  63673. * Append an hook to a rope object
  63674. * @param impostor is the rope impostor to add hook to
  63675. * @param otherImpostor is the rigid impostor to hook to
  63676. * @param length ratio along the rope from 0 to 1
  63677. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63678. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63679. */
  63680. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63681. /**
  63682. * Sleeps the physics body and stops it from being active
  63683. * @param impostor impostor to sleep
  63684. */
  63685. sleepBody(impostor: PhysicsImpostor): void;
  63686. /**
  63687. * Activates the physics body
  63688. * @param impostor impostor to activate
  63689. */
  63690. wakeUpBody(impostor: PhysicsImpostor): void;
  63691. /**
  63692. * Updates the distance parameters of the joint
  63693. * @param joint joint to update
  63694. * @param maxDistance maximum distance of the joint
  63695. * @param minDistance minimum distance of the joint
  63696. */
  63697. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63698. /**
  63699. * Sets a motor on the joint
  63700. * @param joint joint to set motor on
  63701. * @param speed speed of the motor
  63702. * @param maxForce maximum force of the motor
  63703. * @param motorIndex index of the motor
  63704. */
  63705. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63706. /**
  63707. * Sets the motors limit
  63708. * @param joint joint to set limit on
  63709. * @param upperLimit upper limit
  63710. * @param lowerLimit lower limit
  63711. */
  63712. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63713. /**
  63714. * Syncs the position and rotation of a mesh with the impostor
  63715. * @param mesh mesh to sync
  63716. * @param impostor impostor to update the mesh with
  63717. */
  63718. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63719. /**
  63720. * Gets the radius of the impostor
  63721. * @param impostor impostor to get radius from
  63722. * @returns the radius
  63723. */
  63724. getRadius(impostor: PhysicsImpostor): number;
  63725. /**
  63726. * Gets the box size of the impostor
  63727. * @param impostor impostor to get box size from
  63728. * @param result the resulting box size
  63729. */
  63730. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63731. /**
  63732. * Disposes of the impostor
  63733. */
  63734. dispose(): void;
  63735. /**
  63736. * Does a raycast in the physics world
  63737. * @param from when should the ray start?
  63738. * @param to when should the ray end?
  63739. * @returns PhysicsRaycastResult
  63740. */
  63741. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63742. }
  63743. }
  63744. declare module "babylonjs/Probes/reflectionProbe" {
  63745. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63746. import { Vector3 } from "babylonjs/Maths/math.vector";
  63747. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63748. import { Nullable } from "babylonjs/types";
  63749. import { Scene } from "babylonjs/scene";
  63750. module "babylonjs/abstractScene" {
  63751. interface AbstractScene {
  63752. /**
  63753. * The list of reflection probes added to the scene
  63754. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63755. */
  63756. reflectionProbes: Array<ReflectionProbe>;
  63757. /**
  63758. * Removes the given reflection probe from this scene.
  63759. * @param toRemove The reflection probe to remove
  63760. * @returns The index of the removed reflection probe
  63761. */
  63762. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63763. /**
  63764. * Adds the given reflection probe to this scene.
  63765. * @param newReflectionProbe The reflection probe to add
  63766. */
  63767. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63768. }
  63769. }
  63770. /**
  63771. * Class used to generate realtime reflection / refraction cube textures
  63772. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63773. */
  63774. export class ReflectionProbe {
  63775. /** defines the name of the probe */
  63776. name: string;
  63777. private _scene;
  63778. private _renderTargetTexture;
  63779. private _projectionMatrix;
  63780. private _viewMatrix;
  63781. private _target;
  63782. private _add;
  63783. private _attachedMesh;
  63784. private _invertYAxis;
  63785. /** Gets or sets probe position (center of the cube map) */
  63786. position: Vector3;
  63787. /**
  63788. * Creates a new reflection probe
  63789. * @param name defines the name of the probe
  63790. * @param size defines the texture resolution (for each face)
  63791. * @param scene defines the hosting scene
  63792. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63793. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63794. */
  63795. constructor(
  63796. /** defines the name of the probe */
  63797. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63798. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63799. get samples(): number;
  63800. set samples(value: number);
  63801. /** Gets or sets the refresh rate to use (on every frame by default) */
  63802. get refreshRate(): number;
  63803. set refreshRate(value: number);
  63804. /**
  63805. * Gets the hosting scene
  63806. * @returns a Scene
  63807. */
  63808. getScene(): Scene;
  63809. /** Gets the internal CubeTexture used to render to */
  63810. get cubeTexture(): RenderTargetTexture;
  63811. /** Gets the list of meshes to render */
  63812. get renderList(): Nullable<AbstractMesh[]>;
  63813. /**
  63814. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63815. * @param mesh defines the mesh to attach to
  63816. */
  63817. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63818. /**
  63819. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63820. * @param renderingGroupId The rendering group id corresponding to its index
  63821. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63822. */
  63823. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63824. /**
  63825. * Clean all associated resources
  63826. */
  63827. dispose(): void;
  63828. /**
  63829. * Converts the reflection probe information to a readable string for debug purpose.
  63830. * @param fullDetails Supports for multiple levels of logging within scene loading
  63831. * @returns the human readable reflection probe info
  63832. */
  63833. toString(fullDetails?: boolean): string;
  63834. /**
  63835. * Get the class name of the relfection probe.
  63836. * @returns "ReflectionProbe"
  63837. */
  63838. getClassName(): string;
  63839. /**
  63840. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63841. * @returns The JSON representation of the texture
  63842. */
  63843. serialize(): any;
  63844. /**
  63845. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63846. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63847. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63848. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63849. * @returns The parsed reflection probe if successful
  63850. */
  63851. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63852. }
  63853. }
  63854. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63855. /** @hidden */
  63856. export var _BabylonLoaderRegistered: boolean;
  63857. /**
  63858. * Helps setting up some configuration for the babylon file loader.
  63859. */
  63860. export class BabylonFileLoaderConfiguration {
  63861. /**
  63862. * The loader does not allow injecting custom physix engine into the plugins.
  63863. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63864. * So you could set this variable to your engine import to make it work.
  63865. */
  63866. static LoaderInjectedPhysicsEngine: any;
  63867. }
  63868. }
  63869. declare module "babylonjs/Loading/Plugins/index" {
  63870. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63871. }
  63872. declare module "babylonjs/Loading/index" {
  63873. export * from "babylonjs/Loading/loadingScreen";
  63874. export * from "babylonjs/Loading/Plugins/index";
  63875. export * from "babylonjs/Loading/sceneLoader";
  63876. export * from "babylonjs/Loading/sceneLoaderFlags";
  63877. }
  63878. declare module "babylonjs/Materials/Background/index" {
  63879. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63880. }
  63881. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63882. import { Scene } from "babylonjs/scene";
  63883. import { Color3 } from "babylonjs/Maths/math.color";
  63884. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63885. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63886. /**
  63887. * The Physically based simple base material of BJS.
  63888. *
  63889. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63890. * It is used as the base class for both the specGloss and metalRough conventions.
  63891. */
  63892. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63893. /**
  63894. * Number of Simultaneous lights allowed on the material.
  63895. */
  63896. maxSimultaneousLights: number;
  63897. /**
  63898. * If sets to true, disables all the lights affecting the material.
  63899. */
  63900. disableLighting: boolean;
  63901. /**
  63902. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63903. */
  63904. environmentTexture: BaseTexture;
  63905. /**
  63906. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63907. */
  63908. invertNormalMapX: boolean;
  63909. /**
  63910. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63911. */
  63912. invertNormalMapY: boolean;
  63913. /**
  63914. * Normal map used in the model.
  63915. */
  63916. normalTexture: BaseTexture;
  63917. /**
  63918. * Emissivie color used to self-illuminate the model.
  63919. */
  63920. emissiveColor: Color3;
  63921. /**
  63922. * Emissivie texture used to self-illuminate the model.
  63923. */
  63924. emissiveTexture: BaseTexture;
  63925. /**
  63926. * Occlusion Channel Strenght.
  63927. */
  63928. occlusionStrength: number;
  63929. /**
  63930. * Occlusion Texture of the material (adding extra occlusion effects).
  63931. */
  63932. occlusionTexture: BaseTexture;
  63933. /**
  63934. * Defines the alpha limits in alpha test mode.
  63935. */
  63936. alphaCutOff: number;
  63937. /**
  63938. * Gets the current double sided mode.
  63939. */
  63940. get doubleSided(): boolean;
  63941. /**
  63942. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  63943. */
  63944. set doubleSided(value: boolean);
  63945. /**
  63946. * Stores the pre-calculated light information of a mesh in a texture.
  63947. */
  63948. lightmapTexture: BaseTexture;
  63949. /**
  63950. * If true, the light map contains occlusion information instead of lighting info.
  63951. */
  63952. useLightmapAsShadowmap: boolean;
  63953. /**
  63954. * Instantiates a new PBRMaterial instance.
  63955. *
  63956. * @param name The material name
  63957. * @param scene The scene the material will be use in.
  63958. */
  63959. constructor(name: string, scene: Scene);
  63960. getClassName(): string;
  63961. }
  63962. }
  63963. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  63964. import { Scene } from "babylonjs/scene";
  63965. import { Color3 } from "babylonjs/Maths/math.color";
  63966. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63967. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63968. /**
  63969. * The PBR material of BJS following the metal roughness convention.
  63970. *
  63971. * This fits to the PBR convention in the GLTF definition:
  63972. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  63973. */
  63974. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  63975. /**
  63976. * The base color has two different interpretations depending on the value of metalness.
  63977. * When the material is a metal, the base color is the specific measured reflectance value
  63978. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  63979. * of the material.
  63980. */
  63981. baseColor: Color3;
  63982. /**
  63983. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  63984. * well as opacity information in the alpha channel.
  63985. */
  63986. baseTexture: BaseTexture;
  63987. /**
  63988. * Specifies the metallic scalar value of the material.
  63989. * Can also be used to scale the metalness values of the metallic texture.
  63990. */
  63991. metallic: number;
  63992. /**
  63993. * Specifies the roughness scalar value of the material.
  63994. * Can also be used to scale the roughness values of the metallic texture.
  63995. */
  63996. roughness: number;
  63997. /**
  63998. * Texture containing both the metallic value in the B channel and the
  63999. * roughness value in the G channel to keep better precision.
  64000. */
  64001. metallicRoughnessTexture: BaseTexture;
  64002. /**
  64003. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64004. *
  64005. * @param name The material name
  64006. * @param scene The scene the material will be use in.
  64007. */
  64008. constructor(name: string, scene: Scene);
  64009. /**
  64010. * Return the currrent class name of the material.
  64011. */
  64012. getClassName(): string;
  64013. /**
  64014. * Makes a duplicate of the current material.
  64015. * @param name - name to use for the new material.
  64016. */
  64017. clone(name: string): PBRMetallicRoughnessMaterial;
  64018. /**
  64019. * Serialize the material to a parsable JSON object.
  64020. */
  64021. serialize(): any;
  64022. /**
  64023. * Parses a JSON object correponding to the serialize function.
  64024. */
  64025. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64026. }
  64027. }
  64028. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64029. import { Scene } from "babylonjs/scene";
  64030. import { Color3 } from "babylonjs/Maths/math.color";
  64031. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64032. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64033. /**
  64034. * The PBR material of BJS following the specular glossiness convention.
  64035. *
  64036. * This fits to the PBR convention in the GLTF definition:
  64037. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64038. */
  64039. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64040. /**
  64041. * Specifies the diffuse color of the material.
  64042. */
  64043. diffuseColor: Color3;
  64044. /**
  64045. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64046. * channel.
  64047. */
  64048. diffuseTexture: BaseTexture;
  64049. /**
  64050. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64051. */
  64052. specularColor: Color3;
  64053. /**
  64054. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64055. */
  64056. glossiness: number;
  64057. /**
  64058. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64059. */
  64060. specularGlossinessTexture: BaseTexture;
  64061. /**
  64062. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64063. *
  64064. * @param name The material name
  64065. * @param scene The scene the material will be use in.
  64066. */
  64067. constructor(name: string, scene: Scene);
  64068. /**
  64069. * Return the currrent class name of the material.
  64070. */
  64071. getClassName(): string;
  64072. /**
  64073. * Makes a duplicate of the current material.
  64074. * @param name - name to use for the new material.
  64075. */
  64076. clone(name: string): PBRSpecularGlossinessMaterial;
  64077. /**
  64078. * Serialize the material to a parsable JSON object.
  64079. */
  64080. serialize(): any;
  64081. /**
  64082. * Parses a JSON object correponding to the serialize function.
  64083. */
  64084. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64085. }
  64086. }
  64087. declare module "babylonjs/Materials/PBR/index" {
  64088. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64089. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64090. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64091. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64092. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64093. }
  64094. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64095. import { Nullable } from "babylonjs/types";
  64096. import { Scene } from "babylonjs/scene";
  64097. import { Matrix } from "babylonjs/Maths/math.vector";
  64098. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64099. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64100. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64101. /**
  64102. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64103. * It can help converting any input color in a desired output one. This can then be used to create effects
  64104. * from sepia, black and white to sixties or futuristic rendering...
  64105. *
  64106. * The only supported format is currently 3dl.
  64107. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64108. */
  64109. export class ColorGradingTexture extends BaseTexture {
  64110. /**
  64111. * The texture URL.
  64112. */
  64113. url: string;
  64114. /**
  64115. * Empty line regex stored for GC.
  64116. */
  64117. private static _noneEmptyLineRegex;
  64118. private _textureMatrix;
  64119. private _onLoad;
  64120. /**
  64121. * Instantiates a ColorGradingTexture from the following parameters.
  64122. *
  64123. * @param url The location of the color gradind data (currently only supporting 3dl)
  64124. * @param sceneOrEngine The scene or engine the texture will be used in
  64125. * @param onLoad defines a callback triggered when the texture has been loaded
  64126. */
  64127. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64128. /**
  64129. * Fires the onload event from the constructor if requested.
  64130. */
  64131. private _triggerOnLoad;
  64132. /**
  64133. * Returns the texture matrix used in most of the material.
  64134. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64135. */
  64136. getTextureMatrix(): Matrix;
  64137. /**
  64138. * Occurs when the file being loaded is a .3dl LUT file.
  64139. */
  64140. private load3dlTexture;
  64141. /**
  64142. * Starts the loading process of the texture.
  64143. */
  64144. private loadTexture;
  64145. /**
  64146. * Clones the color gradind texture.
  64147. */
  64148. clone(): ColorGradingTexture;
  64149. /**
  64150. * Called during delayed load for textures.
  64151. */
  64152. delayLoad(): void;
  64153. /**
  64154. * Parses a color grading texture serialized by Babylon.
  64155. * @param parsedTexture The texture information being parsedTexture
  64156. * @param scene The scene to load the texture in
  64157. * @param rootUrl The root url of the data assets to load
  64158. * @return A color gradind texture
  64159. */
  64160. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64161. /**
  64162. * Serializes the LUT texture to json format.
  64163. */
  64164. serialize(): any;
  64165. }
  64166. }
  64167. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64168. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64169. import { Scene } from "babylonjs/scene";
  64170. import { Nullable } from "babylonjs/types";
  64171. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64172. /**
  64173. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64174. */
  64175. export class EquiRectangularCubeTexture extends BaseTexture {
  64176. /** The six faces of the cube. */
  64177. private static _FacesMapping;
  64178. private _noMipmap;
  64179. private _onLoad;
  64180. private _onError;
  64181. /** The size of the cubemap. */
  64182. private _size;
  64183. /** The buffer of the image. */
  64184. private _buffer;
  64185. /** The width of the input image. */
  64186. private _width;
  64187. /** The height of the input image. */
  64188. private _height;
  64189. /** The URL to the image. */
  64190. url: string;
  64191. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  64192. coordinatesMode: number;
  64193. /**
  64194. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64195. * @param url The location of the image
  64196. * @param scene The scene the texture will be used in
  64197. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64198. * @param noMipmap Forces to not generate the mipmap if true
  64199. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64200. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64201. * @param onLoad — defines a callback called when texture is loaded
  64202. * @param onError — defines a callback called if there is an error
  64203. */
  64204. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64205. /**
  64206. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64207. */
  64208. private loadImage;
  64209. /**
  64210. * Convert the image buffer into a cubemap and create a CubeTexture.
  64211. */
  64212. private loadTexture;
  64213. /**
  64214. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64215. * @param buffer The ArrayBuffer that should be converted.
  64216. * @returns The buffer as Float32Array.
  64217. */
  64218. private getFloat32ArrayFromArrayBuffer;
  64219. /**
  64220. * Get the current class name of the texture useful for serialization or dynamic coding.
  64221. * @returns "EquiRectangularCubeTexture"
  64222. */
  64223. getClassName(): string;
  64224. /**
  64225. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64226. * @returns A clone of the current EquiRectangularCubeTexture.
  64227. */
  64228. clone(): EquiRectangularCubeTexture;
  64229. }
  64230. }
  64231. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64232. import { Nullable } from "babylonjs/types";
  64233. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64234. import { Matrix } from "babylonjs/Maths/math.vector";
  64235. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64236. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64237. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64238. import { Scene } from "babylonjs/scene";
  64239. /**
  64240. * Defines the options related to the creation of an HtmlElementTexture
  64241. */
  64242. export interface IHtmlElementTextureOptions {
  64243. /**
  64244. * Defines wether mip maps should be created or not.
  64245. */
  64246. generateMipMaps?: boolean;
  64247. /**
  64248. * Defines the sampling mode of the texture.
  64249. */
  64250. samplingMode?: number;
  64251. /**
  64252. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64253. */
  64254. engine: Nullable<ThinEngine>;
  64255. /**
  64256. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64257. */
  64258. scene: Nullable<Scene>;
  64259. }
  64260. /**
  64261. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64262. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64263. * is automatically managed.
  64264. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64265. * in your application.
  64266. *
  64267. * As the update is not automatic, you need to call them manually.
  64268. */
  64269. export class HtmlElementTexture extends BaseTexture {
  64270. /**
  64271. * The texture URL.
  64272. */
  64273. element: HTMLVideoElement | HTMLCanvasElement;
  64274. private static readonly DefaultOptions;
  64275. private _textureMatrix;
  64276. private _isVideo;
  64277. private _generateMipMaps;
  64278. private _samplingMode;
  64279. /**
  64280. * Instantiates a HtmlElementTexture from the following parameters.
  64281. *
  64282. * @param name Defines the name of the texture
  64283. * @param element Defines the video or canvas the texture is filled with
  64284. * @param options Defines the other none mandatory texture creation options
  64285. */
  64286. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64287. private _createInternalTexture;
  64288. /**
  64289. * Returns the texture matrix used in most of the material.
  64290. */
  64291. getTextureMatrix(): Matrix;
  64292. /**
  64293. * Updates the content of the texture.
  64294. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64295. */
  64296. update(invertY?: Nullable<boolean>): void;
  64297. }
  64298. }
  64299. declare module "babylonjs/Misc/tga" {
  64300. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64301. /**
  64302. * Based on jsTGALoader - Javascript loader for TGA file
  64303. * By Vincent Thibault
  64304. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64305. */
  64306. export class TGATools {
  64307. private static _TYPE_INDEXED;
  64308. private static _TYPE_RGB;
  64309. private static _TYPE_GREY;
  64310. private static _TYPE_RLE_INDEXED;
  64311. private static _TYPE_RLE_RGB;
  64312. private static _TYPE_RLE_GREY;
  64313. private static _ORIGIN_MASK;
  64314. private static _ORIGIN_SHIFT;
  64315. private static _ORIGIN_BL;
  64316. private static _ORIGIN_BR;
  64317. private static _ORIGIN_UL;
  64318. private static _ORIGIN_UR;
  64319. /**
  64320. * Gets the header of a TGA file
  64321. * @param data defines the TGA data
  64322. * @returns the header
  64323. */
  64324. static GetTGAHeader(data: Uint8Array): any;
  64325. /**
  64326. * Uploads TGA content to a Babylon Texture
  64327. * @hidden
  64328. */
  64329. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64330. /** @hidden */
  64331. 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;
  64332. /** @hidden */
  64333. 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;
  64334. /** @hidden */
  64335. 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;
  64336. /** @hidden */
  64337. 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;
  64338. /** @hidden */
  64339. 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;
  64340. /** @hidden */
  64341. 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;
  64342. }
  64343. }
  64344. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64345. import { Nullable } from "babylonjs/types";
  64346. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64347. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64348. /**
  64349. * Implementation of the TGA Texture Loader.
  64350. * @hidden
  64351. */
  64352. export class _TGATextureLoader implements IInternalTextureLoader {
  64353. /**
  64354. * Defines wether the loader supports cascade loading the different faces.
  64355. */
  64356. readonly supportCascades: boolean;
  64357. /**
  64358. * This returns if the loader support the current file information.
  64359. * @param extension defines the file extension of the file being loaded
  64360. * @returns true if the loader can load the specified file
  64361. */
  64362. canLoad(extension: string): boolean;
  64363. /**
  64364. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64365. * @param data contains the texture data
  64366. * @param texture defines the BabylonJS internal texture
  64367. * @param createPolynomials will be true if polynomials have been requested
  64368. * @param onLoad defines the callback to trigger once the texture is ready
  64369. * @param onError defines the callback to trigger in case of error
  64370. */
  64371. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64372. /**
  64373. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64374. * @param data contains the texture data
  64375. * @param texture defines the BabylonJS internal texture
  64376. * @param callback defines the method to call once ready to upload
  64377. */
  64378. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64379. }
  64380. }
  64381. declare module "babylonjs/Misc/basis" {
  64382. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64383. /**
  64384. * Info about the .basis files
  64385. */
  64386. class BasisFileInfo {
  64387. /**
  64388. * If the file has alpha
  64389. */
  64390. hasAlpha: boolean;
  64391. /**
  64392. * Info about each image of the basis file
  64393. */
  64394. images: Array<{
  64395. levels: Array<{
  64396. width: number;
  64397. height: number;
  64398. transcodedPixels: ArrayBufferView;
  64399. }>;
  64400. }>;
  64401. }
  64402. /**
  64403. * Result of transcoding a basis file
  64404. */
  64405. class TranscodeResult {
  64406. /**
  64407. * Info about the .basis file
  64408. */
  64409. fileInfo: BasisFileInfo;
  64410. /**
  64411. * Format to use when loading the file
  64412. */
  64413. format: number;
  64414. }
  64415. /**
  64416. * Configuration options for the Basis transcoder
  64417. */
  64418. export class BasisTranscodeConfiguration {
  64419. /**
  64420. * Supported compression formats used to determine the supported output format of the transcoder
  64421. */
  64422. supportedCompressionFormats?: {
  64423. /**
  64424. * etc1 compression format
  64425. */
  64426. etc1?: boolean;
  64427. /**
  64428. * s3tc compression format
  64429. */
  64430. s3tc?: boolean;
  64431. /**
  64432. * pvrtc compression format
  64433. */
  64434. pvrtc?: boolean;
  64435. /**
  64436. * etc2 compression format
  64437. */
  64438. etc2?: boolean;
  64439. };
  64440. /**
  64441. * If mipmap levels should be loaded for transcoded images (Default: true)
  64442. */
  64443. loadMipmapLevels?: boolean;
  64444. /**
  64445. * Index of a single image to load (Default: all images)
  64446. */
  64447. loadSingleImage?: number;
  64448. }
  64449. /**
  64450. * Used to load .Basis files
  64451. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64452. */
  64453. export class BasisTools {
  64454. private static _IgnoreSupportedFormats;
  64455. /**
  64456. * URL to use when loading the basis transcoder
  64457. */
  64458. static JSModuleURL: string;
  64459. /**
  64460. * URL to use when loading the wasm module for the transcoder
  64461. */
  64462. static WasmModuleURL: string;
  64463. /**
  64464. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64465. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64466. * @returns internal format corresponding to the Basis format
  64467. */
  64468. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64469. private static _WorkerPromise;
  64470. private static _Worker;
  64471. private static _actionId;
  64472. private static _CreateWorkerAsync;
  64473. /**
  64474. * Transcodes a loaded image file to compressed pixel data
  64475. * @param data image data to transcode
  64476. * @param config configuration options for the transcoding
  64477. * @returns a promise resulting in the transcoded image
  64478. */
  64479. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64480. /**
  64481. * Loads a texture from the transcode result
  64482. * @param texture texture load to
  64483. * @param transcodeResult the result of transcoding the basis file to load from
  64484. */
  64485. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64486. }
  64487. }
  64488. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64489. import { Nullable } from "babylonjs/types";
  64490. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64491. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64492. /**
  64493. * Loader for .basis file format
  64494. */
  64495. export class _BasisTextureLoader implements IInternalTextureLoader {
  64496. /**
  64497. * Defines whether the loader supports cascade loading the different faces.
  64498. */
  64499. readonly supportCascades: boolean;
  64500. /**
  64501. * This returns if the loader support the current file information.
  64502. * @param extension defines the file extension of the file being loaded
  64503. * @returns true if the loader can load the specified file
  64504. */
  64505. canLoad(extension: string): boolean;
  64506. /**
  64507. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64508. * @param data contains the texture data
  64509. * @param texture defines the BabylonJS internal texture
  64510. * @param createPolynomials will be true if polynomials have been requested
  64511. * @param onLoad defines the callback to trigger once the texture is ready
  64512. * @param onError defines the callback to trigger in case of error
  64513. */
  64514. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64515. /**
  64516. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64517. * @param data contains the texture data
  64518. * @param texture defines the BabylonJS internal texture
  64519. * @param callback defines the method to call once ready to upload
  64520. */
  64521. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64522. }
  64523. }
  64524. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64525. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64526. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64527. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64528. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64529. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64530. }
  64531. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64532. import { Vector2 } from "babylonjs/Maths/math.vector";
  64533. /**
  64534. * Defines the basic options interface of a TexturePacker Frame
  64535. */
  64536. export interface ITexturePackerFrame {
  64537. /**
  64538. * The frame ID
  64539. */
  64540. id: number;
  64541. /**
  64542. * The frames Scale
  64543. */
  64544. scale: Vector2;
  64545. /**
  64546. * The Frames offset
  64547. */
  64548. offset: Vector2;
  64549. }
  64550. /**
  64551. * This is a support class for frame Data on texture packer sets.
  64552. */
  64553. export class TexturePackerFrame implements ITexturePackerFrame {
  64554. /**
  64555. * The frame ID
  64556. */
  64557. id: number;
  64558. /**
  64559. * The frames Scale
  64560. */
  64561. scale: Vector2;
  64562. /**
  64563. * The Frames offset
  64564. */
  64565. offset: Vector2;
  64566. /**
  64567. * Initializes a texture package frame.
  64568. * @param id The numerical frame identifier
  64569. * @param scale Scalar Vector2 for UV frame
  64570. * @param offset Vector2 for the frame position in UV units.
  64571. * @returns TexturePackerFrame
  64572. */
  64573. constructor(id: number, scale: Vector2, offset: Vector2);
  64574. }
  64575. }
  64576. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64577. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64578. import { Scene } from "babylonjs/scene";
  64579. import { Nullable } from "babylonjs/types";
  64580. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64581. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64582. /**
  64583. * Defines the basic options interface of a TexturePacker
  64584. */
  64585. export interface ITexturePackerOptions {
  64586. /**
  64587. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64588. */
  64589. map?: string[];
  64590. /**
  64591. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64592. */
  64593. uvsIn?: string;
  64594. /**
  64595. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64596. */
  64597. uvsOut?: string;
  64598. /**
  64599. * number representing the layout style. Defaults to LAYOUT_STRIP
  64600. */
  64601. layout?: number;
  64602. /**
  64603. * number of columns if using custom column count layout(2). This defaults to 4.
  64604. */
  64605. colnum?: number;
  64606. /**
  64607. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64608. */
  64609. updateInputMeshes?: boolean;
  64610. /**
  64611. * boolean flag to dispose all the source textures. Defaults to true.
  64612. */
  64613. disposeSources?: boolean;
  64614. /**
  64615. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64616. */
  64617. fillBlanks?: boolean;
  64618. /**
  64619. * string value representing the context fill style color. Defaults to 'black'.
  64620. */
  64621. customFillColor?: string;
  64622. /**
  64623. * Width and Height Value of each Frame in the TexturePacker Sets
  64624. */
  64625. frameSize?: number;
  64626. /**
  64627. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64628. */
  64629. paddingRatio?: number;
  64630. /**
  64631. * Number that declares the fill method for the padding gutter.
  64632. */
  64633. paddingMode?: number;
  64634. /**
  64635. * If in SUBUV_COLOR padding mode what color to use.
  64636. */
  64637. paddingColor?: Color3 | Color4;
  64638. }
  64639. /**
  64640. * Defines the basic interface of a TexturePacker JSON File
  64641. */
  64642. export interface ITexturePackerJSON {
  64643. /**
  64644. * The frame ID
  64645. */
  64646. name: string;
  64647. /**
  64648. * The base64 channel data
  64649. */
  64650. sets: any;
  64651. /**
  64652. * The options of the Packer
  64653. */
  64654. options: ITexturePackerOptions;
  64655. /**
  64656. * The frame data of the Packer
  64657. */
  64658. frames: Array<number>;
  64659. }
  64660. /**
  64661. * This is a support class that generates a series of packed texture sets.
  64662. * @see https://doc.babylonjs.com/babylon101/materials
  64663. */
  64664. export class TexturePacker {
  64665. /** Packer Layout Constant 0 */
  64666. static readonly LAYOUT_STRIP: number;
  64667. /** Packer Layout Constant 1 */
  64668. static readonly LAYOUT_POWER2: number;
  64669. /** Packer Layout Constant 2 */
  64670. static readonly LAYOUT_COLNUM: number;
  64671. /** Packer Layout Constant 0 */
  64672. static readonly SUBUV_WRAP: number;
  64673. /** Packer Layout Constant 1 */
  64674. static readonly SUBUV_EXTEND: number;
  64675. /** Packer Layout Constant 2 */
  64676. static readonly SUBUV_COLOR: number;
  64677. /** The Name of the Texture Package */
  64678. name: string;
  64679. /** The scene scope of the TexturePacker */
  64680. scene: Scene;
  64681. /** The Meshes to target */
  64682. meshes: AbstractMesh[];
  64683. /** Arguments passed with the Constructor */
  64684. options: ITexturePackerOptions;
  64685. /** The promise that is started upon initialization */
  64686. promise: Nullable<Promise<TexturePacker | string>>;
  64687. /** The Container object for the channel sets that are generated */
  64688. sets: object;
  64689. /** The Container array for the frames that are generated */
  64690. frames: TexturePackerFrame[];
  64691. /** The expected number of textures the system is parsing. */
  64692. private _expecting;
  64693. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64694. private _paddingValue;
  64695. /**
  64696. * Initializes a texture package series from an array of meshes or a single mesh.
  64697. * @param name The name of the package
  64698. * @param meshes The target meshes to compose the package from
  64699. * @param options The arguments that texture packer should follow while building.
  64700. * @param scene The scene which the textures are scoped to.
  64701. * @returns TexturePacker
  64702. */
  64703. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64704. /**
  64705. * Starts the package process
  64706. * @param resolve The promises resolution function
  64707. * @returns TexturePacker
  64708. */
  64709. private _createFrames;
  64710. /**
  64711. * Calculates the Size of the Channel Sets
  64712. * @returns Vector2
  64713. */
  64714. private _calculateSize;
  64715. /**
  64716. * Calculates the UV data for the frames.
  64717. * @param baseSize the base frameSize
  64718. * @param padding the base frame padding
  64719. * @param dtSize size of the Dynamic Texture for that channel
  64720. * @param dtUnits is 1/dtSize
  64721. * @param update flag to update the input meshes
  64722. */
  64723. private _calculateMeshUVFrames;
  64724. /**
  64725. * Calculates the frames Offset.
  64726. * @param index of the frame
  64727. * @returns Vector2
  64728. */
  64729. private _getFrameOffset;
  64730. /**
  64731. * Updates a Mesh to the frame data
  64732. * @param mesh that is the target
  64733. * @param frameID or the frame index
  64734. */
  64735. private _updateMeshUV;
  64736. /**
  64737. * Updates a Meshes materials to use the texture packer channels
  64738. * @param m is the mesh to target
  64739. * @param force all channels on the packer to be set.
  64740. */
  64741. private _updateTextureReferences;
  64742. /**
  64743. * Public method to set a Mesh to a frame
  64744. * @param m that is the target
  64745. * @param frameID or the frame index
  64746. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64747. */
  64748. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64749. /**
  64750. * Starts the async promise to compile the texture packer.
  64751. * @returns Promise<void>
  64752. */
  64753. processAsync(): Promise<void>;
  64754. /**
  64755. * Disposes all textures associated with this packer
  64756. */
  64757. dispose(): void;
  64758. /**
  64759. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64760. * @param imageType is the image type to use.
  64761. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64762. */
  64763. download(imageType?: string, quality?: number): void;
  64764. /**
  64765. * Public method to load a texturePacker JSON file.
  64766. * @param data of the JSON file in string format.
  64767. */
  64768. updateFromJSON(data: string): void;
  64769. }
  64770. }
  64771. declare module "babylonjs/Materials/Textures/Packer/index" {
  64772. export * from "babylonjs/Materials/Textures/Packer/packer";
  64773. export * from "babylonjs/Materials/Textures/Packer/frame";
  64774. }
  64775. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64776. import { Scene } from "babylonjs/scene";
  64777. import { Texture } from "babylonjs/Materials/Textures/texture";
  64778. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64779. /**
  64780. * 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.
  64781. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64782. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64783. */
  64784. export class CustomProceduralTexture extends ProceduralTexture {
  64785. private _animate;
  64786. private _time;
  64787. private _config;
  64788. private _texturePath;
  64789. /**
  64790. * Instantiates a new Custom Procedural Texture.
  64791. * 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.
  64792. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64793. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64794. * @param name Define the name of the texture
  64795. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64796. * @param size Define the size of the texture to create
  64797. * @param scene Define the scene the texture belongs to
  64798. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64799. * @param generateMipMaps Define if the texture should creates mip maps or not
  64800. */
  64801. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64802. private _loadJson;
  64803. /**
  64804. * Is the texture ready to be used ? (rendered at least once)
  64805. * @returns true if ready, otherwise, false.
  64806. */
  64807. isReady(): boolean;
  64808. /**
  64809. * Render the texture to its associated render target.
  64810. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64811. */
  64812. render(useCameraPostProcess?: boolean): void;
  64813. /**
  64814. * Update the list of dependant textures samplers in the shader.
  64815. */
  64816. updateTextures(): void;
  64817. /**
  64818. * Update the uniform values of the procedural texture in the shader.
  64819. */
  64820. updateShaderUniforms(): void;
  64821. /**
  64822. * Define if the texture animates or not.
  64823. */
  64824. get animate(): boolean;
  64825. set animate(value: boolean);
  64826. }
  64827. }
  64828. declare module "babylonjs/Shaders/noise.fragment" {
  64829. /** @hidden */
  64830. export var noisePixelShader: {
  64831. name: string;
  64832. shader: string;
  64833. };
  64834. }
  64835. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64836. import { Nullable } from "babylonjs/types";
  64837. import { Scene } from "babylonjs/scene";
  64838. import { Texture } from "babylonjs/Materials/Textures/texture";
  64839. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64840. import "babylonjs/Shaders/noise.fragment";
  64841. /**
  64842. * Class used to generate noise procedural textures
  64843. */
  64844. export class NoiseProceduralTexture extends ProceduralTexture {
  64845. private _time;
  64846. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64847. brightness: number;
  64848. /** Defines the number of octaves to process */
  64849. octaves: number;
  64850. /** Defines the level of persistence (0.8 by default) */
  64851. persistence: number;
  64852. /** Gets or sets animation speed factor (default is 1) */
  64853. animationSpeedFactor: number;
  64854. /**
  64855. * Creates a new NoiseProceduralTexture
  64856. * @param name defines the name fo the texture
  64857. * @param size defines the size of the texture (default is 256)
  64858. * @param scene defines the hosting scene
  64859. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64860. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64861. */
  64862. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64863. private _updateShaderUniforms;
  64864. protected _getDefines(): string;
  64865. /** Generate the current state of the procedural texture */
  64866. render(useCameraPostProcess?: boolean): void;
  64867. /**
  64868. * Serializes this noise procedural texture
  64869. * @returns a serialized noise procedural texture object
  64870. */
  64871. serialize(): any;
  64872. /**
  64873. * Clone the texture.
  64874. * @returns the cloned texture
  64875. */
  64876. clone(): NoiseProceduralTexture;
  64877. /**
  64878. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64879. * @param parsedTexture defines parsed texture data
  64880. * @param scene defines the current scene
  64881. * @param rootUrl defines the root URL containing noise procedural texture information
  64882. * @returns a parsed NoiseProceduralTexture
  64883. */
  64884. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64885. }
  64886. }
  64887. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64888. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64889. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64890. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64891. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64892. }
  64893. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64894. import { Nullable } from "babylonjs/types";
  64895. import { Scene } from "babylonjs/scene";
  64896. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64897. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64898. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64899. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64900. /**
  64901. * Raw cube texture where the raw buffers are passed in
  64902. */
  64903. export class RawCubeTexture extends CubeTexture {
  64904. /**
  64905. * Creates a cube texture where the raw buffers are passed in.
  64906. * @param scene defines the scene the texture is attached to
  64907. * @param data defines the array of data to use to create each face
  64908. * @param size defines the size of the textures
  64909. * @param format defines the format of the data
  64910. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64911. * @param generateMipMaps defines if the engine should generate the mip levels
  64912. * @param invertY defines if data must be stored with Y axis inverted
  64913. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64914. * @param compression defines the compression used (null by default)
  64915. */
  64916. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64917. /**
  64918. * Updates the raw cube texture.
  64919. * @param data defines the data to store
  64920. * @param format defines the data format
  64921. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64922. * @param invertY defines if data must be stored with Y axis inverted
  64923. * @param compression defines the compression used (null by default)
  64924. * @param level defines which level of the texture to update
  64925. */
  64926. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64927. /**
  64928. * Updates a raw cube texture with RGBD encoded data.
  64929. * @param data defines the array of data [mipmap][face] to use to create each face
  64930. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64931. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64932. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64933. * @returns a promsie that resolves when the operation is complete
  64934. */
  64935. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64936. /**
  64937. * Clones the raw cube texture.
  64938. * @return a new cube texture
  64939. */
  64940. clone(): CubeTexture;
  64941. /** @hidden */
  64942. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  64943. }
  64944. }
  64945. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  64946. import { Scene } from "babylonjs/scene";
  64947. import { Texture } from "babylonjs/Materials/Textures/texture";
  64948. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64949. /**
  64950. * Class used to store 2D array textures containing user data
  64951. */
  64952. export class RawTexture2DArray extends Texture {
  64953. /** Gets or sets the texture format to use */
  64954. format: number;
  64955. /**
  64956. * Create a new RawTexture2DArray
  64957. * @param data defines the data of the texture
  64958. * @param width defines the width of the texture
  64959. * @param height defines the height of the texture
  64960. * @param depth defines the number of layers of the texture
  64961. * @param format defines the texture format to use
  64962. * @param scene defines the hosting scene
  64963. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  64964. * @param invertY defines if texture must be stored with Y axis inverted
  64965. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  64966. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  64967. */
  64968. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  64969. /** Gets or sets the texture format to use */
  64970. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  64971. /**
  64972. * Update the texture with new data
  64973. * @param data defines the data to store in the texture
  64974. */
  64975. update(data: ArrayBufferView): void;
  64976. }
  64977. }
  64978. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  64979. import { Scene } from "babylonjs/scene";
  64980. import { Texture } from "babylonjs/Materials/Textures/texture";
  64981. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64982. /**
  64983. * Class used to store 3D textures containing user data
  64984. */
  64985. export class RawTexture3D extends Texture {
  64986. /** Gets or sets the texture format to use */
  64987. format: number;
  64988. /**
  64989. * Create a new RawTexture3D
  64990. * @param data defines the data of the texture
  64991. * @param width defines the width of the texture
  64992. * @param height defines the height of the texture
  64993. * @param depth defines the depth of the texture
  64994. * @param format defines the texture format to use
  64995. * @param scene defines the hosting scene
  64996. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  64997. * @param invertY defines if texture must be stored with Y axis inverted
  64998. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  64999. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65000. */
  65001. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65002. /** Gets or sets the texture format to use */
  65003. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65004. /**
  65005. * Update the texture with new data
  65006. * @param data defines the data to store in the texture
  65007. */
  65008. update(data: ArrayBufferView): void;
  65009. }
  65010. }
  65011. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65012. import { Scene } from "babylonjs/scene";
  65013. import { Plane } from "babylonjs/Maths/math.plane";
  65014. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65015. /**
  65016. * Creates a refraction texture used by refraction channel of the standard material.
  65017. * It is like a mirror but to see through a material.
  65018. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65019. */
  65020. export class RefractionTexture extends RenderTargetTexture {
  65021. /**
  65022. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65023. * 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.
  65024. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65025. */
  65026. refractionPlane: Plane;
  65027. /**
  65028. * Define how deep under the surface we should see.
  65029. */
  65030. depth: number;
  65031. /**
  65032. * Creates a refraction texture used by refraction channel of the standard material.
  65033. * It is like a mirror but to see through a material.
  65034. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65035. * @param name Define the texture name
  65036. * @param size Define the size of the underlying texture
  65037. * @param scene Define the scene the refraction belongs to
  65038. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65039. */
  65040. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65041. /**
  65042. * Clone the refraction texture.
  65043. * @returns the cloned texture
  65044. */
  65045. clone(): RefractionTexture;
  65046. /**
  65047. * Serialize the texture to a JSON representation you could use in Parse later on
  65048. * @returns the serialized JSON representation
  65049. */
  65050. serialize(): any;
  65051. }
  65052. }
  65053. declare module "babylonjs/Materials/Textures/index" {
  65054. export * from "babylonjs/Materials/Textures/baseTexture";
  65055. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65056. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65057. export * from "babylonjs/Materials/Textures/cubeTexture";
  65058. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65059. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65060. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65061. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65062. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65063. export * from "babylonjs/Materials/Textures/internalTexture";
  65064. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65065. export * from "babylonjs/Materials/Textures/Loaders/index";
  65066. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65067. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65068. export * from "babylonjs/Materials/Textures/Packer/index";
  65069. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65070. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65071. export * from "babylonjs/Materials/Textures/rawTexture";
  65072. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65073. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65074. export * from "babylonjs/Materials/Textures/refractionTexture";
  65075. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65076. export * from "babylonjs/Materials/Textures/texture";
  65077. export * from "babylonjs/Materials/Textures/videoTexture";
  65078. }
  65079. declare module "babylonjs/Materials/Node/Enums/index" {
  65080. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65081. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65082. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65083. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65084. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65085. }
  65086. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65087. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65088. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65089. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65090. import { Mesh } from "babylonjs/Meshes/mesh";
  65091. import { Effect } from "babylonjs/Materials/effect";
  65092. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65093. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65094. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65095. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65096. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65097. /**
  65098. * Block used to add support for vertex skinning (bones)
  65099. */
  65100. export class BonesBlock extends NodeMaterialBlock {
  65101. /**
  65102. * Creates a new BonesBlock
  65103. * @param name defines the block name
  65104. */
  65105. constructor(name: string);
  65106. /**
  65107. * Initialize the block and prepare the context for build
  65108. * @param state defines the state that will be used for the build
  65109. */
  65110. initialize(state: NodeMaterialBuildState): void;
  65111. /**
  65112. * Gets the current class name
  65113. * @returns the class name
  65114. */
  65115. getClassName(): string;
  65116. /**
  65117. * Gets the matrix indices input component
  65118. */
  65119. get matricesIndices(): NodeMaterialConnectionPoint;
  65120. /**
  65121. * Gets the matrix weights input component
  65122. */
  65123. get matricesWeights(): NodeMaterialConnectionPoint;
  65124. /**
  65125. * Gets the extra matrix indices input component
  65126. */
  65127. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65128. /**
  65129. * Gets the extra matrix weights input component
  65130. */
  65131. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65132. /**
  65133. * Gets the world input component
  65134. */
  65135. get world(): NodeMaterialConnectionPoint;
  65136. /**
  65137. * Gets the output component
  65138. */
  65139. get output(): NodeMaterialConnectionPoint;
  65140. autoConfigure(material: NodeMaterial): void;
  65141. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65142. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65143. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65144. protected _buildBlock(state: NodeMaterialBuildState): this;
  65145. }
  65146. }
  65147. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65148. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65149. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65150. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65151. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65152. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65153. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65154. /**
  65155. * Block used to add support for instances
  65156. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65157. */
  65158. export class InstancesBlock extends NodeMaterialBlock {
  65159. /**
  65160. * Creates a new InstancesBlock
  65161. * @param name defines the block name
  65162. */
  65163. constructor(name: string);
  65164. /**
  65165. * Gets the current class name
  65166. * @returns the class name
  65167. */
  65168. getClassName(): string;
  65169. /**
  65170. * Gets the first world row input component
  65171. */
  65172. get world0(): NodeMaterialConnectionPoint;
  65173. /**
  65174. * Gets the second world row input component
  65175. */
  65176. get world1(): NodeMaterialConnectionPoint;
  65177. /**
  65178. * Gets the third world row input component
  65179. */
  65180. get world2(): NodeMaterialConnectionPoint;
  65181. /**
  65182. * Gets the forth world row input component
  65183. */
  65184. get world3(): NodeMaterialConnectionPoint;
  65185. /**
  65186. * Gets the world input component
  65187. */
  65188. get world(): NodeMaterialConnectionPoint;
  65189. /**
  65190. * Gets the output component
  65191. */
  65192. get output(): NodeMaterialConnectionPoint;
  65193. /**
  65194. * Gets the isntanceID component
  65195. */
  65196. get instanceID(): NodeMaterialConnectionPoint;
  65197. autoConfigure(material: NodeMaterial): void;
  65198. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65199. protected _buildBlock(state: NodeMaterialBuildState): this;
  65200. }
  65201. }
  65202. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65203. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65204. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65205. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65206. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65207. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65208. import { Effect } from "babylonjs/Materials/effect";
  65209. import { Mesh } from "babylonjs/Meshes/mesh";
  65210. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65211. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65212. /**
  65213. * Block used to add morph targets support to vertex shader
  65214. */
  65215. export class MorphTargetsBlock extends NodeMaterialBlock {
  65216. private _repeatableContentAnchor;
  65217. /**
  65218. * Create a new MorphTargetsBlock
  65219. * @param name defines the block name
  65220. */
  65221. constructor(name: string);
  65222. /**
  65223. * Gets the current class name
  65224. * @returns the class name
  65225. */
  65226. getClassName(): string;
  65227. /**
  65228. * Gets the position input component
  65229. */
  65230. get position(): NodeMaterialConnectionPoint;
  65231. /**
  65232. * Gets the normal input component
  65233. */
  65234. get normal(): NodeMaterialConnectionPoint;
  65235. /**
  65236. * Gets the tangent input component
  65237. */
  65238. get tangent(): NodeMaterialConnectionPoint;
  65239. /**
  65240. * Gets the tangent input component
  65241. */
  65242. get uv(): NodeMaterialConnectionPoint;
  65243. /**
  65244. * Gets the position output component
  65245. */
  65246. get positionOutput(): NodeMaterialConnectionPoint;
  65247. /**
  65248. * Gets the normal output component
  65249. */
  65250. get normalOutput(): NodeMaterialConnectionPoint;
  65251. /**
  65252. * Gets the tangent output component
  65253. */
  65254. get tangentOutput(): NodeMaterialConnectionPoint;
  65255. /**
  65256. * Gets the tangent output component
  65257. */
  65258. get uvOutput(): NodeMaterialConnectionPoint;
  65259. initialize(state: NodeMaterialBuildState): void;
  65260. autoConfigure(material: NodeMaterial): void;
  65261. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65262. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65263. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65264. protected _buildBlock(state: NodeMaterialBuildState): this;
  65265. }
  65266. }
  65267. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65268. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65269. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65270. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65271. import { Nullable } from "babylonjs/types";
  65272. import { Scene } from "babylonjs/scene";
  65273. import { Effect } from "babylonjs/Materials/effect";
  65274. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65275. import { Mesh } from "babylonjs/Meshes/mesh";
  65276. import { Light } from "babylonjs/Lights/light";
  65277. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65278. /**
  65279. * Block used to get data information from a light
  65280. */
  65281. export class LightInformationBlock extends NodeMaterialBlock {
  65282. private _lightDataUniformName;
  65283. private _lightColorUniformName;
  65284. private _lightTypeDefineName;
  65285. /**
  65286. * Gets or sets the light associated with this block
  65287. */
  65288. light: Nullable<Light>;
  65289. /**
  65290. * Creates a new LightInformationBlock
  65291. * @param name defines the block name
  65292. */
  65293. constructor(name: string);
  65294. /**
  65295. * Gets the current class name
  65296. * @returns the class name
  65297. */
  65298. getClassName(): string;
  65299. /**
  65300. * Gets the world position input component
  65301. */
  65302. get worldPosition(): NodeMaterialConnectionPoint;
  65303. /**
  65304. * Gets the direction output component
  65305. */
  65306. get direction(): NodeMaterialConnectionPoint;
  65307. /**
  65308. * Gets the direction output component
  65309. */
  65310. get color(): NodeMaterialConnectionPoint;
  65311. /**
  65312. * Gets the direction output component
  65313. */
  65314. get intensity(): NodeMaterialConnectionPoint;
  65315. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65316. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65317. protected _buildBlock(state: NodeMaterialBuildState): this;
  65318. serialize(): any;
  65319. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65320. }
  65321. }
  65322. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65323. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65324. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65325. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65326. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65327. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65328. }
  65329. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65330. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65331. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65332. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65333. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65334. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65335. import { Effect } from "babylonjs/Materials/effect";
  65336. import { Mesh } from "babylonjs/Meshes/mesh";
  65337. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65338. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65339. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65340. /**
  65341. * Block used to add image processing support to fragment shader
  65342. */
  65343. export class ImageProcessingBlock extends NodeMaterialBlock {
  65344. /**
  65345. * Create a new ImageProcessingBlock
  65346. * @param name defines the block name
  65347. */
  65348. constructor(name: string);
  65349. /**
  65350. * Gets the current class name
  65351. * @returns the class name
  65352. */
  65353. getClassName(): string;
  65354. /**
  65355. * Gets the color input component
  65356. */
  65357. get color(): NodeMaterialConnectionPoint;
  65358. /**
  65359. * Gets the output component
  65360. */
  65361. get output(): NodeMaterialConnectionPoint;
  65362. /**
  65363. * Initialize the block and prepare the context for build
  65364. * @param state defines the state that will be used for the build
  65365. */
  65366. initialize(state: NodeMaterialBuildState): void;
  65367. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65368. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65369. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65370. protected _buildBlock(state: NodeMaterialBuildState): this;
  65371. }
  65372. }
  65373. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65374. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65375. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65376. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65377. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65378. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65379. import { Effect } from "babylonjs/Materials/effect";
  65380. import { Mesh } from "babylonjs/Meshes/mesh";
  65381. import { Scene } from "babylonjs/scene";
  65382. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65383. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65384. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65385. /**
  65386. * Block used to pertub normals based on a normal map
  65387. */
  65388. export class PerturbNormalBlock extends NodeMaterialBlock {
  65389. private _tangentSpaceParameterName;
  65390. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65391. invertX: boolean;
  65392. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65393. invertY: boolean;
  65394. /**
  65395. * Create a new PerturbNormalBlock
  65396. * @param name defines the block name
  65397. */
  65398. constructor(name: string);
  65399. /**
  65400. * Gets the current class name
  65401. * @returns the class name
  65402. */
  65403. getClassName(): string;
  65404. /**
  65405. * Gets the world position input component
  65406. */
  65407. get worldPosition(): NodeMaterialConnectionPoint;
  65408. /**
  65409. * Gets the world normal input component
  65410. */
  65411. get worldNormal(): NodeMaterialConnectionPoint;
  65412. /**
  65413. * Gets the world tangent input component
  65414. */
  65415. get worldTangent(): NodeMaterialConnectionPoint;
  65416. /**
  65417. * Gets the uv input component
  65418. */
  65419. get uv(): NodeMaterialConnectionPoint;
  65420. /**
  65421. * Gets the normal map color input component
  65422. */
  65423. get normalMapColor(): NodeMaterialConnectionPoint;
  65424. /**
  65425. * Gets the strength input component
  65426. */
  65427. get strength(): NodeMaterialConnectionPoint;
  65428. /**
  65429. * Gets the output component
  65430. */
  65431. get output(): NodeMaterialConnectionPoint;
  65432. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65433. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65434. autoConfigure(material: NodeMaterial): void;
  65435. protected _buildBlock(state: NodeMaterialBuildState): this;
  65436. protected _dumpPropertiesCode(): string;
  65437. serialize(): any;
  65438. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65439. }
  65440. }
  65441. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65442. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65443. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65444. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65445. /**
  65446. * Block used to discard a pixel if a value is smaller than a cutoff
  65447. */
  65448. export class DiscardBlock extends NodeMaterialBlock {
  65449. /**
  65450. * Create a new DiscardBlock
  65451. * @param name defines the block name
  65452. */
  65453. constructor(name: string);
  65454. /**
  65455. * Gets the current class name
  65456. * @returns the class name
  65457. */
  65458. getClassName(): string;
  65459. /**
  65460. * Gets the color input component
  65461. */
  65462. get value(): NodeMaterialConnectionPoint;
  65463. /**
  65464. * Gets the cutoff input component
  65465. */
  65466. get cutoff(): NodeMaterialConnectionPoint;
  65467. protected _buildBlock(state: NodeMaterialBuildState): this;
  65468. }
  65469. }
  65470. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65471. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65472. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65473. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65474. /**
  65475. * Block used to test if the fragment shader is front facing
  65476. */
  65477. export class FrontFacingBlock extends NodeMaterialBlock {
  65478. /**
  65479. * Creates a new FrontFacingBlock
  65480. * @param name defines the block name
  65481. */
  65482. constructor(name: string);
  65483. /**
  65484. * Gets the current class name
  65485. * @returns the class name
  65486. */
  65487. getClassName(): string;
  65488. /**
  65489. * Gets the output component
  65490. */
  65491. get output(): NodeMaterialConnectionPoint;
  65492. protected _buildBlock(state: NodeMaterialBuildState): this;
  65493. }
  65494. }
  65495. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65496. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65497. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65498. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65499. /**
  65500. * Block used to get the derivative value on x and y of a given input
  65501. */
  65502. export class DerivativeBlock extends NodeMaterialBlock {
  65503. /**
  65504. * Create a new DerivativeBlock
  65505. * @param name defines the block name
  65506. */
  65507. constructor(name: string);
  65508. /**
  65509. * Gets the current class name
  65510. * @returns the class name
  65511. */
  65512. getClassName(): string;
  65513. /**
  65514. * Gets the input component
  65515. */
  65516. get input(): NodeMaterialConnectionPoint;
  65517. /**
  65518. * Gets the derivative output on x
  65519. */
  65520. get dx(): NodeMaterialConnectionPoint;
  65521. /**
  65522. * Gets the derivative output on y
  65523. */
  65524. get dy(): NodeMaterialConnectionPoint;
  65525. protected _buildBlock(state: NodeMaterialBuildState): this;
  65526. }
  65527. }
  65528. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  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. /**
  65533. * Block used to make gl_FragCoord available
  65534. */
  65535. export class FragCoordBlock extends NodeMaterialBlock {
  65536. /**
  65537. * Creates a new FragCoordBlock
  65538. * @param name defines the block name
  65539. */
  65540. constructor(name: string);
  65541. /**
  65542. * Gets the current class name
  65543. * @returns the class name
  65544. */
  65545. getClassName(): string;
  65546. /**
  65547. * Gets the xy component
  65548. */
  65549. get xy(): NodeMaterialConnectionPoint;
  65550. /**
  65551. * Gets the xyz component
  65552. */
  65553. get xyz(): NodeMaterialConnectionPoint;
  65554. /**
  65555. * Gets the xyzw component
  65556. */
  65557. get xyzw(): NodeMaterialConnectionPoint;
  65558. /**
  65559. * Gets the x component
  65560. */
  65561. get x(): NodeMaterialConnectionPoint;
  65562. /**
  65563. * Gets the y component
  65564. */
  65565. get y(): NodeMaterialConnectionPoint;
  65566. /**
  65567. * Gets the z component
  65568. */
  65569. get z(): NodeMaterialConnectionPoint;
  65570. /**
  65571. * Gets the w component
  65572. */
  65573. get output(): NodeMaterialConnectionPoint;
  65574. protected writeOutputs(state: NodeMaterialBuildState): string;
  65575. protected _buildBlock(state: NodeMaterialBuildState): this;
  65576. }
  65577. }
  65578. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65579. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65580. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65581. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65582. import { Effect } from "babylonjs/Materials/effect";
  65583. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65584. import { Mesh } from "babylonjs/Meshes/mesh";
  65585. /**
  65586. * Block used to get the screen sizes
  65587. */
  65588. export class ScreenSizeBlock extends NodeMaterialBlock {
  65589. private _varName;
  65590. private _scene;
  65591. /**
  65592. * Creates a new ScreenSizeBlock
  65593. * @param name defines the block name
  65594. */
  65595. constructor(name: string);
  65596. /**
  65597. * Gets the current class name
  65598. * @returns the class name
  65599. */
  65600. getClassName(): string;
  65601. /**
  65602. * Gets the xy component
  65603. */
  65604. get xy(): NodeMaterialConnectionPoint;
  65605. /**
  65606. * Gets the x component
  65607. */
  65608. get x(): NodeMaterialConnectionPoint;
  65609. /**
  65610. * Gets the y component
  65611. */
  65612. get y(): NodeMaterialConnectionPoint;
  65613. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65614. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65615. protected _buildBlock(state: NodeMaterialBuildState): this;
  65616. }
  65617. }
  65618. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65619. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65620. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65621. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65622. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65623. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65624. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65625. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65626. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65627. }
  65628. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65629. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65630. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65631. import { Mesh } from "babylonjs/Meshes/mesh";
  65632. import { Effect } from "babylonjs/Materials/effect";
  65633. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65634. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65635. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65636. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65637. /**
  65638. * Block used to add support for scene fog
  65639. */
  65640. export class FogBlock extends NodeMaterialBlock {
  65641. private _fogDistanceName;
  65642. private _fogParameters;
  65643. /**
  65644. * Create a new FogBlock
  65645. * @param name defines the block name
  65646. */
  65647. constructor(name: string);
  65648. /**
  65649. * Gets the current class name
  65650. * @returns the class name
  65651. */
  65652. getClassName(): string;
  65653. /**
  65654. * Gets the world position input component
  65655. */
  65656. get worldPosition(): NodeMaterialConnectionPoint;
  65657. /**
  65658. * Gets the view input component
  65659. */
  65660. get view(): NodeMaterialConnectionPoint;
  65661. /**
  65662. * Gets the color input component
  65663. */
  65664. get input(): NodeMaterialConnectionPoint;
  65665. /**
  65666. * Gets the fog color input component
  65667. */
  65668. get fogColor(): NodeMaterialConnectionPoint;
  65669. /**
  65670. * Gets the output component
  65671. */
  65672. get output(): NodeMaterialConnectionPoint;
  65673. autoConfigure(material: NodeMaterial): void;
  65674. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65675. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65676. protected _buildBlock(state: NodeMaterialBuildState): this;
  65677. }
  65678. }
  65679. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65680. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65681. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65682. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65683. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65684. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65685. import { Effect } from "babylonjs/Materials/effect";
  65686. import { Mesh } from "babylonjs/Meshes/mesh";
  65687. import { Light } from "babylonjs/Lights/light";
  65688. import { Nullable } from "babylonjs/types";
  65689. import { Scene } from "babylonjs/scene";
  65690. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65691. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65692. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65693. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65694. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65695. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65696. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65697. /**
  65698. * Block used to add light in the fragment shader
  65699. */
  65700. export class LightBlock extends NodeMaterialBlock {
  65701. private _lightId;
  65702. /**
  65703. * Gets or sets the light associated with this block
  65704. */
  65705. light: Nullable<Light>;
  65706. /**
  65707. * Create a new LightBlock
  65708. * @param name defines the block name
  65709. */
  65710. constructor(name: string);
  65711. /**
  65712. * Gets the current class name
  65713. * @returns the class name
  65714. */
  65715. getClassName(): string;
  65716. /**
  65717. * Gets the world position input component
  65718. */
  65719. get worldPosition(): NodeMaterialConnectionPoint;
  65720. /**
  65721. * Gets the world normal input component
  65722. */
  65723. get worldNormal(): NodeMaterialConnectionPoint;
  65724. /**
  65725. * Gets the camera (or eye) position component
  65726. */
  65727. get cameraPosition(): NodeMaterialConnectionPoint;
  65728. /**
  65729. * Gets the glossiness component
  65730. */
  65731. get glossiness(): NodeMaterialConnectionPoint;
  65732. /**
  65733. * Gets the glossinness power component
  65734. */
  65735. get glossPower(): NodeMaterialConnectionPoint;
  65736. /**
  65737. * Gets the diffuse color component
  65738. */
  65739. get diffuseColor(): NodeMaterialConnectionPoint;
  65740. /**
  65741. * Gets the specular color component
  65742. */
  65743. get specularColor(): NodeMaterialConnectionPoint;
  65744. /**
  65745. * Gets the diffuse output component
  65746. */
  65747. get diffuseOutput(): NodeMaterialConnectionPoint;
  65748. /**
  65749. * Gets the specular output component
  65750. */
  65751. get specularOutput(): NodeMaterialConnectionPoint;
  65752. /**
  65753. * Gets the shadow output component
  65754. */
  65755. get shadow(): NodeMaterialConnectionPoint;
  65756. autoConfigure(material: NodeMaterial): void;
  65757. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65758. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65759. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65760. private _injectVertexCode;
  65761. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65762. serialize(): any;
  65763. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65764. }
  65765. }
  65766. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65767. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65768. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65769. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65770. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65771. /**
  65772. * Block used to read a reflection texture from a sampler
  65773. */
  65774. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65775. /**
  65776. * Create a new ReflectionTextureBlock
  65777. * @param name defines the block name
  65778. */
  65779. constructor(name: string);
  65780. /**
  65781. * Gets the current class name
  65782. * @returns the class name
  65783. */
  65784. getClassName(): string;
  65785. /**
  65786. * Gets the world position input component
  65787. */
  65788. get position(): NodeMaterialConnectionPoint;
  65789. /**
  65790. * Gets the world position input component
  65791. */
  65792. get worldPosition(): NodeMaterialConnectionPoint;
  65793. /**
  65794. * Gets the world normal input component
  65795. */
  65796. get worldNormal(): NodeMaterialConnectionPoint;
  65797. /**
  65798. * Gets the world input component
  65799. */
  65800. get world(): NodeMaterialConnectionPoint;
  65801. /**
  65802. * Gets the camera (or eye) position component
  65803. */
  65804. get cameraPosition(): NodeMaterialConnectionPoint;
  65805. /**
  65806. * Gets the view input component
  65807. */
  65808. get view(): NodeMaterialConnectionPoint;
  65809. /**
  65810. * Gets the rgb output component
  65811. */
  65812. get rgb(): NodeMaterialConnectionPoint;
  65813. /**
  65814. * Gets the rgba output component
  65815. */
  65816. get rgba(): NodeMaterialConnectionPoint;
  65817. /**
  65818. * Gets the r output component
  65819. */
  65820. get r(): NodeMaterialConnectionPoint;
  65821. /**
  65822. * Gets the g output component
  65823. */
  65824. get g(): NodeMaterialConnectionPoint;
  65825. /**
  65826. * Gets the b output component
  65827. */
  65828. get b(): NodeMaterialConnectionPoint;
  65829. /**
  65830. * Gets the a output component
  65831. */
  65832. get a(): NodeMaterialConnectionPoint;
  65833. autoConfigure(material: NodeMaterial): void;
  65834. protected _buildBlock(state: NodeMaterialBuildState): this;
  65835. }
  65836. }
  65837. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65838. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65839. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65840. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65841. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65842. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65843. }
  65844. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65845. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65846. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65847. }
  65848. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65849. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65850. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65851. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65852. /**
  65853. * Block used to add 2 vectors
  65854. */
  65855. export class AddBlock extends NodeMaterialBlock {
  65856. /**
  65857. * Creates a new AddBlock
  65858. * @param name defines the block name
  65859. */
  65860. constructor(name: string);
  65861. /**
  65862. * Gets the current class name
  65863. * @returns the class name
  65864. */
  65865. getClassName(): string;
  65866. /**
  65867. * Gets the left operand input component
  65868. */
  65869. get left(): NodeMaterialConnectionPoint;
  65870. /**
  65871. * Gets the right operand input component
  65872. */
  65873. get right(): NodeMaterialConnectionPoint;
  65874. /**
  65875. * Gets the output component
  65876. */
  65877. get output(): NodeMaterialConnectionPoint;
  65878. protected _buildBlock(state: NodeMaterialBuildState): this;
  65879. }
  65880. }
  65881. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65882. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65883. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65884. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65885. /**
  65886. * Block used to scale a vector by a float
  65887. */
  65888. export class ScaleBlock extends NodeMaterialBlock {
  65889. /**
  65890. * Creates a new ScaleBlock
  65891. * @param name defines the block name
  65892. */
  65893. constructor(name: string);
  65894. /**
  65895. * Gets the current class name
  65896. * @returns the class name
  65897. */
  65898. getClassName(): string;
  65899. /**
  65900. * Gets the input component
  65901. */
  65902. get input(): NodeMaterialConnectionPoint;
  65903. /**
  65904. * Gets the factor input component
  65905. */
  65906. get factor(): NodeMaterialConnectionPoint;
  65907. /**
  65908. * Gets the output component
  65909. */
  65910. get output(): NodeMaterialConnectionPoint;
  65911. protected _buildBlock(state: NodeMaterialBuildState): this;
  65912. }
  65913. }
  65914. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65915. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65916. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65917. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65918. import { Scene } from "babylonjs/scene";
  65919. /**
  65920. * Block used to clamp a float
  65921. */
  65922. export class ClampBlock extends NodeMaterialBlock {
  65923. /** Gets or sets the minimum range */
  65924. minimum: number;
  65925. /** Gets or sets the maximum range */
  65926. maximum: number;
  65927. /**
  65928. * Creates a new ClampBlock
  65929. * @param name defines the block name
  65930. */
  65931. constructor(name: string);
  65932. /**
  65933. * Gets the current class name
  65934. * @returns the class name
  65935. */
  65936. getClassName(): string;
  65937. /**
  65938. * Gets the value input component
  65939. */
  65940. get value(): NodeMaterialConnectionPoint;
  65941. /**
  65942. * Gets the output component
  65943. */
  65944. get output(): NodeMaterialConnectionPoint;
  65945. protected _buildBlock(state: NodeMaterialBuildState): this;
  65946. protected _dumpPropertiesCode(): string;
  65947. serialize(): any;
  65948. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65949. }
  65950. }
  65951. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  65952. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65953. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65954. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65955. /**
  65956. * Block used to apply a cross product between 2 vectors
  65957. */
  65958. export class CrossBlock extends NodeMaterialBlock {
  65959. /**
  65960. * Creates a new CrossBlock
  65961. * @param name defines the block name
  65962. */
  65963. constructor(name: string);
  65964. /**
  65965. * Gets the current class name
  65966. * @returns the class name
  65967. */
  65968. getClassName(): string;
  65969. /**
  65970. * Gets the left operand input component
  65971. */
  65972. get left(): NodeMaterialConnectionPoint;
  65973. /**
  65974. * Gets the right operand input component
  65975. */
  65976. get right(): NodeMaterialConnectionPoint;
  65977. /**
  65978. * Gets the output component
  65979. */
  65980. get output(): NodeMaterialConnectionPoint;
  65981. protected _buildBlock(state: NodeMaterialBuildState): this;
  65982. }
  65983. }
  65984. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  65985. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65986. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65987. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65988. /**
  65989. * Block used to apply a dot product between 2 vectors
  65990. */
  65991. export class DotBlock extends NodeMaterialBlock {
  65992. /**
  65993. * Creates a new DotBlock
  65994. * @param name defines the block name
  65995. */
  65996. constructor(name: string);
  65997. /**
  65998. * Gets the current class name
  65999. * @returns the class name
  66000. */
  66001. getClassName(): string;
  66002. /**
  66003. * Gets the left operand input component
  66004. */
  66005. get left(): NodeMaterialConnectionPoint;
  66006. /**
  66007. * Gets the right operand input component
  66008. */
  66009. get right(): NodeMaterialConnectionPoint;
  66010. /**
  66011. * Gets the output component
  66012. */
  66013. get output(): NodeMaterialConnectionPoint;
  66014. protected _buildBlock(state: NodeMaterialBuildState): this;
  66015. }
  66016. }
  66017. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66018. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66019. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66020. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66021. /**
  66022. * Block used to normalize a vector
  66023. */
  66024. export class NormalizeBlock extends NodeMaterialBlock {
  66025. /**
  66026. * Creates a new NormalizeBlock
  66027. * @param name defines the block name
  66028. */
  66029. constructor(name: string);
  66030. /**
  66031. * Gets the current class name
  66032. * @returns the class name
  66033. */
  66034. getClassName(): string;
  66035. /**
  66036. * Gets the input component
  66037. */
  66038. get input(): NodeMaterialConnectionPoint;
  66039. /**
  66040. * Gets the output component
  66041. */
  66042. get output(): NodeMaterialConnectionPoint;
  66043. protected _buildBlock(state: NodeMaterialBuildState): this;
  66044. }
  66045. }
  66046. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66047. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66048. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66049. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66050. import { Scene } from "babylonjs/scene";
  66051. /**
  66052. * Operations supported by the Trigonometry block
  66053. */
  66054. export enum TrigonometryBlockOperations {
  66055. /** Cos */
  66056. Cos = 0,
  66057. /** Sin */
  66058. Sin = 1,
  66059. /** Abs */
  66060. Abs = 2,
  66061. /** Exp */
  66062. Exp = 3,
  66063. /** Exp2 */
  66064. Exp2 = 4,
  66065. /** Round */
  66066. Round = 5,
  66067. /** Floor */
  66068. Floor = 6,
  66069. /** Ceiling */
  66070. Ceiling = 7,
  66071. /** Square root */
  66072. Sqrt = 8,
  66073. /** Log */
  66074. Log = 9,
  66075. /** Tangent */
  66076. Tan = 10,
  66077. /** Arc tangent */
  66078. ArcTan = 11,
  66079. /** Arc cosinus */
  66080. ArcCos = 12,
  66081. /** Arc sinus */
  66082. ArcSin = 13,
  66083. /** Fraction */
  66084. Fract = 14,
  66085. /** Sign */
  66086. Sign = 15,
  66087. /** To radians (from degrees) */
  66088. Radians = 16,
  66089. /** To degrees (from radians) */
  66090. Degrees = 17
  66091. }
  66092. /**
  66093. * Block used to apply trigonometry operation to floats
  66094. */
  66095. export class TrigonometryBlock extends NodeMaterialBlock {
  66096. /**
  66097. * Gets or sets the operation applied by the block
  66098. */
  66099. operation: TrigonometryBlockOperations;
  66100. /**
  66101. * Creates a new TrigonometryBlock
  66102. * @param name defines the block name
  66103. */
  66104. constructor(name: string);
  66105. /**
  66106. * Gets the current class name
  66107. * @returns the class name
  66108. */
  66109. getClassName(): string;
  66110. /**
  66111. * Gets the input component
  66112. */
  66113. get input(): NodeMaterialConnectionPoint;
  66114. /**
  66115. * Gets the output component
  66116. */
  66117. get output(): NodeMaterialConnectionPoint;
  66118. protected _buildBlock(state: NodeMaterialBuildState): this;
  66119. serialize(): any;
  66120. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66121. protected _dumpPropertiesCode(): string;
  66122. }
  66123. }
  66124. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66125. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66126. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66127. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66128. /**
  66129. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66130. */
  66131. export class ColorMergerBlock extends NodeMaterialBlock {
  66132. /**
  66133. * Create a new ColorMergerBlock
  66134. * @param name defines the block name
  66135. */
  66136. constructor(name: string);
  66137. /**
  66138. * Gets the current class name
  66139. * @returns the class name
  66140. */
  66141. getClassName(): string;
  66142. /**
  66143. * Gets the rgb component (input)
  66144. */
  66145. get rgbIn(): NodeMaterialConnectionPoint;
  66146. /**
  66147. * Gets the r component (input)
  66148. */
  66149. get r(): NodeMaterialConnectionPoint;
  66150. /**
  66151. * Gets the g component (input)
  66152. */
  66153. get g(): NodeMaterialConnectionPoint;
  66154. /**
  66155. * Gets the b component (input)
  66156. */
  66157. get b(): NodeMaterialConnectionPoint;
  66158. /**
  66159. * Gets the a component (input)
  66160. */
  66161. get a(): NodeMaterialConnectionPoint;
  66162. /**
  66163. * Gets the rgba component (output)
  66164. */
  66165. get rgba(): NodeMaterialConnectionPoint;
  66166. /**
  66167. * Gets the rgb component (output)
  66168. */
  66169. get rgbOut(): NodeMaterialConnectionPoint;
  66170. /**
  66171. * Gets the rgb component (output)
  66172. * @deprecated Please use rgbOut instead.
  66173. */
  66174. get rgb(): NodeMaterialConnectionPoint;
  66175. protected _buildBlock(state: NodeMaterialBuildState): this;
  66176. }
  66177. }
  66178. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66179. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66180. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66181. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66182. /**
  66183. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66184. */
  66185. export class VectorSplitterBlock extends NodeMaterialBlock {
  66186. /**
  66187. * Create a new VectorSplitterBlock
  66188. * @param name defines the block name
  66189. */
  66190. constructor(name: string);
  66191. /**
  66192. * Gets the current class name
  66193. * @returns the class name
  66194. */
  66195. getClassName(): string;
  66196. /**
  66197. * Gets the xyzw component (input)
  66198. */
  66199. get xyzw(): NodeMaterialConnectionPoint;
  66200. /**
  66201. * Gets the xyz component (input)
  66202. */
  66203. get xyzIn(): NodeMaterialConnectionPoint;
  66204. /**
  66205. * Gets the xy component (input)
  66206. */
  66207. get xyIn(): NodeMaterialConnectionPoint;
  66208. /**
  66209. * Gets the xyz component (output)
  66210. */
  66211. get xyzOut(): NodeMaterialConnectionPoint;
  66212. /**
  66213. * Gets the xy component (output)
  66214. */
  66215. get xyOut(): NodeMaterialConnectionPoint;
  66216. /**
  66217. * Gets the x component (output)
  66218. */
  66219. get x(): NodeMaterialConnectionPoint;
  66220. /**
  66221. * Gets the y component (output)
  66222. */
  66223. get y(): NodeMaterialConnectionPoint;
  66224. /**
  66225. * Gets the z component (output)
  66226. */
  66227. get z(): NodeMaterialConnectionPoint;
  66228. /**
  66229. * Gets the w component (output)
  66230. */
  66231. get w(): NodeMaterialConnectionPoint;
  66232. protected _inputRename(name: string): string;
  66233. protected _outputRename(name: string): string;
  66234. protected _buildBlock(state: NodeMaterialBuildState): this;
  66235. }
  66236. }
  66237. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66238. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66239. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66240. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66241. /**
  66242. * Block used to lerp between 2 values
  66243. */
  66244. export class LerpBlock extends NodeMaterialBlock {
  66245. /**
  66246. * Creates a new LerpBlock
  66247. * @param name defines the block name
  66248. */
  66249. constructor(name: string);
  66250. /**
  66251. * Gets the current class name
  66252. * @returns the class name
  66253. */
  66254. getClassName(): string;
  66255. /**
  66256. * Gets the left operand input component
  66257. */
  66258. get left(): NodeMaterialConnectionPoint;
  66259. /**
  66260. * Gets the right operand input component
  66261. */
  66262. get right(): NodeMaterialConnectionPoint;
  66263. /**
  66264. * Gets the gradient operand input component
  66265. */
  66266. get gradient(): NodeMaterialConnectionPoint;
  66267. /**
  66268. * Gets the output component
  66269. */
  66270. get output(): NodeMaterialConnectionPoint;
  66271. protected _buildBlock(state: NodeMaterialBuildState): this;
  66272. }
  66273. }
  66274. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66275. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66276. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66277. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66278. /**
  66279. * Block used to divide 2 vectors
  66280. */
  66281. export class DivideBlock extends NodeMaterialBlock {
  66282. /**
  66283. * Creates a new DivideBlock
  66284. * @param name defines the block name
  66285. */
  66286. constructor(name: string);
  66287. /**
  66288. * Gets the current class name
  66289. * @returns the class name
  66290. */
  66291. getClassName(): string;
  66292. /**
  66293. * Gets the left operand input component
  66294. */
  66295. get left(): NodeMaterialConnectionPoint;
  66296. /**
  66297. * Gets the right operand input component
  66298. */
  66299. get right(): NodeMaterialConnectionPoint;
  66300. /**
  66301. * Gets the output component
  66302. */
  66303. get output(): NodeMaterialConnectionPoint;
  66304. protected _buildBlock(state: NodeMaterialBuildState): this;
  66305. }
  66306. }
  66307. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66308. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66309. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66310. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66311. /**
  66312. * Block used to subtract 2 vectors
  66313. */
  66314. export class SubtractBlock extends NodeMaterialBlock {
  66315. /**
  66316. * Creates a new SubtractBlock
  66317. * @param name defines the block name
  66318. */
  66319. constructor(name: string);
  66320. /**
  66321. * Gets the current class name
  66322. * @returns the class name
  66323. */
  66324. getClassName(): string;
  66325. /**
  66326. * Gets the left operand input component
  66327. */
  66328. get left(): NodeMaterialConnectionPoint;
  66329. /**
  66330. * Gets the right operand input component
  66331. */
  66332. get right(): NodeMaterialConnectionPoint;
  66333. /**
  66334. * Gets the output component
  66335. */
  66336. get output(): NodeMaterialConnectionPoint;
  66337. protected _buildBlock(state: NodeMaterialBuildState): this;
  66338. }
  66339. }
  66340. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66341. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66342. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66343. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66344. /**
  66345. * Block used to step a value
  66346. */
  66347. export class StepBlock extends NodeMaterialBlock {
  66348. /**
  66349. * Creates a new StepBlock
  66350. * @param name defines the block name
  66351. */
  66352. constructor(name: string);
  66353. /**
  66354. * Gets the current class name
  66355. * @returns the class name
  66356. */
  66357. getClassName(): string;
  66358. /**
  66359. * Gets the value operand input component
  66360. */
  66361. get value(): NodeMaterialConnectionPoint;
  66362. /**
  66363. * Gets the edge operand input component
  66364. */
  66365. get edge(): NodeMaterialConnectionPoint;
  66366. /**
  66367. * Gets the output component
  66368. */
  66369. get output(): NodeMaterialConnectionPoint;
  66370. protected _buildBlock(state: NodeMaterialBuildState): this;
  66371. }
  66372. }
  66373. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66374. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66375. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66376. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66377. /**
  66378. * Block used to get the opposite (1 - x) of a value
  66379. */
  66380. export class OneMinusBlock extends NodeMaterialBlock {
  66381. /**
  66382. * Creates a new OneMinusBlock
  66383. * @param name defines the block name
  66384. */
  66385. constructor(name: string);
  66386. /**
  66387. * Gets the current class name
  66388. * @returns the class name
  66389. */
  66390. getClassName(): string;
  66391. /**
  66392. * Gets the input component
  66393. */
  66394. get input(): NodeMaterialConnectionPoint;
  66395. /**
  66396. * Gets the output component
  66397. */
  66398. get output(): NodeMaterialConnectionPoint;
  66399. protected _buildBlock(state: NodeMaterialBuildState): this;
  66400. }
  66401. }
  66402. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66403. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66404. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66405. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66406. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66407. /**
  66408. * Block used to get the view direction
  66409. */
  66410. export class ViewDirectionBlock extends NodeMaterialBlock {
  66411. /**
  66412. * Creates a new ViewDirectionBlock
  66413. * @param name defines the block name
  66414. */
  66415. constructor(name: string);
  66416. /**
  66417. * Gets the current class name
  66418. * @returns the class name
  66419. */
  66420. getClassName(): string;
  66421. /**
  66422. * Gets the world position component
  66423. */
  66424. get worldPosition(): NodeMaterialConnectionPoint;
  66425. /**
  66426. * Gets the camera position component
  66427. */
  66428. get cameraPosition(): NodeMaterialConnectionPoint;
  66429. /**
  66430. * Gets the output component
  66431. */
  66432. get output(): NodeMaterialConnectionPoint;
  66433. autoConfigure(material: NodeMaterial): void;
  66434. protected _buildBlock(state: NodeMaterialBuildState): this;
  66435. }
  66436. }
  66437. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66438. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66439. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66440. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66441. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66442. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66443. /**
  66444. * Block used to compute fresnel value
  66445. */
  66446. export class FresnelBlock extends NodeMaterialBlock {
  66447. /**
  66448. * Create a new FresnelBlock
  66449. * @param name defines the block name
  66450. */
  66451. constructor(name: string);
  66452. /**
  66453. * Gets the current class name
  66454. * @returns the class name
  66455. */
  66456. getClassName(): string;
  66457. /**
  66458. * Gets the world normal input component
  66459. */
  66460. get worldNormal(): NodeMaterialConnectionPoint;
  66461. /**
  66462. * Gets the view direction input component
  66463. */
  66464. get viewDirection(): NodeMaterialConnectionPoint;
  66465. /**
  66466. * Gets the bias input component
  66467. */
  66468. get bias(): NodeMaterialConnectionPoint;
  66469. /**
  66470. * Gets the camera (or eye) position component
  66471. */
  66472. get power(): NodeMaterialConnectionPoint;
  66473. /**
  66474. * Gets the fresnel output component
  66475. */
  66476. get fresnel(): NodeMaterialConnectionPoint;
  66477. autoConfigure(material: NodeMaterial): void;
  66478. protected _buildBlock(state: NodeMaterialBuildState): this;
  66479. }
  66480. }
  66481. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66482. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66483. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66484. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66485. /**
  66486. * Block used to get the max of 2 values
  66487. */
  66488. export class MaxBlock extends NodeMaterialBlock {
  66489. /**
  66490. * Creates a new MaxBlock
  66491. * @param name defines the block name
  66492. */
  66493. constructor(name: string);
  66494. /**
  66495. * Gets the current class name
  66496. * @returns the class name
  66497. */
  66498. getClassName(): string;
  66499. /**
  66500. * Gets the left operand input component
  66501. */
  66502. get left(): NodeMaterialConnectionPoint;
  66503. /**
  66504. * Gets the right operand input component
  66505. */
  66506. get right(): NodeMaterialConnectionPoint;
  66507. /**
  66508. * Gets the output component
  66509. */
  66510. get output(): NodeMaterialConnectionPoint;
  66511. protected _buildBlock(state: NodeMaterialBuildState): this;
  66512. }
  66513. }
  66514. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66515. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66516. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66517. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66518. /**
  66519. * Block used to get the min of 2 values
  66520. */
  66521. export class MinBlock extends NodeMaterialBlock {
  66522. /**
  66523. * Creates a new MinBlock
  66524. * @param name defines the block name
  66525. */
  66526. constructor(name: string);
  66527. /**
  66528. * Gets the current class name
  66529. * @returns the class name
  66530. */
  66531. getClassName(): string;
  66532. /**
  66533. * Gets the left operand input component
  66534. */
  66535. get left(): NodeMaterialConnectionPoint;
  66536. /**
  66537. * Gets the right operand input component
  66538. */
  66539. get right(): NodeMaterialConnectionPoint;
  66540. /**
  66541. * Gets the output component
  66542. */
  66543. get output(): NodeMaterialConnectionPoint;
  66544. protected _buildBlock(state: NodeMaterialBuildState): this;
  66545. }
  66546. }
  66547. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66548. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66549. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66550. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66551. /**
  66552. * Block used to get the distance between 2 values
  66553. */
  66554. export class DistanceBlock extends NodeMaterialBlock {
  66555. /**
  66556. * Creates a new DistanceBlock
  66557. * @param name defines the block name
  66558. */
  66559. constructor(name: string);
  66560. /**
  66561. * Gets the current class name
  66562. * @returns the class name
  66563. */
  66564. getClassName(): string;
  66565. /**
  66566. * Gets the left operand input component
  66567. */
  66568. get left(): NodeMaterialConnectionPoint;
  66569. /**
  66570. * Gets the right operand input component
  66571. */
  66572. get right(): NodeMaterialConnectionPoint;
  66573. /**
  66574. * Gets the output component
  66575. */
  66576. get output(): NodeMaterialConnectionPoint;
  66577. protected _buildBlock(state: NodeMaterialBuildState): this;
  66578. }
  66579. }
  66580. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66581. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66582. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66583. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66584. /**
  66585. * Block used to get the length of a vector
  66586. */
  66587. export class LengthBlock extends NodeMaterialBlock {
  66588. /**
  66589. * Creates a new LengthBlock
  66590. * @param name defines the block name
  66591. */
  66592. constructor(name: string);
  66593. /**
  66594. * Gets the current class name
  66595. * @returns the class name
  66596. */
  66597. getClassName(): string;
  66598. /**
  66599. * Gets the value input component
  66600. */
  66601. get value(): NodeMaterialConnectionPoint;
  66602. /**
  66603. * Gets the output component
  66604. */
  66605. get output(): NodeMaterialConnectionPoint;
  66606. protected _buildBlock(state: NodeMaterialBuildState): this;
  66607. }
  66608. }
  66609. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66610. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66611. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66612. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66613. /**
  66614. * Block used to get negative version of a value (i.e. x * -1)
  66615. */
  66616. export class NegateBlock extends NodeMaterialBlock {
  66617. /**
  66618. * Creates a new NegateBlock
  66619. * @param name defines the block name
  66620. */
  66621. constructor(name: string);
  66622. /**
  66623. * Gets the current class name
  66624. * @returns the class name
  66625. */
  66626. getClassName(): string;
  66627. /**
  66628. * Gets the value input component
  66629. */
  66630. get value(): NodeMaterialConnectionPoint;
  66631. /**
  66632. * Gets the output component
  66633. */
  66634. get output(): NodeMaterialConnectionPoint;
  66635. protected _buildBlock(state: NodeMaterialBuildState): this;
  66636. }
  66637. }
  66638. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66639. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66640. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66641. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66642. /**
  66643. * Block used to get the value of the first parameter raised to the power of the second
  66644. */
  66645. export class PowBlock extends NodeMaterialBlock {
  66646. /**
  66647. * Creates a new PowBlock
  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 value operand input component
  66658. */
  66659. get value(): NodeMaterialConnectionPoint;
  66660. /**
  66661. * Gets the power operand input component
  66662. */
  66663. get power(): NodeMaterialConnectionPoint;
  66664. /**
  66665. * Gets the output component
  66666. */
  66667. get output(): NodeMaterialConnectionPoint;
  66668. protected _buildBlock(state: NodeMaterialBuildState): this;
  66669. }
  66670. }
  66671. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66672. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66673. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66674. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66675. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66676. /**
  66677. * Block used to get a random number
  66678. */
  66679. export class RandomNumberBlock extends NodeMaterialBlock {
  66680. /**
  66681. * Creates a new RandomNumberBlock
  66682. * @param name defines the block name
  66683. */
  66684. constructor(name: string);
  66685. /**
  66686. * Gets the current class name
  66687. * @returns the class name
  66688. */
  66689. getClassName(): string;
  66690. /**
  66691. * Gets the seed input component
  66692. */
  66693. get seed(): NodeMaterialConnectionPoint;
  66694. /**
  66695. * Gets the output component
  66696. */
  66697. get output(): NodeMaterialConnectionPoint;
  66698. protected _buildBlock(state: NodeMaterialBuildState): this;
  66699. }
  66700. }
  66701. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66702. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66703. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66704. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66705. /**
  66706. * Block used to compute arc tangent of 2 values
  66707. */
  66708. export class ArcTan2Block extends NodeMaterialBlock {
  66709. /**
  66710. * Creates a new ArcTan2Block
  66711. * @param name defines the block name
  66712. */
  66713. constructor(name: string);
  66714. /**
  66715. * Gets the current class name
  66716. * @returns the class name
  66717. */
  66718. getClassName(): string;
  66719. /**
  66720. * Gets the x operand input component
  66721. */
  66722. get x(): NodeMaterialConnectionPoint;
  66723. /**
  66724. * Gets the y operand input component
  66725. */
  66726. get y(): NodeMaterialConnectionPoint;
  66727. /**
  66728. * Gets the output component
  66729. */
  66730. get output(): NodeMaterialConnectionPoint;
  66731. protected _buildBlock(state: NodeMaterialBuildState): this;
  66732. }
  66733. }
  66734. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66735. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66736. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66737. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66738. /**
  66739. * Block used to smooth step a value
  66740. */
  66741. export class SmoothStepBlock extends NodeMaterialBlock {
  66742. /**
  66743. * Creates a new SmoothStepBlock
  66744. * @param name defines the block name
  66745. */
  66746. constructor(name: string);
  66747. /**
  66748. * Gets the current class name
  66749. * @returns the class name
  66750. */
  66751. getClassName(): string;
  66752. /**
  66753. * Gets the value operand input component
  66754. */
  66755. get value(): NodeMaterialConnectionPoint;
  66756. /**
  66757. * Gets the first edge operand input component
  66758. */
  66759. get edge0(): NodeMaterialConnectionPoint;
  66760. /**
  66761. * Gets the second edge operand input component
  66762. */
  66763. get edge1(): NodeMaterialConnectionPoint;
  66764. /**
  66765. * Gets the output component
  66766. */
  66767. get output(): NodeMaterialConnectionPoint;
  66768. protected _buildBlock(state: NodeMaterialBuildState): this;
  66769. }
  66770. }
  66771. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66772. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66773. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66774. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66775. /**
  66776. * Block used to get the reciprocal (1 / x) of a value
  66777. */
  66778. export class ReciprocalBlock extends NodeMaterialBlock {
  66779. /**
  66780. * Creates a new ReciprocalBlock
  66781. * @param name defines the block name
  66782. */
  66783. constructor(name: string);
  66784. /**
  66785. * Gets the current class name
  66786. * @returns the class name
  66787. */
  66788. getClassName(): string;
  66789. /**
  66790. * Gets the input component
  66791. */
  66792. get input(): NodeMaterialConnectionPoint;
  66793. /**
  66794. * Gets the output component
  66795. */
  66796. get output(): NodeMaterialConnectionPoint;
  66797. protected _buildBlock(state: NodeMaterialBuildState): this;
  66798. }
  66799. }
  66800. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66801. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66802. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66803. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66804. /**
  66805. * Block used to replace a color by another one
  66806. */
  66807. export class ReplaceColorBlock extends NodeMaterialBlock {
  66808. /**
  66809. * Creates a new ReplaceColorBlock
  66810. * @param name defines the block name
  66811. */
  66812. constructor(name: string);
  66813. /**
  66814. * Gets the current class name
  66815. * @returns the class name
  66816. */
  66817. getClassName(): string;
  66818. /**
  66819. * Gets the value input component
  66820. */
  66821. get value(): NodeMaterialConnectionPoint;
  66822. /**
  66823. * Gets the reference input component
  66824. */
  66825. get reference(): NodeMaterialConnectionPoint;
  66826. /**
  66827. * Gets the distance input component
  66828. */
  66829. get distance(): NodeMaterialConnectionPoint;
  66830. /**
  66831. * Gets the replacement input component
  66832. */
  66833. get replacement(): NodeMaterialConnectionPoint;
  66834. /**
  66835. * Gets the output component
  66836. */
  66837. get output(): NodeMaterialConnectionPoint;
  66838. protected _buildBlock(state: NodeMaterialBuildState): this;
  66839. }
  66840. }
  66841. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66842. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66843. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66844. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66845. /**
  66846. * Block used to posterize a value
  66847. * @see https://en.wikipedia.org/wiki/Posterization
  66848. */
  66849. export class PosterizeBlock extends NodeMaterialBlock {
  66850. /**
  66851. * Creates a new PosterizeBlock
  66852. * @param name defines the block name
  66853. */
  66854. constructor(name: string);
  66855. /**
  66856. * Gets the current class name
  66857. * @returns the class name
  66858. */
  66859. getClassName(): string;
  66860. /**
  66861. * Gets the value input component
  66862. */
  66863. get value(): NodeMaterialConnectionPoint;
  66864. /**
  66865. * Gets the steps input component
  66866. */
  66867. get steps(): NodeMaterialConnectionPoint;
  66868. /**
  66869. * Gets the output component
  66870. */
  66871. get output(): NodeMaterialConnectionPoint;
  66872. protected _buildBlock(state: NodeMaterialBuildState): this;
  66873. }
  66874. }
  66875. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66876. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66877. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66878. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66879. import { Scene } from "babylonjs/scene";
  66880. /**
  66881. * Operations supported by the Wave block
  66882. */
  66883. export enum WaveBlockKind {
  66884. /** SawTooth */
  66885. SawTooth = 0,
  66886. /** Square */
  66887. Square = 1,
  66888. /** Triangle */
  66889. Triangle = 2
  66890. }
  66891. /**
  66892. * Block used to apply wave operation to floats
  66893. */
  66894. export class WaveBlock extends NodeMaterialBlock {
  66895. /**
  66896. * Gets or sets the kibnd of wave to be applied by the block
  66897. */
  66898. kind: WaveBlockKind;
  66899. /**
  66900. * Creates a new WaveBlock
  66901. * @param name defines the block name
  66902. */
  66903. constructor(name: string);
  66904. /**
  66905. * Gets the current class name
  66906. * @returns the class name
  66907. */
  66908. getClassName(): string;
  66909. /**
  66910. * Gets the input component
  66911. */
  66912. get input(): NodeMaterialConnectionPoint;
  66913. /**
  66914. * Gets the output component
  66915. */
  66916. get output(): NodeMaterialConnectionPoint;
  66917. protected _buildBlock(state: NodeMaterialBuildState): this;
  66918. serialize(): any;
  66919. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66920. }
  66921. }
  66922. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66923. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66924. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66925. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66926. import { Color3 } from "babylonjs/Maths/math.color";
  66927. import { Scene } from "babylonjs/scene";
  66928. /**
  66929. * Class used to store a color step for the GradientBlock
  66930. */
  66931. export class GradientBlockColorStep {
  66932. /**
  66933. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66934. */
  66935. step: number;
  66936. /**
  66937. * Gets or sets the color associated with this step
  66938. */
  66939. color: Color3;
  66940. /**
  66941. * Creates a new GradientBlockColorStep
  66942. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  66943. * @param color defines the color associated with this step
  66944. */
  66945. constructor(
  66946. /**
  66947. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66948. */
  66949. step: number,
  66950. /**
  66951. * Gets or sets the color associated with this step
  66952. */
  66953. color: Color3);
  66954. }
  66955. /**
  66956. * Block used to return a color from a gradient based on an input value between 0 and 1
  66957. */
  66958. export class GradientBlock extends NodeMaterialBlock {
  66959. /**
  66960. * Gets or sets the list of color steps
  66961. */
  66962. colorSteps: GradientBlockColorStep[];
  66963. /**
  66964. * Creates a new GradientBlock
  66965. * @param name defines the block name
  66966. */
  66967. constructor(name: string);
  66968. /**
  66969. * Gets the current class name
  66970. * @returns the class name
  66971. */
  66972. getClassName(): string;
  66973. /**
  66974. * Gets the gradient input component
  66975. */
  66976. get gradient(): NodeMaterialConnectionPoint;
  66977. /**
  66978. * Gets the output component
  66979. */
  66980. get output(): NodeMaterialConnectionPoint;
  66981. private _writeColorConstant;
  66982. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66983. serialize(): any;
  66984. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66985. protected _dumpPropertiesCode(): string;
  66986. }
  66987. }
  66988. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  66989. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66990. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66991. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66992. /**
  66993. * Block used to normalize lerp between 2 values
  66994. */
  66995. export class NLerpBlock extends NodeMaterialBlock {
  66996. /**
  66997. * Creates a new NLerpBlock
  66998. * @param name defines the block name
  66999. */
  67000. constructor(name: string);
  67001. /**
  67002. * Gets the current class name
  67003. * @returns the class name
  67004. */
  67005. getClassName(): string;
  67006. /**
  67007. * Gets the left operand input component
  67008. */
  67009. get left(): NodeMaterialConnectionPoint;
  67010. /**
  67011. * Gets the right operand input component
  67012. */
  67013. get right(): NodeMaterialConnectionPoint;
  67014. /**
  67015. * Gets the gradient operand input component
  67016. */
  67017. get gradient(): NodeMaterialConnectionPoint;
  67018. /**
  67019. * Gets the output component
  67020. */
  67021. get output(): NodeMaterialConnectionPoint;
  67022. protected _buildBlock(state: NodeMaterialBuildState): this;
  67023. }
  67024. }
  67025. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67026. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67027. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67028. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67029. import { Scene } from "babylonjs/scene";
  67030. /**
  67031. * block used to Generate a Worley Noise 3D Noise Pattern
  67032. */
  67033. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67034. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67035. manhattanDistance: boolean;
  67036. /**
  67037. * Creates a new WorleyNoise3DBlock
  67038. * @param name defines the block name
  67039. */
  67040. constructor(name: string);
  67041. /**
  67042. * Gets the current class name
  67043. * @returns the class name
  67044. */
  67045. getClassName(): string;
  67046. /**
  67047. * Gets the seed input component
  67048. */
  67049. get seed(): NodeMaterialConnectionPoint;
  67050. /**
  67051. * Gets the jitter input component
  67052. */
  67053. get jitter(): NodeMaterialConnectionPoint;
  67054. /**
  67055. * Gets the output component
  67056. */
  67057. get output(): NodeMaterialConnectionPoint;
  67058. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67059. /**
  67060. * Exposes the properties to the UI?
  67061. */
  67062. protected _dumpPropertiesCode(): string;
  67063. /**
  67064. * Exposes the properties to the Seralize?
  67065. */
  67066. serialize(): any;
  67067. /**
  67068. * Exposes the properties to the deseralize?
  67069. */
  67070. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67071. }
  67072. }
  67073. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67074. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67075. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67076. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67077. /**
  67078. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67079. */
  67080. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67081. /**
  67082. * Creates a new SimplexPerlin3DBlock
  67083. * @param name defines the block name
  67084. */
  67085. constructor(name: string);
  67086. /**
  67087. * Gets the current class name
  67088. * @returns the class name
  67089. */
  67090. getClassName(): string;
  67091. /**
  67092. * Gets the seed operand input component
  67093. */
  67094. get seed(): NodeMaterialConnectionPoint;
  67095. /**
  67096. * Gets the output component
  67097. */
  67098. get output(): NodeMaterialConnectionPoint;
  67099. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67100. }
  67101. }
  67102. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67103. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67104. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67105. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67106. /**
  67107. * Block used to blend normals
  67108. */
  67109. export class NormalBlendBlock extends NodeMaterialBlock {
  67110. /**
  67111. * Creates a new NormalBlendBlock
  67112. * @param name defines the block name
  67113. */
  67114. constructor(name: string);
  67115. /**
  67116. * Gets the current class name
  67117. * @returns the class name
  67118. */
  67119. getClassName(): string;
  67120. /**
  67121. * Gets the first input component
  67122. */
  67123. get normalMap0(): NodeMaterialConnectionPoint;
  67124. /**
  67125. * Gets the second input component
  67126. */
  67127. get normalMap1(): NodeMaterialConnectionPoint;
  67128. /**
  67129. * Gets the output component
  67130. */
  67131. get output(): NodeMaterialConnectionPoint;
  67132. protected _buildBlock(state: NodeMaterialBuildState): this;
  67133. }
  67134. }
  67135. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67136. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67137. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67138. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67139. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67140. /**
  67141. * Block used to rotate a 2d vector by a given angle
  67142. */
  67143. export class Rotate2dBlock extends NodeMaterialBlock {
  67144. /**
  67145. * Creates a new Rotate2dBlock
  67146. * @param name defines the block name
  67147. */
  67148. constructor(name: string);
  67149. /**
  67150. * Gets the current class name
  67151. * @returns the class name
  67152. */
  67153. getClassName(): string;
  67154. /**
  67155. * Gets the input vector
  67156. */
  67157. get input(): NodeMaterialConnectionPoint;
  67158. /**
  67159. * Gets the input angle
  67160. */
  67161. get angle(): NodeMaterialConnectionPoint;
  67162. /**
  67163. * Gets the output component
  67164. */
  67165. get output(): NodeMaterialConnectionPoint;
  67166. autoConfigure(material: NodeMaterial): void;
  67167. protected _buildBlock(state: NodeMaterialBuildState): this;
  67168. }
  67169. }
  67170. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67171. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67172. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67173. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67174. /**
  67175. * Block used to get the reflected vector from a direction and a normal
  67176. */
  67177. export class ReflectBlock extends NodeMaterialBlock {
  67178. /**
  67179. * Creates a new ReflectBlock
  67180. * @param name defines the block name
  67181. */
  67182. constructor(name: string);
  67183. /**
  67184. * Gets the current class name
  67185. * @returns the class name
  67186. */
  67187. getClassName(): string;
  67188. /**
  67189. * Gets the incident component
  67190. */
  67191. get incident(): NodeMaterialConnectionPoint;
  67192. /**
  67193. * Gets the normal component
  67194. */
  67195. get normal(): NodeMaterialConnectionPoint;
  67196. /**
  67197. * Gets the output component
  67198. */
  67199. get output(): NodeMaterialConnectionPoint;
  67200. protected _buildBlock(state: NodeMaterialBuildState): this;
  67201. }
  67202. }
  67203. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67204. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67205. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67206. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67207. /**
  67208. * Block used to get the refracted vector from a direction and a normal
  67209. */
  67210. export class RefractBlock extends NodeMaterialBlock {
  67211. /**
  67212. * Creates a new RefractBlock
  67213. * @param name defines the block name
  67214. */
  67215. constructor(name: string);
  67216. /**
  67217. * Gets the current class name
  67218. * @returns the class name
  67219. */
  67220. getClassName(): string;
  67221. /**
  67222. * Gets the incident component
  67223. */
  67224. get incident(): NodeMaterialConnectionPoint;
  67225. /**
  67226. * Gets the normal component
  67227. */
  67228. get normal(): NodeMaterialConnectionPoint;
  67229. /**
  67230. * Gets the index of refraction component
  67231. */
  67232. get ior(): NodeMaterialConnectionPoint;
  67233. /**
  67234. * Gets the output component
  67235. */
  67236. get output(): NodeMaterialConnectionPoint;
  67237. protected _buildBlock(state: NodeMaterialBuildState): this;
  67238. }
  67239. }
  67240. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67241. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67242. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67243. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67244. /**
  67245. * Block used to desaturate a color
  67246. */
  67247. export class DesaturateBlock extends NodeMaterialBlock {
  67248. /**
  67249. * Creates a new DesaturateBlock
  67250. * @param name defines the block name
  67251. */
  67252. constructor(name: string);
  67253. /**
  67254. * Gets the current class name
  67255. * @returns the class name
  67256. */
  67257. getClassName(): string;
  67258. /**
  67259. * Gets the color operand input component
  67260. */
  67261. get color(): NodeMaterialConnectionPoint;
  67262. /**
  67263. * Gets the level operand input component
  67264. */
  67265. get level(): NodeMaterialConnectionPoint;
  67266. /**
  67267. * Gets the output component
  67268. */
  67269. get output(): NodeMaterialConnectionPoint;
  67270. protected _buildBlock(state: NodeMaterialBuildState): this;
  67271. }
  67272. }
  67273. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67274. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67275. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67276. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67277. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67278. import { Nullable } from "babylonjs/types";
  67279. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67280. import { Scene } from "babylonjs/scene";
  67281. /**
  67282. * Block used to implement the ambient occlusion module of the PBR material
  67283. */
  67284. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67285. /**
  67286. * Create a new AmbientOcclusionBlock
  67287. * @param name defines the block name
  67288. */
  67289. constructor(name: string);
  67290. /**
  67291. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67292. */
  67293. useAmbientInGrayScale: boolean;
  67294. /**
  67295. * Initialize the block and prepare the context for build
  67296. * @param state defines the state that will be used for the build
  67297. */
  67298. initialize(state: NodeMaterialBuildState): void;
  67299. /**
  67300. * Gets the current class name
  67301. * @returns the class name
  67302. */
  67303. getClassName(): string;
  67304. /**
  67305. * Gets the texture input component
  67306. */
  67307. get texture(): NodeMaterialConnectionPoint;
  67308. /**
  67309. * Gets the texture intensity component
  67310. */
  67311. get intensity(): NodeMaterialConnectionPoint;
  67312. /**
  67313. * Gets the direct light intensity input component
  67314. */
  67315. get directLightIntensity(): NodeMaterialConnectionPoint;
  67316. /**
  67317. * Gets the ambient occlusion object output component
  67318. */
  67319. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67320. /**
  67321. * Gets the main code of the block (fragment side)
  67322. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67323. * @returns the shader code
  67324. */
  67325. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67326. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67327. protected _buildBlock(state: NodeMaterialBuildState): this;
  67328. protected _dumpPropertiesCode(): string;
  67329. serialize(): any;
  67330. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67331. }
  67332. }
  67333. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67334. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67335. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67336. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67337. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67338. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67339. import { Nullable } from "babylonjs/types";
  67340. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67341. import { Mesh } from "babylonjs/Meshes/mesh";
  67342. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67343. import { Effect } from "babylonjs/Materials/effect";
  67344. import { Scene } from "babylonjs/scene";
  67345. /**
  67346. * Block used to implement the reflection module of the PBR material
  67347. */
  67348. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67349. /** @hidden */
  67350. _defineLODReflectionAlpha: string;
  67351. /** @hidden */
  67352. _defineLinearSpecularReflection: string;
  67353. private _vEnvironmentIrradianceName;
  67354. /** @hidden */
  67355. _vReflectionMicrosurfaceInfosName: string;
  67356. /** @hidden */
  67357. _vReflectionInfosName: string;
  67358. /** @hidden */
  67359. _vReflectionFilteringInfoName: string;
  67360. private _scene;
  67361. /**
  67362. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67363. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67364. * It's less burden on the user side in the editor part.
  67365. */
  67366. /** @hidden */
  67367. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67368. /** @hidden */
  67369. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67370. /** @hidden */
  67371. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67372. /**
  67373. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67374. * diffuse part of the IBL.
  67375. */
  67376. useSphericalHarmonics: boolean;
  67377. /**
  67378. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67379. */
  67380. forceIrradianceInFragment: boolean;
  67381. /**
  67382. * Create a new ReflectionBlock
  67383. * @param name defines the block name
  67384. */
  67385. constructor(name: string);
  67386. /**
  67387. * Gets the current class name
  67388. * @returns the class name
  67389. */
  67390. getClassName(): string;
  67391. /**
  67392. * Gets the position input component
  67393. */
  67394. get position(): NodeMaterialConnectionPoint;
  67395. /**
  67396. * Gets the world position input component
  67397. */
  67398. get worldPosition(): NodeMaterialConnectionPoint;
  67399. /**
  67400. * Gets the world normal input component
  67401. */
  67402. get worldNormal(): NodeMaterialConnectionPoint;
  67403. /**
  67404. * Gets the world input component
  67405. */
  67406. get world(): NodeMaterialConnectionPoint;
  67407. /**
  67408. * Gets the camera (or eye) position component
  67409. */
  67410. get cameraPosition(): NodeMaterialConnectionPoint;
  67411. /**
  67412. * Gets the view input component
  67413. */
  67414. get view(): NodeMaterialConnectionPoint;
  67415. /**
  67416. * Gets the color input component
  67417. */
  67418. get color(): NodeMaterialConnectionPoint;
  67419. /**
  67420. * Gets the reflection object output component
  67421. */
  67422. get reflection(): NodeMaterialConnectionPoint;
  67423. /**
  67424. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67425. */
  67426. get hasTexture(): boolean;
  67427. /**
  67428. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67429. */
  67430. get reflectionColor(): string;
  67431. protected _getTexture(): Nullable<BaseTexture>;
  67432. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67433. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67434. /**
  67435. * Gets the code to inject in the vertex shader
  67436. * @param state current state of the node material building
  67437. * @returns the shader code
  67438. */
  67439. handleVertexSide(state: NodeMaterialBuildState): string;
  67440. /**
  67441. * Gets the main code of the block (fragment side)
  67442. * @param state current state of the node material building
  67443. * @param normalVarName name of the existing variable corresponding to the normal
  67444. * @returns the shader code
  67445. */
  67446. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67447. protected _buildBlock(state: NodeMaterialBuildState): this;
  67448. protected _dumpPropertiesCode(): string;
  67449. serialize(): any;
  67450. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67451. }
  67452. }
  67453. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67454. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67455. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67456. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67457. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67458. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67459. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67460. import { Scene } from "babylonjs/scene";
  67461. import { Nullable } from "babylonjs/types";
  67462. /**
  67463. * Block used to implement the sheen module of the PBR material
  67464. */
  67465. export class SheenBlock extends NodeMaterialBlock {
  67466. /**
  67467. * Create a new SheenBlock
  67468. * @param name defines the block name
  67469. */
  67470. constructor(name: string);
  67471. /**
  67472. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67473. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67474. * making it easier to setup and tweak the effect
  67475. */
  67476. albedoScaling: boolean;
  67477. /**
  67478. * Defines if the sheen is linked to the sheen color.
  67479. */
  67480. linkSheenWithAlbedo: boolean;
  67481. /**
  67482. * Initialize the block and prepare the context for build
  67483. * @param state defines the state that will be used for the build
  67484. */
  67485. initialize(state: NodeMaterialBuildState): void;
  67486. /**
  67487. * Gets the current class name
  67488. * @returns the class name
  67489. */
  67490. getClassName(): string;
  67491. /**
  67492. * Gets the intensity input component
  67493. */
  67494. get intensity(): NodeMaterialConnectionPoint;
  67495. /**
  67496. * Gets the color input component
  67497. */
  67498. get color(): NodeMaterialConnectionPoint;
  67499. /**
  67500. * Gets the roughness input component
  67501. */
  67502. get roughness(): NodeMaterialConnectionPoint;
  67503. /**
  67504. * Gets the sheen object output component
  67505. */
  67506. get sheen(): NodeMaterialConnectionPoint;
  67507. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67508. /**
  67509. * Gets the main code of the block (fragment side)
  67510. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67511. * @returns the shader code
  67512. */
  67513. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67514. protected _buildBlock(state: NodeMaterialBuildState): this;
  67515. protected _dumpPropertiesCode(): string;
  67516. serialize(): any;
  67517. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67518. }
  67519. }
  67520. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67521. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67522. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67523. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67524. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67525. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67526. import { Scene } from "babylonjs/scene";
  67527. import { Nullable } from "babylonjs/types";
  67528. import { Mesh } from "babylonjs/Meshes/mesh";
  67529. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67530. import { Effect } from "babylonjs/Materials/effect";
  67531. /**
  67532. * Block used to implement the reflectivity module of the PBR material
  67533. */
  67534. export class ReflectivityBlock extends NodeMaterialBlock {
  67535. private _metallicReflectanceColor;
  67536. private _metallicF0Factor;
  67537. /** @hidden */
  67538. _vMetallicReflectanceFactorsName: string;
  67539. /**
  67540. * The property below is set by the main PBR block prior to calling methods of this class.
  67541. */
  67542. /** @hidden */
  67543. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67544. /**
  67545. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67546. */
  67547. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67548. /**
  67549. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67550. */
  67551. useMetallnessFromMetallicTextureBlue: boolean;
  67552. /**
  67553. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67554. */
  67555. useRoughnessFromMetallicTextureAlpha: boolean;
  67556. /**
  67557. * Specifies if the metallic texture contains the roughness information in its green channel.
  67558. */
  67559. useRoughnessFromMetallicTextureGreen: boolean;
  67560. /**
  67561. * Create a new ReflectivityBlock
  67562. * @param name defines the block name
  67563. */
  67564. constructor(name: string);
  67565. /**
  67566. * Initialize the block and prepare the context for build
  67567. * @param state defines the state that will be used for the build
  67568. */
  67569. initialize(state: NodeMaterialBuildState): void;
  67570. /**
  67571. * Gets the current class name
  67572. * @returns the class name
  67573. */
  67574. getClassName(): string;
  67575. /**
  67576. * Gets the metallic input component
  67577. */
  67578. get metallic(): NodeMaterialConnectionPoint;
  67579. /**
  67580. * Gets the roughness input component
  67581. */
  67582. get roughness(): NodeMaterialConnectionPoint;
  67583. /**
  67584. * Gets the texture input component
  67585. */
  67586. get texture(): NodeMaterialConnectionPoint;
  67587. /**
  67588. * Gets the reflectivity object output component
  67589. */
  67590. get reflectivity(): NodeMaterialConnectionPoint;
  67591. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67592. /**
  67593. * Gets the main code of the block (fragment side)
  67594. * @param state current state of the node material building
  67595. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67596. * @returns the shader code
  67597. */
  67598. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67599. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67600. protected _buildBlock(state: NodeMaterialBuildState): this;
  67601. protected _dumpPropertiesCode(): string;
  67602. serialize(): any;
  67603. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67604. }
  67605. }
  67606. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67607. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67608. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67609. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67610. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67611. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67612. /**
  67613. * Block used to implement the anisotropy module of the PBR material
  67614. */
  67615. export class AnisotropyBlock extends NodeMaterialBlock {
  67616. /**
  67617. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67618. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67619. * It's less burden on the user side in the editor part.
  67620. */
  67621. /** @hidden */
  67622. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67623. /** @hidden */
  67624. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67625. /**
  67626. * Create a new AnisotropyBlock
  67627. * @param name defines the block name
  67628. */
  67629. constructor(name: string);
  67630. /**
  67631. * Initialize the block and prepare the context for build
  67632. * @param state defines the state that will be used for the build
  67633. */
  67634. initialize(state: NodeMaterialBuildState): void;
  67635. /**
  67636. * Gets the current class name
  67637. * @returns the class name
  67638. */
  67639. getClassName(): string;
  67640. /**
  67641. * Gets the intensity input component
  67642. */
  67643. get intensity(): NodeMaterialConnectionPoint;
  67644. /**
  67645. * Gets the direction input component
  67646. */
  67647. get direction(): NodeMaterialConnectionPoint;
  67648. /**
  67649. * Gets the texture input component
  67650. */
  67651. get texture(): NodeMaterialConnectionPoint;
  67652. /**
  67653. * Gets the uv input component
  67654. */
  67655. get uv(): NodeMaterialConnectionPoint;
  67656. /**
  67657. * Gets the worldTangent input component
  67658. */
  67659. get worldTangent(): NodeMaterialConnectionPoint;
  67660. /**
  67661. * Gets the anisotropy object output component
  67662. */
  67663. get anisotropy(): NodeMaterialConnectionPoint;
  67664. private _generateTBNSpace;
  67665. /**
  67666. * Gets the main code of the block (fragment side)
  67667. * @param state current state of the node material building
  67668. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67669. * @returns the shader code
  67670. */
  67671. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67672. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67673. protected _buildBlock(state: NodeMaterialBuildState): this;
  67674. }
  67675. }
  67676. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67677. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67678. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67679. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67680. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67681. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67682. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67683. import { Nullable } from "babylonjs/types";
  67684. import { Mesh } from "babylonjs/Meshes/mesh";
  67685. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67686. import { Effect } from "babylonjs/Materials/effect";
  67687. /**
  67688. * Block used to implement the clear coat module of the PBR material
  67689. */
  67690. export class ClearCoatBlock extends NodeMaterialBlock {
  67691. private _scene;
  67692. /**
  67693. * Create a new ClearCoatBlock
  67694. * @param name defines the block name
  67695. */
  67696. constructor(name: string);
  67697. /**
  67698. * Initialize the block and prepare the context for build
  67699. * @param state defines the state that will be used for the build
  67700. */
  67701. initialize(state: NodeMaterialBuildState): void;
  67702. /**
  67703. * Gets the current class name
  67704. * @returns the class name
  67705. */
  67706. getClassName(): string;
  67707. /**
  67708. * Gets the intensity input component
  67709. */
  67710. get intensity(): NodeMaterialConnectionPoint;
  67711. /**
  67712. * Gets the roughness input component
  67713. */
  67714. get roughness(): NodeMaterialConnectionPoint;
  67715. /**
  67716. * Gets the ior input component
  67717. */
  67718. get ior(): NodeMaterialConnectionPoint;
  67719. /**
  67720. * Gets the texture input component
  67721. */
  67722. get texture(): NodeMaterialConnectionPoint;
  67723. /**
  67724. * Gets the bump texture input component
  67725. */
  67726. get bumpTexture(): NodeMaterialConnectionPoint;
  67727. /**
  67728. * Gets the uv input component
  67729. */
  67730. get uv(): NodeMaterialConnectionPoint;
  67731. /**
  67732. * Gets the tint color input component
  67733. */
  67734. get tintColor(): NodeMaterialConnectionPoint;
  67735. /**
  67736. * Gets the tint "at distance" input component
  67737. */
  67738. get tintAtDistance(): NodeMaterialConnectionPoint;
  67739. /**
  67740. * Gets the tint thickness input component
  67741. */
  67742. get tintThickness(): NodeMaterialConnectionPoint;
  67743. /**
  67744. * Gets the world tangent input component
  67745. */
  67746. get worldTangent(): NodeMaterialConnectionPoint;
  67747. /**
  67748. * Gets the clear coat object output component
  67749. */
  67750. get clearcoat(): NodeMaterialConnectionPoint;
  67751. autoConfigure(material: NodeMaterial): void;
  67752. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67753. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67754. private _generateTBNSpace;
  67755. /**
  67756. * Gets the main code of the block (fragment side)
  67757. * @param state current state of the node material building
  67758. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67759. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67760. * @param worldPosVarName name of the variable holding the world position
  67761. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67762. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67763. * @param worldNormalVarName name of the variable holding the world normal
  67764. * @returns the shader code
  67765. */
  67766. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67767. protected _buildBlock(state: NodeMaterialBuildState): this;
  67768. }
  67769. }
  67770. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67771. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67772. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67773. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67774. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67775. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67776. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67777. import { Nullable } from "babylonjs/types";
  67778. /**
  67779. * Block used to implement the sub surface module of the PBR material
  67780. */
  67781. export class SubSurfaceBlock extends NodeMaterialBlock {
  67782. /**
  67783. * Create a new SubSurfaceBlock
  67784. * @param name defines the block name
  67785. */
  67786. constructor(name: string);
  67787. /**
  67788. * Stores the intensity of the different subsurface effects in the thickness texture.
  67789. * * the green channel is the translucency intensity.
  67790. * * the blue channel is the scattering intensity.
  67791. * * the alpha channel is the refraction intensity.
  67792. */
  67793. useMaskFromThicknessTexture: boolean;
  67794. /**
  67795. * Initialize the block and prepare the context for build
  67796. * @param state defines the state that will be used for the build
  67797. */
  67798. initialize(state: NodeMaterialBuildState): void;
  67799. /**
  67800. * Gets the current class name
  67801. * @returns the class name
  67802. */
  67803. getClassName(): string;
  67804. /**
  67805. * Gets the min thickness input component
  67806. */
  67807. get minThickness(): NodeMaterialConnectionPoint;
  67808. /**
  67809. * Gets the max thickness input component
  67810. */
  67811. get maxThickness(): NodeMaterialConnectionPoint;
  67812. /**
  67813. * Gets the thickness texture component
  67814. */
  67815. get thicknessTexture(): NodeMaterialConnectionPoint;
  67816. /**
  67817. * Gets the tint color input component
  67818. */
  67819. get tintColor(): NodeMaterialConnectionPoint;
  67820. /**
  67821. * Gets the translucency intensity input component
  67822. */
  67823. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67824. /**
  67825. * Gets the translucency diffusion distance input component
  67826. */
  67827. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67828. /**
  67829. * Gets the refraction object parameters
  67830. */
  67831. get refraction(): NodeMaterialConnectionPoint;
  67832. /**
  67833. * Gets the sub surface object output component
  67834. */
  67835. get subsurface(): NodeMaterialConnectionPoint;
  67836. autoConfigure(material: NodeMaterial): void;
  67837. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67838. /**
  67839. * Gets the main code of the block (fragment side)
  67840. * @param state current state of the node material building
  67841. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67842. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67843. * @param worldPosVarName name of the variable holding the world position
  67844. * @returns the shader code
  67845. */
  67846. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67847. protected _buildBlock(state: NodeMaterialBuildState): this;
  67848. }
  67849. }
  67850. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67851. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67852. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67853. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67854. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67855. import { Light } from "babylonjs/Lights/light";
  67856. import { Nullable } from "babylonjs/types";
  67857. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67858. import { Effect } from "babylonjs/Materials/effect";
  67859. import { Mesh } from "babylonjs/Meshes/mesh";
  67860. import { Scene } from "babylonjs/scene";
  67861. /**
  67862. * Block used to implement the PBR metallic/roughness model
  67863. */
  67864. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67865. /**
  67866. * Gets or sets the light associated with this block
  67867. */
  67868. light: Nullable<Light>;
  67869. private _lightId;
  67870. private _scene;
  67871. private _environmentBRDFTexture;
  67872. private _environmentBrdfSamplerName;
  67873. private _vNormalWName;
  67874. private _invertNormalName;
  67875. /**
  67876. * Create a new ReflectionBlock
  67877. * @param name defines the block name
  67878. */
  67879. constructor(name: string);
  67880. /**
  67881. * Intensity of the direct lights e.g. the four lights available in your scene.
  67882. * This impacts both the direct diffuse and specular highlights.
  67883. */
  67884. directIntensity: number;
  67885. /**
  67886. * Intensity of the environment e.g. how much the environment will light the object
  67887. * either through harmonics for rough material or through the refelction for shiny ones.
  67888. */
  67889. environmentIntensity: number;
  67890. /**
  67891. * This is a special control allowing the reduction of the specular highlights coming from the
  67892. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67893. */
  67894. specularIntensity: number;
  67895. /**
  67896. * Defines the falloff type used in this material.
  67897. * It by default is Physical.
  67898. */
  67899. lightFalloff: number;
  67900. /**
  67901. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67902. */
  67903. useAlphaFromAlbedoTexture: boolean;
  67904. /**
  67905. * Specifies that alpha test should be used
  67906. */
  67907. useAlphaTest: boolean;
  67908. /**
  67909. * Defines the alpha limits in alpha test mode.
  67910. */
  67911. alphaTestCutoff: number;
  67912. /**
  67913. * Specifies that alpha blending should be used
  67914. */
  67915. useAlphaBlending: boolean;
  67916. /**
  67917. * Defines if the alpha value should be determined via the rgb values.
  67918. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67919. */
  67920. opacityRGB: boolean;
  67921. /**
  67922. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67923. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67924. */
  67925. useRadianceOverAlpha: boolean;
  67926. /**
  67927. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67928. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67929. */
  67930. useSpecularOverAlpha: boolean;
  67931. /**
  67932. * Enables specular anti aliasing in the PBR shader.
  67933. * It will both interacts on the Geometry for analytical and IBL lighting.
  67934. * It also prefilter the roughness map based on the bump values.
  67935. */
  67936. enableSpecularAntiAliasing: boolean;
  67937. /**
  67938. * Enables realtime filtering on the texture.
  67939. */
  67940. realTimeFiltering: boolean;
  67941. /**
  67942. * Quality switch for realtime filtering
  67943. */
  67944. realTimeFilteringQuality: number;
  67945. /**
  67946. * Defines if the material uses energy conservation.
  67947. */
  67948. useEnergyConservation: boolean;
  67949. /**
  67950. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  67951. * too much the area relying on ambient texture to define their ambient occlusion.
  67952. */
  67953. useRadianceOcclusion: boolean;
  67954. /**
  67955. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  67956. * makes the reflect vector face the model (under horizon).
  67957. */
  67958. useHorizonOcclusion: boolean;
  67959. /**
  67960. * If set to true, no lighting calculations will be applied.
  67961. */
  67962. unlit: boolean;
  67963. /**
  67964. * Force normal to face away from face.
  67965. */
  67966. forceNormalForward: boolean;
  67967. /**
  67968. * Defines the material debug mode.
  67969. * It helps seeing only some components of the material while troubleshooting.
  67970. */
  67971. debugMode: number;
  67972. /**
  67973. * Specify from where on screen the debug mode should start.
  67974. * The value goes from -1 (full screen) to 1 (not visible)
  67975. * It helps with side by side comparison against the final render
  67976. * This defaults to 0
  67977. */
  67978. debugLimit: number;
  67979. /**
  67980. * As the default viewing range might not be enough (if the ambient is really small for instance)
  67981. * You can use the factor to better multiply the final value.
  67982. */
  67983. debugFactor: number;
  67984. /**
  67985. * Initialize the block and prepare the context for build
  67986. * @param state defines the state that will be used for the build
  67987. */
  67988. initialize(state: NodeMaterialBuildState): void;
  67989. /**
  67990. * Gets the current class name
  67991. * @returns the class name
  67992. */
  67993. getClassName(): string;
  67994. /**
  67995. * Gets the world position input component
  67996. */
  67997. get worldPosition(): NodeMaterialConnectionPoint;
  67998. /**
  67999. * Gets the world normal input component
  68000. */
  68001. get worldNormal(): NodeMaterialConnectionPoint;
  68002. /**
  68003. * Gets the perturbed normal input component
  68004. */
  68005. get perturbedNormal(): NodeMaterialConnectionPoint;
  68006. /**
  68007. * Gets the camera position input component
  68008. */
  68009. get cameraPosition(): NodeMaterialConnectionPoint;
  68010. /**
  68011. * Gets the base color input component
  68012. */
  68013. get baseColor(): NodeMaterialConnectionPoint;
  68014. /**
  68015. * Gets the opacity texture input component
  68016. */
  68017. get opacityTexture(): NodeMaterialConnectionPoint;
  68018. /**
  68019. * Gets the ambient color input component
  68020. */
  68021. get ambientColor(): NodeMaterialConnectionPoint;
  68022. /**
  68023. * Gets the reflectivity object parameters
  68024. */
  68025. get reflectivity(): NodeMaterialConnectionPoint;
  68026. /**
  68027. * Gets the ambient occlusion object parameters
  68028. */
  68029. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68030. /**
  68031. * Gets the reflection object parameters
  68032. */
  68033. get reflection(): NodeMaterialConnectionPoint;
  68034. /**
  68035. * Gets the sheen object parameters
  68036. */
  68037. get sheen(): NodeMaterialConnectionPoint;
  68038. /**
  68039. * Gets the clear coat object parameters
  68040. */
  68041. get clearcoat(): NodeMaterialConnectionPoint;
  68042. /**
  68043. * Gets the sub surface object parameters
  68044. */
  68045. get subsurface(): NodeMaterialConnectionPoint;
  68046. /**
  68047. * Gets the anisotropy object parameters
  68048. */
  68049. get anisotropy(): NodeMaterialConnectionPoint;
  68050. /**
  68051. * Gets the ambient output component
  68052. */
  68053. get ambient(): NodeMaterialConnectionPoint;
  68054. /**
  68055. * Gets the diffuse output component
  68056. */
  68057. get diffuse(): NodeMaterialConnectionPoint;
  68058. /**
  68059. * Gets the specular output component
  68060. */
  68061. get specular(): NodeMaterialConnectionPoint;
  68062. /**
  68063. * Gets the sheen output component
  68064. */
  68065. get sheenDir(): NodeMaterialConnectionPoint;
  68066. /**
  68067. * Gets the clear coat output component
  68068. */
  68069. get clearcoatDir(): NodeMaterialConnectionPoint;
  68070. /**
  68071. * Gets the indirect diffuse output component
  68072. */
  68073. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68074. /**
  68075. * Gets the indirect specular output component
  68076. */
  68077. get specularIndirect(): NodeMaterialConnectionPoint;
  68078. /**
  68079. * Gets the indirect sheen output component
  68080. */
  68081. get sheenIndirect(): NodeMaterialConnectionPoint;
  68082. /**
  68083. * Gets the indirect clear coat output component
  68084. */
  68085. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68086. /**
  68087. * Gets the refraction output component
  68088. */
  68089. get refraction(): NodeMaterialConnectionPoint;
  68090. /**
  68091. * Gets the global lighting output component
  68092. */
  68093. get lighting(): NodeMaterialConnectionPoint;
  68094. /**
  68095. * Gets the shadow output component
  68096. */
  68097. get shadow(): NodeMaterialConnectionPoint;
  68098. /**
  68099. * Gets the alpha output component
  68100. */
  68101. get alpha(): NodeMaterialConnectionPoint;
  68102. autoConfigure(material: NodeMaterial): void;
  68103. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68104. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68105. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68106. private _injectVertexCode;
  68107. /**
  68108. * Gets the code corresponding to the albedo/opacity module
  68109. * @returns the shader code
  68110. */
  68111. getAlbedoOpacityCode(): string;
  68112. protected _buildBlock(state: NodeMaterialBuildState): this;
  68113. protected _dumpPropertiesCode(): string;
  68114. serialize(): any;
  68115. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68116. }
  68117. }
  68118. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68119. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68120. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68121. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68122. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68123. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68124. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68125. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68126. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68127. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68128. }
  68129. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68130. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68131. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68132. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68133. }
  68134. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68135. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68136. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68137. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68138. /**
  68139. * Block used to compute value of one parameter modulo another
  68140. */
  68141. export class ModBlock extends NodeMaterialBlock {
  68142. /**
  68143. * Creates a new ModBlock
  68144. * @param name defines the block name
  68145. */
  68146. constructor(name: string);
  68147. /**
  68148. * Gets the current class name
  68149. * @returns the class name
  68150. */
  68151. getClassName(): string;
  68152. /**
  68153. * Gets the left operand input component
  68154. */
  68155. get left(): NodeMaterialConnectionPoint;
  68156. /**
  68157. * Gets the right operand input component
  68158. */
  68159. get right(): NodeMaterialConnectionPoint;
  68160. /**
  68161. * Gets the output component
  68162. */
  68163. get output(): NodeMaterialConnectionPoint;
  68164. protected _buildBlock(state: NodeMaterialBuildState): this;
  68165. }
  68166. }
  68167. declare module "babylonjs/Materials/Node/Blocks/index" {
  68168. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68169. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68170. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68171. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68172. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68173. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68174. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68175. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68176. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68177. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68178. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68179. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68180. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68181. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68182. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68183. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68184. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68185. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68186. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68187. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68188. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68189. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68190. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68191. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68192. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68193. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68194. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68195. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68196. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68197. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68198. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68199. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68200. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68201. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68202. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68203. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68204. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68205. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68206. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68207. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68208. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68209. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68210. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68211. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68212. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68213. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68214. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68215. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68216. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68217. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68218. }
  68219. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68220. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68221. }
  68222. declare module "babylonjs/Materials/Node/index" {
  68223. export * from "babylonjs/Materials/Node/Enums/index";
  68224. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68225. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68226. export * from "babylonjs/Materials/Node/nodeMaterial";
  68227. export * from "babylonjs/Materials/Node/Blocks/index";
  68228. export * from "babylonjs/Materials/Node/Optimizers/index";
  68229. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68230. }
  68231. declare module "babylonjs/Materials/index" {
  68232. export * from "babylonjs/Materials/Background/index";
  68233. export * from "babylonjs/Materials/colorCurves";
  68234. export * from "babylonjs/Materials/iEffectFallbacks";
  68235. export * from "babylonjs/Materials/effectFallbacks";
  68236. export * from "babylonjs/Materials/effect";
  68237. export * from "babylonjs/Materials/fresnelParameters";
  68238. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68239. export * from "babylonjs/Materials/material";
  68240. export * from "babylonjs/Materials/materialDefines";
  68241. export * from "babylonjs/Materials/thinMaterialHelper";
  68242. export * from "babylonjs/Materials/materialHelper";
  68243. export * from "babylonjs/Materials/multiMaterial";
  68244. export * from "babylonjs/Materials/PBR/index";
  68245. export * from "babylonjs/Materials/pushMaterial";
  68246. export * from "babylonjs/Materials/shaderMaterial";
  68247. export * from "babylonjs/Materials/standardMaterial";
  68248. export * from "babylonjs/Materials/Textures/index";
  68249. export * from "babylonjs/Materials/uniformBuffer";
  68250. export * from "babylonjs/Materials/materialFlags";
  68251. export * from "babylonjs/Materials/Node/index";
  68252. export * from "babylonjs/Materials/effectRenderer";
  68253. export * from "babylonjs/Materials/shadowDepthWrapper";
  68254. }
  68255. declare module "babylonjs/Maths/index" {
  68256. export * from "babylonjs/Maths/math.scalar";
  68257. export * from "babylonjs/Maths/math";
  68258. export * from "babylonjs/Maths/sphericalPolynomial";
  68259. }
  68260. declare module "babylonjs/Misc/workerPool" {
  68261. import { IDisposable } from "babylonjs/scene";
  68262. /**
  68263. * Helper class to push actions to a pool of workers.
  68264. */
  68265. export class WorkerPool implements IDisposable {
  68266. private _workerInfos;
  68267. private _pendingActions;
  68268. /**
  68269. * Constructor
  68270. * @param workers Array of workers to use for actions
  68271. */
  68272. constructor(workers: Array<Worker>);
  68273. /**
  68274. * Terminates all workers and clears any pending actions.
  68275. */
  68276. dispose(): void;
  68277. /**
  68278. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68279. * pended until a worker has completed its action.
  68280. * @param action The action to perform. Call onComplete when the action is complete.
  68281. */
  68282. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68283. private _execute;
  68284. }
  68285. }
  68286. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68287. import { IDisposable } from "babylonjs/scene";
  68288. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68289. /**
  68290. * Configuration for Draco compression
  68291. */
  68292. export interface IDracoCompressionConfiguration {
  68293. /**
  68294. * Configuration for the decoder.
  68295. */
  68296. decoder: {
  68297. /**
  68298. * The url to the WebAssembly module.
  68299. */
  68300. wasmUrl?: string;
  68301. /**
  68302. * The url to the WebAssembly binary.
  68303. */
  68304. wasmBinaryUrl?: string;
  68305. /**
  68306. * The url to the fallback JavaScript module.
  68307. */
  68308. fallbackUrl?: string;
  68309. };
  68310. }
  68311. /**
  68312. * Draco compression (https://google.github.io/draco/)
  68313. *
  68314. * This class wraps the Draco module.
  68315. *
  68316. * **Encoder**
  68317. *
  68318. * The encoder is not currently implemented.
  68319. *
  68320. * **Decoder**
  68321. *
  68322. * 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.
  68323. *
  68324. * To update the configuration, use the following code:
  68325. * ```javascript
  68326. * DracoCompression.Configuration = {
  68327. * decoder: {
  68328. * wasmUrl: "<url to the WebAssembly library>",
  68329. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68330. * fallbackUrl: "<url to the fallback JavaScript library>",
  68331. * }
  68332. * };
  68333. * ```
  68334. *
  68335. * 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.
  68336. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68337. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68338. *
  68339. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68340. * ```javascript
  68341. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68342. * ```
  68343. *
  68344. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68345. */
  68346. export class DracoCompression implements IDisposable {
  68347. private _workerPoolPromise?;
  68348. private _decoderModulePromise?;
  68349. /**
  68350. * The configuration. Defaults to the following urls:
  68351. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68352. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68353. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68354. */
  68355. static Configuration: IDracoCompressionConfiguration;
  68356. /**
  68357. * Returns true if the decoder configuration is available.
  68358. */
  68359. static get DecoderAvailable(): boolean;
  68360. /**
  68361. * Default number of workers to create when creating the draco compression object.
  68362. */
  68363. static DefaultNumWorkers: number;
  68364. private static GetDefaultNumWorkers;
  68365. private static _Default;
  68366. /**
  68367. * Default instance for the draco compression object.
  68368. */
  68369. static get Default(): DracoCompression;
  68370. /**
  68371. * Constructor
  68372. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68373. */
  68374. constructor(numWorkers?: number);
  68375. /**
  68376. * Stop all async operations and release resources.
  68377. */
  68378. dispose(): void;
  68379. /**
  68380. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68381. * @returns a promise that resolves when ready
  68382. */
  68383. whenReadyAsync(): Promise<void>;
  68384. /**
  68385. * Decode Draco compressed mesh data to vertex data.
  68386. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68387. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68388. * @returns A promise that resolves with the decoded vertex data
  68389. */
  68390. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68391. [kind: string]: number;
  68392. }): Promise<VertexData>;
  68393. }
  68394. }
  68395. declare module "babylonjs/Meshes/Compression/index" {
  68396. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68397. }
  68398. declare module "babylonjs/Meshes/csg" {
  68399. import { Nullable } from "babylonjs/types";
  68400. import { Scene } from "babylonjs/scene";
  68401. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68402. import { Mesh } from "babylonjs/Meshes/mesh";
  68403. import { Material } from "babylonjs/Materials/material";
  68404. /**
  68405. * Class for building Constructive Solid Geometry
  68406. */
  68407. export class CSG {
  68408. private polygons;
  68409. /**
  68410. * The world matrix
  68411. */
  68412. matrix: Matrix;
  68413. /**
  68414. * Stores the position
  68415. */
  68416. position: Vector3;
  68417. /**
  68418. * Stores the rotation
  68419. */
  68420. rotation: Vector3;
  68421. /**
  68422. * Stores the rotation quaternion
  68423. */
  68424. rotationQuaternion: Nullable<Quaternion>;
  68425. /**
  68426. * Stores the scaling vector
  68427. */
  68428. scaling: Vector3;
  68429. /**
  68430. * Convert the Mesh to CSG
  68431. * @param mesh The Mesh to convert to CSG
  68432. * @returns A new CSG from the Mesh
  68433. */
  68434. static FromMesh(mesh: Mesh): CSG;
  68435. /**
  68436. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68437. * @param polygons Polygons used to construct a CSG solid
  68438. */
  68439. private static FromPolygons;
  68440. /**
  68441. * Clones, or makes a deep copy, of the CSG
  68442. * @returns A new CSG
  68443. */
  68444. clone(): CSG;
  68445. /**
  68446. * Unions this CSG with another CSG
  68447. * @param csg The CSG to union against this CSG
  68448. * @returns The unioned CSG
  68449. */
  68450. union(csg: CSG): CSG;
  68451. /**
  68452. * Unions this CSG with another CSG in place
  68453. * @param csg The CSG to union against this CSG
  68454. */
  68455. unionInPlace(csg: CSG): void;
  68456. /**
  68457. * Subtracts this CSG with another CSG
  68458. * @param csg The CSG to subtract against this CSG
  68459. * @returns A new CSG
  68460. */
  68461. subtract(csg: CSG): CSG;
  68462. /**
  68463. * Subtracts this CSG with another CSG in place
  68464. * @param csg The CSG to subtact against this CSG
  68465. */
  68466. subtractInPlace(csg: CSG): void;
  68467. /**
  68468. * Intersect this CSG with another CSG
  68469. * @param csg The CSG to intersect against this CSG
  68470. * @returns A new CSG
  68471. */
  68472. intersect(csg: CSG): CSG;
  68473. /**
  68474. * Intersects this CSG with another CSG in place
  68475. * @param csg The CSG to intersect against this CSG
  68476. */
  68477. intersectInPlace(csg: CSG): void;
  68478. /**
  68479. * Return a new CSG solid with solid and empty space switched. This solid is
  68480. * not modified.
  68481. * @returns A new CSG solid with solid and empty space switched
  68482. */
  68483. inverse(): CSG;
  68484. /**
  68485. * Inverses the CSG in place
  68486. */
  68487. inverseInPlace(): void;
  68488. /**
  68489. * This is used to keep meshes transformations so they can be restored
  68490. * when we build back a Babylon Mesh
  68491. * NB : All CSG operations are performed in world coordinates
  68492. * @param csg The CSG to copy the transform attributes from
  68493. * @returns This CSG
  68494. */
  68495. copyTransformAttributes(csg: CSG): CSG;
  68496. /**
  68497. * Build Raw mesh from CSG
  68498. * Coordinates here are in world space
  68499. * @param name The name of the mesh geometry
  68500. * @param scene The Scene
  68501. * @param keepSubMeshes Specifies if the submeshes should be kept
  68502. * @returns A new Mesh
  68503. */
  68504. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68505. /**
  68506. * Build Mesh from CSG taking material and transforms into account
  68507. * @param name The name of the Mesh
  68508. * @param material The material of the Mesh
  68509. * @param scene The Scene
  68510. * @param keepSubMeshes Specifies if submeshes should be kept
  68511. * @returns The new Mesh
  68512. */
  68513. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68514. }
  68515. }
  68516. declare module "babylonjs/Meshes/trailMesh" {
  68517. import { Mesh } from "babylonjs/Meshes/mesh";
  68518. import { Scene } from "babylonjs/scene";
  68519. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68520. /**
  68521. * Class used to create a trail following a mesh
  68522. */
  68523. export class TrailMesh extends Mesh {
  68524. private _generator;
  68525. private _autoStart;
  68526. private _running;
  68527. private _diameter;
  68528. private _length;
  68529. private _sectionPolygonPointsCount;
  68530. private _sectionVectors;
  68531. private _sectionNormalVectors;
  68532. private _beforeRenderObserver;
  68533. /**
  68534. * @constructor
  68535. * @param name The value used by scene.getMeshByName() to do a lookup.
  68536. * @param generator The mesh or transform node to generate a trail.
  68537. * @param scene The scene to add this mesh to.
  68538. * @param diameter Diameter of trailing mesh. Default is 1.
  68539. * @param length Length of trailing mesh. Default is 60.
  68540. * @param autoStart Automatically start trailing mesh. Default true.
  68541. */
  68542. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68543. /**
  68544. * "TrailMesh"
  68545. * @returns "TrailMesh"
  68546. */
  68547. getClassName(): string;
  68548. private _createMesh;
  68549. /**
  68550. * Start trailing mesh.
  68551. */
  68552. start(): void;
  68553. /**
  68554. * Stop trailing mesh.
  68555. */
  68556. stop(): void;
  68557. /**
  68558. * Update trailing mesh geometry.
  68559. */
  68560. update(): void;
  68561. /**
  68562. * Returns a new TrailMesh object.
  68563. * @param name is a string, the name given to the new mesh
  68564. * @param newGenerator use new generator object for cloned trail mesh
  68565. * @returns a new mesh
  68566. */
  68567. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68568. /**
  68569. * Serializes this trail mesh
  68570. * @param serializationObject object to write serialization to
  68571. */
  68572. serialize(serializationObject: any): void;
  68573. /**
  68574. * Parses a serialized trail mesh
  68575. * @param parsedMesh the serialized mesh
  68576. * @param scene the scene to create the trail mesh in
  68577. * @returns the created trail mesh
  68578. */
  68579. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68580. }
  68581. }
  68582. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68583. import { Nullable } from "babylonjs/types";
  68584. import { Scene } from "babylonjs/scene";
  68585. import { Vector4 } from "babylonjs/Maths/math.vector";
  68586. import { Color4 } from "babylonjs/Maths/math.color";
  68587. import { Mesh } from "babylonjs/Meshes/mesh";
  68588. /**
  68589. * Class containing static functions to help procedurally build meshes
  68590. */
  68591. export class TiledBoxBuilder {
  68592. /**
  68593. * Creates a box mesh
  68594. * 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)
  68595. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68596. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68597. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68598. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68599. * @param name defines the name of the mesh
  68600. * @param options defines the options used to create the mesh
  68601. * @param scene defines the hosting scene
  68602. * @returns the box mesh
  68603. */
  68604. static CreateTiledBox(name: string, options: {
  68605. pattern?: number;
  68606. width?: number;
  68607. height?: number;
  68608. depth?: number;
  68609. tileSize?: number;
  68610. tileWidth?: number;
  68611. tileHeight?: number;
  68612. alignHorizontal?: number;
  68613. alignVertical?: number;
  68614. faceUV?: Vector4[];
  68615. faceColors?: Color4[];
  68616. sideOrientation?: number;
  68617. updatable?: boolean;
  68618. }, scene?: Nullable<Scene>): Mesh;
  68619. }
  68620. }
  68621. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68622. import { Vector4 } from "babylonjs/Maths/math.vector";
  68623. import { Mesh } from "babylonjs/Meshes/mesh";
  68624. /**
  68625. * Class containing static functions to help procedurally build meshes
  68626. */
  68627. export class TorusKnotBuilder {
  68628. /**
  68629. * Creates a torus knot mesh
  68630. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68631. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68632. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68633. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68634. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68635. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68636. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68637. * @param name defines the name of the mesh
  68638. * @param options defines the options used to create the mesh
  68639. * @param scene defines the hosting scene
  68640. * @returns the torus knot mesh
  68641. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68642. */
  68643. static CreateTorusKnot(name: string, options: {
  68644. radius?: number;
  68645. tube?: number;
  68646. radialSegments?: number;
  68647. tubularSegments?: number;
  68648. p?: number;
  68649. q?: number;
  68650. updatable?: boolean;
  68651. sideOrientation?: number;
  68652. frontUVs?: Vector4;
  68653. backUVs?: Vector4;
  68654. }, scene: any): Mesh;
  68655. }
  68656. }
  68657. declare module "babylonjs/Meshes/polygonMesh" {
  68658. import { Scene } from "babylonjs/scene";
  68659. import { Vector2 } from "babylonjs/Maths/math.vector";
  68660. import { Mesh } from "babylonjs/Meshes/mesh";
  68661. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68662. import { Path2 } from "babylonjs/Maths/math.path";
  68663. /**
  68664. * Polygon
  68665. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68666. */
  68667. export class Polygon {
  68668. /**
  68669. * Creates a rectangle
  68670. * @param xmin bottom X coord
  68671. * @param ymin bottom Y coord
  68672. * @param xmax top X coord
  68673. * @param ymax top Y coord
  68674. * @returns points that make the resulting rectation
  68675. */
  68676. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68677. /**
  68678. * Creates a circle
  68679. * @param radius radius of circle
  68680. * @param cx scale in x
  68681. * @param cy scale in y
  68682. * @param numberOfSides number of sides that make up the circle
  68683. * @returns points that make the resulting circle
  68684. */
  68685. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68686. /**
  68687. * Creates a polygon from input string
  68688. * @param input Input polygon data
  68689. * @returns the parsed points
  68690. */
  68691. static Parse(input: string): Vector2[];
  68692. /**
  68693. * Starts building a polygon from x and y coordinates
  68694. * @param x x coordinate
  68695. * @param y y coordinate
  68696. * @returns the started path2
  68697. */
  68698. static StartingAt(x: number, y: number): Path2;
  68699. }
  68700. /**
  68701. * Builds a polygon
  68702. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68703. */
  68704. export class PolygonMeshBuilder {
  68705. private _points;
  68706. private _outlinepoints;
  68707. private _holes;
  68708. private _name;
  68709. private _scene;
  68710. private _epoints;
  68711. private _eholes;
  68712. private _addToepoint;
  68713. /**
  68714. * Babylon reference to the earcut plugin.
  68715. */
  68716. bjsEarcut: any;
  68717. /**
  68718. * Creates a PolygonMeshBuilder
  68719. * @param name name of the builder
  68720. * @param contours Path of the polygon
  68721. * @param scene scene to add to when creating the mesh
  68722. * @param earcutInjection can be used to inject your own earcut reference
  68723. */
  68724. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68725. /**
  68726. * Adds a whole within the polygon
  68727. * @param hole Array of points defining the hole
  68728. * @returns this
  68729. */
  68730. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68731. /**
  68732. * Creates the polygon
  68733. * @param updatable If the mesh should be updatable
  68734. * @param depth The depth of the mesh created
  68735. * @returns the created mesh
  68736. */
  68737. build(updatable?: boolean, depth?: number): Mesh;
  68738. /**
  68739. * Creates the polygon
  68740. * @param depth The depth of the mesh created
  68741. * @returns the created VertexData
  68742. */
  68743. buildVertexData(depth?: number): VertexData;
  68744. /**
  68745. * Adds a side to the polygon
  68746. * @param positions points that make the polygon
  68747. * @param normals normals of the polygon
  68748. * @param uvs uvs of the polygon
  68749. * @param indices indices of the polygon
  68750. * @param bounds bounds of the polygon
  68751. * @param points points of the polygon
  68752. * @param depth depth of the polygon
  68753. * @param flip flip of the polygon
  68754. */
  68755. private addSide;
  68756. }
  68757. }
  68758. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68759. import { Scene } from "babylonjs/scene";
  68760. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68761. import { Color4 } from "babylonjs/Maths/math.color";
  68762. import { Mesh } from "babylonjs/Meshes/mesh";
  68763. import { Nullable } from "babylonjs/types";
  68764. /**
  68765. * Class containing static functions to help procedurally build meshes
  68766. */
  68767. export class PolygonBuilder {
  68768. /**
  68769. * Creates a polygon mesh
  68770. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68771. * * 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
  68772. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68773. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68774. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68775. * * Remember you can only change the shape positions, not their number when updating a polygon
  68776. * @param name defines the name of the mesh
  68777. * @param options defines the options used to create the mesh
  68778. * @param scene defines the hosting scene
  68779. * @param earcutInjection can be used to inject your own earcut reference
  68780. * @returns the polygon mesh
  68781. */
  68782. static CreatePolygon(name: string, options: {
  68783. shape: Vector3[];
  68784. holes?: Vector3[][];
  68785. depth?: number;
  68786. faceUV?: Vector4[];
  68787. faceColors?: Color4[];
  68788. updatable?: boolean;
  68789. sideOrientation?: number;
  68790. frontUVs?: Vector4;
  68791. backUVs?: Vector4;
  68792. wrap?: boolean;
  68793. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68794. /**
  68795. * Creates an extruded polygon mesh, with depth in the Y direction.
  68796. * * 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)
  68797. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68798. * @param name defines the name of the mesh
  68799. * @param options defines the options used to create the mesh
  68800. * @param scene defines the hosting scene
  68801. * @param earcutInjection can be used to inject your own earcut reference
  68802. * @returns the polygon mesh
  68803. */
  68804. static ExtrudePolygon(name: string, options: {
  68805. shape: Vector3[];
  68806. holes?: Vector3[][];
  68807. depth?: number;
  68808. faceUV?: Vector4[];
  68809. faceColors?: Color4[];
  68810. updatable?: boolean;
  68811. sideOrientation?: number;
  68812. frontUVs?: Vector4;
  68813. backUVs?: Vector4;
  68814. wrap?: boolean;
  68815. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68816. }
  68817. }
  68818. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68819. import { Scene } from "babylonjs/scene";
  68820. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68821. import { Mesh } from "babylonjs/Meshes/mesh";
  68822. import { Nullable } from "babylonjs/types";
  68823. /**
  68824. * Class containing static functions to help procedurally build meshes
  68825. */
  68826. export class LatheBuilder {
  68827. /**
  68828. * Creates lathe mesh.
  68829. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68830. * * 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
  68831. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68832. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68833. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68834. * * 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
  68835. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68836. * * 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
  68837. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68838. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68839. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68840. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68841. * @param name defines the name of the mesh
  68842. * @param options defines the options used to create the mesh
  68843. * @param scene defines the hosting scene
  68844. * @returns the lathe mesh
  68845. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68846. */
  68847. static CreateLathe(name: string, options: {
  68848. shape: Vector3[];
  68849. radius?: number;
  68850. tessellation?: number;
  68851. clip?: number;
  68852. arc?: number;
  68853. closed?: boolean;
  68854. updatable?: boolean;
  68855. sideOrientation?: number;
  68856. frontUVs?: Vector4;
  68857. backUVs?: Vector4;
  68858. cap?: number;
  68859. invertUV?: boolean;
  68860. }, scene?: Nullable<Scene>): Mesh;
  68861. }
  68862. }
  68863. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68864. import { Nullable } from "babylonjs/types";
  68865. import { Scene } from "babylonjs/scene";
  68866. import { Vector4 } from "babylonjs/Maths/math.vector";
  68867. import { Mesh } from "babylonjs/Meshes/mesh";
  68868. /**
  68869. * Class containing static functions to help procedurally build meshes
  68870. */
  68871. export class TiledPlaneBuilder {
  68872. /**
  68873. * Creates a tiled plane mesh
  68874. * * The parameter `pattern` will, depending on value, do nothing or
  68875. * * * flip (reflect about central vertical) alternate tiles across and up
  68876. * * * flip every tile on alternate rows
  68877. * * * rotate (180 degs) alternate tiles across and up
  68878. * * * rotate every tile on alternate rows
  68879. * * * flip and rotate alternate tiles across and up
  68880. * * * flip and rotate every tile on alternate rows
  68881. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68882. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68883. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68884. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68885. * * 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)
  68886. * * 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)
  68887. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68888. * @param name defines the name of the mesh
  68889. * @param options defines the options used to create the mesh
  68890. * @param scene defines the hosting scene
  68891. * @returns the box mesh
  68892. */
  68893. static CreateTiledPlane(name: string, options: {
  68894. pattern?: number;
  68895. tileSize?: number;
  68896. tileWidth?: number;
  68897. tileHeight?: number;
  68898. size?: number;
  68899. width?: number;
  68900. height?: number;
  68901. alignHorizontal?: number;
  68902. alignVertical?: number;
  68903. sideOrientation?: number;
  68904. frontUVs?: Vector4;
  68905. backUVs?: Vector4;
  68906. updatable?: boolean;
  68907. }, scene?: Nullable<Scene>): Mesh;
  68908. }
  68909. }
  68910. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68911. import { Nullable } from "babylonjs/types";
  68912. import { Scene } from "babylonjs/scene";
  68913. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68914. import { Mesh } from "babylonjs/Meshes/mesh";
  68915. /**
  68916. * Class containing static functions to help procedurally build meshes
  68917. */
  68918. export class TubeBuilder {
  68919. /**
  68920. * Creates a tube mesh.
  68921. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68922. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68923. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68924. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68925. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68926. * * 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)
  68927. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68928. * * 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
  68929. * * 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
  68930. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68931. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68932. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68933. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68934. * @param name defines the name of the mesh
  68935. * @param options defines the options used to create the mesh
  68936. * @param scene defines the hosting scene
  68937. * @returns the tube mesh
  68938. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68939. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  68940. */
  68941. static CreateTube(name: string, options: {
  68942. path: Vector3[];
  68943. radius?: number;
  68944. tessellation?: number;
  68945. radiusFunction?: {
  68946. (i: number, distance: number): number;
  68947. };
  68948. cap?: number;
  68949. arc?: number;
  68950. updatable?: boolean;
  68951. sideOrientation?: number;
  68952. frontUVs?: Vector4;
  68953. backUVs?: Vector4;
  68954. instance?: Mesh;
  68955. invertUV?: boolean;
  68956. }, scene?: Nullable<Scene>): Mesh;
  68957. }
  68958. }
  68959. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  68960. import { Scene } from "babylonjs/scene";
  68961. import { Vector4 } from "babylonjs/Maths/math.vector";
  68962. import { Mesh } from "babylonjs/Meshes/mesh";
  68963. import { Nullable } from "babylonjs/types";
  68964. /**
  68965. * Class containing static functions to help procedurally build meshes
  68966. */
  68967. export class IcoSphereBuilder {
  68968. /**
  68969. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  68970. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  68971. * * 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`)
  68972. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  68973. * * 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
  68974. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68975. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68976. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68977. * @param name defines the name of the mesh
  68978. * @param options defines the options used to create the mesh
  68979. * @param scene defines the hosting scene
  68980. * @returns the icosahedron mesh
  68981. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  68982. */
  68983. static CreateIcoSphere(name: string, options: {
  68984. radius?: number;
  68985. radiusX?: number;
  68986. radiusY?: number;
  68987. radiusZ?: number;
  68988. flat?: boolean;
  68989. subdivisions?: number;
  68990. sideOrientation?: number;
  68991. frontUVs?: Vector4;
  68992. backUVs?: Vector4;
  68993. updatable?: boolean;
  68994. }, scene?: Nullable<Scene>): Mesh;
  68995. }
  68996. }
  68997. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  68998. import { Vector3 } from "babylonjs/Maths/math.vector";
  68999. import { Mesh } from "babylonjs/Meshes/mesh";
  69000. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69001. /**
  69002. * Class containing static functions to help procedurally build meshes
  69003. */
  69004. export class DecalBuilder {
  69005. /**
  69006. * Creates a decal mesh.
  69007. * 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
  69008. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69009. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69010. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69011. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69012. * @param name defines the name of the mesh
  69013. * @param sourceMesh defines the mesh where the decal must be applied
  69014. * @param options defines the options used to create the mesh
  69015. * @param scene defines the hosting scene
  69016. * @returns the decal mesh
  69017. * @see https://doc.babylonjs.com/how_to/decals
  69018. */
  69019. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69020. position?: Vector3;
  69021. normal?: Vector3;
  69022. size?: Vector3;
  69023. angle?: number;
  69024. }): Mesh;
  69025. }
  69026. }
  69027. declare module "babylonjs/Meshes/meshBuilder" {
  69028. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69029. import { Nullable } from "babylonjs/types";
  69030. import { Scene } from "babylonjs/scene";
  69031. import { Mesh } from "babylonjs/Meshes/mesh";
  69032. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69033. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69034. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69035. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69036. import { Plane } from "babylonjs/Maths/math.plane";
  69037. /**
  69038. * Class containing static functions to help procedurally build meshes
  69039. */
  69040. export class MeshBuilder {
  69041. /**
  69042. * Creates a box mesh
  69043. * * The parameter `size` sets the size (float) of each box side (default 1)
  69044. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69045. * * 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)
  69046. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69047. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69048. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69049. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69050. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69051. * @param name defines the name of the mesh
  69052. * @param options defines the options used to create the mesh
  69053. * @param scene defines the hosting scene
  69054. * @returns the box mesh
  69055. */
  69056. static CreateBox(name: string, options: {
  69057. size?: number;
  69058. width?: number;
  69059. height?: number;
  69060. depth?: number;
  69061. faceUV?: Vector4[];
  69062. faceColors?: Color4[];
  69063. sideOrientation?: number;
  69064. frontUVs?: Vector4;
  69065. backUVs?: Vector4;
  69066. wrap?: boolean;
  69067. topBaseAt?: number;
  69068. bottomBaseAt?: number;
  69069. updatable?: boolean;
  69070. }, scene?: Nullable<Scene>): Mesh;
  69071. /**
  69072. * Creates a tiled box mesh
  69073. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69074. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69075. * @param name defines the name of the mesh
  69076. * @param options defines the options used to create the mesh
  69077. * @param scene defines the hosting scene
  69078. * @returns the tiled box mesh
  69079. */
  69080. static CreateTiledBox(name: string, options: {
  69081. pattern?: number;
  69082. size?: number;
  69083. width?: number;
  69084. height?: number;
  69085. depth: number;
  69086. tileSize?: number;
  69087. tileWidth?: number;
  69088. tileHeight?: number;
  69089. faceUV?: Vector4[];
  69090. faceColors?: Color4[];
  69091. alignHorizontal?: number;
  69092. alignVertical?: number;
  69093. sideOrientation?: number;
  69094. updatable?: boolean;
  69095. }, scene?: Nullable<Scene>): Mesh;
  69096. /**
  69097. * Creates a sphere mesh
  69098. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69099. * * 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`)
  69100. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69101. * * 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
  69102. * * 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)
  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 mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69106. * @param name defines the name of the mesh
  69107. * @param options defines the options used to create the mesh
  69108. * @param scene defines the hosting scene
  69109. * @returns the sphere mesh
  69110. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69111. */
  69112. static CreateSphere(name: string, options: {
  69113. segments?: number;
  69114. diameter?: number;
  69115. diameterX?: number;
  69116. diameterY?: number;
  69117. diameterZ?: number;
  69118. arc?: number;
  69119. slice?: number;
  69120. sideOrientation?: number;
  69121. frontUVs?: Vector4;
  69122. backUVs?: Vector4;
  69123. updatable?: boolean;
  69124. }, scene?: Nullable<Scene>): Mesh;
  69125. /**
  69126. * Creates a plane polygonal mesh. By default, this is a disc
  69127. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69128. * * 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
  69129. * * 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
  69130. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69131. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69132. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69133. * @param name defines the name of the mesh
  69134. * @param options defines the options used to create the mesh
  69135. * @param scene defines the hosting scene
  69136. * @returns the plane polygonal mesh
  69137. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69138. */
  69139. static CreateDisc(name: string, options: {
  69140. radius?: number;
  69141. tessellation?: number;
  69142. arc?: number;
  69143. updatable?: boolean;
  69144. sideOrientation?: number;
  69145. frontUVs?: Vector4;
  69146. backUVs?: Vector4;
  69147. }, scene?: Nullable<Scene>): Mesh;
  69148. /**
  69149. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69150. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69151. * * 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`)
  69152. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69153. * * 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
  69154. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69155. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69156. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69157. * @param name defines the name of the mesh
  69158. * @param options defines the options used to create the mesh
  69159. * @param scene defines the hosting scene
  69160. * @returns the icosahedron mesh
  69161. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69162. */
  69163. static CreateIcoSphere(name: string, options: {
  69164. radius?: number;
  69165. radiusX?: number;
  69166. radiusY?: number;
  69167. radiusZ?: number;
  69168. flat?: boolean;
  69169. subdivisions?: number;
  69170. sideOrientation?: number;
  69171. frontUVs?: Vector4;
  69172. backUVs?: Vector4;
  69173. updatable?: boolean;
  69174. }, scene?: Nullable<Scene>): Mesh;
  69175. /**
  69176. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69177. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69178. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69179. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69180. * * 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
  69181. * * 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
  69182. * * 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
  69183. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69184. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69185. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69186. * * 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
  69187. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69188. * * 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
  69189. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69190. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69191. * @param name defines the name of the mesh
  69192. * @param options defines the options used to create the mesh
  69193. * @param scene defines the hosting scene
  69194. * @returns the ribbon mesh
  69195. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69196. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69197. */
  69198. static CreateRibbon(name: string, options: {
  69199. pathArray: Vector3[][];
  69200. closeArray?: boolean;
  69201. closePath?: boolean;
  69202. offset?: number;
  69203. updatable?: boolean;
  69204. sideOrientation?: number;
  69205. frontUVs?: Vector4;
  69206. backUVs?: Vector4;
  69207. instance?: Mesh;
  69208. invertUV?: boolean;
  69209. uvs?: Vector2[];
  69210. colors?: Color4[];
  69211. }, scene?: Nullable<Scene>): Mesh;
  69212. /**
  69213. * Creates a cylinder or a cone mesh
  69214. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69215. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69216. * * 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.
  69217. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69218. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69219. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69220. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69221. * * 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).
  69222. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69223. * * 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).
  69224. * * 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
  69225. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69226. * * 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
  69227. * * 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.
  69228. * * If `enclose` is false, a ring surface is one element.
  69229. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69230. * * 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
  69231. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69232. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69233. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69234. * @param name defines the name of the mesh
  69235. * @param options defines the options used to create the mesh
  69236. * @param scene defines the hosting scene
  69237. * @returns the cylinder mesh
  69238. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69239. */
  69240. static CreateCylinder(name: string, options: {
  69241. height?: number;
  69242. diameterTop?: number;
  69243. diameterBottom?: number;
  69244. diameter?: number;
  69245. tessellation?: number;
  69246. subdivisions?: number;
  69247. arc?: number;
  69248. faceColors?: Color4[];
  69249. faceUV?: Vector4[];
  69250. updatable?: boolean;
  69251. hasRings?: boolean;
  69252. enclose?: boolean;
  69253. cap?: number;
  69254. sideOrientation?: number;
  69255. frontUVs?: Vector4;
  69256. backUVs?: Vector4;
  69257. }, scene?: Nullable<Scene>): Mesh;
  69258. /**
  69259. * Creates a torus mesh
  69260. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69261. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69262. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69263. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69264. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69265. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69266. * @param name defines the name of the mesh
  69267. * @param options defines the options used to create the mesh
  69268. * @param scene defines the hosting scene
  69269. * @returns the torus mesh
  69270. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69271. */
  69272. static CreateTorus(name: string, options: {
  69273. diameter?: number;
  69274. thickness?: number;
  69275. tessellation?: number;
  69276. updatable?: boolean;
  69277. sideOrientation?: number;
  69278. frontUVs?: Vector4;
  69279. backUVs?: Vector4;
  69280. }, scene?: Nullable<Scene>): Mesh;
  69281. /**
  69282. * Creates a torus knot mesh
  69283. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69284. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69285. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69286. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69287. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69288. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69289. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69290. * @param name defines the name of the mesh
  69291. * @param options defines the options used to create the mesh
  69292. * @param scene defines the hosting scene
  69293. * @returns the torus knot mesh
  69294. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69295. */
  69296. static CreateTorusKnot(name: string, options: {
  69297. radius?: number;
  69298. tube?: number;
  69299. radialSegments?: number;
  69300. tubularSegments?: number;
  69301. p?: number;
  69302. q?: number;
  69303. updatable?: boolean;
  69304. sideOrientation?: number;
  69305. frontUVs?: Vector4;
  69306. backUVs?: Vector4;
  69307. }, scene?: Nullable<Scene>): Mesh;
  69308. /**
  69309. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69310. * * 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
  69311. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69312. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69313. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69314. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69315. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69316. * * 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
  69317. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69318. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69319. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69320. * @param name defines the name of the new line system
  69321. * @param options defines the options used to create the line system
  69322. * @param scene defines the hosting scene
  69323. * @returns a new line system mesh
  69324. */
  69325. static CreateLineSystem(name: string, options: {
  69326. lines: Vector3[][];
  69327. updatable?: boolean;
  69328. instance?: Nullable<LinesMesh>;
  69329. colors?: Nullable<Color4[][]>;
  69330. useVertexAlpha?: boolean;
  69331. }, scene: Nullable<Scene>): LinesMesh;
  69332. /**
  69333. * Creates a line mesh
  69334. * 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
  69335. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69336. * * The parameter `points` is an array successive Vector3
  69337. * * 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
  69338. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69339. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69340. * * When updating an instance, remember that only point positions can change, not the number of points
  69341. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69342. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69343. * @param name defines the name of the new line system
  69344. * @param options defines the options used to create the line system
  69345. * @param scene defines the hosting scene
  69346. * @returns a new line mesh
  69347. */
  69348. static CreateLines(name: string, options: {
  69349. points: Vector3[];
  69350. updatable?: boolean;
  69351. instance?: Nullable<LinesMesh>;
  69352. colors?: Color4[];
  69353. useVertexAlpha?: boolean;
  69354. }, scene?: Nullable<Scene>): LinesMesh;
  69355. /**
  69356. * Creates a dashed line mesh
  69357. * * 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
  69358. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69359. * * The parameter `points` is an array successive Vector3
  69360. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69361. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69362. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69363. * * 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
  69364. * * When updating an instance, remember that only point positions can change, not the number of points
  69365. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69366. * @param name defines the name of the mesh
  69367. * @param options defines the options used to create the mesh
  69368. * @param scene defines the hosting scene
  69369. * @returns the dashed line mesh
  69370. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69371. */
  69372. static CreateDashedLines(name: string, options: {
  69373. points: Vector3[];
  69374. dashSize?: number;
  69375. gapSize?: number;
  69376. dashNb?: number;
  69377. updatable?: boolean;
  69378. instance?: LinesMesh;
  69379. }, scene?: Nullable<Scene>): LinesMesh;
  69380. /**
  69381. * 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.
  69382. * * 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.
  69383. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69384. * * 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.
  69385. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69386. * * 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
  69387. * * 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
  69388. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69389. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69390. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69391. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69392. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69393. * @param name defines the name of the mesh
  69394. * @param options defines the options used to create the mesh
  69395. * @param scene defines the hosting scene
  69396. * @returns the extruded shape mesh
  69397. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69398. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69399. */
  69400. static ExtrudeShape(name: string, options: {
  69401. shape: Vector3[];
  69402. path: Vector3[];
  69403. scale?: number;
  69404. rotation?: number;
  69405. cap?: number;
  69406. updatable?: boolean;
  69407. sideOrientation?: number;
  69408. frontUVs?: Vector4;
  69409. backUVs?: Vector4;
  69410. instance?: Mesh;
  69411. invertUV?: boolean;
  69412. }, scene?: Nullable<Scene>): Mesh;
  69413. /**
  69414. * Creates an custom extruded shape mesh.
  69415. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69416. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  69417. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69418. * * The parameter `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
  69419. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69420. * * 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
  69421. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69422. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69423. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69424. * * 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
  69425. * * 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
  69426. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69427. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69428. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69429. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69430. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69431. * @param name defines the name of the mesh
  69432. * @param options defines the options used to create the mesh
  69433. * @param scene defines the hosting scene
  69434. * @returns the custom extruded shape mesh
  69435. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69436. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69437. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69438. */
  69439. static ExtrudeShapeCustom(name: string, options: {
  69440. shape: Vector3[];
  69441. path: Vector3[];
  69442. scaleFunction?: any;
  69443. rotationFunction?: any;
  69444. ribbonCloseArray?: boolean;
  69445. ribbonClosePath?: boolean;
  69446. cap?: number;
  69447. updatable?: boolean;
  69448. sideOrientation?: number;
  69449. frontUVs?: Vector4;
  69450. backUVs?: Vector4;
  69451. instance?: Mesh;
  69452. invertUV?: boolean;
  69453. }, scene?: Nullable<Scene>): Mesh;
  69454. /**
  69455. * Creates lathe mesh.
  69456. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69457. * * 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
  69458. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69459. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69460. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69461. * * 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
  69462. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69463. * * 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
  69464. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69465. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69466. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69467. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69468. * @param name defines the name of the mesh
  69469. * @param options defines the options used to create the mesh
  69470. * @param scene defines the hosting scene
  69471. * @returns the lathe mesh
  69472. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69473. */
  69474. static CreateLathe(name: string, options: {
  69475. shape: Vector3[];
  69476. radius?: number;
  69477. tessellation?: number;
  69478. clip?: number;
  69479. arc?: number;
  69480. closed?: boolean;
  69481. updatable?: boolean;
  69482. sideOrientation?: number;
  69483. frontUVs?: Vector4;
  69484. backUVs?: Vector4;
  69485. cap?: number;
  69486. invertUV?: boolean;
  69487. }, scene?: Nullable<Scene>): Mesh;
  69488. /**
  69489. * Creates a tiled plane mesh
  69490. * * You can set a limited pattern arrangement with the tiles
  69491. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69492. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69493. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69494. * @param name defines the name of the mesh
  69495. * @param options defines the options used to create the mesh
  69496. * @param scene defines the hosting scene
  69497. * @returns the plane mesh
  69498. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69499. */
  69500. static CreateTiledPlane(name: string, options: {
  69501. pattern?: number;
  69502. tileSize?: number;
  69503. tileWidth?: number;
  69504. tileHeight?: number;
  69505. size?: number;
  69506. width?: number;
  69507. height?: number;
  69508. alignHorizontal?: number;
  69509. alignVertical?: number;
  69510. sideOrientation?: number;
  69511. frontUVs?: Vector4;
  69512. backUVs?: Vector4;
  69513. updatable?: boolean;
  69514. }, scene?: Nullable<Scene>): Mesh;
  69515. /**
  69516. * Creates a plane mesh
  69517. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69518. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69519. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69520. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69521. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69522. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69523. * @param name defines the name of the mesh
  69524. * @param options defines the options used to create the mesh
  69525. * @param scene defines the hosting scene
  69526. * @returns the plane mesh
  69527. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69528. */
  69529. static CreatePlane(name: string, options: {
  69530. size?: number;
  69531. width?: number;
  69532. height?: number;
  69533. sideOrientation?: number;
  69534. frontUVs?: Vector4;
  69535. backUVs?: Vector4;
  69536. updatable?: boolean;
  69537. sourcePlane?: Plane;
  69538. }, scene?: Nullable<Scene>): Mesh;
  69539. /**
  69540. * Creates a ground mesh
  69541. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69542. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69543. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69544. * @param name defines the name of the mesh
  69545. * @param options defines the options used to create the mesh
  69546. * @param scene defines the hosting scene
  69547. * @returns the ground mesh
  69548. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69549. */
  69550. static CreateGround(name: string, options: {
  69551. width?: number;
  69552. height?: number;
  69553. subdivisions?: number;
  69554. subdivisionsX?: number;
  69555. subdivisionsY?: number;
  69556. updatable?: boolean;
  69557. }, scene?: Nullable<Scene>): Mesh;
  69558. /**
  69559. * Creates a tiled ground mesh
  69560. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69561. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69562. * * 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
  69563. * * 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
  69564. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69565. * @param name defines the name of the mesh
  69566. * @param options defines the options used to create the mesh
  69567. * @param scene defines the hosting scene
  69568. * @returns the tiled ground mesh
  69569. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69570. */
  69571. static CreateTiledGround(name: string, options: {
  69572. xmin: number;
  69573. zmin: number;
  69574. xmax: number;
  69575. zmax: number;
  69576. subdivisions?: {
  69577. w: number;
  69578. h: number;
  69579. };
  69580. precision?: {
  69581. w: number;
  69582. h: number;
  69583. };
  69584. updatable?: boolean;
  69585. }, scene?: Nullable<Scene>): Mesh;
  69586. /**
  69587. * Creates a ground mesh from a height map
  69588. * * The parameter `url` sets the URL of the height map image resource.
  69589. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69590. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69591. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69592. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69593. * * 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.
  69594. * * 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).
  69595. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69596. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69597. * @param name defines the name of the mesh
  69598. * @param url defines the url to the height map
  69599. * @param options defines the options used to create the mesh
  69600. * @param scene defines the hosting scene
  69601. * @returns the ground mesh
  69602. * @see https://doc.babylonjs.com/babylon101/height_map
  69603. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69604. */
  69605. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69606. width?: number;
  69607. height?: number;
  69608. subdivisions?: number;
  69609. minHeight?: number;
  69610. maxHeight?: number;
  69611. colorFilter?: Color3;
  69612. alphaFilter?: number;
  69613. updatable?: boolean;
  69614. onReady?: (mesh: GroundMesh) => void;
  69615. }, scene?: Nullable<Scene>): GroundMesh;
  69616. /**
  69617. * Creates a polygon mesh
  69618. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69619. * * 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
  69620. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69621. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69622. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69623. * * Remember you can only change the shape positions, not their number when updating a polygon
  69624. * @param name defines the name of the mesh
  69625. * @param options defines the options used to create the mesh
  69626. * @param scene defines the hosting scene
  69627. * @param earcutInjection can be used to inject your own earcut reference
  69628. * @returns the polygon mesh
  69629. */
  69630. static CreatePolygon(name: string, options: {
  69631. shape: Vector3[];
  69632. holes?: Vector3[][];
  69633. depth?: number;
  69634. faceUV?: Vector4[];
  69635. faceColors?: Color4[];
  69636. updatable?: boolean;
  69637. sideOrientation?: number;
  69638. frontUVs?: Vector4;
  69639. backUVs?: Vector4;
  69640. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69641. /**
  69642. * Creates an extruded polygon mesh, with depth in the Y direction.
  69643. * * 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)
  69644. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69645. * @param name defines the name of the mesh
  69646. * @param options defines the options used to create the mesh
  69647. * @param scene defines the hosting scene
  69648. * @param earcutInjection can be used to inject your own earcut reference
  69649. * @returns the polygon mesh
  69650. */
  69651. static ExtrudePolygon(name: string, options: {
  69652. shape: Vector3[];
  69653. holes?: Vector3[][];
  69654. depth?: number;
  69655. faceUV?: Vector4[];
  69656. faceColors?: Color4[];
  69657. updatable?: boolean;
  69658. sideOrientation?: number;
  69659. frontUVs?: Vector4;
  69660. backUVs?: Vector4;
  69661. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69662. /**
  69663. * Creates a tube mesh.
  69664. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69665. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69666. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69667. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69668. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69669. * * 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)
  69670. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69671. * * 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
  69672. * * 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
  69673. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69674. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69675. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69676. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69677. * @param name defines the name of the mesh
  69678. * @param options defines the options used to create the mesh
  69679. * @param scene defines the hosting scene
  69680. * @returns the tube mesh
  69681. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69682. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69683. */
  69684. static CreateTube(name: string, options: {
  69685. path: Vector3[];
  69686. radius?: number;
  69687. tessellation?: number;
  69688. radiusFunction?: {
  69689. (i: number, distance: number): number;
  69690. };
  69691. cap?: number;
  69692. arc?: number;
  69693. updatable?: boolean;
  69694. sideOrientation?: number;
  69695. frontUVs?: Vector4;
  69696. backUVs?: Vector4;
  69697. instance?: Mesh;
  69698. invertUV?: boolean;
  69699. }, scene?: Nullable<Scene>): Mesh;
  69700. /**
  69701. * Creates a polyhedron mesh
  69702. * * 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
  69703. * * The parameter `size` (positive float, default 1) sets the polygon size
  69704. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69705. * * 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`
  69706. * * 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
  69707. * * 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)`)
  69708. * * 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
  69709. * * 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
  69710. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69711. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69712. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69713. * @param name defines the name of the mesh
  69714. * @param options defines the options used to create the mesh
  69715. * @param scene defines the hosting scene
  69716. * @returns the polyhedron mesh
  69717. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69718. */
  69719. static CreatePolyhedron(name: string, options: {
  69720. type?: number;
  69721. size?: number;
  69722. sizeX?: number;
  69723. sizeY?: number;
  69724. sizeZ?: number;
  69725. custom?: any;
  69726. faceUV?: Vector4[];
  69727. faceColors?: Color4[];
  69728. flat?: boolean;
  69729. updatable?: boolean;
  69730. sideOrientation?: number;
  69731. frontUVs?: Vector4;
  69732. backUVs?: Vector4;
  69733. }, scene?: Nullable<Scene>): Mesh;
  69734. /**
  69735. * Creates a decal mesh.
  69736. * 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
  69737. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69738. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69739. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69740. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69741. * @param name defines the name of the mesh
  69742. * @param sourceMesh defines the mesh where the decal must be applied
  69743. * @param options defines the options used to create the mesh
  69744. * @param scene defines the hosting scene
  69745. * @returns the decal mesh
  69746. * @see https://doc.babylonjs.com/how_to/decals
  69747. */
  69748. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69749. position?: Vector3;
  69750. normal?: Vector3;
  69751. size?: Vector3;
  69752. angle?: number;
  69753. }): Mesh;
  69754. }
  69755. }
  69756. declare module "babylonjs/Meshes/meshSimplification" {
  69757. import { Mesh } from "babylonjs/Meshes/mesh";
  69758. /**
  69759. * A simplifier interface for future simplification implementations
  69760. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69761. */
  69762. export interface ISimplifier {
  69763. /**
  69764. * Simplification of a given mesh according to the given settings.
  69765. * Since this requires computation, it is assumed that the function runs async.
  69766. * @param settings The settings of the simplification, including quality and distance
  69767. * @param successCallback A callback that will be called after the mesh was simplified.
  69768. * @param errorCallback in case of an error, this callback will be called. optional.
  69769. */
  69770. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69771. }
  69772. /**
  69773. * Expected simplification settings.
  69774. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69775. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69776. */
  69777. export interface ISimplificationSettings {
  69778. /**
  69779. * Gets or sets the expected quality
  69780. */
  69781. quality: number;
  69782. /**
  69783. * Gets or sets the distance when this optimized version should be used
  69784. */
  69785. distance: number;
  69786. /**
  69787. * Gets an already optimized mesh
  69788. */
  69789. optimizeMesh?: boolean;
  69790. }
  69791. /**
  69792. * Class used to specify simplification options
  69793. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69794. */
  69795. export class SimplificationSettings implements ISimplificationSettings {
  69796. /** expected quality */
  69797. quality: number;
  69798. /** distance when this optimized version should be used */
  69799. distance: number;
  69800. /** already optimized mesh */
  69801. optimizeMesh?: boolean | undefined;
  69802. /**
  69803. * Creates a SimplificationSettings
  69804. * @param quality expected quality
  69805. * @param distance distance when this optimized version should be used
  69806. * @param optimizeMesh already optimized mesh
  69807. */
  69808. constructor(
  69809. /** expected quality */
  69810. quality: number,
  69811. /** distance when this optimized version should be used */
  69812. distance: number,
  69813. /** already optimized mesh */
  69814. optimizeMesh?: boolean | undefined);
  69815. }
  69816. /**
  69817. * Interface used to define a simplification task
  69818. */
  69819. export interface ISimplificationTask {
  69820. /**
  69821. * Array of settings
  69822. */
  69823. settings: Array<ISimplificationSettings>;
  69824. /**
  69825. * Simplification type
  69826. */
  69827. simplificationType: SimplificationType;
  69828. /**
  69829. * Mesh to simplify
  69830. */
  69831. mesh: Mesh;
  69832. /**
  69833. * Callback called on success
  69834. */
  69835. successCallback?: () => void;
  69836. /**
  69837. * Defines if parallel processing can be used
  69838. */
  69839. parallelProcessing: boolean;
  69840. }
  69841. /**
  69842. * Queue used to order the simplification tasks
  69843. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69844. */
  69845. export class SimplificationQueue {
  69846. private _simplificationArray;
  69847. /**
  69848. * Gets a boolean indicating that the process is still running
  69849. */
  69850. running: boolean;
  69851. /**
  69852. * Creates a new queue
  69853. */
  69854. constructor();
  69855. /**
  69856. * Adds a new simplification task
  69857. * @param task defines a task to add
  69858. */
  69859. addTask(task: ISimplificationTask): void;
  69860. /**
  69861. * Execute next task
  69862. */
  69863. executeNext(): void;
  69864. /**
  69865. * Execute a simplification task
  69866. * @param task defines the task to run
  69867. */
  69868. runSimplification(task: ISimplificationTask): void;
  69869. private getSimplifier;
  69870. }
  69871. /**
  69872. * The implemented types of simplification
  69873. * At the moment only Quadratic Error Decimation is implemented
  69874. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69875. */
  69876. export enum SimplificationType {
  69877. /** Quadratic error decimation */
  69878. QUADRATIC = 0
  69879. }
  69880. /**
  69881. * An implementation of the Quadratic Error simplification algorithm.
  69882. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69883. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69884. * @author RaananW
  69885. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69886. */
  69887. export class QuadraticErrorSimplification implements ISimplifier {
  69888. private _mesh;
  69889. private triangles;
  69890. private vertices;
  69891. private references;
  69892. private _reconstructedMesh;
  69893. /** Gets or sets the number pf sync interations */
  69894. syncIterations: number;
  69895. /** Gets or sets the aggressiveness of the simplifier */
  69896. aggressiveness: number;
  69897. /** Gets or sets the number of allowed iterations for decimation */
  69898. decimationIterations: number;
  69899. /** Gets or sets the espilon to use for bounding box computation */
  69900. boundingBoxEpsilon: number;
  69901. /**
  69902. * Creates a new QuadraticErrorSimplification
  69903. * @param _mesh defines the target mesh
  69904. */
  69905. constructor(_mesh: Mesh);
  69906. /**
  69907. * Simplification of a given mesh according to the given settings.
  69908. * Since this requires computation, it is assumed that the function runs async.
  69909. * @param settings The settings of the simplification, including quality and distance
  69910. * @param successCallback A callback that will be called after the mesh was simplified.
  69911. */
  69912. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69913. private runDecimation;
  69914. private initWithMesh;
  69915. private init;
  69916. private reconstructMesh;
  69917. private initDecimatedMesh;
  69918. private isFlipped;
  69919. private updateTriangles;
  69920. private identifyBorder;
  69921. private updateMesh;
  69922. private vertexError;
  69923. private calculateError;
  69924. }
  69925. }
  69926. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69927. import { Scene } from "babylonjs/scene";
  69928. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69929. import { ISceneComponent } from "babylonjs/sceneComponent";
  69930. module "babylonjs/scene" {
  69931. interface Scene {
  69932. /** @hidden (Backing field) */
  69933. _simplificationQueue: SimplificationQueue;
  69934. /**
  69935. * Gets or sets the simplification queue attached to the scene
  69936. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69937. */
  69938. simplificationQueue: SimplificationQueue;
  69939. }
  69940. }
  69941. module "babylonjs/Meshes/mesh" {
  69942. interface Mesh {
  69943. /**
  69944. * Simplify the mesh according to the given array of settings.
  69945. * Function will return immediately and will simplify async
  69946. * @param settings a collection of simplification settings
  69947. * @param parallelProcessing should all levels calculate parallel or one after the other
  69948. * @param simplificationType the type of simplification to run
  69949. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  69950. * @returns the current mesh
  69951. */
  69952. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  69953. }
  69954. }
  69955. /**
  69956. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  69957. * created in a scene
  69958. */
  69959. export class SimplicationQueueSceneComponent implements ISceneComponent {
  69960. /**
  69961. * The component name helpfull to identify the component in the list of scene components.
  69962. */
  69963. readonly name: string;
  69964. /**
  69965. * The scene the component belongs to.
  69966. */
  69967. scene: Scene;
  69968. /**
  69969. * Creates a new instance of the component for the given scene
  69970. * @param scene Defines the scene to register the component in
  69971. */
  69972. constructor(scene: Scene);
  69973. /**
  69974. * Registers the component in a given scene
  69975. */
  69976. register(): void;
  69977. /**
  69978. * Rebuilds the elements related to this component in case of
  69979. * context lost for instance.
  69980. */
  69981. rebuild(): void;
  69982. /**
  69983. * Disposes the component and the associated ressources
  69984. */
  69985. dispose(): void;
  69986. private _beforeCameraUpdate;
  69987. }
  69988. }
  69989. declare module "babylonjs/Meshes/Builders/index" {
  69990. export * from "babylonjs/Meshes/Builders/boxBuilder";
  69991. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  69992. export * from "babylonjs/Meshes/Builders/discBuilder";
  69993. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  69994. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  69995. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  69996. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  69997. export * from "babylonjs/Meshes/Builders/torusBuilder";
  69998. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  69999. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70000. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70001. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70002. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70003. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70004. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70005. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70006. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70007. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70008. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70009. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70010. }
  70011. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70012. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70013. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70014. import { Matrix } from "babylonjs/Maths/math.vector";
  70015. module "babylonjs/Meshes/mesh" {
  70016. interface Mesh {
  70017. /**
  70018. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70019. */
  70020. thinInstanceEnablePicking: boolean;
  70021. /**
  70022. * Creates a new thin instance
  70023. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70024. * @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
  70025. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70026. */
  70027. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70028. /**
  70029. * Adds the transformation (matrix) of the current mesh as a thin instance
  70030. * @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
  70031. * @returns the thin instance index number
  70032. */
  70033. thinInstanceAddSelf(refresh: boolean): number;
  70034. /**
  70035. * Registers a custom attribute to be used with thin instances
  70036. * @param kind name of the attribute
  70037. * @param stride size in floats of the attribute
  70038. */
  70039. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70040. /**
  70041. * Sets the matrix of a thin instance
  70042. * @param index index of the thin instance
  70043. * @param matrix matrix to set
  70044. * @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
  70045. */
  70046. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70047. /**
  70048. * Sets the value of a custom attribute for a thin instance
  70049. * @param kind name of the attribute
  70050. * @param index index of the thin instance
  70051. * @param value value to set
  70052. * @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
  70053. */
  70054. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70055. /**
  70056. * 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.
  70057. */
  70058. thinInstanceCount: number;
  70059. /**
  70060. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70061. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70062. * @param buffer buffer to set
  70063. * @param stride size in floats of each value of the buffer
  70064. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70065. */
  70066. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70067. /**
  70068. * Gets the list of world matrices
  70069. * @return an array containing all the world matrices from the thin instances
  70070. */
  70071. thinInstanceGetWorldMatrices(): Matrix[];
  70072. /**
  70073. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70074. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70075. */
  70076. thinInstanceBufferUpdated(kind: string): void;
  70077. /**
  70078. * Refreshes the bounding info, taking into account all the thin instances defined
  70079. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70080. */
  70081. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70082. /** @hidden */
  70083. _thinInstanceInitializeUserStorage(): void;
  70084. /** @hidden */
  70085. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70086. /** @hidden */
  70087. _userThinInstanceBuffersStorage: {
  70088. data: {
  70089. [key: string]: Float32Array;
  70090. };
  70091. sizes: {
  70092. [key: string]: number;
  70093. };
  70094. vertexBuffers: {
  70095. [key: string]: Nullable<VertexBuffer>;
  70096. };
  70097. strides: {
  70098. [key: string]: number;
  70099. };
  70100. };
  70101. }
  70102. }
  70103. }
  70104. declare module "babylonjs/Meshes/index" {
  70105. export * from "babylonjs/Meshes/abstractMesh";
  70106. export * from "babylonjs/Meshes/buffer";
  70107. export * from "babylonjs/Meshes/Compression/index";
  70108. export * from "babylonjs/Meshes/csg";
  70109. export * from "babylonjs/Meshes/geometry";
  70110. export * from "babylonjs/Meshes/groundMesh";
  70111. export * from "babylonjs/Meshes/trailMesh";
  70112. export * from "babylonjs/Meshes/instancedMesh";
  70113. export * from "babylonjs/Meshes/linesMesh";
  70114. export * from "babylonjs/Meshes/mesh";
  70115. export * from "babylonjs/Meshes/mesh.vertexData";
  70116. export * from "babylonjs/Meshes/meshBuilder";
  70117. export * from "babylonjs/Meshes/meshSimplification";
  70118. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70119. export * from "babylonjs/Meshes/polygonMesh";
  70120. export * from "babylonjs/Meshes/subMesh";
  70121. export * from "babylonjs/Meshes/meshLODLevel";
  70122. export * from "babylonjs/Meshes/transformNode";
  70123. export * from "babylonjs/Meshes/Builders/index";
  70124. export * from "babylonjs/Meshes/dataBuffer";
  70125. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70126. import "babylonjs/Meshes/thinInstanceMesh";
  70127. export * from "babylonjs/Meshes/thinInstanceMesh";
  70128. }
  70129. declare module "babylonjs/Morph/index" {
  70130. export * from "babylonjs/Morph/morphTarget";
  70131. export * from "babylonjs/Morph/morphTargetManager";
  70132. }
  70133. declare module "babylonjs/Navigation/INavigationEngine" {
  70134. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70135. import { Vector3 } from "babylonjs/Maths/math";
  70136. import { Mesh } from "babylonjs/Meshes/mesh";
  70137. import { Scene } from "babylonjs/scene";
  70138. /**
  70139. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70140. */
  70141. export interface INavigationEnginePlugin {
  70142. /**
  70143. * plugin name
  70144. */
  70145. name: string;
  70146. /**
  70147. * Creates a navigation mesh
  70148. * @param meshes array of all the geometry used to compute the navigatio mesh
  70149. * @param parameters bunch of parameters used to filter geometry
  70150. */
  70151. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70152. /**
  70153. * Create a navigation mesh debug mesh
  70154. * @param scene is where the mesh will be added
  70155. * @returns debug display mesh
  70156. */
  70157. createDebugNavMesh(scene: Scene): Mesh;
  70158. /**
  70159. * Get a navigation mesh constrained position, closest to the parameter position
  70160. * @param position world position
  70161. * @returns the closest point to position constrained by the navigation mesh
  70162. */
  70163. getClosestPoint(position: Vector3): Vector3;
  70164. /**
  70165. * Get a navigation mesh constrained position, closest to the parameter position
  70166. * @param position world position
  70167. * @param result output the closest point to position constrained by the navigation mesh
  70168. */
  70169. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70170. /**
  70171. * Get a navigation mesh constrained position, within a particular radius
  70172. * @param position world position
  70173. * @param maxRadius the maximum distance to the constrained world position
  70174. * @returns the closest point to position constrained by the navigation mesh
  70175. */
  70176. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70177. /**
  70178. * Get a navigation mesh constrained position, within a particular radius
  70179. * @param position world position
  70180. * @param maxRadius the maximum distance to the constrained world position
  70181. * @param result output the closest point to position constrained by the navigation mesh
  70182. */
  70183. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70184. /**
  70185. * Compute the final position from a segment made of destination-position
  70186. * @param position world position
  70187. * @param destination world position
  70188. * @returns the resulting point along the navmesh
  70189. */
  70190. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70191. /**
  70192. * Compute the final position from a segment made of destination-position
  70193. * @param position world position
  70194. * @param destination world position
  70195. * @param result output the resulting point along the navmesh
  70196. */
  70197. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70198. /**
  70199. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70200. * @param start world position
  70201. * @param end world position
  70202. * @returns array containing world position composing the path
  70203. */
  70204. computePath(start: Vector3, end: Vector3): Vector3[];
  70205. /**
  70206. * If this plugin is supported
  70207. * @returns true if plugin is supported
  70208. */
  70209. isSupported(): boolean;
  70210. /**
  70211. * Create a new Crowd so you can add agents
  70212. * @param maxAgents the maximum agent count in the crowd
  70213. * @param maxAgentRadius the maximum radius an agent can have
  70214. * @param scene to attach the crowd to
  70215. * @returns the crowd you can add agents to
  70216. */
  70217. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70218. /**
  70219. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70220. * The queries will try to find a solution within those bounds
  70221. * default is (1,1,1)
  70222. * @param extent x,y,z value that define the extent around the queries point of reference
  70223. */
  70224. setDefaultQueryExtent(extent: Vector3): void;
  70225. /**
  70226. * Get the Bounding box extent specified by setDefaultQueryExtent
  70227. * @returns the box extent values
  70228. */
  70229. getDefaultQueryExtent(): Vector3;
  70230. /**
  70231. * build the navmesh from a previously saved state using getNavmeshData
  70232. * @param data the Uint8Array returned by getNavmeshData
  70233. */
  70234. buildFromNavmeshData(data: Uint8Array): void;
  70235. /**
  70236. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70237. * @returns data the Uint8Array that can be saved and reused
  70238. */
  70239. getNavmeshData(): Uint8Array;
  70240. /**
  70241. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70242. * @param result output the box extent values
  70243. */
  70244. getDefaultQueryExtentToRef(result: Vector3): void;
  70245. /**
  70246. * Release all resources
  70247. */
  70248. dispose(): void;
  70249. }
  70250. /**
  70251. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70252. */
  70253. export interface ICrowd {
  70254. /**
  70255. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70256. * You can attach anything to that node. The node position is updated in the scene update tick.
  70257. * @param pos world position that will be constrained by the navigation mesh
  70258. * @param parameters agent parameters
  70259. * @param transform hooked to the agent that will be update by the scene
  70260. * @returns agent index
  70261. */
  70262. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70263. /**
  70264. * Returns the agent position in world space
  70265. * @param index agent index returned by addAgent
  70266. * @returns world space position
  70267. */
  70268. getAgentPosition(index: number): Vector3;
  70269. /**
  70270. * Gets the agent position result in world space
  70271. * @param index agent index returned by addAgent
  70272. * @param result output world space position
  70273. */
  70274. getAgentPositionToRef(index: number, result: Vector3): void;
  70275. /**
  70276. * Gets the agent velocity in world space
  70277. * @param index agent index returned by addAgent
  70278. * @returns world space velocity
  70279. */
  70280. getAgentVelocity(index: number): Vector3;
  70281. /**
  70282. * Gets the agent velocity result in world space
  70283. * @param index agent index returned by addAgent
  70284. * @param result output world space velocity
  70285. */
  70286. getAgentVelocityToRef(index: number, result: Vector3): void;
  70287. /**
  70288. * remove a particular agent previously created
  70289. * @param index agent index returned by addAgent
  70290. */
  70291. removeAgent(index: number): void;
  70292. /**
  70293. * get the list of all agents attached to this crowd
  70294. * @returns list of agent indices
  70295. */
  70296. getAgents(): number[];
  70297. /**
  70298. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70299. * @param deltaTime in seconds
  70300. */
  70301. update(deltaTime: number): void;
  70302. /**
  70303. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70304. * @param index agent index returned by addAgent
  70305. * @param destination targeted world position
  70306. */
  70307. agentGoto(index: number, destination: Vector3): void;
  70308. /**
  70309. * Teleport the agent to a new position
  70310. * @param index agent index returned by addAgent
  70311. * @param destination targeted world position
  70312. */
  70313. agentTeleport(index: number, destination: Vector3): void;
  70314. /**
  70315. * Update agent parameters
  70316. * @param index agent index returned by addAgent
  70317. * @param parameters agent parameters
  70318. */
  70319. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70320. /**
  70321. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70322. * The queries will try to find a solution within those bounds
  70323. * default is (1,1,1)
  70324. * @param extent x,y,z value that define the extent around the queries point of reference
  70325. */
  70326. setDefaultQueryExtent(extent: Vector3): void;
  70327. /**
  70328. * Get the Bounding box extent specified by setDefaultQueryExtent
  70329. * @returns the box extent values
  70330. */
  70331. getDefaultQueryExtent(): Vector3;
  70332. /**
  70333. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70334. * @param result output the box extent values
  70335. */
  70336. getDefaultQueryExtentToRef(result: Vector3): void;
  70337. /**
  70338. * Release all resources
  70339. */
  70340. dispose(): void;
  70341. }
  70342. /**
  70343. * Configures an agent
  70344. */
  70345. export interface IAgentParameters {
  70346. /**
  70347. * Agent radius. [Limit: >= 0]
  70348. */
  70349. radius: number;
  70350. /**
  70351. * Agent height. [Limit: > 0]
  70352. */
  70353. height: number;
  70354. /**
  70355. * Maximum allowed acceleration. [Limit: >= 0]
  70356. */
  70357. maxAcceleration: number;
  70358. /**
  70359. * Maximum allowed speed. [Limit: >= 0]
  70360. */
  70361. maxSpeed: number;
  70362. /**
  70363. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70364. */
  70365. collisionQueryRange: number;
  70366. /**
  70367. * The path visibility optimization range. [Limit: > 0]
  70368. */
  70369. pathOptimizationRange: number;
  70370. /**
  70371. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70372. */
  70373. separationWeight: number;
  70374. }
  70375. /**
  70376. * Configures the navigation mesh creation
  70377. */
  70378. export interface INavMeshParameters {
  70379. /**
  70380. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70381. */
  70382. cs: number;
  70383. /**
  70384. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70385. */
  70386. ch: number;
  70387. /**
  70388. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70389. */
  70390. walkableSlopeAngle: number;
  70391. /**
  70392. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70393. * be considered walkable. [Limit: >= 3] [Units: vx]
  70394. */
  70395. walkableHeight: number;
  70396. /**
  70397. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70398. */
  70399. walkableClimb: number;
  70400. /**
  70401. * The distance to erode/shrink the walkable area of the heightfield away from
  70402. * obstructions. [Limit: >=0] [Units: vx]
  70403. */
  70404. walkableRadius: number;
  70405. /**
  70406. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70407. */
  70408. maxEdgeLen: number;
  70409. /**
  70410. * The maximum distance a simplfied contour's border edges should deviate
  70411. * the original raw contour. [Limit: >=0] [Units: vx]
  70412. */
  70413. maxSimplificationError: number;
  70414. /**
  70415. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70416. */
  70417. minRegionArea: number;
  70418. /**
  70419. * Any regions with a span count smaller than this value will, if possible,
  70420. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70421. */
  70422. mergeRegionArea: number;
  70423. /**
  70424. * The maximum number of vertices allowed for polygons generated during the
  70425. * contour to polygon conversion process. [Limit: >= 3]
  70426. */
  70427. maxVertsPerPoly: number;
  70428. /**
  70429. * Sets the sampling distance to use when generating the detail mesh.
  70430. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70431. */
  70432. detailSampleDist: number;
  70433. /**
  70434. * The maximum distance the detail mesh surface should deviate from heightfield
  70435. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70436. */
  70437. detailSampleMaxError: number;
  70438. }
  70439. }
  70440. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70441. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70442. import { Mesh } from "babylonjs/Meshes/mesh";
  70443. import { Scene } from "babylonjs/scene";
  70444. import { Vector3 } from "babylonjs/Maths/math";
  70445. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70446. /**
  70447. * RecastJS navigation plugin
  70448. */
  70449. export class RecastJSPlugin implements INavigationEnginePlugin {
  70450. /**
  70451. * Reference to the Recast library
  70452. */
  70453. bjsRECAST: any;
  70454. /**
  70455. * plugin name
  70456. */
  70457. name: string;
  70458. /**
  70459. * the first navmesh created. We might extend this to support multiple navmeshes
  70460. */
  70461. navMesh: any;
  70462. /**
  70463. * Initializes the recastJS plugin
  70464. * @param recastInjection can be used to inject your own recast reference
  70465. */
  70466. constructor(recastInjection?: any);
  70467. /**
  70468. * Creates a navigation mesh
  70469. * @param meshes array of all the geometry used to compute the navigatio mesh
  70470. * @param parameters bunch of parameters used to filter geometry
  70471. */
  70472. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70473. /**
  70474. * Create a navigation mesh debug mesh
  70475. * @param scene is where the mesh will be added
  70476. * @returns debug display mesh
  70477. */
  70478. createDebugNavMesh(scene: Scene): Mesh;
  70479. /**
  70480. * Get a navigation mesh constrained position, closest to the parameter position
  70481. * @param position world position
  70482. * @returns the closest point to position constrained by the navigation mesh
  70483. */
  70484. getClosestPoint(position: Vector3): Vector3;
  70485. /**
  70486. * Get a navigation mesh constrained position, closest to the parameter position
  70487. * @param position world position
  70488. * @param result output the closest point to position constrained by the navigation mesh
  70489. */
  70490. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70491. /**
  70492. * Get a navigation mesh constrained position, within a particular radius
  70493. * @param position world position
  70494. * @param maxRadius the maximum distance to the constrained world position
  70495. * @returns the closest point to position constrained by the navigation mesh
  70496. */
  70497. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70498. /**
  70499. * Get a navigation mesh constrained position, within a particular radius
  70500. * @param position world position
  70501. * @param maxRadius the maximum distance to the constrained world position
  70502. * @param result output the closest point to position constrained by the navigation mesh
  70503. */
  70504. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70505. /**
  70506. * Compute the final position from a segment made of destination-position
  70507. * @param position world position
  70508. * @param destination world position
  70509. * @returns the resulting point along the navmesh
  70510. */
  70511. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70512. /**
  70513. * Compute the final position from a segment made of destination-position
  70514. * @param position world position
  70515. * @param destination world position
  70516. * @param result output the resulting point along the navmesh
  70517. */
  70518. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70519. /**
  70520. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70521. * @param start world position
  70522. * @param end world position
  70523. * @returns array containing world position composing the path
  70524. */
  70525. computePath(start: Vector3, end: Vector3): Vector3[];
  70526. /**
  70527. * Create a new Crowd so you can add agents
  70528. * @param maxAgents the maximum agent count in the crowd
  70529. * @param maxAgentRadius the maximum radius an agent can have
  70530. * @param scene to attach the crowd to
  70531. * @returns the crowd you can add agents to
  70532. */
  70533. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70534. /**
  70535. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70536. * The queries will try to find a solution within those bounds
  70537. * default is (1,1,1)
  70538. * @param extent x,y,z value that define the extent around the queries point of reference
  70539. */
  70540. setDefaultQueryExtent(extent: Vector3): void;
  70541. /**
  70542. * Get the Bounding box extent specified by setDefaultQueryExtent
  70543. * @returns the box extent values
  70544. */
  70545. getDefaultQueryExtent(): Vector3;
  70546. /**
  70547. * build the navmesh from a previously saved state using getNavmeshData
  70548. * @param data the Uint8Array returned by getNavmeshData
  70549. */
  70550. buildFromNavmeshData(data: Uint8Array): void;
  70551. /**
  70552. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70553. * @returns data the Uint8Array that can be saved and reused
  70554. */
  70555. getNavmeshData(): Uint8Array;
  70556. /**
  70557. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70558. * @param result output the box extent values
  70559. */
  70560. getDefaultQueryExtentToRef(result: Vector3): void;
  70561. /**
  70562. * Disposes
  70563. */
  70564. dispose(): void;
  70565. /**
  70566. * If this plugin is supported
  70567. * @returns true if plugin is supported
  70568. */
  70569. isSupported(): boolean;
  70570. }
  70571. /**
  70572. * Recast detour crowd implementation
  70573. */
  70574. export class RecastJSCrowd implements ICrowd {
  70575. /**
  70576. * Recast/detour plugin
  70577. */
  70578. bjsRECASTPlugin: RecastJSPlugin;
  70579. /**
  70580. * Link to the detour crowd
  70581. */
  70582. recastCrowd: any;
  70583. /**
  70584. * One transform per agent
  70585. */
  70586. transforms: TransformNode[];
  70587. /**
  70588. * All agents created
  70589. */
  70590. agents: number[];
  70591. /**
  70592. * Link to the scene is kept to unregister the crowd from the scene
  70593. */
  70594. private _scene;
  70595. /**
  70596. * Observer for crowd updates
  70597. */
  70598. private _onBeforeAnimationsObserver;
  70599. /**
  70600. * Constructor
  70601. * @param plugin recastJS plugin
  70602. * @param maxAgents the maximum agent count in the crowd
  70603. * @param maxAgentRadius the maximum radius an agent can have
  70604. * @param scene to attach the crowd to
  70605. * @returns the crowd you can add agents to
  70606. */
  70607. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70608. /**
  70609. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70610. * You can attach anything to that node. The node position is updated in the scene update tick.
  70611. * @param pos world position that will be constrained by the navigation mesh
  70612. * @param parameters agent parameters
  70613. * @param transform hooked to the agent that will be update by the scene
  70614. * @returns agent index
  70615. */
  70616. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70617. /**
  70618. * Returns the agent position in world space
  70619. * @param index agent index returned by addAgent
  70620. * @returns world space position
  70621. */
  70622. getAgentPosition(index: number): Vector3;
  70623. /**
  70624. * Returns the agent position result in world space
  70625. * @param index agent index returned by addAgent
  70626. * @param result output world space position
  70627. */
  70628. getAgentPositionToRef(index: number, result: Vector3): void;
  70629. /**
  70630. * Returns the agent velocity in world space
  70631. * @param index agent index returned by addAgent
  70632. * @returns world space velocity
  70633. */
  70634. getAgentVelocity(index: number): Vector3;
  70635. /**
  70636. * Returns the agent velocity result in world space
  70637. * @param index agent index returned by addAgent
  70638. * @param result output world space velocity
  70639. */
  70640. getAgentVelocityToRef(index: number, result: Vector3): void;
  70641. /**
  70642. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70643. * @param index agent index returned by addAgent
  70644. * @param destination targeted world position
  70645. */
  70646. agentGoto(index: number, destination: Vector3): void;
  70647. /**
  70648. * Teleport the agent to a new position
  70649. * @param index agent index returned by addAgent
  70650. * @param destination targeted world position
  70651. */
  70652. agentTeleport(index: number, destination: Vector3): void;
  70653. /**
  70654. * Update agent parameters
  70655. * @param index agent index returned by addAgent
  70656. * @param parameters agent parameters
  70657. */
  70658. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70659. /**
  70660. * remove a particular agent previously created
  70661. * @param index agent index returned by addAgent
  70662. */
  70663. removeAgent(index: number): void;
  70664. /**
  70665. * get the list of all agents attached to this crowd
  70666. * @returns list of agent indices
  70667. */
  70668. getAgents(): number[];
  70669. /**
  70670. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70671. * @param deltaTime in seconds
  70672. */
  70673. update(deltaTime: number): void;
  70674. /**
  70675. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70676. * The queries will try to find a solution within those bounds
  70677. * default is (1,1,1)
  70678. * @param extent x,y,z value that define the extent around the queries point of reference
  70679. */
  70680. setDefaultQueryExtent(extent: Vector3): void;
  70681. /**
  70682. * Get the Bounding box extent specified by setDefaultQueryExtent
  70683. * @returns the box extent values
  70684. */
  70685. getDefaultQueryExtent(): Vector3;
  70686. /**
  70687. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70688. * @param result output the box extent values
  70689. */
  70690. getDefaultQueryExtentToRef(result: Vector3): void;
  70691. /**
  70692. * Release all resources
  70693. */
  70694. dispose(): void;
  70695. }
  70696. }
  70697. declare module "babylonjs/Navigation/Plugins/index" {
  70698. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70699. }
  70700. declare module "babylonjs/Navigation/index" {
  70701. export * from "babylonjs/Navigation/INavigationEngine";
  70702. export * from "babylonjs/Navigation/Plugins/index";
  70703. }
  70704. declare module "babylonjs/Offline/database" {
  70705. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70706. /**
  70707. * Class used to enable access to IndexedDB
  70708. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70709. */
  70710. export class Database implements IOfflineProvider {
  70711. private _callbackManifestChecked;
  70712. private _currentSceneUrl;
  70713. private _db;
  70714. private _enableSceneOffline;
  70715. private _enableTexturesOffline;
  70716. private _manifestVersionFound;
  70717. private _mustUpdateRessources;
  70718. private _hasReachedQuota;
  70719. private _isSupported;
  70720. private _idbFactory;
  70721. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70722. private static IsUASupportingBlobStorage;
  70723. /**
  70724. * Gets a boolean indicating if Database storate is enabled (off by default)
  70725. */
  70726. static IDBStorageEnabled: boolean;
  70727. /**
  70728. * Gets a boolean indicating if scene must be saved in the database
  70729. */
  70730. get enableSceneOffline(): boolean;
  70731. /**
  70732. * Gets a boolean indicating if textures must be saved in the database
  70733. */
  70734. get enableTexturesOffline(): boolean;
  70735. /**
  70736. * Creates a new Database
  70737. * @param urlToScene defines the url to load the scene
  70738. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70739. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70740. */
  70741. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70742. private static _ParseURL;
  70743. private static _ReturnFullUrlLocation;
  70744. private _checkManifestFile;
  70745. /**
  70746. * Open the database and make it available
  70747. * @param successCallback defines the callback to call on success
  70748. * @param errorCallback defines the callback to call on error
  70749. */
  70750. open(successCallback: () => void, errorCallback: () => void): void;
  70751. /**
  70752. * Loads an image from the database
  70753. * @param url defines the url to load from
  70754. * @param image defines the target DOM image
  70755. */
  70756. loadImage(url: string, image: HTMLImageElement): void;
  70757. private _loadImageFromDBAsync;
  70758. private _saveImageIntoDBAsync;
  70759. private _checkVersionFromDB;
  70760. private _loadVersionFromDBAsync;
  70761. private _saveVersionIntoDBAsync;
  70762. /**
  70763. * Loads a file from database
  70764. * @param url defines the URL to load from
  70765. * @param sceneLoaded defines a callback to call on success
  70766. * @param progressCallBack defines a callback to call when progress changed
  70767. * @param errorCallback defines a callback to call on error
  70768. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70769. */
  70770. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70771. private _loadFileAsync;
  70772. private _saveFileAsync;
  70773. /**
  70774. * Validates if xhr data is correct
  70775. * @param xhr defines the request to validate
  70776. * @param dataType defines the expected data type
  70777. * @returns true if data is correct
  70778. */
  70779. private static _ValidateXHRData;
  70780. }
  70781. }
  70782. declare module "babylonjs/Offline/index" {
  70783. export * from "babylonjs/Offline/database";
  70784. export * from "babylonjs/Offline/IOfflineProvider";
  70785. }
  70786. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70787. /** @hidden */
  70788. export var gpuUpdateParticlesPixelShader: {
  70789. name: string;
  70790. shader: string;
  70791. };
  70792. }
  70793. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70794. /** @hidden */
  70795. export var gpuUpdateParticlesVertexShader: {
  70796. name: string;
  70797. shader: string;
  70798. };
  70799. }
  70800. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70801. /** @hidden */
  70802. export var clipPlaneFragmentDeclaration2: {
  70803. name: string;
  70804. shader: string;
  70805. };
  70806. }
  70807. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70808. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70809. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70810. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70811. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70812. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70813. /** @hidden */
  70814. export var gpuRenderParticlesPixelShader: {
  70815. name: string;
  70816. shader: string;
  70817. };
  70818. }
  70819. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70820. /** @hidden */
  70821. export var clipPlaneVertexDeclaration2: {
  70822. name: string;
  70823. shader: string;
  70824. };
  70825. }
  70826. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70827. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70828. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70829. /** @hidden */
  70830. export var gpuRenderParticlesVertexShader: {
  70831. name: string;
  70832. shader: string;
  70833. };
  70834. }
  70835. declare module "babylonjs/Particles/gpuParticleSystem" {
  70836. import { Nullable } from "babylonjs/types";
  70837. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70838. import { Observable } from "babylonjs/Misc/observable";
  70839. import { Matrix } from "babylonjs/Maths/math.vector";
  70840. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70841. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70842. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70843. import { IDisposable } from "babylonjs/scene";
  70844. import { Effect } from "babylonjs/Materials/effect";
  70845. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70846. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70847. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  70848. import { Scene } from "babylonjs/scene";
  70849. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70850. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70851. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70852. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70853. /**
  70854. * This represents a GPU particle system in Babylon
  70855. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70856. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70857. */
  70858. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70859. /**
  70860. * The layer mask we are rendering the particles through.
  70861. */
  70862. layerMask: number;
  70863. private _capacity;
  70864. private _activeCount;
  70865. private _currentActiveCount;
  70866. private _accumulatedCount;
  70867. private _renderEffect;
  70868. private _updateEffect;
  70869. private _buffer0;
  70870. private _buffer1;
  70871. private _spriteBuffer;
  70872. private _updateVAO;
  70873. private _renderVAO;
  70874. private _targetIndex;
  70875. private _sourceBuffer;
  70876. private _targetBuffer;
  70877. private _currentRenderId;
  70878. private _started;
  70879. private _stopped;
  70880. private _timeDelta;
  70881. private _randomTexture;
  70882. private _randomTexture2;
  70883. private _attributesStrideSize;
  70884. private _updateEffectOptions;
  70885. private _randomTextureSize;
  70886. private _actualFrame;
  70887. private _customEffect;
  70888. private readonly _rawTextureWidth;
  70889. /**
  70890. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70891. */
  70892. static get IsSupported(): boolean;
  70893. /**
  70894. * An event triggered when the system is disposed.
  70895. */
  70896. onDisposeObservable: Observable<IParticleSystem>;
  70897. /**
  70898. * Gets the maximum number of particles active at the same time.
  70899. * @returns The max number of active particles.
  70900. */
  70901. getCapacity(): number;
  70902. /**
  70903. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70904. * to override the particles.
  70905. */
  70906. forceDepthWrite: boolean;
  70907. /**
  70908. * Gets or set the number of active particles
  70909. */
  70910. get activeParticleCount(): number;
  70911. set activeParticleCount(value: number);
  70912. private _preWarmDone;
  70913. /**
  70914. * Specifies if the particles are updated in emitter local space or world space.
  70915. */
  70916. isLocal: boolean;
  70917. /** Gets or sets a matrix to use to compute projection */
  70918. defaultProjectionMatrix: Matrix;
  70919. /**
  70920. * Is this system ready to be used/rendered
  70921. * @return true if the system is ready
  70922. */
  70923. isReady(): boolean;
  70924. /**
  70925. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70926. * @returns True if it has been started, otherwise false.
  70927. */
  70928. isStarted(): boolean;
  70929. /**
  70930. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  70931. * @returns True if it has been stopped, otherwise false.
  70932. */
  70933. isStopped(): boolean;
  70934. /**
  70935. * Gets a boolean indicating that the system is stopping
  70936. * @returns true if the system is currently stopping
  70937. */
  70938. isStopping(): boolean;
  70939. /**
  70940. * Gets the number of particles active at the same time.
  70941. * @returns The number of active particles.
  70942. */
  70943. getActiveCount(): number;
  70944. /**
  70945. * Starts the particle system and begins to emit
  70946. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  70947. */
  70948. start(delay?: number): void;
  70949. /**
  70950. * Stops the particle system.
  70951. */
  70952. stop(): void;
  70953. /**
  70954. * Remove all active particles
  70955. */
  70956. reset(): void;
  70957. /**
  70958. * Returns the string "GPUParticleSystem"
  70959. * @returns a string containing the class name
  70960. */
  70961. getClassName(): string;
  70962. /**
  70963. * Gets the custom effect used to render the particles
  70964. * @param blendMode Blend mode for which the effect should be retrieved
  70965. * @returns The effect
  70966. */
  70967. getCustomEffect(blendMode?: number): Nullable<Effect>;
  70968. /**
  70969. * Sets the custom effect used to render the particles
  70970. * @param effect The effect to set
  70971. * @param blendMode Blend mode for which the effect should be set
  70972. */
  70973. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  70974. /** @hidden */
  70975. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  70976. /**
  70977. * Observable that will be called just before the particles are drawn
  70978. */
  70979. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  70980. /**
  70981. * Gets the name of the particle vertex shader
  70982. */
  70983. get vertexShaderName(): string;
  70984. private _colorGradientsTexture;
  70985. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  70986. /**
  70987. * Adds a new color gradient
  70988. * @param gradient defines the gradient to use (between 0 and 1)
  70989. * @param color1 defines the color to affect to the specified gradient
  70990. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  70991. * @returns the current particle system
  70992. */
  70993. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  70994. private _refreshColorGradient;
  70995. /** Force the system to rebuild all gradients that need to be resync */
  70996. forceRefreshGradients(): void;
  70997. /**
  70998. * Remove a specific color gradient
  70999. * @param gradient defines the gradient to remove
  71000. * @returns the current particle system
  71001. */
  71002. removeColorGradient(gradient: number): GPUParticleSystem;
  71003. private _angularSpeedGradientsTexture;
  71004. private _sizeGradientsTexture;
  71005. private _velocityGradientsTexture;
  71006. private _limitVelocityGradientsTexture;
  71007. private _dragGradientsTexture;
  71008. private _addFactorGradient;
  71009. /**
  71010. * Adds a new size gradient
  71011. * @param gradient defines the gradient to use (between 0 and 1)
  71012. * @param factor defines the size factor to affect to the specified gradient
  71013. * @returns the current particle system
  71014. */
  71015. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71016. /**
  71017. * Remove a specific size gradient
  71018. * @param gradient defines the gradient to remove
  71019. * @returns the current particle system
  71020. */
  71021. removeSizeGradient(gradient: number): GPUParticleSystem;
  71022. private _refreshFactorGradient;
  71023. /**
  71024. * Adds a new angular speed gradient
  71025. * @param gradient defines the gradient to use (between 0 and 1)
  71026. * @param factor defines the angular speed to affect to the specified gradient
  71027. * @returns the current particle system
  71028. */
  71029. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71030. /**
  71031. * Remove a specific angular speed gradient
  71032. * @param gradient defines the gradient to remove
  71033. * @returns the current particle system
  71034. */
  71035. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71036. /**
  71037. * Adds a new velocity gradient
  71038. * @param gradient defines the gradient to use (between 0 and 1)
  71039. * @param factor defines the velocity to affect to the specified gradient
  71040. * @returns the current particle system
  71041. */
  71042. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71043. /**
  71044. * Remove a specific velocity gradient
  71045. * @param gradient defines the gradient to remove
  71046. * @returns the current particle system
  71047. */
  71048. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71049. /**
  71050. * Adds a new limit velocity gradient
  71051. * @param gradient defines the gradient to use (between 0 and 1)
  71052. * @param factor defines the limit velocity value to affect to the specified gradient
  71053. * @returns the current particle system
  71054. */
  71055. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71056. /**
  71057. * Remove a specific limit velocity gradient
  71058. * @param gradient defines the gradient to remove
  71059. * @returns the current particle system
  71060. */
  71061. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71062. /**
  71063. * Adds a new drag gradient
  71064. * @param gradient defines the gradient to use (between 0 and 1)
  71065. * @param factor defines the drag value to affect to the specified gradient
  71066. * @returns the current particle system
  71067. */
  71068. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71069. /**
  71070. * Remove a specific drag gradient
  71071. * @param gradient defines the gradient to remove
  71072. * @returns the current particle system
  71073. */
  71074. removeDragGradient(gradient: number): GPUParticleSystem;
  71075. /**
  71076. * Not supported by GPUParticleSystem
  71077. * @param gradient defines the gradient to use (between 0 and 1)
  71078. * @param factor defines the emit rate value to affect to the specified gradient
  71079. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71080. * @returns the current particle system
  71081. */
  71082. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71083. /**
  71084. * Not supported by GPUParticleSystem
  71085. * @param gradient defines the gradient to remove
  71086. * @returns the current particle system
  71087. */
  71088. removeEmitRateGradient(gradient: number): IParticleSystem;
  71089. /**
  71090. * Not supported by GPUParticleSystem
  71091. * @param gradient defines the gradient to use (between 0 and 1)
  71092. * @param factor defines the start size value to affect to the specified gradient
  71093. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71094. * @returns the current particle system
  71095. */
  71096. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71097. /**
  71098. * Not supported by GPUParticleSystem
  71099. * @param gradient defines the gradient to remove
  71100. * @returns the current particle system
  71101. */
  71102. removeStartSizeGradient(gradient: number): IParticleSystem;
  71103. /**
  71104. * Not supported by GPUParticleSystem
  71105. * @param gradient defines the gradient to use (between 0 and 1)
  71106. * @param min defines the color remap minimal range
  71107. * @param max defines the color remap maximal range
  71108. * @returns the current particle system
  71109. */
  71110. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71111. /**
  71112. * Not supported by GPUParticleSystem
  71113. * @param gradient defines the gradient to remove
  71114. * @returns the current particle system
  71115. */
  71116. removeColorRemapGradient(): IParticleSystem;
  71117. /**
  71118. * Not supported by GPUParticleSystem
  71119. * @param gradient defines the gradient to use (between 0 and 1)
  71120. * @param min defines the alpha remap minimal range
  71121. * @param max defines the alpha remap maximal range
  71122. * @returns the current particle system
  71123. */
  71124. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71125. /**
  71126. * Not supported by GPUParticleSystem
  71127. * @param gradient defines the gradient to remove
  71128. * @returns the current particle system
  71129. */
  71130. removeAlphaRemapGradient(): IParticleSystem;
  71131. /**
  71132. * Not supported by GPUParticleSystem
  71133. * @param gradient defines the gradient to use (between 0 and 1)
  71134. * @param color defines the color to affect to the specified gradient
  71135. * @returns the current particle system
  71136. */
  71137. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71138. /**
  71139. * Not supported by GPUParticleSystem
  71140. * @param gradient defines the gradient to remove
  71141. * @returns the current particle system
  71142. */
  71143. removeRampGradient(): IParticleSystem;
  71144. /**
  71145. * Not supported by GPUParticleSystem
  71146. * @returns the list of ramp gradients
  71147. */
  71148. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71149. /**
  71150. * Not supported by GPUParticleSystem
  71151. * Gets or sets a boolean indicating that ramp gradients must be used
  71152. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71153. */
  71154. get useRampGradients(): boolean;
  71155. set useRampGradients(value: boolean);
  71156. /**
  71157. * Not supported by GPUParticleSystem
  71158. * @param gradient defines the gradient to use (between 0 and 1)
  71159. * @param factor defines the life time factor to affect to the specified gradient
  71160. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71161. * @returns the current particle system
  71162. */
  71163. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71164. /**
  71165. * Not supported by GPUParticleSystem
  71166. * @param gradient defines the gradient to remove
  71167. * @returns the current particle system
  71168. */
  71169. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71170. /**
  71171. * Instantiates a GPU particle system.
  71172. * 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.
  71173. * @param name The name of the particle system
  71174. * @param options The options used to create the system
  71175. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71176. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71177. * @param customEffect a custom effect used to change the way particles are rendered by default
  71178. */
  71179. constructor(name: string, options: Partial<{
  71180. capacity: number;
  71181. randomTextureSize: number;
  71182. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71183. protected _reset(): void;
  71184. private _createUpdateVAO;
  71185. private _createRenderVAO;
  71186. private _initialize;
  71187. /** @hidden */
  71188. _recreateUpdateEffect(): void;
  71189. private _getEffect;
  71190. /**
  71191. * Fill the defines array according to the current settings of the particle system
  71192. * @param defines Array to be updated
  71193. * @param blendMode blend mode to take into account when updating the array
  71194. */
  71195. fillDefines(defines: Array<string>, blendMode?: number): void;
  71196. /**
  71197. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71198. * @param uniforms Uniforms array to fill
  71199. * @param attributes Attributes array to fill
  71200. * @param samplers Samplers array to fill
  71201. */
  71202. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71203. /** @hidden */
  71204. _recreateRenderEffect(): Effect;
  71205. /**
  71206. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71207. * @param preWarm defines if we are in the pre-warmimg phase
  71208. */
  71209. animate(preWarm?: boolean): void;
  71210. private _createFactorGradientTexture;
  71211. private _createSizeGradientTexture;
  71212. private _createAngularSpeedGradientTexture;
  71213. private _createVelocityGradientTexture;
  71214. private _createLimitVelocityGradientTexture;
  71215. private _createDragGradientTexture;
  71216. private _createColorGradientTexture;
  71217. /**
  71218. * Renders the particle system in its current state
  71219. * @param preWarm defines if the system should only update the particles but not render them
  71220. * @returns the current number of particles
  71221. */
  71222. render(preWarm?: boolean): number;
  71223. /**
  71224. * Rebuilds the particle system
  71225. */
  71226. rebuild(): void;
  71227. private _releaseBuffers;
  71228. private _releaseVAOs;
  71229. /**
  71230. * Disposes the particle system and free the associated resources
  71231. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71232. */
  71233. dispose(disposeTexture?: boolean): void;
  71234. /**
  71235. * Clones the particle system.
  71236. * @param name The name of the cloned object
  71237. * @param newEmitter The new emitter to use
  71238. * @returns the cloned particle system
  71239. */
  71240. clone(name: string, newEmitter: any): GPUParticleSystem;
  71241. /**
  71242. * Serializes the particle system to a JSON object
  71243. * @param serializeTexture defines if the texture must be serialized as well
  71244. * @returns the JSON object
  71245. */
  71246. serialize(serializeTexture?: boolean): any;
  71247. /**
  71248. * Parses a JSON object to create a GPU particle system.
  71249. * @param parsedParticleSystem The JSON object to parse
  71250. * @param sceneOrEngine The scene or the engine to create the particle system in
  71251. * @param rootUrl The root url to use to load external dependencies like texture
  71252. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71253. * @returns the parsed GPU particle system
  71254. */
  71255. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71256. }
  71257. }
  71258. declare module "babylonjs/Particles/particleSystemSet" {
  71259. import { Nullable } from "babylonjs/types";
  71260. import { Color3 } from "babylonjs/Maths/math.color";
  71261. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71262. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71263. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71264. import { Scene, IDisposable } from "babylonjs/scene";
  71265. /**
  71266. * Represents a set of particle systems working together to create a specific effect
  71267. */
  71268. export class ParticleSystemSet implements IDisposable {
  71269. /**
  71270. * Gets or sets base Assets URL
  71271. */
  71272. static BaseAssetsUrl: string;
  71273. private _emitterCreationOptions;
  71274. private _emitterNode;
  71275. /**
  71276. * Gets the particle system list
  71277. */
  71278. systems: IParticleSystem[];
  71279. /**
  71280. * Gets the emitter node used with this set
  71281. */
  71282. get emitterNode(): Nullable<TransformNode>;
  71283. /**
  71284. * Creates a new emitter mesh as a sphere
  71285. * @param options defines the options used to create the sphere
  71286. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71287. * @param scene defines the hosting scene
  71288. */
  71289. setEmitterAsSphere(options: {
  71290. diameter: number;
  71291. segments: number;
  71292. color: Color3;
  71293. }, renderingGroupId: number, scene: Scene): void;
  71294. /**
  71295. * Starts all particle systems of the set
  71296. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71297. */
  71298. start(emitter?: AbstractMesh): void;
  71299. /**
  71300. * Release all associated resources
  71301. */
  71302. dispose(): void;
  71303. /**
  71304. * Serialize the set into a JSON compatible object
  71305. * @param serializeTexture defines if the texture must be serialized as well
  71306. * @returns a JSON compatible representation of the set
  71307. */
  71308. serialize(serializeTexture?: boolean): any;
  71309. /**
  71310. * Parse a new ParticleSystemSet from a serialized source
  71311. * @param data defines a JSON compatible representation of the set
  71312. * @param scene defines the hosting scene
  71313. * @param gpu defines if we want GPU particles or CPU particles
  71314. * @returns a new ParticleSystemSet
  71315. */
  71316. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71317. }
  71318. }
  71319. declare module "babylonjs/Particles/particleHelper" {
  71320. import { Nullable } from "babylonjs/types";
  71321. import { Scene } from "babylonjs/scene";
  71322. import { Vector3 } from "babylonjs/Maths/math.vector";
  71323. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71324. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71325. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71326. /**
  71327. * This class is made for on one-liner static method to help creating particle system set.
  71328. */
  71329. export class ParticleHelper {
  71330. /**
  71331. * Gets or sets base Assets URL
  71332. */
  71333. static BaseAssetsUrl: string;
  71334. /** Define the Url to load snippets */
  71335. static SnippetUrl: string;
  71336. /**
  71337. * Create a default particle system that you can tweak
  71338. * @param emitter defines the emitter to use
  71339. * @param capacity defines the system capacity (default is 500 particles)
  71340. * @param scene defines the hosting scene
  71341. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71342. * @returns the new Particle system
  71343. */
  71344. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71345. /**
  71346. * This is the main static method (one-liner) of this helper to create different particle systems
  71347. * @param type This string represents the type to the particle system to create
  71348. * @param scene The scene where the particle system should live
  71349. * @param gpu If the system will use gpu
  71350. * @returns the ParticleSystemSet created
  71351. */
  71352. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71353. /**
  71354. * Static function used to export a particle system to a ParticleSystemSet variable.
  71355. * Please note that the emitter shape is not exported
  71356. * @param systems defines the particle systems to export
  71357. * @returns the created particle system set
  71358. */
  71359. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71360. /**
  71361. * Creates a particle system from a snippet saved in a remote file
  71362. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71363. * @param url defines the url to load from
  71364. * @param scene defines the hosting scene
  71365. * @param gpu If the system will use gpu
  71366. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71367. * @returns a promise that will resolve to the new particle system
  71368. */
  71369. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71370. /**
  71371. * Creates a particle system from a snippet saved by the particle system editor
  71372. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71373. * @param scene defines the hosting scene
  71374. * @param gpu If the system will use gpu
  71375. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71376. * @returns a promise that will resolve to the new particle system
  71377. */
  71378. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71379. }
  71380. }
  71381. declare module "babylonjs/Particles/particleSystemComponent" {
  71382. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71383. import { Effect } from "babylonjs/Materials/effect";
  71384. import "babylonjs/Shaders/particles.vertex";
  71385. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71386. module "babylonjs/Engines/engine" {
  71387. interface Engine {
  71388. /**
  71389. * Create an effect to use with particle systems.
  71390. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71391. * the particle system for which you want to create a custom effect in the last parameter
  71392. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71393. * @param uniformsNames defines a list of attribute names
  71394. * @param samplers defines an array of string used to represent textures
  71395. * @param defines defines the string containing the defines to use to compile the shaders
  71396. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71397. * @param onCompiled defines a function to call when the effect creation is successful
  71398. * @param onError defines a function to call when the effect creation has failed
  71399. * @param particleSystem the particle system you want to create the effect for
  71400. * @returns the new Effect
  71401. */
  71402. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71403. }
  71404. }
  71405. module "babylonjs/Meshes/mesh" {
  71406. interface Mesh {
  71407. /**
  71408. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71409. * @returns an array of IParticleSystem
  71410. */
  71411. getEmittedParticleSystems(): IParticleSystem[];
  71412. /**
  71413. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71414. * @returns an array of IParticleSystem
  71415. */
  71416. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71417. }
  71418. }
  71419. }
  71420. declare module "babylonjs/Particles/pointsCloudSystem" {
  71421. import { Color4 } from "babylonjs/Maths/math";
  71422. import { Mesh } from "babylonjs/Meshes/mesh";
  71423. import { Scene, IDisposable } from "babylonjs/scene";
  71424. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71425. /** Defines the 4 color options */
  71426. export enum PointColor {
  71427. /** color value */
  71428. Color = 2,
  71429. /** uv value */
  71430. UV = 1,
  71431. /** random value */
  71432. Random = 0,
  71433. /** stated value */
  71434. Stated = 3
  71435. }
  71436. /**
  71437. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71438. * 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.
  71439. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71440. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71441. *
  71442. * Full documentation here : TO BE ENTERED
  71443. */
  71444. export class PointsCloudSystem implements IDisposable {
  71445. /**
  71446. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71447. * Example : var p = SPS.particles[i];
  71448. */
  71449. particles: CloudPoint[];
  71450. /**
  71451. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71452. */
  71453. nbParticles: number;
  71454. /**
  71455. * This a counter for your own usage. It's not set by any SPS functions.
  71456. */
  71457. counter: number;
  71458. /**
  71459. * The PCS name. This name is also given to the underlying mesh.
  71460. */
  71461. name: string;
  71462. /**
  71463. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71464. */
  71465. mesh: Mesh;
  71466. /**
  71467. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71468. * Please read :
  71469. */
  71470. vars: any;
  71471. /**
  71472. * @hidden
  71473. */
  71474. _size: number;
  71475. private _scene;
  71476. private _promises;
  71477. private _positions;
  71478. private _indices;
  71479. private _normals;
  71480. private _colors;
  71481. private _uvs;
  71482. private _indices32;
  71483. private _positions32;
  71484. private _colors32;
  71485. private _uvs32;
  71486. private _updatable;
  71487. private _isVisibilityBoxLocked;
  71488. private _alwaysVisible;
  71489. private _groups;
  71490. private _groupCounter;
  71491. private _computeParticleColor;
  71492. private _computeParticleTexture;
  71493. private _computeParticleRotation;
  71494. private _computeBoundingBox;
  71495. private _isReady;
  71496. /**
  71497. * Creates a PCS (Points Cloud System) object
  71498. * @param name (String) is the PCS name, this will be the underlying mesh name
  71499. * @param pointSize (number) is the size for each point
  71500. * @param scene (Scene) is the scene in which the PCS is added
  71501. * @param options defines the options of the PCS e.g.
  71502. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71503. */
  71504. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71505. updatable?: boolean;
  71506. });
  71507. /**
  71508. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71509. * If no points were added to the PCS, the returned mesh is just a single point.
  71510. * @returns a promise for the created mesh
  71511. */
  71512. buildMeshAsync(): Promise<Mesh>;
  71513. /**
  71514. * @hidden
  71515. */
  71516. private _buildMesh;
  71517. private _addParticle;
  71518. private _randomUnitVector;
  71519. private _getColorIndicesForCoord;
  71520. private _setPointsColorOrUV;
  71521. private _colorFromTexture;
  71522. private _calculateDensity;
  71523. /**
  71524. * Adds points to the PCS in random positions within a unit sphere
  71525. * @param nb (positive integer) the number of particles to be created from this model
  71526. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71527. * @returns the number of groups in the system
  71528. */
  71529. addPoints(nb: number, pointFunction?: any): number;
  71530. /**
  71531. * Adds points to the PCS from the surface of the model shape
  71532. * @param mesh is any Mesh object that will be used as a surface model for the points
  71533. * @param nb (positive integer) the number of particles to be created from this model
  71534. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71535. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71536. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71537. * @returns the number of groups in the system
  71538. */
  71539. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71540. /**
  71541. * Adds points to the PCS inside the model shape
  71542. * @param mesh is any Mesh object that will be used as a surface model for the points
  71543. * @param nb (positive integer) the number of particles to be created from this model
  71544. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71545. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71546. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71547. * @returns the number of groups in the system
  71548. */
  71549. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71550. /**
  71551. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71552. * This method calls `updateParticle()` for each particle of the SPS.
  71553. * For an animated SPS, it is usually called within the render loop.
  71554. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71555. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71556. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71557. * @returns the PCS.
  71558. */
  71559. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71560. /**
  71561. * Disposes the PCS.
  71562. */
  71563. dispose(): void;
  71564. /**
  71565. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71566. * doc :
  71567. * @returns the PCS.
  71568. */
  71569. refreshVisibleSize(): PointsCloudSystem;
  71570. /**
  71571. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71572. * @param size the size (float) of the visibility box
  71573. * note : this doesn't lock the PCS mesh bounding box.
  71574. * doc :
  71575. */
  71576. setVisibilityBox(size: number): void;
  71577. /**
  71578. * Gets whether the PCS is always visible or not
  71579. * doc :
  71580. */
  71581. get isAlwaysVisible(): boolean;
  71582. /**
  71583. * Sets the PCS as always visible or not
  71584. * doc :
  71585. */
  71586. set isAlwaysVisible(val: boolean);
  71587. /**
  71588. * Tells to `setParticles()` to compute the particle rotations or not
  71589. * Default value : false. The PCS is faster when it's set to false
  71590. * Note : particle rotations are only applied to parent particles
  71591. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71592. */
  71593. set computeParticleRotation(val: boolean);
  71594. /**
  71595. * Tells to `setParticles()` to compute the particle colors or not.
  71596. * Default value : true. The PCS is faster when it's set to false.
  71597. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71598. */
  71599. set computeParticleColor(val: boolean);
  71600. set computeParticleTexture(val: boolean);
  71601. /**
  71602. * Gets if `setParticles()` computes the particle colors or not.
  71603. * Default value : false. The PCS is faster when it's set to false.
  71604. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71605. */
  71606. get computeParticleColor(): boolean;
  71607. /**
  71608. * Gets if `setParticles()` computes the particle textures or not.
  71609. * Default value : false. The PCS is faster when it's set to false.
  71610. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71611. */
  71612. get computeParticleTexture(): boolean;
  71613. /**
  71614. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71615. */
  71616. set computeBoundingBox(val: boolean);
  71617. /**
  71618. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71619. */
  71620. get computeBoundingBox(): boolean;
  71621. /**
  71622. * This function does nothing. It may be overwritten to set all the particle first values.
  71623. * The PCS doesn't call this function, you may have to call it by your own.
  71624. * doc :
  71625. */
  71626. initParticles(): void;
  71627. /**
  71628. * This function does nothing. It may be overwritten to recycle a particle
  71629. * The PCS doesn't call this function, you can to call it
  71630. * doc :
  71631. * @param particle The particle to recycle
  71632. * @returns the recycled particle
  71633. */
  71634. recycleParticle(particle: CloudPoint): CloudPoint;
  71635. /**
  71636. * Updates a particle : this function should be overwritten by the user.
  71637. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71638. * doc :
  71639. * @example : just set a particle position or velocity and recycle conditions
  71640. * @param particle The particle to update
  71641. * @returns the updated particle
  71642. */
  71643. updateParticle(particle: CloudPoint): CloudPoint;
  71644. /**
  71645. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71646. * This does nothing and may be overwritten by the user.
  71647. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71648. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71649. * @param update the boolean update value actually passed to setParticles()
  71650. */
  71651. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71652. /**
  71653. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71654. * This will be passed three parameters.
  71655. * This does nothing and may be overwritten by the user.
  71656. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71657. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71658. * @param update the boolean update value actually passed to setParticles()
  71659. */
  71660. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71661. }
  71662. }
  71663. declare module "babylonjs/Particles/cloudPoint" {
  71664. import { Nullable } from "babylonjs/types";
  71665. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71666. import { Mesh } from "babylonjs/Meshes/mesh";
  71667. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71668. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71669. /**
  71670. * Represents one particle of a points cloud system.
  71671. */
  71672. export class CloudPoint {
  71673. /**
  71674. * particle global index
  71675. */
  71676. idx: number;
  71677. /**
  71678. * The color of the particle
  71679. */
  71680. color: Nullable<Color4>;
  71681. /**
  71682. * The world space position of the particle.
  71683. */
  71684. position: Vector3;
  71685. /**
  71686. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71687. */
  71688. rotation: Vector3;
  71689. /**
  71690. * The world space rotation quaternion of the particle.
  71691. */
  71692. rotationQuaternion: Nullable<Quaternion>;
  71693. /**
  71694. * The uv of the particle.
  71695. */
  71696. uv: Nullable<Vector2>;
  71697. /**
  71698. * The current speed of the particle.
  71699. */
  71700. velocity: Vector3;
  71701. /**
  71702. * The pivot point in the particle local space.
  71703. */
  71704. pivot: Vector3;
  71705. /**
  71706. * Must the particle be translated from its pivot point in its local space ?
  71707. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71708. * Default : false
  71709. */
  71710. translateFromPivot: boolean;
  71711. /**
  71712. * Index of this particle in the global "positions" array (Internal use)
  71713. * @hidden
  71714. */
  71715. _pos: number;
  71716. /**
  71717. * @hidden Index of this particle in the global "indices" array (Internal use)
  71718. */
  71719. _ind: number;
  71720. /**
  71721. * Group this particle belongs to
  71722. */
  71723. _group: PointsGroup;
  71724. /**
  71725. * Group id of this particle
  71726. */
  71727. groupId: number;
  71728. /**
  71729. * Index of the particle in its group id (Internal use)
  71730. */
  71731. idxInGroup: number;
  71732. /**
  71733. * @hidden Particle BoundingInfo object (Internal use)
  71734. */
  71735. _boundingInfo: BoundingInfo;
  71736. /**
  71737. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71738. */
  71739. _pcs: PointsCloudSystem;
  71740. /**
  71741. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71742. */
  71743. _stillInvisible: boolean;
  71744. /**
  71745. * @hidden Last computed particle rotation matrix
  71746. */
  71747. _rotationMatrix: number[];
  71748. /**
  71749. * Parent particle Id, if any.
  71750. * Default null.
  71751. */
  71752. parentId: Nullable<number>;
  71753. /**
  71754. * @hidden Internal global position in the PCS.
  71755. */
  71756. _globalPosition: Vector3;
  71757. /**
  71758. * Creates a Point Cloud object.
  71759. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71760. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71761. * @param group (PointsGroup) is the group the particle belongs to
  71762. * @param groupId (integer) is the group identifier in the PCS.
  71763. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71764. * @param pcs defines the PCS it is associated to
  71765. */
  71766. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71767. /**
  71768. * get point size
  71769. */
  71770. get size(): Vector3;
  71771. /**
  71772. * Set point size
  71773. */
  71774. set size(scale: Vector3);
  71775. /**
  71776. * Legacy support, changed quaternion to rotationQuaternion
  71777. */
  71778. get quaternion(): Nullable<Quaternion>;
  71779. /**
  71780. * Legacy support, changed quaternion to rotationQuaternion
  71781. */
  71782. set quaternion(q: Nullable<Quaternion>);
  71783. /**
  71784. * Returns a boolean. True if the particle intersects a mesh, else false
  71785. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71786. * @param target is the object (point or mesh) what the intersection is computed against
  71787. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71788. * @returns true if it intersects
  71789. */
  71790. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71791. /**
  71792. * get the rotation matrix of the particle
  71793. * @hidden
  71794. */
  71795. getRotationMatrix(m: Matrix): void;
  71796. }
  71797. /**
  71798. * Represents a group of points in a points cloud system
  71799. * * PCS internal tool, don't use it manually.
  71800. */
  71801. export class PointsGroup {
  71802. /**
  71803. * The group id
  71804. * @hidden
  71805. */
  71806. groupID: number;
  71807. /**
  71808. * image data for group (internal use)
  71809. * @hidden
  71810. */
  71811. _groupImageData: Nullable<ArrayBufferView>;
  71812. /**
  71813. * Image Width (internal use)
  71814. * @hidden
  71815. */
  71816. _groupImgWidth: number;
  71817. /**
  71818. * Image Height (internal use)
  71819. * @hidden
  71820. */
  71821. _groupImgHeight: number;
  71822. /**
  71823. * Custom position function (internal use)
  71824. * @hidden
  71825. */
  71826. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71827. /**
  71828. * density per facet for surface points
  71829. * @hidden
  71830. */
  71831. _groupDensity: number[];
  71832. /**
  71833. * Only when points are colored by texture carries pointer to texture list array
  71834. * @hidden
  71835. */
  71836. _textureNb: number;
  71837. /**
  71838. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71839. * PCS internal tool, don't use it manually.
  71840. * @hidden
  71841. */
  71842. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71843. }
  71844. }
  71845. declare module "babylonjs/Particles/index" {
  71846. export * from "babylonjs/Particles/baseParticleSystem";
  71847. export * from "babylonjs/Particles/EmitterTypes/index";
  71848. export * from "babylonjs/Particles/gpuParticleSystem";
  71849. export * from "babylonjs/Particles/IParticleSystem";
  71850. export * from "babylonjs/Particles/particle";
  71851. export * from "babylonjs/Particles/particleHelper";
  71852. export * from "babylonjs/Particles/particleSystem";
  71853. import "babylonjs/Particles/particleSystemComponent";
  71854. export * from "babylonjs/Particles/particleSystemComponent";
  71855. export * from "babylonjs/Particles/particleSystemSet";
  71856. export * from "babylonjs/Particles/solidParticle";
  71857. export * from "babylonjs/Particles/solidParticleSystem";
  71858. export * from "babylonjs/Particles/cloudPoint";
  71859. export * from "babylonjs/Particles/pointsCloudSystem";
  71860. export * from "babylonjs/Particles/subEmitter";
  71861. }
  71862. declare module "babylonjs/Physics/physicsEngineComponent" {
  71863. import { Nullable } from "babylonjs/types";
  71864. import { Observable, Observer } from "babylonjs/Misc/observable";
  71865. import { Vector3 } from "babylonjs/Maths/math.vector";
  71866. import { Mesh } from "babylonjs/Meshes/mesh";
  71867. import { ISceneComponent } from "babylonjs/sceneComponent";
  71868. import { Scene } from "babylonjs/scene";
  71869. import { Node } from "babylonjs/node";
  71870. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71871. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71872. module "babylonjs/scene" {
  71873. interface Scene {
  71874. /** @hidden (Backing field) */
  71875. _physicsEngine: Nullable<IPhysicsEngine>;
  71876. /** @hidden */
  71877. _physicsTimeAccumulator: number;
  71878. /**
  71879. * Gets the current physics engine
  71880. * @returns a IPhysicsEngine or null if none attached
  71881. */
  71882. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71883. /**
  71884. * Enables physics to the current scene
  71885. * @param gravity defines the scene's gravity for the physics engine
  71886. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71887. * @return a boolean indicating if the physics engine was initialized
  71888. */
  71889. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71890. /**
  71891. * Disables and disposes the physics engine associated with the scene
  71892. */
  71893. disablePhysicsEngine(): void;
  71894. /**
  71895. * Gets a boolean indicating if there is an active physics engine
  71896. * @returns a boolean indicating if there is an active physics engine
  71897. */
  71898. isPhysicsEnabled(): boolean;
  71899. /**
  71900. * Deletes a physics compound impostor
  71901. * @param compound defines the compound to delete
  71902. */
  71903. deleteCompoundImpostor(compound: any): void;
  71904. /**
  71905. * An event triggered when physic simulation is about to be run
  71906. */
  71907. onBeforePhysicsObservable: Observable<Scene>;
  71908. /**
  71909. * An event triggered when physic simulation has been done
  71910. */
  71911. onAfterPhysicsObservable: Observable<Scene>;
  71912. }
  71913. }
  71914. module "babylonjs/Meshes/abstractMesh" {
  71915. interface AbstractMesh {
  71916. /** @hidden */
  71917. _physicsImpostor: Nullable<PhysicsImpostor>;
  71918. /**
  71919. * Gets or sets impostor used for physic simulation
  71920. * @see https://doc.babylonjs.com/features/physics_engine
  71921. */
  71922. physicsImpostor: Nullable<PhysicsImpostor>;
  71923. /**
  71924. * Gets the current physics impostor
  71925. * @see https://doc.babylonjs.com/features/physics_engine
  71926. * @returns a physics impostor or null
  71927. */
  71928. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71929. /** Apply a physic impulse to the mesh
  71930. * @param force defines the force to apply
  71931. * @param contactPoint defines where to apply the force
  71932. * @returns the current mesh
  71933. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  71934. */
  71935. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  71936. /**
  71937. * Creates a physic joint between two meshes
  71938. * @param otherMesh defines the other mesh to use
  71939. * @param pivot1 defines the pivot to use on this mesh
  71940. * @param pivot2 defines the pivot to use on the other mesh
  71941. * @param options defines additional options (can be plugin dependent)
  71942. * @returns the current mesh
  71943. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  71944. */
  71945. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  71946. /** @hidden */
  71947. _disposePhysicsObserver: Nullable<Observer<Node>>;
  71948. }
  71949. }
  71950. /**
  71951. * Defines the physics engine scene component responsible to manage a physics engine
  71952. */
  71953. export class PhysicsEngineSceneComponent implements ISceneComponent {
  71954. /**
  71955. * The component name helpful to identify the component in the list of scene components.
  71956. */
  71957. readonly name: string;
  71958. /**
  71959. * The scene the component belongs to.
  71960. */
  71961. scene: Scene;
  71962. /**
  71963. * Creates a new instance of the component for the given scene
  71964. * @param scene Defines the scene to register the component in
  71965. */
  71966. constructor(scene: Scene);
  71967. /**
  71968. * Registers the component in a given scene
  71969. */
  71970. register(): void;
  71971. /**
  71972. * Rebuilds the elements related to this component in case of
  71973. * context lost for instance.
  71974. */
  71975. rebuild(): void;
  71976. /**
  71977. * Disposes the component and the associated ressources
  71978. */
  71979. dispose(): void;
  71980. }
  71981. }
  71982. declare module "babylonjs/Physics/physicsHelper" {
  71983. import { Nullable } from "babylonjs/types";
  71984. import { Vector3 } from "babylonjs/Maths/math.vector";
  71985. import { Mesh } from "babylonjs/Meshes/mesh";
  71986. import { Scene } from "babylonjs/scene";
  71987. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71988. /**
  71989. * A helper for physics simulations
  71990. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71991. */
  71992. export class PhysicsHelper {
  71993. private _scene;
  71994. private _physicsEngine;
  71995. /**
  71996. * Initializes the Physics helper
  71997. * @param scene Babylon.js scene
  71998. */
  71999. constructor(scene: Scene);
  72000. /**
  72001. * Applies a radial explosion impulse
  72002. * @param origin the origin of the explosion
  72003. * @param radiusOrEventOptions the radius or the options of radial explosion
  72004. * @param strength the explosion strength
  72005. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72006. * @returns A physics radial explosion event, or null
  72007. */
  72008. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72009. /**
  72010. * Applies a radial explosion force
  72011. * @param origin the origin of the explosion
  72012. * @param radiusOrEventOptions the radius or the options of radial explosion
  72013. * @param strength the explosion strength
  72014. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72015. * @returns A physics radial explosion event, or null
  72016. */
  72017. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72018. /**
  72019. * Creates a gravitational field
  72020. * @param origin the origin of the explosion
  72021. * @param radiusOrEventOptions the radius or the options of radial explosion
  72022. * @param strength the explosion strength
  72023. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72024. * @returns A physics gravitational field event, or null
  72025. */
  72026. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72027. /**
  72028. * Creates a physics updraft event
  72029. * @param origin the origin of the updraft
  72030. * @param radiusOrEventOptions the radius or the options of the updraft
  72031. * @param strength the strength of the updraft
  72032. * @param height the height of the updraft
  72033. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72034. * @returns A physics updraft event, or null
  72035. */
  72036. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72037. /**
  72038. * Creates a physics vortex event
  72039. * @param origin the of the vortex
  72040. * @param radiusOrEventOptions the radius or the options of the vortex
  72041. * @param strength the strength of the vortex
  72042. * @param height the height of the vortex
  72043. * @returns a Physics vortex event, or null
  72044. * A physics vortex event or null
  72045. */
  72046. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72047. }
  72048. /**
  72049. * Represents a physics radial explosion event
  72050. */
  72051. class PhysicsRadialExplosionEvent {
  72052. private _scene;
  72053. private _options;
  72054. private _sphere;
  72055. private _dataFetched;
  72056. /**
  72057. * Initializes a radial explosioin event
  72058. * @param _scene BabylonJS scene
  72059. * @param _options The options for the vortex event
  72060. */
  72061. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72062. /**
  72063. * Returns the data related to the radial explosion event (sphere).
  72064. * @returns The radial explosion event data
  72065. */
  72066. getData(): PhysicsRadialExplosionEventData;
  72067. /**
  72068. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72069. * @param impostor A physics imposter
  72070. * @param origin the origin of the explosion
  72071. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72072. */
  72073. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72074. /**
  72075. * Triggers affecterd impostors callbacks
  72076. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72077. */
  72078. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72079. /**
  72080. * Disposes the sphere.
  72081. * @param force Specifies if the sphere should be disposed by force
  72082. */
  72083. dispose(force?: boolean): void;
  72084. /*** Helpers ***/
  72085. private _prepareSphere;
  72086. private _intersectsWithSphere;
  72087. }
  72088. /**
  72089. * Represents a gravitational field event
  72090. */
  72091. class PhysicsGravitationalFieldEvent {
  72092. private _physicsHelper;
  72093. private _scene;
  72094. private _origin;
  72095. private _options;
  72096. private _tickCallback;
  72097. private _sphere;
  72098. private _dataFetched;
  72099. /**
  72100. * Initializes the physics gravitational field event
  72101. * @param _physicsHelper A physics helper
  72102. * @param _scene BabylonJS scene
  72103. * @param _origin The origin position of the gravitational field event
  72104. * @param _options The options for the vortex event
  72105. */
  72106. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72107. /**
  72108. * Returns the data related to the gravitational field event (sphere).
  72109. * @returns A gravitational field event
  72110. */
  72111. getData(): PhysicsGravitationalFieldEventData;
  72112. /**
  72113. * Enables the gravitational field.
  72114. */
  72115. enable(): void;
  72116. /**
  72117. * Disables the gravitational field.
  72118. */
  72119. disable(): void;
  72120. /**
  72121. * Disposes the sphere.
  72122. * @param force The force to dispose from the gravitational field event
  72123. */
  72124. dispose(force?: boolean): void;
  72125. private _tick;
  72126. }
  72127. /**
  72128. * Represents a physics updraft event
  72129. */
  72130. class PhysicsUpdraftEvent {
  72131. private _scene;
  72132. private _origin;
  72133. private _options;
  72134. private _physicsEngine;
  72135. private _originTop;
  72136. private _originDirection;
  72137. private _tickCallback;
  72138. private _cylinder;
  72139. private _cylinderPosition;
  72140. private _dataFetched;
  72141. /**
  72142. * Initializes the physics updraft event
  72143. * @param _scene BabylonJS scene
  72144. * @param _origin The origin position of the updraft
  72145. * @param _options The options for the updraft event
  72146. */
  72147. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72148. /**
  72149. * Returns the data related to the updraft event (cylinder).
  72150. * @returns A physics updraft event
  72151. */
  72152. getData(): PhysicsUpdraftEventData;
  72153. /**
  72154. * Enables the updraft.
  72155. */
  72156. enable(): void;
  72157. /**
  72158. * Disables the updraft.
  72159. */
  72160. disable(): void;
  72161. /**
  72162. * Disposes the cylinder.
  72163. * @param force Specifies if the updraft should be disposed by force
  72164. */
  72165. dispose(force?: boolean): void;
  72166. private getImpostorHitData;
  72167. private _tick;
  72168. /*** Helpers ***/
  72169. private _prepareCylinder;
  72170. private _intersectsWithCylinder;
  72171. }
  72172. /**
  72173. * Represents a physics vortex event
  72174. */
  72175. class PhysicsVortexEvent {
  72176. private _scene;
  72177. private _origin;
  72178. private _options;
  72179. private _physicsEngine;
  72180. private _originTop;
  72181. private _tickCallback;
  72182. private _cylinder;
  72183. private _cylinderPosition;
  72184. private _dataFetched;
  72185. /**
  72186. * Initializes the physics vortex event
  72187. * @param _scene The BabylonJS scene
  72188. * @param _origin The origin position of the vortex
  72189. * @param _options The options for the vortex event
  72190. */
  72191. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72192. /**
  72193. * Returns the data related to the vortex event (cylinder).
  72194. * @returns The physics vortex event data
  72195. */
  72196. getData(): PhysicsVortexEventData;
  72197. /**
  72198. * Enables the vortex.
  72199. */
  72200. enable(): void;
  72201. /**
  72202. * Disables the cortex.
  72203. */
  72204. disable(): void;
  72205. /**
  72206. * Disposes the sphere.
  72207. * @param force
  72208. */
  72209. dispose(force?: boolean): void;
  72210. private getImpostorHitData;
  72211. private _tick;
  72212. /*** Helpers ***/
  72213. private _prepareCylinder;
  72214. private _intersectsWithCylinder;
  72215. }
  72216. /**
  72217. * Options fot the radial explosion event
  72218. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72219. */
  72220. export class PhysicsRadialExplosionEventOptions {
  72221. /**
  72222. * The radius of the sphere for the radial explosion.
  72223. */
  72224. radius: number;
  72225. /**
  72226. * The strenth of the explosion.
  72227. */
  72228. strength: number;
  72229. /**
  72230. * The strenght of the force in correspondence to the distance of the affected object
  72231. */
  72232. falloff: PhysicsRadialImpulseFalloff;
  72233. /**
  72234. * Sphere options for the radial explosion.
  72235. */
  72236. sphere: {
  72237. segments: number;
  72238. diameter: number;
  72239. };
  72240. /**
  72241. * Sphere options for the radial explosion.
  72242. */
  72243. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72244. }
  72245. /**
  72246. * Options fot the updraft event
  72247. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72248. */
  72249. export class PhysicsUpdraftEventOptions {
  72250. /**
  72251. * The radius of the cylinder for the vortex
  72252. */
  72253. radius: number;
  72254. /**
  72255. * The strenth of the updraft.
  72256. */
  72257. strength: number;
  72258. /**
  72259. * The height of the cylinder for the updraft.
  72260. */
  72261. height: number;
  72262. /**
  72263. * The mode for the the updraft.
  72264. */
  72265. updraftMode: PhysicsUpdraftMode;
  72266. }
  72267. /**
  72268. * Options fot the vortex event
  72269. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72270. */
  72271. export class PhysicsVortexEventOptions {
  72272. /**
  72273. * The radius of the cylinder for the vortex
  72274. */
  72275. radius: number;
  72276. /**
  72277. * The strenth of the vortex.
  72278. */
  72279. strength: number;
  72280. /**
  72281. * The height of the cylinder for the vortex.
  72282. */
  72283. height: number;
  72284. /**
  72285. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72286. */
  72287. centripetalForceThreshold: number;
  72288. /**
  72289. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72290. */
  72291. centripetalForceMultiplier: number;
  72292. /**
  72293. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72294. */
  72295. centrifugalForceMultiplier: number;
  72296. /**
  72297. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72298. */
  72299. updraftForceMultiplier: number;
  72300. }
  72301. /**
  72302. * The strenght of the force in correspondence to the distance of the affected object
  72303. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72304. */
  72305. export enum PhysicsRadialImpulseFalloff {
  72306. /** Defines that impulse is constant in strength across it's whole radius */
  72307. Constant = 0,
  72308. /** Defines that impulse gets weaker if it's further from the origin */
  72309. Linear = 1
  72310. }
  72311. /**
  72312. * The strength of the force in correspondence to the distance of the affected object
  72313. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72314. */
  72315. export enum PhysicsUpdraftMode {
  72316. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72317. Center = 0,
  72318. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72319. Perpendicular = 1
  72320. }
  72321. /**
  72322. * Interface for a physics hit data
  72323. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72324. */
  72325. export interface PhysicsHitData {
  72326. /**
  72327. * The force applied at the contact point
  72328. */
  72329. force: Vector3;
  72330. /**
  72331. * The contact point
  72332. */
  72333. contactPoint: Vector3;
  72334. /**
  72335. * The distance from the origin to the contact point
  72336. */
  72337. distanceFromOrigin: number;
  72338. }
  72339. /**
  72340. * Interface for radial explosion event data
  72341. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72342. */
  72343. export interface PhysicsRadialExplosionEventData {
  72344. /**
  72345. * A sphere used for the radial explosion event
  72346. */
  72347. sphere: Mesh;
  72348. }
  72349. /**
  72350. * Interface for gravitational field event data
  72351. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72352. */
  72353. export interface PhysicsGravitationalFieldEventData {
  72354. /**
  72355. * A sphere mesh used for the gravitational field event
  72356. */
  72357. sphere: Mesh;
  72358. }
  72359. /**
  72360. * Interface for updraft event data
  72361. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72362. */
  72363. export interface PhysicsUpdraftEventData {
  72364. /**
  72365. * A cylinder used for the updraft event
  72366. */
  72367. cylinder: Mesh;
  72368. }
  72369. /**
  72370. * Interface for vortex event data
  72371. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72372. */
  72373. export interface PhysicsVortexEventData {
  72374. /**
  72375. * A cylinder used for the vortex event
  72376. */
  72377. cylinder: Mesh;
  72378. }
  72379. /**
  72380. * Interface for an affected physics impostor
  72381. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72382. */
  72383. export interface PhysicsAffectedImpostorWithData {
  72384. /**
  72385. * The impostor affected by the effect
  72386. */
  72387. impostor: PhysicsImpostor;
  72388. /**
  72389. * The data about the hit/horce from the explosion
  72390. */
  72391. hitData: PhysicsHitData;
  72392. }
  72393. }
  72394. declare module "babylonjs/Physics/Plugins/index" {
  72395. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72396. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72397. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72398. }
  72399. declare module "babylonjs/Physics/index" {
  72400. export * from "babylonjs/Physics/IPhysicsEngine";
  72401. export * from "babylonjs/Physics/physicsEngine";
  72402. export * from "babylonjs/Physics/physicsEngineComponent";
  72403. export * from "babylonjs/Physics/physicsHelper";
  72404. export * from "babylonjs/Physics/physicsImpostor";
  72405. export * from "babylonjs/Physics/physicsJoint";
  72406. export * from "babylonjs/Physics/Plugins/index";
  72407. }
  72408. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72409. /** @hidden */
  72410. export var blackAndWhitePixelShader: {
  72411. name: string;
  72412. shader: string;
  72413. };
  72414. }
  72415. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72416. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72417. import { Camera } from "babylonjs/Cameras/camera";
  72418. import { Engine } from "babylonjs/Engines/engine";
  72419. import "babylonjs/Shaders/blackAndWhite.fragment";
  72420. import { Nullable } from "babylonjs/types";
  72421. import { Scene } from "babylonjs/scene";
  72422. /**
  72423. * Post process used to render in black and white
  72424. */
  72425. export class BlackAndWhitePostProcess extends PostProcess {
  72426. /**
  72427. * Linear about to convert he result to black and white (default: 1)
  72428. */
  72429. degree: number;
  72430. /**
  72431. * Gets a string identifying the name of the class
  72432. * @returns "BlackAndWhitePostProcess" string
  72433. */
  72434. getClassName(): string;
  72435. /**
  72436. * Creates a black and white post process
  72437. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72438. * @param name The name of the effect.
  72439. * @param options The required width/height ratio to downsize to before computing the render pass.
  72440. * @param camera The camera to apply the render pass to.
  72441. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72442. * @param engine The engine which the post process will be applied. (default: current engine)
  72443. * @param reusable If the post process can be reused on the same frame. (default: false)
  72444. */
  72445. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72446. /** @hidden */
  72447. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72448. }
  72449. }
  72450. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72451. import { Nullable } from "babylonjs/types";
  72452. import { Camera } from "babylonjs/Cameras/camera";
  72453. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72454. import { Engine } from "babylonjs/Engines/engine";
  72455. /**
  72456. * This represents a set of one or more post processes in Babylon.
  72457. * A post process can be used to apply a shader to a texture after it is rendered.
  72458. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72459. */
  72460. export class PostProcessRenderEffect {
  72461. private _postProcesses;
  72462. private _getPostProcesses;
  72463. private _singleInstance;
  72464. private _cameras;
  72465. private _indicesForCamera;
  72466. /**
  72467. * Name of the effect
  72468. * @hidden
  72469. */
  72470. _name: string;
  72471. /**
  72472. * Instantiates a post process render effect.
  72473. * A post process can be used to apply a shader to a texture after it is rendered.
  72474. * @param engine The engine the effect is tied to
  72475. * @param name The name of the effect
  72476. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72477. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72478. */
  72479. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72480. /**
  72481. * Checks if all the post processes in the effect are supported.
  72482. */
  72483. get isSupported(): boolean;
  72484. /**
  72485. * Updates the current state of the effect
  72486. * @hidden
  72487. */
  72488. _update(): void;
  72489. /**
  72490. * Attaches the effect on cameras
  72491. * @param cameras The camera to attach to.
  72492. * @hidden
  72493. */
  72494. _attachCameras(cameras: Camera): void;
  72495. /**
  72496. * Attaches the effect on cameras
  72497. * @param cameras The camera to attach to.
  72498. * @hidden
  72499. */
  72500. _attachCameras(cameras: Camera[]): void;
  72501. /**
  72502. * Detaches the effect on cameras
  72503. * @param cameras The camera to detatch from.
  72504. * @hidden
  72505. */
  72506. _detachCameras(cameras: Camera): void;
  72507. /**
  72508. * Detatches the effect on cameras
  72509. * @param cameras The camera to detatch from.
  72510. * @hidden
  72511. */
  72512. _detachCameras(cameras: Camera[]): void;
  72513. /**
  72514. * Enables the effect on given cameras
  72515. * @param cameras The camera to enable.
  72516. * @hidden
  72517. */
  72518. _enable(cameras: Camera): void;
  72519. /**
  72520. * Enables the effect on given cameras
  72521. * @param cameras The camera to enable.
  72522. * @hidden
  72523. */
  72524. _enable(cameras: Nullable<Camera[]>): void;
  72525. /**
  72526. * Disables the effect on the given cameras
  72527. * @param cameras The camera to disable.
  72528. * @hidden
  72529. */
  72530. _disable(cameras: Camera): void;
  72531. /**
  72532. * Disables the effect on the given cameras
  72533. * @param cameras The camera to disable.
  72534. * @hidden
  72535. */
  72536. _disable(cameras: Nullable<Camera[]>): void;
  72537. /**
  72538. * Gets a list of the post processes contained in the effect.
  72539. * @param camera The camera to get the post processes on.
  72540. * @returns The list of the post processes in the effect.
  72541. */
  72542. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72543. }
  72544. }
  72545. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72546. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72547. /** @hidden */
  72548. export var extractHighlightsPixelShader: {
  72549. name: string;
  72550. shader: string;
  72551. };
  72552. }
  72553. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72554. import { Nullable } from "babylonjs/types";
  72555. import { Camera } from "babylonjs/Cameras/camera";
  72556. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72557. import { Engine } from "babylonjs/Engines/engine";
  72558. import "babylonjs/Shaders/extractHighlights.fragment";
  72559. /**
  72560. * 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.
  72561. */
  72562. export class ExtractHighlightsPostProcess extends PostProcess {
  72563. /**
  72564. * The luminance threshold, pixels below this value will be set to black.
  72565. */
  72566. threshold: number;
  72567. /** @hidden */
  72568. _exposure: number;
  72569. /**
  72570. * Post process which has the input texture to be used when performing highlight extraction
  72571. * @hidden
  72572. */
  72573. _inputPostProcess: Nullable<PostProcess>;
  72574. /**
  72575. * Gets a string identifying the name of the class
  72576. * @returns "ExtractHighlightsPostProcess" string
  72577. */
  72578. getClassName(): string;
  72579. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72580. }
  72581. }
  72582. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72583. /** @hidden */
  72584. export var bloomMergePixelShader: {
  72585. name: string;
  72586. shader: string;
  72587. };
  72588. }
  72589. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72590. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72591. import { Nullable } from "babylonjs/types";
  72592. import { Engine } from "babylonjs/Engines/engine";
  72593. import { Camera } from "babylonjs/Cameras/camera";
  72594. import "babylonjs/Shaders/bloomMerge.fragment";
  72595. /**
  72596. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72597. */
  72598. export class BloomMergePostProcess extends PostProcess {
  72599. /** Weight of the bloom to be added to the original input. */
  72600. weight: number;
  72601. /**
  72602. * Gets a string identifying the name of the class
  72603. * @returns "BloomMergePostProcess" string
  72604. */
  72605. getClassName(): string;
  72606. /**
  72607. * Creates a new instance of @see BloomMergePostProcess
  72608. * @param name The name of the effect.
  72609. * @param originalFromInput Post process which's input will be used for the merge.
  72610. * @param blurred Blurred highlights post process which's output will be used.
  72611. * @param weight Weight of the bloom to be added to the original input.
  72612. * @param options The required width/height ratio to downsize to before computing the render pass.
  72613. * @param camera The camera to apply the render pass to.
  72614. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72615. * @param engine The engine which the post process will be applied. (default: current engine)
  72616. * @param reusable If the post process can be reused on the same frame. (default: false)
  72617. * @param textureType Type of textures used when performing the post process. (default: 0)
  72618. * @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)
  72619. */
  72620. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72621. /** Weight of the bloom to be added to the original input. */
  72622. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72623. }
  72624. }
  72625. declare module "babylonjs/PostProcesses/bloomEffect" {
  72626. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72627. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72628. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72629. import { Camera } from "babylonjs/Cameras/camera";
  72630. import { Scene } from "babylonjs/scene";
  72631. /**
  72632. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72633. */
  72634. export class BloomEffect extends PostProcessRenderEffect {
  72635. private bloomScale;
  72636. /**
  72637. * @hidden Internal
  72638. */
  72639. _effects: Array<PostProcess>;
  72640. /**
  72641. * @hidden Internal
  72642. */
  72643. _downscale: ExtractHighlightsPostProcess;
  72644. private _blurX;
  72645. private _blurY;
  72646. private _merge;
  72647. /**
  72648. * The luminance threshold to find bright areas of the image to bloom.
  72649. */
  72650. get threshold(): number;
  72651. set threshold(value: number);
  72652. /**
  72653. * The strength of the bloom.
  72654. */
  72655. get weight(): number;
  72656. set weight(value: number);
  72657. /**
  72658. * Specifies the size of the bloom blur kernel, relative to the final output size
  72659. */
  72660. get kernel(): number;
  72661. set kernel(value: number);
  72662. /**
  72663. * Creates a new instance of @see BloomEffect
  72664. * @param scene The scene the effect belongs to.
  72665. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72666. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72667. * @param bloomWeight The the strength of bloom.
  72668. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72669. * @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)
  72670. */
  72671. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72672. /**
  72673. * Disposes each of the internal effects for a given camera.
  72674. * @param camera The camera to dispose the effect on.
  72675. */
  72676. disposeEffects(camera: Camera): void;
  72677. /**
  72678. * @hidden Internal
  72679. */
  72680. _updateEffects(): void;
  72681. /**
  72682. * Internal
  72683. * @returns if all the contained post processes are ready.
  72684. * @hidden
  72685. */
  72686. _isReady(): boolean;
  72687. }
  72688. }
  72689. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72690. /** @hidden */
  72691. export var chromaticAberrationPixelShader: {
  72692. name: string;
  72693. shader: string;
  72694. };
  72695. }
  72696. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72697. import { Vector2 } from "babylonjs/Maths/math.vector";
  72698. import { Nullable } from "babylonjs/types";
  72699. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72700. import { Camera } from "babylonjs/Cameras/camera";
  72701. import { Engine } from "babylonjs/Engines/engine";
  72702. import "babylonjs/Shaders/chromaticAberration.fragment";
  72703. import { Scene } from "babylonjs/scene";
  72704. /**
  72705. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72706. */
  72707. export class ChromaticAberrationPostProcess extends PostProcess {
  72708. /**
  72709. * The amount of seperation of rgb channels (default: 30)
  72710. */
  72711. aberrationAmount: number;
  72712. /**
  72713. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72714. */
  72715. radialIntensity: number;
  72716. /**
  72717. * 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))
  72718. */
  72719. direction: Vector2;
  72720. /**
  72721. * 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))
  72722. */
  72723. centerPosition: Vector2;
  72724. /** The width of the screen to apply the effect on */
  72725. screenWidth: number;
  72726. /** The height of the screen to apply the effect on */
  72727. screenHeight: number;
  72728. /**
  72729. * Gets a string identifying the name of the class
  72730. * @returns "ChromaticAberrationPostProcess" string
  72731. */
  72732. getClassName(): string;
  72733. /**
  72734. * Creates a new instance ChromaticAberrationPostProcess
  72735. * @param name The name of the effect.
  72736. * @param screenWidth The width of the screen to apply the effect on.
  72737. * @param screenHeight The height of the screen to apply the effect on.
  72738. * @param options The required width/height ratio to downsize to before computing the render pass.
  72739. * @param camera The camera to apply the render pass to.
  72740. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72741. * @param engine The engine which the post process will be applied. (default: current engine)
  72742. * @param reusable If the post process can be reused on the same frame. (default: false)
  72743. * @param textureType Type of textures used when performing the post process. (default: 0)
  72744. * @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)
  72745. */
  72746. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72747. /** @hidden */
  72748. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72749. }
  72750. }
  72751. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72752. /** @hidden */
  72753. export var circleOfConfusionPixelShader: {
  72754. name: string;
  72755. shader: string;
  72756. };
  72757. }
  72758. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72759. import { Nullable } from "babylonjs/types";
  72760. import { Engine } from "babylonjs/Engines/engine";
  72761. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72762. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72763. import { Camera } from "babylonjs/Cameras/camera";
  72764. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72765. /**
  72766. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72767. */
  72768. export class CircleOfConfusionPostProcess extends PostProcess {
  72769. /**
  72770. * 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.
  72771. */
  72772. lensSize: number;
  72773. /**
  72774. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72775. */
  72776. fStop: number;
  72777. /**
  72778. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72779. */
  72780. focusDistance: number;
  72781. /**
  72782. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72783. */
  72784. focalLength: number;
  72785. /**
  72786. * Gets a string identifying the name of the class
  72787. * @returns "CircleOfConfusionPostProcess" string
  72788. */
  72789. getClassName(): string;
  72790. private _depthTexture;
  72791. /**
  72792. * Creates a new instance CircleOfConfusionPostProcess
  72793. * @param name The name of the effect.
  72794. * @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.
  72795. * @param options The required width/height ratio to downsize to before computing the render pass.
  72796. * @param camera The camera to apply the render pass to.
  72797. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72798. * @param engine The engine which the post process will be applied. (default: current engine)
  72799. * @param reusable If the post process can be reused on the same frame. (default: false)
  72800. * @param textureType Type of textures used when performing the post process. (default: 0)
  72801. * @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)
  72802. */
  72803. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72804. /**
  72805. * 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.
  72806. */
  72807. set depthTexture(value: RenderTargetTexture);
  72808. }
  72809. }
  72810. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72811. /** @hidden */
  72812. export var colorCorrectionPixelShader: {
  72813. name: string;
  72814. shader: string;
  72815. };
  72816. }
  72817. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72818. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72819. import { Engine } from "babylonjs/Engines/engine";
  72820. import { Camera } from "babylonjs/Cameras/camera";
  72821. import "babylonjs/Shaders/colorCorrection.fragment";
  72822. import { Nullable } from "babylonjs/types";
  72823. import { Scene } from "babylonjs/scene";
  72824. /**
  72825. *
  72826. * This post-process allows the modification of rendered colors by using
  72827. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72828. *
  72829. * The object needs to be provided an url to a texture containing the color
  72830. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72831. * Use an image editing software to tweak the LUT to match your needs.
  72832. *
  72833. * For an example of a color LUT, see here:
  72834. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72835. * For explanations on color grading, see here:
  72836. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72837. *
  72838. */
  72839. export class ColorCorrectionPostProcess extends PostProcess {
  72840. private _colorTableTexture;
  72841. /**
  72842. * Gets the color table url used to create the LUT texture
  72843. */
  72844. colorTableUrl: string;
  72845. /**
  72846. * Gets a string identifying the name of the class
  72847. * @returns "ColorCorrectionPostProcess" string
  72848. */
  72849. getClassName(): string;
  72850. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72851. /** @hidden */
  72852. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  72853. }
  72854. }
  72855. declare module "babylonjs/Shaders/convolution.fragment" {
  72856. /** @hidden */
  72857. export var convolutionPixelShader: {
  72858. name: string;
  72859. shader: string;
  72860. };
  72861. }
  72862. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72863. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72864. import { Nullable } from "babylonjs/types";
  72865. import { Camera } from "babylonjs/Cameras/camera";
  72866. import { Engine } from "babylonjs/Engines/engine";
  72867. import "babylonjs/Shaders/convolution.fragment";
  72868. import { Scene } from "babylonjs/scene";
  72869. /**
  72870. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72871. * input texture to perform effects such as edge detection or sharpening
  72872. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72873. */
  72874. export class ConvolutionPostProcess extends PostProcess {
  72875. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72876. kernel: number[];
  72877. /**
  72878. * Gets a string identifying the name of the class
  72879. * @returns "ConvolutionPostProcess" string
  72880. */
  72881. getClassName(): string;
  72882. /**
  72883. * Creates a new instance ConvolutionPostProcess
  72884. * @param name The name of the effect.
  72885. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72886. * @param options The required width/height ratio to downsize to before computing the render pass.
  72887. * @param camera The camera to apply the render pass to.
  72888. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72889. * @param engine The engine which the post process will be applied. (default: current engine)
  72890. * @param reusable If the post process can be reused on the same frame. (default: false)
  72891. * @param textureType Type of textures used when performing the post process. (default: 0)
  72892. */
  72893. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72894. /** @hidden */
  72895. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  72896. /**
  72897. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72898. */
  72899. static EdgeDetect0Kernel: number[];
  72900. /**
  72901. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72902. */
  72903. static EdgeDetect1Kernel: number[];
  72904. /**
  72905. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72906. */
  72907. static EdgeDetect2Kernel: number[];
  72908. /**
  72909. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72910. */
  72911. static SharpenKernel: number[];
  72912. /**
  72913. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72914. */
  72915. static EmbossKernel: number[];
  72916. /**
  72917. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72918. */
  72919. static GaussianKernel: number[];
  72920. }
  72921. }
  72922. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72923. import { Nullable } from "babylonjs/types";
  72924. import { Vector2 } from "babylonjs/Maths/math.vector";
  72925. import { Camera } from "babylonjs/Cameras/camera";
  72926. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72927. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72928. import { Engine } from "babylonjs/Engines/engine";
  72929. import { Scene } from "babylonjs/scene";
  72930. /**
  72931. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  72932. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  72933. * based on samples that have a large difference in distance than the center pixel.
  72934. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  72935. */
  72936. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  72937. /**
  72938. * The direction the blur should be applied
  72939. */
  72940. direction: Vector2;
  72941. /**
  72942. * Gets a string identifying the name of the class
  72943. * @returns "DepthOfFieldBlurPostProcess" string
  72944. */
  72945. getClassName(): string;
  72946. /**
  72947. * Creates a new instance CircleOfConfusionPostProcess
  72948. * @param name The name of the effect.
  72949. * @param scene The scene the effect belongs to.
  72950. * @param direction The direction the blur should be applied.
  72951. * @param kernel The size of the kernel used to blur.
  72952. * @param options The required width/height ratio to downsize to before computing the render pass.
  72953. * @param camera The camera to apply the render pass to.
  72954. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  72955. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  72956. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72957. * @param engine The engine which the post process will be applied. (default: current engine)
  72958. * @param reusable If the post process can be reused on the same frame. (default: false)
  72959. * @param textureType Type of textures used when performing the post process. (default: 0)
  72960. * @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)
  72961. */
  72962. 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);
  72963. }
  72964. }
  72965. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  72966. /** @hidden */
  72967. export var depthOfFieldMergePixelShader: {
  72968. name: string;
  72969. shader: string;
  72970. };
  72971. }
  72972. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  72973. import { Nullable } from "babylonjs/types";
  72974. import { Camera } from "babylonjs/Cameras/camera";
  72975. import { Effect } from "babylonjs/Materials/effect";
  72976. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72977. import { Engine } from "babylonjs/Engines/engine";
  72978. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  72979. /**
  72980. * Options to be set when merging outputs from the default pipeline.
  72981. */
  72982. export class DepthOfFieldMergePostProcessOptions {
  72983. /**
  72984. * The original image to merge on top of
  72985. */
  72986. originalFromInput: PostProcess;
  72987. /**
  72988. * Parameters to perform the merge of the depth of field effect
  72989. */
  72990. depthOfField?: {
  72991. circleOfConfusion: PostProcess;
  72992. blurSteps: Array<PostProcess>;
  72993. };
  72994. /**
  72995. * Parameters to perform the merge of bloom effect
  72996. */
  72997. bloom?: {
  72998. blurred: PostProcess;
  72999. weight: number;
  73000. };
  73001. }
  73002. /**
  73003. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73004. */
  73005. export class DepthOfFieldMergePostProcess extends PostProcess {
  73006. private blurSteps;
  73007. /**
  73008. * Gets a string identifying the name of the class
  73009. * @returns "DepthOfFieldMergePostProcess" string
  73010. */
  73011. getClassName(): string;
  73012. /**
  73013. * Creates a new instance of DepthOfFieldMergePostProcess
  73014. * @param name The name of the effect.
  73015. * @param originalFromInput Post process which's input will be used for the merge.
  73016. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73017. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73018. * @param options The required width/height ratio to downsize to before computing the render pass.
  73019. * @param camera The camera to apply the render pass to.
  73020. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73021. * @param engine The engine which the post process will be applied. (default: current engine)
  73022. * @param reusable If the post process can be reused on the same frame. (default: false)
  73023. * @param textureType Type of textures used when performing the post process. (default: 0)
  73024. * @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)
  73025. */
  73026. 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);
  73027. /**
  73028. * Updates the effect with the current post process compile time values and recompiles the shader.
  73029. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73030. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73031. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73032. * @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
  73033. * @param onCompiled Called when the shader has been compiled.
  73034. * @param onError Called if there is an error when compiling a shader.
  73035. */
  73036. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73037. }
  73038. }
  73039. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73040. import { Nullable } from "babylonjs/types";
  73041. import { Camera } from "babylonjs/Cameras/camera";
  73042. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73043. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73044. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73045. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73046. import { Scene } from "babylonjs/scene";
  73047. /**
  73048. * Specifies the level of max blur that should be applied when using the depth of field effect
  73049. */
  73050. export enum DepthOfFieldEffectBlurLevel {
  73051. /**
  73052. * Subtle blur
  73053. */
  73054. Low = 0,
  73055. /**
  73056. * Medium blur
  73057. */
  73058. Medium = 1,
  73059. /**
  73060. * Large blur
  73061. */
  73062. High = 2
  73063. }
  73064. /**
  73065. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73066. */
  73067. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73068. private _circleOfConfusion;
  73069. /**
  73070. * @hidden Internal, blurs from high to low
  73071. */
  73072. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73073. private _depthOfFieldBlurY;
  73074. private _dofMerge;
  73075. /**
  73076. * @hidden Internal post processes in depth of field effect
  73077. */
  73078. _effects: Array<PostProcess>;
  73079. /**
  73080. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73081. */
  73082. set focalLength(value: number);
  73083. get focalLength(): number;
  73084. /**
  73085. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73086. */
  73087. set fStop(value: number);
  73088. get fStop(): number;
  73089. /**
  73090. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73091. */
  73092. set focusDistance(value: number);
  73093. get focusDistance(): number;
  73094. /**
  73095. * 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.
  73096. */
  73097. set lensSize(value: number);
  73098. get lensSize(): number;
  73099. /**
  73100. * Creates a new instance DepthOfFieldEffect
  73101. * @param scene The scene the effect belongs to.
  73102. * @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.
  73103. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73104. * @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)
  73105. */
  73106. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73107. /**
  73108. * Get the current class name of the current effet
  73109. * @returns "DepthOfFieldEffect"
  73110. */
  73111. getClassName(): string;
  73112. /**
  73113. * 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.
  73114. */
  73115. set depthTexture(value: RenderTargetTexture);
  73116. /**
  73117. * Disposes each of the internal effects for a given camera.
  73118. * @param camera The camera to dispose the effect on.
  73119. */
  73120. disposeEffects(camera: Camera): void;
  73121. /**
  73122. * @hidden Internal
  73123. */
  73124. _updateEffects(): void;
  73125. /**
  73126. * Internal
  73127. * @returns if all the contained post processes are ready.
  73128. * @hidden
  73129. */
  73130. _isReady(): boolean;
  73131. }
  73132. }
  73133. declare module "babylonjs/Shaders/displayPass.fragment" {
  73134. /** @hidden */
  73135. export var displayPassPixelShader: {
  73136. name: string;
  73137. shader: string;
  73138. };
  73139. }
  73140. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73141. import { Nullable } from "babylonjs/types";
  73142. import { Camera } from "babylonjs/Cameras/camera";
  73143. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73144. import { Engine } from "babylonjs/Engines/engine";
  73145. import "babylonjs/Shaders/displayPass.fragment";
  73146. import { Scene } from "babylonjs/scene";
  73147. /**
  73148. * DisplayPassPostProcess which produces an output the same as it's input
  73149. */
  73150. export class DisplayPassPostProcess extends PostProcess {
  73151. /**
  73152. * Gets a string identifying the name of the class
  73153. * @returns "DisplayPassPostProcess" string
  73154. */
  73155. getClassName(): string;
  73156. /**
  73157. * Creates the DisplayPassPostProcess
  73158. * @param name The name of the effect.
  73159. * @param options The required width/height ratio to downsize to before computing the render pass.
  73160. * @param camera The camera to apply the render pass to.
  73161. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73162. * @param engine The engine which the post process will be applied. (default: current engine)
  73163. * @param reusable If the post process can be reused on the same frame. (default: false)
  73164. */
  73165. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73166. /** @hidden */
  73167. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73168. }
  73169. }
  73170. declare module "babylonjs/Shaders/filter.fragment" {
  73171. /** @hidden */
  73172. export var filterPixelShader: {
  73173. name: string;
  73174. shader: string;
  73175. };
  73176. }
  73177. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73178. import { Nullable } from "babylonjs/types";
  73179. import { Matrix } from "babylonjs/Maths/math.vector";
  73180. import { Camera } from "babylonjs/Cameras/camera";
  73181. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73182. import { Engine } from "babylonjs/Engines/engine";
  73183. import "babylonjs/Shaders/filter.fragment";
  73184. import { Scene } from "babylonjs/scene";
  73185. /**
  73186. * Applies a kernel filter to the image
  73187. */
  73188. export class FilterPostProcess extends PostProcess {
  73189. /** The matrix to be applied to the image */
  73190. kernelMatrix: Matrix;
  73191. /**
  73192. * Gets a string identifying the name of the class
  73193. * @returns "FilterPostProcess" string
  73194. */
  73195. getClassName(): string;
  73196. /**
  73197. *
  73198. * @param name The name of the effect.
  73199. * @param kernelMatrix The matrix to be applied to the image
  73200. * @param options The required width/height ratio to downsize to before computing the render pass.
  73201. * @param camera The camera to apply the render pass to.
  73202. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73203. * @param engine The engine which the post process will be applied. (default: current engine)
  73204. * @param reusable If the post process can be reused on the same frame. (default: false)
  73205. */
  73206. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73207. /** @hidden */
  73208. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73209. }
  73210. }
  73211. declare module "babylonjs/Shaders/fxaa.fragment" {
  73212. /** @hidden */
  73213. export var fxaaPixelShader: {
  73214. name: string;
  73215. shader: string;
  73216. };
  73217. }
  73218. declare module "babylonjs/Shaders/fxaa.vertex" {
  73219. /** @hidden */
  73220. export var fxaaVertexShader: {
  73221. name: string;
  73222. shader: string;
  73223. };
  73224. }
  73225. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73226. import { Nullable } from "babylonjs/types";
  73227. import { Camera } from "babylonjs/Cameras/camera";
  73228. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73229. import { Engine } from "babylonjs/Engines/engine";
  73230. import "babylonjs/Shaders/fxaa.fragment";
  73231. import "babylonjs/Shaders/fxaa.vertex";
  73232. import { Scene } from "babylonjs/scene";
  73233. /**
  73234. * Fxaa post process
  73235. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73236. */
  73237. export class FxaaPostProcess extends PostProcess {
  73238. /**
  73239. * Gets a string identifying the name of the class
  73240. * @returns "FxaaPostProcess" string
  73241. */
  73242. getClassName(): string;
  73243. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73244. private _getDefines;
  73245. /** @hidden */
  73246. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73247. }
  73248. }
  73249. declare module "babylonjs/Shaders/grain.fragment" {
  73250. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73251. /** @hidden */
  73252. export var grainPixelShader: {
  73253. name: string;
  73254. shader: string;
  73255. };
  73256. }
  73257. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73258. import { Nullable } from "babylonjs/types";
  73259. import { Camera } from "babylonjs/Cameras/camera";
  73260. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73261. import { Engine } from "babylonjs/Engines/engine";
  73262. import "babylonjs/Shaders/grain.fragment";
  73263. import { Scene } from "babylonjs/scene";
  73264. /**
  73265. * The GrainPostProcess adds noise to the image at mid luminance levels
  73266. */
  73267. export class GrainPostProcess extends PostProcess {
  73268. /**
  73269. * The intensity of the grain added (default: 30)
  73270. */
  73271. intensity: number;
  73272. /**
  73273. * If the grain should be randomized on every frame
  73274. */
  73275. animated: boolean;
  73276. /**
  73277. * Gets a string identifying the name of the class
  73278. * @returns "GrainPostProcess" string
  73279. */
  73280. getClassName(): string;
  73281. /**
  73282. * Creates a new instance of @see GrainPostProcess
  73283. * @param name The name of the effect.
  73284. * @param options The required width/height ratio to downsize to before computing the render pass.
  73285. * @param camera The camera to apply the render pass to.
  73286. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73287. * @param engine The engine which the post process will be applied. (default: current engine)
  73288. * @param reusable If the post process can be reused on the same frame. (default: false)
  73289. * @param textureType Type of textures used when performing the post process. (default: 0)
  73290. * @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)
  73291. */
  73292. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73293. /** @hidden */
  73294. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73295. }
  73296. }
  73297. declare module "babylonjs/Shaders/highlights.fragment" {
  73298. /** @hidden */
  73299. export var highlightsPixelShader: {
  73300. name: string;
  73301. shader: string;
  73302. };
  73303. }
  73304. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73305. import { Nullable } from "babylonjs/types";
  73306. import { Camera } from "babylonjs/Cameras/camera";
  73307. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73308. import { Engine } from "babylonjs/Engines/engine";
  73309. import "babylonjs/Shaders/highlights.fragment";
  73310. /**
  73311. * Extracts highlights from the image
  73312. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73313. */
  73314. export class HighlightsPostProcess extends PostProcess {
  73315. /**
  73316. * Gets a string identifying the name of the class
  73317. * @returns "HighlightsPostProcess" string
  73318. */
  73319. getClassName(): string;
  73320. /**
  73321. * Extracts highlights from the image
  73322. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73323. * @param name The name of the effect.
  73324. * @param options The required width/height ratio to downsize to before computing the render pass.
  73325. * @param camera The camera to apply the render pass to.
  73326. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73327. * @param engine The engine which the post process will be applied. (default: current engine)
  73328. * @param reusable If the post process can be reused on the same frame. (default: false)
  73329. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73330. */
  73331. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73332. }
  73333. }
  73334. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73335. /** @hidden */
  73336. export var mrtFragmentDeclaration: {
  73337. name: string;
  73338. shader: string;
  73339. };
  73340. }
  73341. declare module "babylonjs/Shaders/geometry.fragment" {
  73342. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73343. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73344. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73345. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73346. /** @hidden */
  73347. export var geometryPixelShader: {
  73348. name: string;
  73349. shader: string;
  73350. };
  73351. }
  73352. declare module "babylonjs/Shaders/geometry.vertex" {
  73353. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73354. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73355. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73356. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73357. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73358. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73359. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73360. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73361. /** @hidden */
  73362. export var geometryVertexShader: {
  73363. name: string;
  73364. shader: string;
  73365. };
  73366. }
  73367. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73368. import { Matrix } from "babylonjs/Maths/math.vector";
  73369. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73370. import { Mesh } from "babylonjs/Meshes/mesh";
  73371. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73372. import { Effect } from "babylonjs/Materials/effect";
  73373. import { Scene } from "babylonjs/scene";
  73374. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73375. import "babylonjs/Shaders/geometry.fragment";
  73376. import "babylonjs/Shaders/geometry.vertex";
  73377. /** @hidden */
  73378. interface ISavedTransformationMatrix {
  73379. world: Matrix;
  73380. viewProjection: Matrix;
  73381. }
  73382. /**
  73383. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73384. */
  73385. export class GeometryBufferRenderer {
  73386. /**
  73387. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73388. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73389. */
  73390. static readonly POSITION_TEXTURE_TYPE: number;
  73391. /**
  73392. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73393. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73394. */
  73395. static readonly VELOCITY_TEXTURE_TYPE: number;
  73396. /**
  73397. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73398. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73399. */
  73400. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73401. /**
  73402. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73403. * in order to compute objects velocities when enableVelocity is set to "true"
  73404. * @hidden
  73405. */
  73406. _previousTransformationMatrices: {
  73407. [index: number]: ISavedTransformationMatrix;
  73408. };
  73409. /**
  73410. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73411. * in order to compute objects velocities when enableVelocity is set to "true"
  73412. * @hidden
  73413. */
  73414. _previousBonesTransformationMatrices: {
  73415. [index: number]: Float32Array;
  73416. };
  73417. /**
  73418. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73419. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73420. */
  73421. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73422. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73423. renderTransparentMeshes: boolean;
  73424. private _scene;
  73425. private _resizeObserver;
  73426. private _multiRenderTarget;
  73427. private _ratio;
  73428. private _enablePosition;
  73429. private _enableVelocity;
  73430. private _enableReflectivity;
  73431. private _positionIndex;
  73432. private _velocityIndex;
  73433. private _reflectivityIndex;
  73434. protected _effect: Effect;
  73435. protected _cachedDefines: string;
  73436. /**
  73437. * Set the render list (meshes to be rendered) used in the G buffer.
  73438. */
  73439. set renderList(meshes: Mesh[]);
  73440. /**
  73441. * Gets wether or not G buffer are supported by the running hardware.
  73442. * This requires draw buffer supports
  73443. */
  73444. get isSupported(): boolean;
  73445. /**
  73446. * Returns the index of the given texture type in the G-Buffer textures array
  73447. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73448. * @returns the index of the given texture type in the G-Buffer textures array
  73449. */
  73450. getTextureIndex(textureType: number): number;
  73451. /**
  73452. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73453. */
  73454. get enablePosition(): boolean;
  73455. /**
  73456. * Sets whether or not objects positions are enabled for the G buffer.
  73457. */
  73458. set enablePosition(enable: boolean);
  73459. /**
  73460. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73461. */
  73462. get enableVelocity(): boolean;
  73463. /**
  73464. * Sets wether or not objects velocities are enabled for the G buffer.
  73465. */
  73466. set enableVelocity(enable: boolean);
  73467. /**
  73468. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73469. */
  73470. get enableReflectivity(): boolean;
  73471. /**
  73472. * Sets wether or not objects roughness are enabled for the G buffer.
  73473. */
  73474. set enableReflectivity(enable: boolean);
  73475. /**
  73476. * Gets the scene associated with the buffer.
  73477. */
  73478. get scene(): Scene;
  73479. /**
  73480. * Gets the ratio used by the buffer during its creation.
  73481. * How big is the buffer related to the main canvas.
  73482. */
  73483. get ratio(): number;
  73484. /** @hidden */
  73485. static _SceneComponentInitialization: (scene: Scene) => void;
  73486. /**
  73487. * Creates a new G Buffer for the scene
  73488. * @param scene The scene the buffer belongs to
  73489. * @param ratio How big is the buffer related to the main canvas.
  73490. */
  73491. constructor(scene: Scene, ratio?: number);
  73492. /**
  73493. * Checks wether everything is ready to render a submesh to the G buffer.
  73494. * @param subMesh the submesh to check readiness for
  73495. * @param useInstances is the mesh drawn using instance or not
  73496. * @returns true if ready otherwise false
  73497. */
  73498. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73499. /**
  73500. * Gets the current underlying G Buffer.
  73501. * @returns the buffer
  73502. */
  73503. getGBuffer(): MultiRenderTarget;
  73504. /**
  73505. * Gets the number of samples used to render the buffer (anti aliasing).
  73506. */
  73507. get samples(): number;
  73508. /**
  73509. * Sets the number of samples used to render the buffer (anti aliasing).
  73510. */
  73511. set samples(value: number);
  73512. /**
  73513. * Disposes the renderer and frees up associated resources.
  73514. */
  73515. dispose(): void;
  73516. protected _createRenderTargets(): void;
  73517. private _copyBonesTransformationMatrices;
  73518. }
  73519. }
  73520. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73521. import { Nullable } from "babylonjs/types";
  73522. import { Scene } from "babylonjs/scene";
  73523. import { ISceneComponent } from "babylonjs/sceneComponent";
  73524. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73525. module "babylonjs/scene" {
  73526. interface Scene {
  73527. /** @hidden (Backing field) */
  73528. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73529. /**
  73530. * Gets or Sets the current geometry buffer associated to the scene.
  73531. */
  73532. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73533. /**
  73534. * Enables a GeometryBufferRender and associates it with the scene
  73535. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73536. * @returns the GeometryBufferRenderer
  73537. */
  73538. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73539. /**
  73540. * Disables the GeometryBufferRender associated with the scene
  73541. */
  73542. disableGeometryBufferRenderer(): void;
  73543. }
  73544. }
  73545. /**
  73546. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73547. * in several rendering techniques.
  73548. */
  73549. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73550. /**
  73551. * The component name helpful to identify the component in the list of scene components.
  73552. */
  73553. readonly name: string;
  73554. /**
  73555. * The scene the component belongs to.
  73556. */
  73557. scene: Scene;
  73558. /**
  73559. * Creates a new instance of the component for the given scene
  73560. * @param scene Defines the scene to register the component in
  73561. */
  73562. constructor(scene: Scene);
  73563. /**
  73564. * Registers the component in a given scene
  73565. */
  73566. register(): void;
  73567. /**
  73568. * Rebuilds the elements related to this component in case of
  73569. * context lost for instance.
  73570. */
  73571. rebuild(): void;
  73572. /**
  73573. * Disposes the component and the associated ressources
  73574. */
  73575. dispose(): void;
  73576. private _gatherRenderTargets;
  73577. }
  73578. }
  73579. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73580. /** @hidden */
  73581. export var motionBlurPixelShader: {
  73582. name: string;
  73583. shader: string;
  73584. };
  73585. }
  73586. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73587. import { Nullable } from "babylonjs/types";
  73588. import { Camera } from "babylonjs/Cameras/camera";
  73589. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73590. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73591. import "babylonjs/Animations/animatable";
  73592. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73593. import "babylonjs/Shaders/motionBlur.fragment";
  73594. import { Engine } from "babylonjs/Engines/engine";
  73595. import { Scene } from "babylonjs/scene";
  73596. /**
  73597. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73598. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73599. * As an example, all you have to do is to create the post-process:
  73600. * var mb = new BABYLON.MotionBlurPostProcess(
  73601. * 'mb', // The name of the effect.
  73602. * scene, // The scene containing the objects to blur according to their velocity.
  73603. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73604. * camera // The camera to apply the render pass to.
  73605. * );
  73606. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73607. */
  73608. export class MotionBlurPostProcess extends PostProcess {
  73609. /**
  73610. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73611. */
  73612. motionStrength: number;
  73613. /**
  73614. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73615. */
  73616. get motionBlurSamples(): number;
  73617. /**
  73618. * Sets the number of iterations to be used for motion blur quality
  73619. */
  73620. set motionBlurSamples(samples: number);
  73621. private _motionBlurSamples;
  73622. private _geometryBufferRenderer;
  73623. /**
  73624. * Gets a string identifying the name of the class
  73625. * @returns "MotionBlurPostProcess" string
  73626. */
  73627. getClassName(): string;
  73628. /**
  73629. * Creates a new instance MotionBlurPostProcess
  73630. * @param name The name of the effect.
  73631. * @param scene The scene containing the objects to blur according to their velocity.
  73632. * @param options The required width/height ratio to downsize to before computing the render pass.
  73633. * @param camera The camera to apply the render pass to.
  73634. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73635. * @param engine The engine which the post process will be applied. (default: current engine)
  73636. * @param reusable If the post process can be reused on the same frame. (default: false)
  73637. * @param textureType Type of textures used when performing the post process. (default: 0)
  73638. * @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)
  73639. */
  73640. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73641. /**
  73642. * Excludes the given skinned mesh from computing bones velocities.
  73643. * 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.
  73644. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73645. */
  73646. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73647. /**
  73648. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73649. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73650. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73651. */
  73652. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73653. /**
  73654. * Disposes the post process.
  73655. * @param camera The camera to dispose the post process on.
  73656. */
  73657. dispose(camera?: Camera): void;
  73658. /** @hidden */
  73659. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73660. }
  73661. }
  73662. declare module "babylonjs/Shaders/refraction.fragment" {
  73663. /** @hidden */
  73664. export var refractionPixelShader: {
  73665. name: string;
  73666. shader: string;
  73667. };
  73668. }
  73669. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73670. import { Color3 } from "babylonjs/Maths/math.color";
  73671. import { Camera } from "babylonjs/Cameras/camera";
  73672. import { Texture } from "babylonjs/Materials/Textures/texture";
  73673. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73674. import { Engine } from "babylonjs/Engines/engine";
  73675. import "babylonjs/Shaders/refraction.fragment";
  73676. import { Scene } from "babylonjs/scene";
  73677. /**
  73678. * Post process which applies a refractin texture
  73679. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73680. */
  73681. export class RefractionPostProcess extends PostProcess {
  73682. private _refTexture;
  73683. private _ownRefractionTexture;
  73684. /** the base color of the refraction (used to taint the rendering) */
  73685. color: Color3;
  73686. /** simulated refraction depth */
  73687. depth: number;
  73688. /** the coefficient of the base color (0 to remove base color tainting) */
  73689. colorLevel: number;
  73690. /** Gets the url used to load the refraction texture */
  73691. refractionTextureUrl: string;
  73692. /**
  73693. * Gets or sets the refraction texture
  73694. * Please note that you are responsible for disposing the texture if you set it manually
  73695. */
  73696. get refractionTexture(): Texture;
  73697. set refractionTexture(value: Texture);
  73698. /**
  73699. * Gets a string identifying the name of the class
  73700. * @returns "RefractionPostProcess" string
  73701. */
  73702. getClassName(): string;
  73703. /**
  73704. * Initializes the RefractionPostProcess
  73705. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73706. * @param name The name of the effect.
  73707. * @param refractionTextureUrl Url of the refraction texture to use
  73708. * @param color the base color of the refraction (used to taint the rendering)
  73709. * @param depth simulated refraction depth
  73710. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73711. * @param camera The camera to apply the render pass to.
  73712. * @param options The required width/height ratio to downsize to before computing the render pass.
  73713. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73714. * @param engine The engine which the post process will be applied. (default: current engine)
  73715. * @param reusable If the post process can be reused on the same frame. (default: false)
  73716. */
  73717. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73718. /**
  73719. * Disposes of the post process
  73720. * @param camera Camera to dispose post process on
  73721. */
  73722. dispose(camera: Camera): void;
  73723. /** @hidden */
  73724. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73725. }
  73726. }
  73727. declare module "babylonjs/Shaders/sharpen.fragment" {
  73728. /** @hidden */
  73729. export var sharpenPixelShader: {
  73730. name: string;
  73731. shader: string;
  73732. };
  73733. }
  73734. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73735. import { Nullable } from "babylonjs/types";
  73736. import { Camera } from "babylonjs/Cameras/camera";
  73737. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73738. import "babylonjs/Shaders/sharpen.fragment";
  73739. import { Engine } from "babylonjs/Engines/engine";
  73740. import { Scene } from "babylonjs/scene";
  73741. /**
  73742. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73743. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73744. */
  73745. export class SharpenPostProcess extends PostProcess {
  73746. /**
  73747. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73748. */
  73749. colorAmount: number;
  73750. /**
  73751. * How much sharpness should be applied (default: 0.3)
  73752. */
  73753. edgeAmount: number;
  73754. /**
  73755. * Gets a string identifying the name of the class
  73756. * @returns "SharpenPostProcess" string
  73757. */
  73758. getClassName(): string;
  73759. /**
  73760. * Creates a new instance ConvolutionPostProcess
  73761. * @param name The name of the effect.
  73762. * @param options The required width/height ratio to downsize to before computing the render pass.
  73763. * @param camera The camera to apply the render pass to.
  73764. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73765. * @param engine The engine which the post process will be applied. (default: current engine)
  73766. * @param reusable If the post process can be reused on the same frame. (default: false)
  73767. * @param textureType Type of textures used when performing the post process. (default: 0)
  73768. * @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)
  73769. */
  73770. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73771. /** @hidden */
  73772. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73773. }
  73774. }
  73775. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73776. import { Nullable } from "babylonjs/types";
  73777. import { Camera } from "babylonjs/Cameras/camera";
  73778. import { Engine } from "babylonjs/Engines/engine";
  73779. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73780. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73781. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73782. /**
  73783. * PostProcessRenderPipeline
  73784. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73785. */
  73786. export class PostProcessRenderPipeline {
  73787. private engine;
  73788. private _renderEffects;
  73789. private _renderEffectsForIsolatedPass;
  73790. /**
  73791. * List of inspectable custom properties (used by the Inspector)
  73792. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73793. */
  73794. inspectableCustomProperties: IInspectable[];
  73795. /**
  73796. * @hidden
  73797. */
  73798. protected _cameras: Camera[];
  73799. /** @hidden */
  73800. _name: string;
  73801. /**
  73802. * Gets pipeline name
  73803. */
  73804. get name(): string;
  73805. /** Gets the list of attached cameras */
  73806. get cameras(): Camera[];
  73807. /**
  73808. * Initializes a PostProcessRenderPipeline
  73809. * @param engine engine to add the pipeline to
  73810. * @param name name of the pipeline
  73811. */
  73812. constructor(engine: Engine, name: string);
  73813. /**
  73814. * Gets the class name
  73815. * @returns "PostProcessRenderPipeline"
  73816. */
  73817. getClassName(): string;
  73818. /**
  73819. * If all the render effects in the pipeline are supported
  73820. */
  73821. get isSupported(): boolean;
  73822. /**
  73823. * Adds an effect to the pipeline
  73824. * @param renderEffect the effect to add
  73825. */
  73826. addEffect(renderEffect: PostProcessRenderEffect): void;
  73827. /** @hidden */
  73828. _rebuild(): void;
  73829. /** @hidden */
  73830. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73831. /** @hidden */
  73832. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73833. /** @hidden */
  73834. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73835. /** @hidden */
  73836. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73837. /** @hidden */
  73838. _attachCameras(cameras: Camera, unique: boolean): void;
  73839. /** @hidden */
  73840. _attachCameras(cameras: Camera[], unique: boolean): void;
  73841. /** @hidden */
  73842. _detachCameras(cameras: Camera): void;
  73843. /** @hidden */
  73844. _detachCameras(cameras: Nullable<Camera[]>): void;
  73845. /** @hidden */
  73846. _update(): void;
  73847. /** @hidden */
  73848. _reset(): void;
  73849. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73850. /**
  73851. * Sets the required values to the prepass renderer.
  73852. * @param prePassRenderer defines the prepass renderer to setup.
  73853. * @returns true if the pre pass is needed.
  73854. */
  73855. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73856. /**
  73857. * Disposes of the pipeline
  73858. */
  73859. dispose(): void;
  73860. }
  73861. }
  73862. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73863. import { Camera } from "babylonjs/Cameras/camera";
  73864. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73865. /**
  73866. * PostProcessRenderPipelineManager class
  73867. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73868. */
  73869. export class PostProcessRenderPipelineManager {
  73870. private _renderPipelines;
  73871. /**
  73872. * Initializes a PostProcessRenderPipelineManager
  73873. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73874. */
  73875. constructor();
  73876. /**
  73877. * Gets the list of supported render pipelines
  73878. */
  73879. get supportedPipelines(): PostProcessRenderPipeline[];
  73880. /**
  73881. * Adds a pipeline to the manager
  73882. * @param renderPipeline The pipeline to add
  73883. */
  73884. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73885. /**
  73886. * Attaches a camera to the pipeline
  73887. * @param renderPipelineName The name of the pipeline to attach to
  73888. * @param cameras the camera to attach
  73889. * @param unique if the camera can be attached multiple times to the pipeline
  73890. */
  73891. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73892. /**
  73893. * Detaches a camera from the pipeline
  73894. * @param renderPipelineName The name of the pipeline to detach from
  73895. * @param cameras the camera to detach
  73896. */
  73897. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73898. /**
  73899. * Enables an effect by name on a pipeline
  73900. * @param renderPipelineName the name of the pipeline to enable the effect in
  73901. * @param renderEffectName the name of the effect to enable
  73902. * @param cameras the cameras that the effect should be enabled on
  73903. */
  73904. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73905. /**
  73906. * Disables an effect by name on a pipeline
  73907. * @param renderPipelineName the name of the pipeline to disable the effect in
  73908. * @param renderEffectName the name of the effect to disable
  73909. * @param cameras the cameras that the effect should be disabled on
  73910. */
  73911. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73912. /**
  73913. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73914. */
  73915. update(): void;
  73916. /** @hidden */
  73917. _rebuild(): void;
  73918. /**
  73919. * Disposes of the manager and pipelines
  73920. */
  73921. dispose(): void;
  73922. }
  73923. }
  73924. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73925. import { ISceneComponent } from "babylonjs/sceneComponent";
  73926. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73927. import { Scene } from "babylonjs/scene";
  73928. module "babylonjs/scene" {
  73929. interface Scene {
  73930. /** @hidden (Backing field) */
  73931. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73932. /**
  73933. * Gets the postprocess render pipeline manager
  73934. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73935. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73936. */
  73937. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73938. }
  73939. }
  73940. /**
  73941. * Defines the Render Pipeline scene component responsible to rendering pipelines
  73942. */
  73943. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  73944. /**
  73945. * The component name helpfull to identify the component in the list of scene components.
  73946. */
  73947. readonly name: string;
  73948. /**
  73949. * The scene the component belongs to.
  73950. */
  73951. scene: Scene;
  73952. /**
  73953. * Creates a new instance of the component for the given scene
  73954. * @param scene Defines the scene to register the component in
  73955. */
  73956. constructor(scene: Scene);
  73957. /**
  73958. * Registers the component in a given scene
  73959. */
  73960. register(): void;
  73961. /**
  73962. * Rebuilds the elements related to this component in case of
  73963. * context lost for instance.
  73964. */
  73965. rebuild(): void;
  73966. /**
  73967. * Disposes the component and the associated ressources
  73968. */
  73969. dispose(): void;
  73970. private _gatherRenderTargets;
  73971. }
  73972. }
  73973. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  73974. import { Nullable } from "babylonjs/types";
  73975. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  73976. import { Camera } from "babylonjs/Cameras/camera";
  73977. import { IDisposable } from "babylonjs/scene";
  73978. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  73979. import { Scene } from "babylonjs/scene";
  73980. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  73981. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  73982. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  73983. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  73984. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  73985. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73986. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  73987. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73988. import { Animation } from "babylonjs/Animations/animation";
  73989. /**
  73990. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  73991. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73992. */
  73993. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  73994. private _scene;
  73995. private _camerasToBeAttached;
  73996. /**
  73997. * ID of the sharpen post process,
  73998. */
  73999. private readonly SharpenPostProcessId;
  74000. /**
  74001. * @ignore
  74002. * ID of the image processing post process;
  74003. */
  74004. readonly ImageProcessingPostProcessId: string;
  74005. /**
  74006. * @ignore
  74007. * ID of the Fast Approximate Anti-Aliasing post process;
  74008. */
  74009. readonly FxaaPostProcessId: string;
  74010. /**
  74011. * ID of the chromatic aberration post process,
  74012. */
  74013. private readonly ChromaticAberrationPostProcessId;
  74014. /**
  74015. * ID of the grain post process
  74016. */
  74017. private readonly GrainPostProcessId;
  74018. /**
  74019. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74020. */
  74021. sharpen: SharpenPostProcess;
  74022. private _sharpenEffect;
  74023. private bloom;
  74024. /**
  74025. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74026. */
  74027. depthOfField: DepthOfFieldEffect;
  74028. /**
  74029. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74030. */
  74031. fxaa: FxaaPostProcess;
  74032. /**
  74033. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74034. */
  74035. imageProcessing: ImageProcessingPostProcess;
  74036. /**
  74037. * Chromatic aberration post process which will shift rgb colors in the image
  74038. */
  74039. chromaticAberration: ChromaticAberrationPostProcess;
  74040. private _chromaticAberrationEffect;
  74041. /**
  74042. * Grain post process which add noise to the image
  74043. */
  74044. grain: GrainPostProcess;
  74045. private _grainEffect;
  74046. /**
  74047. * Glow post process which adds a glow to emissive areas of the image
  74048. */
  74049. private _glowLayer;
  74050. /**
  74051. * Animations which can be used to tweak settings over a period of time
  74052. */
  74053. animations: Animation[];
  74054. private _imageProcessingConfigurationObserver;
  74055. private _sharpenEnabled;
  74056. private _bloomEnabled;
  74057. private _depthOfFieldEnabled;
  74058. private _depthOfFieldBlurLevel;
  74059. private _fxaaEnabled;
  74060. private _imageProcessingEnabled;
  74061. private _defaultPipelineTextureType;
  74062. private _bloomScale;
  74063. private _chromaticAberrationEnabled;
  74064. private _grainEnabled;
  74065. private _buildAllowed;
  74066. /**
  74067. * Gets active scene
  74068. */
  74069. get scene(): Scene;
  74070. /**
  74071. * Enable or disable the sharpen process from the pipeline
  74072. */
  74073. set sharpenEnabled(enabled: boolean);
  74074. get sharpenEnabled(): boolean;
  74075. private _resizeObserver;
  74076. private _hardwareScaleLevel;
  74077. private _bloomKernel;
  74078. /**
  74079. * Specifies the size of the bloom blur kernel, relative to the final output size
  74080. */
  74081. get bloomKernel(): number;
  74082. set bloomKernel(value: number);
  74083. /**
  74084. * Specifies the weight of the bloom in the final rendering
  74085. */
  74086. private _bloomWeight;
  74087. /**
  74088. * Specifies the luma threshold for the area that will be blurred by the bloom
  74089. */
  74090. private _bloomThreshold;
  74091. private _hdr;
  74092. /**
  74093. * The strength of the bloom.
  74094. */
  74095. set bloomWeight(value: number);
  74096. get bloomWeight(): number;
  74097. /**
  74098. * The strength of the bloom.
  74099. */
  74100. set bloomThreshold(value: number);
  74101. get bloomThreshold(): number;
  74102. /**
  74103. * The scale of the bloom, lower value will provide better performance.
  74104. */
  74105. set bloomScale(value: number);
  74106. get bloomScale(): number;
  74107. /**
  74108. * Enable or disable the bloom from the pipeline
  74109. */
  74110. set bloomEnabled(enabled: boolean);
  74111. get bloomEnabled(): boolean;
  74112. private _rebuildBloom;
  74113. /**
  74114. * If the depth of field is enabled.
  74115. */
  74116. get depthOfFieldEnabled(): boolean;
  74117. set depthOfFieldEnabled(enabled: boolean);
  74118. /**
  74119. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74120. */
  74121. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74122. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74123. /**
  74124. * If the anti aliasing is enabled.
  74125. */
  74126. set fxaaEnabled(enabled: boolean);
  74127. get fxaaEnabled(): boolean;
  74128. private _samples;
  74129. /**
  74130. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74131. */
  74132. set samples(sampleCount: number);
  74133. get samples(): number;
  74134. /**
  74135. * If image processing is enabled.
  74136. */
  74137. set imageProcessingEnabled(enabled: boolean);
  74138. get imageProcessingEnabled(): boolean;
  74139. /**
  74140. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74141. */
  74142. set glowLayerEnabled(enabled: boolean);
  74143. get glowLayerEnabled(): boolean;
  74144. /**
  74145. * Gets the glow layer (or null if not defined)
  74146. */
  74147. get glowLayer(): Nullable<GlowLayer>;
  74148. /**
  74149. * Enable or disable the chromaticAberration process from the pipeline
  74150. */
  74151. set chromaticAberrationEnabled(enabled: boolean);
  74152. get chromaticAberrationEnabled(): boolean;
  74153. /**
  74154. * Enable or disable the grain process from the pipeline
  74155. */
  74156. set grainEnabled(enabled: boolean);
  74157. get grainEnabled(): boolean;
  74158. /**
  74159. * @constructor
  74160. * @param name - The rendering pipeline name (default: "")
  74161. * @param hdr - If high dynamic range textures should be used (default: true)
  74162. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74163. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74164. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74165. */
  74166. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74167. /**
  74168. * Get the class name
  74169. * @returns "DefaultRenderingPipeline"
  74170. */
  74171. getClassName(): string;
  74172. /**
  74173. * Force the compilation of the entire pipeline.
  74174. */
  74175. prepare(): void;
  74176. private _hasCleared;
  74177. private _prevPostProcess;
  74178. private _prevPrevPostProcess;
  74179. private _setAutoClearAndTextureSharing;
  74180. private _depthOfFieldSceneObserver;
  74181. private _buildPipeline;
  74182. private _disposePostProcesses;
  74183. /**
  74184. * Adds a camera to the pipeline
  74185. * @param camera the camera to be added
  74186. */
  74187. addCamera(camera: Camera): void;
  74188. /**
  74189. * Removes a camera from the pipeline
  74190. * @param camera the camera to remove
  74191. */
  74192. removeCamera(camera: Camera): void;
  74193. /**
  74194. * Dispose of the pipeline and stop all post processes
  74195. */
  74196. dispose(): void;
  74197. /**
  74198. * Serialize the rendering pipeline (Used when exporting)
  74199. * @returns the serialized object
  74200. */
  74201. serialize(): any;
  74202. /**
  74203. * Parse the serialized pipeline
  74204. * @param source Source pipeline.
  74205. * @param scene The scene to load the pipeline to.
  74206. * @param rootUrl The URL of the serialized pipeline.
  74207. * @returns An instantiated pipeline from the serialized object.
  74208. */
  74209. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74210. }
  74211. }
  74212. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74213. /** @hidden */
  74214. export var lensHighlightsPixelShader: {
  74215. name: string;
  74216. shader: string;
  74217. };
  74218. }
  74219. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74220. /** @hidden */
  74221. export var depthOfFieldPixelShader: {
  74222. name: string;
  74223. shader: string;
  74224. };
  74225. }
  74226. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74227. import { Camera } from "babylonjs/Cameras/camera";
  74228. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74229. import { Scene } from "babylonjs/scene";
  74230. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74231. import "babylonjs/Shaders/chromaticAberration.fragment";
  74232. import "babylonjs/Shaders/lensHighlights.fragment";
  74233. import "babylonjs/Shaders/depthOfField.fragment";
  74234. /**
  74235. * BABYLON.JS Chromatic Aberration GLSL Shader
  74236. * Author: Olivier Guyot
  74237. * Separates very slightly R, G and B colors on the edges of the screen
  74238. * Inspired by Francois Tarlier & Martins Upitis
  74239. */
  74240. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74241. /**
  74242. * @ignore
  74243. * The chromatic aberration PostProcess id in the pipeline
  74244. */
  74245. LensChromaticAberrationEffect: string;
  74246. /**
  74247. * @ignore
  74248. * The highlights enhancing PostProcess id in the pipeline
  74249. */
  74250. HighlightsEnhancingEffect: string;
  74251. /**
  74252. * @ignore
  74253. * The depth-of-field PostProcess id in the pipeline
  74254. */
  74255. LensDepthOfFieldEffect: string;
  74256. private _scene;
  74257. private _depthTexture;
  74258. private _grainTexture;
  74259. private _chromaticAberrationPostProcess;
  74260. private _highlightsPostProcess;
  74261. private _depthOfFieldPostProcess;
  74262. private _edgeBlur;
  74263. private _grainAmount;
  74264. private _chromaticAberration;
  74265. private _distortion;
  74266. private _highlightsGain;
  74267. private _highlightsThreshold;
  74268. private _dofDistance;
  74269. private _dofAperture;
  74270. private _dofDarken;
  74271. private _dofPentagon;
  74272. private _blurNoise;
  74273. /**
  74274. * @constructor
  74275. *
  74276. * Effect parameters are as follow:
  74277. * {
  74278. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74279. * edge_blur: number; // from 0 to x (1 for realism)
  74280. * distortion: number; // from 0 to x (1 for realism)
  74281. * grain_amount: number; // from 0 to 1
  74282. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74283. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74284. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74285. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74286. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74287. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74288. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74289. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74290. * }
  74291. * Note: if an effect parameter is unset, effect is disabled
  74292. *
  74293. * @param name The rendering pipeline name
  74294. * @param parameters - An object containing all parameters (see above)
  74295. * @param scene The scene linked to this pipeline
  74296. * @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)
  74297. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74298. */
  74299. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74300. /**
  74301. * Get the class name
  74302. * @returns "LensRenderingPipeline"
  74303. */
  74304. getClassName(): string;
  74305. /**
  74306. * Gets associated scene
  74307. */
  74308. get scene(): Scene;
  74309. /**
  74310. * Gets or sets the edge blur
  74311. */
  74312. get edgeBlur(): number;
  74313. set edgeBlur(value: number);
  74314. /**
  74315. * Gets or sets the grain amount
  74316. */
  74317. get grainAmount(): number;
  74318. set grainAmount(value: number);
  74319. /**
  74320. * Gets or sets the chromatic aberration amount
  74321. */
  74322. get chromaticAberration(): number;
  74323. set chromaticAberration(value: number);
  74324. /**
  74325. * Gets or sets the depth of field aperture
  74326. */
  74327. get dofAperture(): number;
  74328. set dofAperture(value: number);
  74329. /**
  74330. * Gets or sets the edge distortion
  74331. */
  74332. get edgeDistortion(): number;
  74333. set edgeDistortion(value: number);
  74334. /**
  74335. * Gets or sets the depth of field distortion
  74336. */
  74337. get dofDistortion(): number;
  74338. set dofDistortion(value: number);
  74339. /**
  74340. * Gets or sets the darken out of focus amount
  74341. */
  74342. get darkenOutOfFocus(): number;
  74343. set darkenOutOfFocus(value: number);
  74344. /**
  74345. * Gets or sets a boolean indicating if blur noise is enabled
  74346. */
  74347. get blurNoise(): boolean;
  74348. set blurNoise(value: boolean);
  74349. /**
  74350. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74351. */
  74352. get pentagonBokeh(): boolean;
  74353. set pentagonBokeh(value: boolean);
  74354. /**
  74355. * Gets or sets the highlight grain amount
  74356. */
  74357. get highlightsGain(): number;
  74358. set highlightsGain(value: number);
  74359. /**
  74360. * Gets or sets the highlight threshold
  74361. */
  74362. get highlightsThreshold(): number;
  74363. set highlightsThreshold(value: number);
  74364. /**
  74365. * Sets the amount of blur at the edges
  74366. * @param amount blur amount
  74367. */
  74368. setEdgeBlur(amount: number): void;
  74369. /**
  74370. * Sets edge blur to 0
  74371. */
  74372. disableEdgeBlur(): void;
  74373. /**
  74374. * Sets the amout of grain
  74375. * @param amount Amount of grain
  74376. */
  74377. setGrainAmount(amount: number): void;
  74378. /**
  74379. * Set grain amount to 0
  74380. */
  74381. disableGrain(): void;
  74382. /**
  74383. * Sets the chromatic aberration amount
  74384. * @param amount amount of chromatic aberration
  74385. */
  74386. setChromaticAberration(amount: number): void;
  74387. /**
  74388. * Sets chromatic aberration amount to 0
  74389. */
  74390. disableChromaticAberration(): void;
  74391. /**
  74392. * Sets the EdgeDistortion amount
  74393. * @param amount amount of EdgeDistortion
  74394. */
  74395. setEdgeDistortion(amount: number): void;
  74396. /**
  74397. * Sets edge distortion to 0
  74398. */
  74399. disableEdgeDistortion(): void;
  74400. /**
  74401. * Sets the FocusDistance amount
  74402. * @param amount amount of FocusDistance
  74403. */
  74404. setFocusDistance(amount: number): void;
  74405. /**
  74406. * Disables depth of field
  74407. */
  74408. disableDepthOfField(): void;
  74409. /**
  74410. * Sets the Aperture amount
  74411. * @param amount amount of Aperture
  74412. */
  74413. setAperture(amount: number): void;
  74414. /**
  74415. * Sets the DarkenOutOfFocus amount
  74416. * @param amount amount of DarkenOutOfFocus
  74417. */
  74418. setDarkenOutOfFocus(amount: number): void;
  74419. private _pentagonBokehIsEnabled;
  74420. /**
  74421. * Creates a pentagon bokeh effect
  74422. */
  74423. enablePentagonBokeh(): void;
  74424. /**
  74425. * Disables the pentagon bokeh effect
  74426. */
  74427. disablePentagonBokeh(): void;
  74428. /**
  74429. * Enables noise blur
  74430. */
  74431. enableNoiseBlur(): void;
  74432. /**
  74433. * Disables noise blur
  74434. */
  74435. disableNoiseBlur(): void;
  74436. /**
  74437. * Sets the HighlightsGain amount
  74438. * @param amount amount of HighlightsGain
  74439. */
  74440. setHighlightsGain(amount: number): void;
  74441. /**
  74442. * Sets the HighlightsThreshold amount
  74443. * @param amount amount of HighlightsThreshold
  74444. */
  74445. setHighlightsThreshold(amount: number): void;
  74446. /**
  74447. * Disables highlights
  74448. */
  74449. disableHighlights(): void;
  74450. /**
  74451. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74452. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74453. */
  74454. dispose(disableDepthRender?: boolean): void;
  74455. private _createChromaticAberrationPostProcess;
  74456. private _createHighlightsPostProcess;
  74457. private _createDepthOfFieldPostProcess;
  74458. private _createGrainTexture;
  74459. }
  74460. }
  74461. declare module "babylonjs/Shaders/ssao2.fragment" {
  74462. /** @hidden */
  74463. export var ssao2PixelShader: {
  74464. name: string;
  74465. shader: string;
  74466. };
  74467. }
  74468. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74469. /** @hidden */
  74470. export var ssaoCombinePixelShader: {
  74471. name: string;
  74472. shader: string;
  74473. };
  74474. }
  74475. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74476. import { Camera } from "babylonjs/Cameras/camera";
  74477. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74478. import { Scene } from "babylonjs/scene";
  74479. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74480. import "babylonjs/Shaders/ssao2.fragment";
  74481. import "babylonjs/Shaders/ssaoCombine.fragment";
  74482. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74483. /**
  74484. * Render pipeline to produce ssao effect
  74485. */
  74486. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74487. /**
  74488. * @ignore
  74489. * The PassPostProcess id in the pipeline that contains the original scene color
  74490. */
  74491. SSAOOriginalSceneColorEffect: string;
  74492. /**
  74493. * @ignore
  74494. * The SSAO PostProcess id in the pipeline
  74495. */
  74496. SSAORenderEffect: string;
  74497. /**
  74498. * @ignore
  74499. * The horizontal blur PostProcess id in the pipeline
  74500. */
  74501. SSAOBlurHRenderEffect: string;
  74502. /**
  74503. * @ignore
  74504. * The vertical blur PostProcess id in the pipeline
  74505. */
  74506. SSAOBlurVRenderEffect: string;
  74507. /**
  74508. * @ignore
  74509. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74510. */
  74511. SSAOCombineRenderEffect: string;
  74512. /**
  74513. * The output strength of the SSAO post-process. Default value is 1.0.
  74514. */
  74515. totalStrength: number;
  74516. /**
  74517. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74518. */
  74519. maxZ: number;
  74520. /**
  74521. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74522. */
  74523. minZAspect: number;
  74524. private _samples;
  74525. /**
  74526. * Number of samples used for the SSAO calculations. Default value is 8
  74527. */
  74528. set samples(n: number);
  74529. get samples(): number;
  74530. private _textureSamples;
  74531. /**
  74532. * Number of samples to use for antialiasing
  74533. */
  74534. set textureSamples(n: number);
  74535. get textureSamples(): number;
  74536. /**
  74537. * Force rendering the geometry through geometry buffer
  74538. */
  74539. private _forceGeometryBuffer;
  74540. /**
  74541. * Ratio object used for SSAO ratio and blur ratio
  74542. */
  74543. private _ratio;
  74544. /**
  74545. * Dynamically generated sphere sampler.
  74546. */
  74547. private _sampleSphere;
  74548. /**
  74549. * Blur filter offsets
  74550. */
  74551. private _samplerOffsets;
  74552. private _expensiveBlur;
  74553. /**
  74554. * If bilateral blur should be used
  74555. */
  74556. set expensiveBlur(b: boolean);
  74557. get expensiveBlur(): boolean;
  74558. /**
  74559. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74560. */
  74561. radius: number;
  74562. /**
  74563. * The base color of the SSAO post-process
  74564. * The final result is "base + ssao" between [0, 1]
  74565. */
  74566. base: number;
  74567. /**
  74568. * Support test.
  74569. */
  74570. static get IsSupported(): boolean;
  74571. private _scene;
  74572. private _randomTexture;
  74573. private _originalColorPostProcess;
  74574. private _ssaoPostProcess;
  74575. private _blurHPostProcess;
  74576. private _blurVPostProcess;
  74577. private _ssaoCombinePostProcess;
  74578. private _prePassRenderer;
  74579. /**
  74580. * Gets active scene
  74581. */
  74582. get scene(): Scene;
  74583. /**
  74584. * @constructor
  74585. * @param name The rendering pipeline name
  74586. * @param scene The scene linked to this pipeline
  74587. * @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 }
  74588. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74589. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74590. */
  74591. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74592. /**
  74593. * Get the class name
  74594. * @returns "SSAO2RenderingPipeline"
  74595. */
  74596. getClassName(): string;
  74597. /**
  74598. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74599. */
  74600. dispose(disableGeometryBufferRenderer?: boolean): void;
  74601. private _createBlurPostProcess;
  74602. /** @hidden */
  74603. _rebuild(): void;
  74604. private _bits;
  74605. private _radicalInverse_VdC;
  74606. private _hammersley;
  74607. private _hemisphereSample_uniform;
  74608. private _generateHemisphere;
  74609. private _getDefinesForSSAO;
  74610. private _createSSAOPostProcess;
  74611. private _createSSAOCombinePostProcess;
  74612. private _createRandomTexture;
  74613. /**
  74614. * Serialize the rendering pipeline (Used when exporting)
  74615. * @returns the serialized object
  74616. */
  74617. serialize(): any;
  74618. /**
  74619. * Parse the serialized pipeline
  74620. * @param source Source pipeline.
  74621. * @param scene The scene to load the pipeline to.
  74622. * @param rootUrl The URL of the serialized pipeline.
  74623. * @returns An instantiated pipeline from the serialized object.
  74624. */
  74625. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74626. /**
  74627. * Sets the required values to the prepass renderer.
  74628. * @param prePassRenderer defines the prepass renderer to setup
  74629. * @returns true if the pre pass is needed.
  74630. */
  74631. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74632. }
  74633. }
  74634. declare module "babylonjs/Shaders/ssao.fragment" {
  74635. /** @hidden */
  74636. export var ssaoPixelShader: {
  74637. name: string;
  74638. shader: string;
  74639. };
  74640. }
  74641. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74642. import { Camera } from "babylonjs/Cameras/camera";
  74643. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74644. import { Scene } from "babylonjs/scene";
  74645. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74646. import "babylonjs/Shaders/ssao.fragment";
  74647. import "babylonjs/Shaders/ssaoCombine.fragment";
  74648. /**
  74649. * Render pipeline to produce ssao effect
  74650. */
  74651. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74652. /**
  74653. * @ignore
  74654. * The PassPostProcess id in the pipeline that contains the original scene color
  74655. */
  74656. SSAOOriginalSceneColorEffect: string;
  74657. /**
  74658. * @ignore
  74659. * The SSAO PostProcess id in the pipeline
  74660. */
  74661. SSAORenderEffect: string;
  74662. /**
  74663. * @ignore
  74664. * The horizontal blur PostProcess id in the pipeline
  74665. */
  74666. SSAOBlurHRenderEffect: string;
  74667. /**
  74668. * @ignore
  74669. * The vertical blur PostProcess id in the pipeline
  74670. */
  74671. SSAOBlurVRenderEffect: string;
  74672. /**
  74673. * @ignore
  74674. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74675. */
  74676. SSAOCombineRenderEffect: string;
  74677. /**
  74678. * The output strength of the SSAO post-process. Default value is 1.0.
  74679. */
  74680. totalStrength: number;
  74681. /**
  74682. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74683. */
  74684. radius: number;
  74685. /**
  74686. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74687. * Must not be equal to fallOff and superior to fallOff.
  74688. * Default value is 0.0075
  74689. */
  74690. area: number;
  74691. /**
  74692. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74693. * Must not be equal to area and inferior to area.
  74694. * Default value is 0.000001
  74695. */
  74696. fallOff: number;
  74697. /**
  74698. * The base color of the SSAO post-process
  74699. * The final result is "base + ssao" between [0, 1]
  74700. */
  74701. base: number;
  74702. private _scene;
  74703. private _depthTexture;
  74704. private _randomTexture;
  74705. private _originalColorPostProcess;
  74706. private _ssaoPostProcess;
  74707. private _blurHPostProcess;
  74708. private _blurVPostProcess;
  74709. private _ssaoCombinePostProcess;
  74710. private _firstUpdate;
  74711. /**
  74712. * Gets active scene
  74713. */
  74714. get scene(): Scene;
  74715. /**
  74716. * @constructor
  74717. * @param name - The rendering pipeline name
  74718. * @param scene - The scene linked to this pipeline
  74719. * @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 }
  74720. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74721. */
  74722. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74723. /**
  74724. * Get the class name
  74725. * @returns "SSAORenderingPipeline"
  74726. */
  74727. getClassName(): string;
  74728. /**
  74729. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74730. */
  74731. dispose(disableDepthRender?: boolean): void;
  74732. private _createBlurPostProcess;
  74733. /** @hidden */
  74734. _rebuild(): void;
  74735. private _createSSAOPostProcess;
  74736. private _createSSAOCombinePostProcess;
  74737. private _createRandomTexture;
  74738. }
  74739. }
  74740. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74741. /** @hidden */
  74742. export var screenSpaceReflectionPixelShader: {
  74743. name: string;
  74744. shader: string;
  74745. };
  74746. }
  74747. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74748. import { Nullable } from "babylonjs/types";
  74749. import { Camera } from "babylonjs/Cameras/camera";
  74750. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74751. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74752. import { Engine } from "babylonjs/Engines/engine";
  74753. import { Scene } from "babylonjs/scene";
  74754. /**
  74755. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74756. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74757. */
  74758. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74759. /**
  74760. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74761. */
  74762. threshold: number;
  74763. /**
  74764. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74765. */
  74766. strength: number;
  74767. /**
  74768. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74769. */
  74770. reflectionSpecularFalloffExponent: number;
  74771. /**
  74772. * 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]
  74773. */
  74774. step: number;
  74775. /**
  74776. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74777. */
  74778. roughnessFactor: number;
  74779. private _geometryBufferRenderer;
  74780. private _enableSmoothReflections;
  74781. private _reflectionSamples;
  74782. private _smoothSteps;
  74783. /**
  74784. * Gets a string identifying the name of the class
  74785. * @returns "ScreenSpaceReflectionPostProcess" string
  74786. */
  74787. getClassName(): string;
  74788. /**
  74789. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74790. * @param name The name of the effect.
  74791. * @param scene The scene containing the objects to calculate reflections.
  74792. * @param options The required width/height ratio to downsize to before computing the render pass.
  74793. * @param camera The camera to apply the render pass to.
  74794. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74795. * @param engine The engine which the post process will be applied. (default: current engine)
  74796. * @param reusable If the post process can be reused on the same frame. (default: false)
  74797. * @param textureType Type of textures used when performing the post process. (default: 0)
  74798. * @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)
  74799. */
  74800. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74801. /**
  74802. * Gets wether or not smoothing reflections is enabled.
  74803. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74804. */
  74805. get enableSmoothReflections(): boolean;
  74806. /**
  74807. * Sets wether or not smoothing reflections is enabled.
  74808. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74809. */
  74810. set enableSmoothReflections(enabled: boolean);
  74811. /**
  74812. * Gets the number of samples taken while computing reflections. More samples count is high,
  74813. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74814. */
  74815. get reflectionSamples(): number;
  74816. /**
  74817. * Sets the number of samples taken while computing reflections. More samples count is high,
  74818. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74819. */
  74820. set reflectionSamples(samples: number);
  74821. /**
  74822. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74823. * more the post-process will require GPU power and can generate a drop in FPS.
  74824. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74825. */
  74826. get smoothSteps(): number;
  74827. set smoothSteps(steps: number);
  74828. private _updateEffectDefines;
  74829. /** @hidden */
  74830. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74831. }
  74832. }
  74833. declare module "babylonjs/Shaders/standard.fragment" {
  74834. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74835. /** @hidden */
  74836. export var standardPixelShader: {
  74837. name: string;
  74838. shader: string;
  74839. };
  74840. }
  74841. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74842. import { Nullable } from "babylonjs/types";
  74843. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74844. import { Camera } from "babylonjs/Cameras/camera";
  74845. import { Texture } from "babylonjs/Materials/Textures/texture";
  74846. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74847. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74848. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74849. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74850. import { IDisposable } from "babylonjs/scene";
  74851. import { SpotLight } from "babylonjs/Lights/spotLight";
  74852. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74853. import { Scene } from "babylonjs/scene";
  74854. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74855. import { Animation } from "babylonjs/Animations/animation";
  74856. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74857. import "babylonjs/Shaders/standard.fragment";
  74858. /**
  74859. * Standard rendering pipeline
  74860. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74861. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74862. */
  74863. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74864. /**
  74865. * Public members
  74866. */
  74867. /**
  74868. * Post-process which contains the original scene color before the pipeline applies all the effects
  74869. */
  74870. originalPostProcess: Nullable<PostProcess>;
  74871. /**
  74872. * Post-process used to down scale an image x4
  74873. */
  74874. downSampleX4PostProcess: Nullable<PostProcess>;
  74875. /**
  74876. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74877. */
  74878. brightPassPostProcess: Nullable<PostProcess>;
  74879. /**
  74880. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74881. */
  74882. blurHPostProcesses: PostProcess[];
  74883. /**
  74884. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74885. */
  74886. blurVPostProcesses: PostProcess[];
  74887. /**
  74888. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74889. */
  74890. textureAdderPostProcess: Nullable<PostProcess>;
  74891. /**
  74892. * Post-process used to create volumetric lighting effect
  74893. */
  74894. volumetricLightPostProcess: Nullable<PostProcess>;
  74895. /**
  74896. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74897. */
  74898. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74899. /**
  74900. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74901. */
  74902. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74903. /**
  74904. * Post-process used to merge the volumetric light effect and the real scene color
  74905. */
  74906. volumetricLightMergePostProces: Nullable<PostProcess>;
  74907. /**
  74908. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74909. */
  74910. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74911. /**
  74912. * Base post-process used to calculate the average luminance of the final image for HDR
  74913. */
  74914. luminancePostProcess: Nullable<PostProcess>;
  74915. /**
  74916. * Post-processes used to create down sample post-processes in order to get
  74917. * the average luminance of the final image for HDR
  74918. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74919. */
  74920. luminanceDownSamplePostProcesses: PostProcess[];
  74921. /**
  74922. * Post-process used to create a HDR effect (light adaptation)
  74923. */
  74924. hdrPostProcess: Nullable<PostProcess>;
  74925. /**
  74926. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74927. */
  74928. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74929. /**
  74930. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  74931. */
  74932. lensFlareFinalPostProcess: Nullable<PostProcess>;
  74933. /**
  74934. * Post-process used to merge the final HDR post-process and the real scene color
  74935. */
  74936. hdrFinalPostProcess: Nullable<PostProcess>;
  74937. /**
  74938. * Post-process used to create a lens flare effect
  74939. */
  74940. lensFlarePostProcess: Nullable<PostProcess>;
  74941. /**
  74942. * Post-process that merges the result of the lens flare post-process and the real scene color
  74943. */
  74944. lensFlareComposePostProcess: Nullable<PostProcess>;
  74945. /**
  74946. * Post-process used to create a motion blur effect
  74947. */
  74948. motionBlurPostProcess: Nullable<PostProcess>;
  74949. /**
  74950. * Post-process used to create a depth of field effect
  74951. */
  74952. depthOfFieldPostProcess: Nullable<PostProcess>;
  74953. /**
  74954. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74955. */
  74956. fxaaPostProcess: Nullable<FxaaPostProcess>;
  74957. /**
  74958. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  74959. */
  74960. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  74961. /**
  74962. * Represents the brightness threshold in order to configure the illuminated surfaces
  74963. */
  74964. brightThreshold: number;
  74965. /**
  74966. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  74967. */
  74968. blurWidth: number;
  74969. /**
  74970. * Sets if the blur for highlighted surfaces must be only horizontal
  74971. */
  74972. horizontalBlur: boolean;
  74973. /**
  74974. * Gets the overall exposure used by the pipeline
  74975. */
  74976. get exposure(): number;
  74977. /**
  74978. * Sets the overall exposure used by the pipeline
  74979. */
  74980. set exposure(value: number);
  74981. /**
  74982. * Texture used typically to simulate "dirty" on camera lens
  74983. */
  74984. lensTexture: Nullable<Texture>;
  74985. /**
  74986. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  74987. */
  74988. volumetricLightCoefficient: number;
  74989. /**
  74990. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  74991. */
  74992. volumetricLightPower: number;
  74993. /**
  74994. * Used the set the blur intensity to smooth the volumetric lights
  74995. */
  74996. volumetricLightBlurScale: number;
  74997. /**
  74998. * Light (spot or directional) used to generate the volumetric lights rays
  74999. * The source light must have a shadow generate so the pipeline can get its
  75000. * depth map
  75001. */
  75002. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75003. /**
  75004. * For eye adaptation, represents the minimum luminance the eye can see
  75005. */
  75006. hdrMinimumLuminance: number;
  75007. /**
  75008. * For eye adaptation, represents the decrease luminance speed
  75009. */
  75010. hdrDecreaseRate: number;
  75011. /**
  75012. * For eye adaptation, represents the increase luminance speed
  75013. */
  75014. hdrIncreaseRate: number;
  75015. /**
  75016. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75017. */
  75018. get hdrAutoExposure(): boolean;
  75019. /**
  75020. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75021. */
  75022. set hdrAutoExposure(value: boolean);
  75023. /**
  75024. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75025. */
  75026. lensColorTexture: Nullable<Texture>;
  75027. /**
  75028. * The overall strengh for the lens flare effect
  75029. */
  75030. lensFlareStrength: number;
  75031. /**
  75032. * Dispersion coefficient for lens flare ghosts
  75033. */
  75034. lensFlareGhostDispersal: number;
  75035. /**
  75036. * Main lens flare halo width
  75037. */
  75038. lensFlareHaloWidth: number;
  75039. /**
  75040. * Based on the lens distortion effect, defines how much the lens flare result
  75041. * is distorted
  75042. */
  75043. lensFlareDistortionStrength: number;
  75044. /**
  75045. * Configures the blur intensity used for for lens flare (halo)
  75046. */
  75047. lensFlareBlurWidth: number;
  75048. /**
  75049. * Lens star texture must be used to simulate rays on the flares and is available
  75050. * in the documentation
  75051. */
  75052. lensStarTexture: Nullable<Texture>;
  75053. /**
  75054. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75055. * flare effect by taking account of the dirt texture
  75056. */
  75057. lensFlareDirtTexture: Nullable<Texture>;
  75058. /**
  75059. * Represents the focal length for the depth of field effect
  75060. */
  75061. depthOfFieldDistance: number;
  75062. /**
  75063. * Represents the blur intensity for the blurred part of the depth of field effect
  75064. */
  75065. depthOfFieldBlurWidth: number;
  75066. /**
  75067. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75068. */
  75069. get motionStrength(): number;
  75070. /**
  75071. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75072. */
  75073. set motionStrength(strength: number);
  75074. /**
  75075. * Gets wether or not the motion blur post-process is object based or screen based.
  75076. */
  75077. get objectBasedMotionBlur(): boolean;
  75078. /**
  75079. * Sets wether or not the motion blur post-process should be object based or screen based
  75080. */
  75081. set objectBasedMotionBlur(value: boolean);
  75082. /**
  75083. * List of animations for the pipeline (IAnimatable implementation)
  75084. */
  75085. animations: Animation[];
  75086. /**
  75087. * Private members
  75088. */
  75089. private _scene;
  75090. private _currentDepthOfFieldSource;
  75091. private _basePostProcess;
  75092. private _fixedExposure;
  75093. private _currentExposure;
  75094. private _hdrAutoExposure;
  75095. private _hdrCurrentLuminance;
  75096. private _motionStrength;
  75097. private _isObjectBasedMotionBlur;
  75098. private _floatTextureType;
  75099. private _camerasToBeAttached;
  75100. private _ratio;
  75101. private _bloomEnabled;
  75102. private _depthOfFieldEnabled;
  75103. private _vlsEnabled;
  75104. private _lensFlareEnabled;
  75105. private _hdrEnabled;
  75106. private _motionBlurEnabled;
  75107. private _fxaaEnabled;
  75108. private _screenSpaceReflectionsEnabled;
  75109. private _motionBlurSamples;
  75110. private _volumetricLightStepsCount;
  75111. private _samples;
  75112. /**
  75113. * @ignore
  75114. * Specifies if the bloom pipeline is enabled
  75115. */
  75116. get BloomEnabled(): boolean;
  75117. set BloomEnabled(enabled: boolean);
  75118. /**
  75119. * @ignore
  75120. * Specifies if the depth of field pipeline is enabed
  75121. */
  75122. get DepthOfFieldEnabled(): boolean;
  75123. set DepthOfFieldEnabled(enabled: boolean);
  75124. /**
  75125. * @ignore
  75126. * Specifies if the lens flare pipeline is enabed
  75127. */
  75128. get LensFlareEnabled(): boolean;
  75129. set LensFlareEnabled(enabled: boolean);
  75130. /**
  75131. * @ignore
  75132. * Specifies if the HDR pipeline is enabled
  75133. */
  75134. get HDREnabled(): boolean;
  75135. set HDREnabled(enabled: boolean);
  75136. /**
  75137. * @ignore
  75138. * Specifies if the volumetric lights scattering effect is enabled
  75139. */
  75140. get VLSEnabled(): boolean;
  75141. set VLSEnabled(enabled: boolean);
  75142. /**
  75143. * @ignore
  75144. * Specifies if the motion blur effect is enabled
  75145. */
  75146. get MotionBlurEnabled(): boolean;
  75147. set MotionBlurEnabled(enabled: boolean);
  75148. /**
  75149. * Specifies if anti-aliasing is enabled
  75150. */
  75151. get fxaaEnabled(): boolean;
  75152. set fxaaEnabled(enabled: boolean);
  75153. /**
  75154. * Specifies if screen space reflections are enabled.
  75155. */
  75156. get screenSpaceReflectionsEnabled(): boolean;
  75157. set screenSpaceReflectionsEnabled(enabled: boolean);
  75158. /**
  75159. * Specifies the number of steps used to calculate the volumetric lights
  75160. * Typically in interval [50, 200]
  75161. */
  75162. get volumetricLightStepsCount(): number;
  75163. set volumetricLightStepsCount(count: number);
  75164. /**
  75165. * Specifies the number of samples used for the motion blur effect
  75166. * Typically in interval [16, 64]
  75167. */
  75168. get motionBlurSamples(): number;
  75169. set motionBlurSamples(samples: number);
  75170. /**
  75171. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75172. */
  75173. get samples(): number;
  75174. set samples(sampleCount: number);
  75175. /**
  75176. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75177. * @constructor
  75178. * @param name The rendering pipeline name
  75179. * @param scene The scene linked to this pipeline
  75180. * @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)
  75181. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75182. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75183. */
  75184. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75185. private _buildPipeline;
  75186. private _createDownSampleX4PostProcess;
  75187. private _createBrightPassPostProcess;
  75188. private _createBlurPostProcesses;
  75189. private _createTextureAdderPostProcess;
  75190. private _createVolumetricLightPostProcess;
  75191. private _createLuminancePostProcesses;
  75192. private _createHdrPostProcess;
  75193. private _createLensFlarePostProcess;
  75194. private _createDepthOfFieldPostProcess;
  75195. private _createMotionBlurPostProcess;
  75196. private _getDepthTexture;
  75197. private _disposePostProcesses;
  75198. /**
  75199. * Dispose of the pipeline and stop all post processes
  75200. */
  75201. dispose(): void;
  75202. /**
  75203. * Serialize the rendering pipeline (Used when exporting)
  75204. * @returns the serialized object
  75205. */
  75206. serialize(): any;
  75207. /**
  75208. * Parse the serialized pipeline
  75209. * @param source Source pipeline.
  75210. * @param scene The scene to load the pipeline to.
  75211. * @param rootUrl The URL of the serialized pipeline.
  75212. * @returns An instantiated pipeline from the serialized object.
  75213. */
  75214. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75215. /**
  75216. * Luminance steps
  75217. */
  75218. static LuminanceSteps: number;
  75219. }
  75220. }
  75221. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75222. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75223. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75224. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75225. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75226. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75227. }
  75228. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75229. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75230. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75231. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75232. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75233. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75234. }
  75235. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75236. /** @hidden */
  75237. export var stereoscopicInterlacePixelShader: {
  75238. name: string;
  75239. shader: string;
  75240. };
  75241. }
  75242. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75243. import { Camera } from "babylonjs/Cameras/camera";
  75244. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75245. import { Engine } from "babylonjs/Engines/engine";
  75246. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75247. /**
  75248. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75249. */
  75250. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75251. private _stepSize;
  75252. private _passedProcess;
  75253. /**
  75254. * Gets a string identifying the name of the class
  75255. * @returns "StereoscopicInterlacePostProcessI" string
  75256. */
  75257. getClassName(): string;
  75258. /**
  75259. * Initializes a StereoscopicInterlacePostProcessI
  75260. * @param name The name of the effect.
  75261. * @param rigCameras The rig cameras to be appled to the post process
  75262. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75263. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75264. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75265. * @param engine The engine which the post process will be applied. (default: current engine)
  75266. * @param reusable If the post process can be reused on the same frame. (default: false)
  75267. */
  75268. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75269. }
  75270. /**
  75271. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75272. */
  75273. export class StereoscopicInterlacePostProcess extends PostProcess {
  75274. private _stepSize;
  75275. private _passedProcess;
  75276. /**
  75277. * Gets a string identifying the name of the class
  75278. * @returns "StereoscopicInterlacePostProcess" string
  75279. */
  75280. getClassName(): string;
  75281. /**
  75282. * Initializes a StereoscopicInterlacePostProcess
  75283. * @param name The name of the effect.
  75284. * @param rigCameras The rig cameras to be appled to the post process
  75285. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75286. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75287. * @param engine The engine which the post process will be applied. (default: current engine)
  75288. * @param reusable If the post process can be reused on the same frame. (default: false)
  75289. */
  75290. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75291. }
  75292. }
  75293. declare module "babylonjs/Shaders/tonemap.fragment" {
  75294. /** @hidden */
  75295. export var tonemapPixelShader: {
  75296. name: string;
  75297. shader: string;
  75298. };
  75299. }
  75300. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75301. import { Camera } from "babylonjs/Cameras/camera";
  75302. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75303. import "babylonjs/Shaders/tonemap.fragment";
  75304. import { Engine } from "babylonjs/Engines/engine";
  75305. /** Defines operator used for tonemapping */
  75306. export enum TonemappingOperator {
  75307. /** Hable */
  75308. Hable = 0,
  75309. /** Reinhard */
  75310. Reinhard = 1,
  75311. /** HejiDawson */
  75312. HejiDawson = 2,
  75313. /** Photographic */
  75314. Photographic = 3
  75315. }
  75316. /**
  75317. * Defines a post process to apply tone mapping
  75318. */
  75319. export class TonemapPostProcess extends PostProcess {
  75320. private _operator;
  75321. /** Defines the required exposure adjustement */
  75322. exposureAdjustment: number;
  75323. /**
  75324. * Gets a string identifying the name of the class
  75325. * @returns "TonemapPostProcess" string
  75326. */
  75327. getClassName(): string;
  75328. /**
  75329. * Creates a new TonemapPostProcess
  75330. * @param name defines the name of the postprocess
  75331. * @param _operator defines the operator to use
  75332. * @param exposureAdjustment defines the required exposure adjustement
  75333. * @param camera defines the camera to use (can be null)
  75334. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75335. * @param engine defines the hosting engine (can be ignore if camera is set)
  75336. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75337. */
  75338. constructor(name: string, _operator: TonemappingOperator,
  75339. /** Defines the required exposure adjustement */
  75340. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75341. }
  75342. }
  75343. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75344. /** @hidden */
  75345. export var volumetricLightScatteringPixelShader: {
  75346. name: string;
  75347. shader: string;
  75348. };
  75349. }
  75350. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75351. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75352. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75353. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75354. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75355. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75356. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75357. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75358. /** @hidden */
  75359. export var volumetricLightScatteringPassVertexShader: {
  75360. name: string;
  75361. shader: string;
  75362. };
  75363. }
  75364. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75365. /** @hidden */
  75366. export var volumetricLightScatteringPassPixelShader: {
  75367. name: string;
  75368. shader: string;
  75369. };
  75370. }
  75371. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75372. import { Vector3 } from "babylonjs/Maths/math.vector";
  75373. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75374. import { Mesh } from "babylonjs/Meshes/mesh";
  75375. import { Camera } from "babylonjs/Cameras/camera";
  75376. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75377. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75378. import { Scene } from "babylonjs/scene";
  75379. import "babylonjs/Meshes/Builders/planeBuilder";
  75380. import "babylonjs/Shaders/depth.vertex";
  75381. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75382. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75383. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75384. import { Engine } from "babylonjs/Engines/engine";
  75385. /**
  75386. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75387. */
  75388. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75389. private _volumetricLightScatteringPass;
  75390. private _volumetricLightScatteringRTT;
  75391. private _viewPort;
  75392. private _screenCoordinates;
  75393. private _cachedDefines;
  75394. /**
  75395. * If not undefined, the mesh position is computed from the attached node position
  75396. */
  75397. attachedNode: {
  75398. position: Vector3;
  75399. };
  75400. /**
  75401. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75402. */
  75403. customMeshPosition: Vector3;
  75404. /**
  75405. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75406. */
  75407. useCustomMeshPosition: boolean;
  75408. /**
  75409. * If the post-process should inverse the light scattering direction
  75410. */
  75411. invert: boolean;
  75412. /**
  75413. * The internal mesh used by the post-process
  75414. */
  75415. mesh: Mesh;
  75416. /**
  75417. * @hidden
  75418. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75419. */
  75420. get useDiffuseColor(): boolean;
  75421. set useDiffuseColor(useDiffuseColor: boolean);
  75422. /**
  75423. * Array containing the excluded meshes not rendered in the internal pass
  75424. */
  75425. excludedMeshes: AbstractMesh[];
  75426. /**
  75427. * Controls the overall intensity of the post-process
  75428. */
  75429. exposure: number;
  75430. /**
  75431. * Dissipates each sample's contribution in range [0, 1]
  75432. */
  75433. decay: number;
  75434. /**
  75435. * Controls the overall intensity of each sample
  75436. */
  75437. weight: number;
  75438. /**
  75439. * Controls the density of each sample
  75440. */
  75441. density: number;
  75442. /**
  75443. * @constructor
  75444. * @param name The post-process name
  75445. * @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)
  75446. * @param camera The camera that the post-process will be attached to
  75447. * @param mesh The mesh used to create the light scattering
  75448. * @param samples The post-process quality, default 100
  75449. * @param samplingModeThe post-process filtering mode
  75450. * @param engine The babylon engine
  75451. * @param reusable If the post-process is reusable
  75452. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75453. */
  75454. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75455. /**
  75456. * Returns the string "VolumetricLightScatteringPostProcess"
  75457. * @returns "VolumetricLightScatteringPostProcess"
  75458. */
  75459. getClassName(): string;
  75460. private _isReady;
  75461. /**
  75462. * Sets the new light position for light scattering effect
  75463. * @param position The new custom light position
  75464. */
  75465. setCustomMeshPosition(position: Vector3): void;
  75466. /**
  75467. * Returns the light position for light scattering effect
  75468. * @return Vector3 The custom light position
  75469. */
  75470. getCustomMeshPosition(): Vector3;
  75471. /**
  75472. * Disposes the internal assets and detaches the post-process from the camera
  75473. */
  75474. dispose(camera: Camera): void;
  75475. /**
  75476. * Returns the render target texture used by the post-process
  75477. * @return the render target texture used by the post-process
  75478. */
  75479. getPass(): RenderTargetTexture;
  75480. private _meshExcluded;
  75481. private _createPass;
  75482. private _updateMeshScreenCoordinates;
  75483. /**
  75484. * Creates a default mesh for the Volumeric Light Scattering post-process
  75485. * @param name The mesh name
  75486. * @param scene The scene where to create the mesh
  75487. * @return the default mesh
  75488. */
  75489. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75490. }
  75491. }
  75492. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75493. /** @hidden */
  75494. export var screenSpaceCurvaturePixelShader: {
  75495. name: string;
  75496. shader: string;
  75497. };
  75498. }
  75499. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75500. import { Nullable } from "babylonjs/types";
  75501. import { Camera } from "babylonjs/Cameras/camera";
  75502. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75503. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75504. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75505. import { Engine } from "babylonjs/Engines/engine";
  75506. import { Scene } from "babylonjs/scene";
  75507. /**
  75508. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75509. */
  75510. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75511. /**
  75512. * Defines how much ridge the curvature effect displays.
  75513. */
  75514. ridge: number;
  75515. /**
  75516. * Defines how much valley the curvature effect displays.
  75517. */
  75518. valley: number;
  75519. private _geometryBufferRenderer;
  75520. /**
  75521. * Gets a string identifying the name of the class
  75522. * @returns "ScreenSpaceCurvaturePostProcess" string
  75523. */
  75524. getClassName(): string;
  75525. /**
  75526. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75527. * @param name The name of the effect.
  75528. * @param scene The scene containing the objects to blur according to their velocity.
  75529. * @param options The required width/height ratio to downsize to before computing the render pass.
  75530. * @param camera The camera to apply the render pass to.
  75531. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75532. * @param engine The engine which the post process will be applied. (default: current engine)
  75533. * @param reusable If the post process can be reused on the same frame. (default: false)
  75534. * @param textureType Type of textures used when performing the post process. (default: 0)
  75535. * @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)
  75536. */
  75537. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75538. /**
  75539. * Support test.
  75540. */
  75541. static get IsSupported(): boolean;
  75542. /** @hidden */
  75543. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75544. }
  75545. }
  75546. declare module "babylonjs/PostProcesses/index" {
  75547. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75548. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75549. export * from "babylonjs/PostProcesses/bloomEffect";
  75550. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75551. export * from "babylonjs/PostProcesses/blurPostProcess";
  75552. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75553. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75554. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75555. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75556. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75557. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75558. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75559. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75560. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75561. export * from "babylonjs/PostProcesses/filterPostProcess";
  75562. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75563. export * from "babylonjs/PostProcesses/grainPostProcess";
  75564. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75565. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75566. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75567. export * from "babylonjs/PostProcesses/passPostProcess";
  75568. export * from "babylonjs/PostProcesses/postProcess";
  75569. export * from "babylonjs/PostProcesses/postProcessManager";
  75570. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75571. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75572. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75573. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75574. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75575. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75576. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75577. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75578. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75579. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75580. }
  75581. declare module "babylonjs/Probes/index" {
  75582. export * from "babylonjs/Probes/reflectionProbe";
  75583. }
  75584. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75585. import { Scene } from "babylonjs/scene";
  75586. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75587. import { SmartArray } from "babylonjs/Misc/smartArray";
  75588. import { ISceneComponent } from "babylonjs/sceneComponent";
  75589. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75590. import "babylonjs/Meshes/Builders/boxBuilder";
  75591. import "babylonjs/Shaders/color.fragment";
  75592. import "babylonjs/Shaders/color.vertex";
  75593. import { Color3 } from "babylonjs/Maths/math.color";
  75594. import { Observable } from "babylonjs/Misc/observable";
  75595. module "babylonjs/scene" {
  75596. interface Scene {
  75597. /** @hidden (Backing field) */
  75598. _boundingBoxRenderer: BoundingBoxRenderer;
  75599. /** @hidden (Backing field) */
  75600. _forceShowBoundingBoxes: boolean;
  75601. /**
  75602. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75603. */
  75604. forceShowBoundingBoxes: boolean;
  75605. /**
  75606. * Gets the bounding box renderer associated with the scene
  75607. * @returns a BoundingBoxRenderer
  75608. */
  75609. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75610. }
  75611. }
  75612. module "babylonjs/Meshes/abstractMesh" {
  75613. interface AbstractMesh {
  75614. /** @hidden (Backing field) */
  75615. _showBoundingBox: boolean;
  75616. /**
  75617. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75618. */
  75619. showBoundingBox: boolean;
  75620. }
  75621. }
  75622. /**
  75623. * Component responsible of rendering the bounding box of the meshes in a scene.
  75624. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75625. */
  75626. export class BoundingBoxRenderer implements ISceneComponent {
  75627. /**
  75628. * The component name helpfull to identify the component in the list of scene components.
  75629. */
  75630. readonly name: string;
  75631. /**
  75632. * The scene the component belongs to.
  75633. */
  75634. scene: Scene;
  75635. /**
  75636. * Color of the bounding box lines placed in front of an object
  75637. */
  75638. frontColor: Color3;
  75639. /**
  75640. * Color of the bounding box lines placed behind an object
  75641. */
  75642. backColor: Color3;
  75643. /**
  75644. * Defines if the renderer should show the back lines or not
  75645. */
  75646. showBackLines: boolean;
  75647. /**
  75648. * Observable raised before rendering a bounding box
  75649. */
  75650. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75651. /**
  75652. * Observable raised after rendering a bounding box
  75653. */
  75654. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75655. /**
  75656. * @hidden
  75657. */
  75658. renderList: SmartArray<BoundingBox>;
  75659. private _colorShader;
  75660. private _vertexBuffers;
  75661. private _indexBuffer;
  75662. private _fillIndexBuffer;
  75663. private _fillIndexData;
  75664. /**
  75665. * Instantiates a new bounding box renderer in a scene.
  75666. * @param scene the scene the renderer renders in
  75667. */
  75668. constructor(scene: Scene);
  75669. /**
  75670. * Registers the component in a given scene
  75671. */
  75672. register(): void;
  75673. private _evaluateSubMesh;
  75674. private _activeMesh;
  75675. private _prepareRessources;
  75676. private _createIndexBuffer;
  75677. /**
  75678. * Rebuilds the elements related to this component in case of
  75679. * context lost for instance.
  75680. */
  75681. rebuild(): void;
  75682. /**
  75683. * @hidden
  75684. */
  75685. reset(): void;
  75686. /**
  75687. * Render the bounding boxes of a specific rendering group
  75688. * @param renderingGroupId defines the rendering group to render
  75689. */
  75690. render(renderingGroupId: number): void;
  75691. /**
  75692. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75693. * @param mesh Define the mesh to render the occlusion bounding box for
  75694. */
  75695. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75696. /**
  75697. * Dispose and release the resources attached to this renderer.
  75698. */
  75699. dispose(): void;
  75700. }
  75701. }
  75702. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75703. import { Nullable } from "babylonjs/types";
  75704. import { Scene } from "babylonjs/scene";
  75705. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75706. import { Camera } from "babylonjs/Cameras/camera";
  75707. import { ISceneComponent } from "babylonjs/sceneComponent";
  75708. module "babylonjs/scene" {
  75709. interface Scene {
  75710. /** @hidden (Backing field) */
  75711. _depthRenderer: {
  75712. [id: string]: DepthRenderer;
  75713. };
  75714. /**
  75715. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75716. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75717. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75718. * @returns the created depth renderer
  75719. */
  75720. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75721. /**
  75722. * Disables a depth renderer for a given camera
  75723. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75724. */
  75725. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75726. }
  75727. }
  75728. /**
  75729. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75730. * in several rendering techniques.
  75731. */
  75732. export class DepthRendererSceneComponent implements ISceneComponent {
  75733. /**
  75734. * The component name helpfull to identify the component in the list of scene components.
  75735. */
  75736. readonly name: string;
  75737. /**
  75738. * The scene the component belongs to.
  75739. */
  75740. scene: Scene;
  75741. /**
  75742. * Creates a new instance of the component for the given scene
  75743. * @param scene Defines the scene to register the component in
  75744. */
  75745. constructor(scene: Scene);
  75746. /**
  75747. * Registers the component in a given scene
  75748. */
  75749. register(): void;
  75750. /**
  75751. * Rebuilds the elements related to this component in case of
  75752. * context lost for instance.
  75753. */
  75754. rebuild(): void;
  75755. /**
  75756. * Disposes the component and the associated ressources
  75757. */
  75758. dispose(): void;
  75759. private _gatherRenderTargets;
  75760. private _gatherActiveCameraRenderTargets;
  75761. }
  75762. }
  75763. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75764. import { Nullable } from "babylonjs/types";
  75765. import { Scene } from "babylonjs/scene";
  75766. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75767. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75768. import { AbstractScene } from "babylonjs/abstractScene";
  75769. module "babylonjs/abstractScene" {
  75770. interface AbstractScene {
  75771. /** @hidden (Backing field) */
  75772. _prePassRenderer: Nullable<PrePassRenderer>;
  75773. /**
  75774. * Gets or Sets the current prepass renderer associated to the scene.
  75775. */
  75776. prePassRenderer: Nullable<PrePassRenderer>;
  75777. /**
  75778. * Enables the prepass and associates it with the scene
  75779. * @returns the PrePassRenderer
  75780. */
  75781. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75782. /**
  75783. * Disables the prepass associated with the scene
  75784. */
  75785. disablePrePassRenderer(): void;
  75786. }
  75787. }
  75788. /**
  75789. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75790. * in several rendering techniques.
  75791. */
  75792. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75793. /**
  75794. * The component name helpful to identify the component in the list of scene components.
  75795. */
  75796. readonly name: string;
  75797. /**
  75798. * The scene the component belongs to.
  75799. */
  75800. scene: Scene;
  75801. /**
  75802. * Creates a new instance of the component for the given scene
  75803. * @param scene Defines the scene to register the component in
  75804. */
  75805. constructor(scene: Scene);
  75806. /**
  75807. * Registers the component in a given scene
  75808. */
  75809. register(): void;
  75810. private _beforeCameraDraw;
  75811. private _afterCameraDraw;
  75812. private _beforeClearStage;
  75813. /**
  75814. * Serializes the component data to the specified json object
  75815. * @param serializationObject The object to serialize to
  75816. */
  75817. serialize(serializationObject: any): void;
  75818. /**
  75819. * Adds all the elements from the container to the scene
  75820. * @param container the container holding the elements
  75821. */
  75822. addFromContainer(container: AbstractScene): void;
  75823. /**
  75824. * Removes all the elements in the container from the scene
  75825. * @param container contains the elements to remove
  75826. * @param dispose if the removed element should be disposed (default: false)
  75827. */
  75828. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75829. /**
  75830. * Rebuilds the elements related to this component in case of
  75831. * context lost for instance.
  75832. */
  75833. rebuild(): void;
  75834. /**
  75835. * Disposes the component and the associated ressources
  75836. */
  75837. dispose(): void;
  75838. }
  75839. }
  75840. declare module "babylonjs/Shaders/outline.fragment" {
  75841. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75842. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75843. /** @hidden */
  75844. export var outlinePixelShader: {
  75845. name: string;
  75846. shader: string;
  75847. };
  75848. }
  75849. declare module "babylonjs/Shaders/outline.vertex" {
  75850. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75851. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75852. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75853. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75854. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75855. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75856. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75857. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75858. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75859. /** @hidden */
  75860. export var outlineVertexShader: {
  75861. name: string;
  75862. shader: string;
  75863. };
  75864. }
  75865. declare module "babylonjs/Rendering/outlineRenderer" {
  75866. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75867. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75868. import { Scene } from "babylonjs/scene";
  75869. import { ISceneComponent } from "babylonjs/sceneComponent";
  75870. import "babylonjs/Shaders/outline.fragment";
  75871. import "babylonjs/Shaders/outline.vertex";
  75872. module "babylonjs/scene" {
  75873. interface Scene {
  75874. /** @hidden */
  75875. _outlineRenderer: OutlineRenderer;
  75876. /**
  75877. * Gets the outline renderer associated with the scene
  75878. * @returns a OutlineRenderer
  75879. */
  75880. getOutlineRenderer(): OutlineRenderer;
  75881. }
  75882. }
  75883. module "babylonjs/Meshes/abstractMesh" {
  75884. interface AbstractMesh {
  75885. /** @hidden (Backing field) */
  75886. _renderOutline: boolean;
  75887. /**
  75888. * Gets or sets a boolean indicating if the outline must be rendered as well
  75889. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75890. */
  75891. renderOutline: boolean;
  75892. /** @hidden (Backing field) */
  75893. _renderOverlay: boolean;
  75894. /**
  75895. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75896. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75897. */
  75898. renderOverlay: boolean;
  75899. }
  75900. }
  75901. /**
  75902. * This class is responsible to draw bothe outline/overlay of meshes.
  75903. * It should not be used directly but through the available method on mesh.
  75904. */
  75905. export class OutlineRenderer implements ISceneComponent {
  75906. /**
  75907. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75908. */
  75909. private static _StencilReference;
  75910. /**
  75911. * The name of the component. Each component must have a unique name.
  75912. */
  75913. name: string;
  75914. /**
  75915. * The scene the component belongs to.
  75916. */
  75917. scene: Scene;
  75918. /**
  75919. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75920. */
  75921. zOffset: number;
  75922. private _engine;
  75923. private _effect;
  75924. private _cachedDefines;
  75925. private _savedDepthWrite;
  75926. /**
  75927. * Instantiates a new outline renderer. (There could be only one per scene).
  75928. * @param scene Defines the scene it belongs to
  75929. */
  75930. constructor(scene: Scene);
  75931. /**
  75932. * Register the component to one instance of a scene.
  75933. */
  75934. register(): void;
  75935. /**
  75936. * Rebuilds the elements related to this component in case of
  75937. * context lost for instance.
  75938. */
  75939. rebuild(): void;
  75940. /**
  75941. * Disposes the component and the associated ressources.
  75942. */
  75943. dispose(): void;
  75944. /**
  75945. * Renders the outline in the canvas.
  75946. * @param subMesh Defines the sumesh to render
  75947. * @param batch Defines the batch of meshes in case of instances
  75948. * @param useOverlay Defines if the rendering is for the overlay or the outline
  75949. */
  75950. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  75951. /**
  75952. * Returns whether or not the outline renderer is ready for a given submesh.
  75953. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  75954. * @param subMesh Defines the submesh to check readyness for
  75955. * @param useInstances Defines wheter wee are trying to render instances or not
  75956. * @returns true if ready otherwise false
  75957. */
  75958. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  75959. private _beforeRenderingMesh;
  75960. private _afterRenderingMesh;
  75961. }
  75962. }
  75963. declare module "babylonjs/Rendering/index" {
  75964. export * from "babylonjs/Rendering/boundingBoxRenderer";
  75965. export * from "babylonjs/Rendering/depthRenderer";
  75966. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  75967. export * from "babylonjs/Rendering/edgesRenderer";
  75968. export * from "babylonjs/Rendering/geometryBufferRenderer";
  75969. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75970. export * from "babylonjs/Rendering/prePassRenderer";
  75971. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  75972. export * from "babylonjs/Rendering/outlineRenderer";
  75973. export * from "babylonjs/Rendering/renderingGroup";
  75974. export * from "babylonjs/Rendering/renderingManager";
  75975. export * from "babylonjs/Rendering/utilityLayerRenderer";
  75976. }
  75977. declare module "babylonjs/Sprites/ISprites" {
  75978. /**
  75979. * Defines the basic options interface of a Sprite Frame Source Size.
  75980. */
  75981. export interface ISpriteJSONSpriteSourceSize {
  75982. /**
  75983. * number of the original width of the Frame
  75984. */
  75985. w: number;
  75986. /**
  75987. * number of the original height of the Frame
  75988. */
  75989. h: number;
  75990. }
  75991. /**
  75992. * Defines the basic options interface of a Sprite Frame Data.
  75993. */
  75994. export interface ISpriteJSONSpriteFrameData {
  75995. /**
  75996. * number of the x offset of the Frame
  75997. */
  75998. x: number;
  75999. /**
  76000. * number of the y offset of the Frame
  76001. */
  76002. y: number;
  76003. /**
  76004. * number of the width of the Frame
  76005. */
  76006. w: number;
  76007. /**
  76008. * number of the height of the Frame
  76009. */
  76010. h: number;
  76011. }
  76012. /**
  76013. * Defines the basic options interface of a JSON Sprite.
  76014. */
  76015. export interface ISpriteJSONSprite {
  76016. /**
  76017. * string name of the Frame
  76018. */
  76019. filename: string;
  76020. /**
  76021. * ISpriteJSONSpriteFrame basic object of the frame data
  76022. */
  76023. frame: ISpriteJSONSpriteFrameData;
  76024. /**
  76025. * boolean to flag is the frame was rotated.
  76026. */
  76027. rotated: boolean;
  76028. /**
  76029. * boolean to flag is the frame was trimmed.
  76030. */
  76031. trimmed: boolean;
  76032. /**
  76033. * ISpriteJSONSpriteFrame basic object of the source data
  76034. */
  76035. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76036. /**
  76037. * ISpriteJSONSpriteFrame basic object of the source data
  76038. */
  76039. sourceSize: ISpriteJSONSpriteSourceSize;
  76040. }
  76041. /**
  76042. * Defines the basic options interface of a JSON atlas.
  76043. */
  76044. export interface ISpriteJSONAtlas {
  76045. /**
  76046. * Array of objects that contain the frame data.
  76047. */
  76048. frames: Array<ISpriteJSONSprite>;
  76049. /**
  76050. * object basic object containing the sprite meta data.
  76051. */
  76052. meta?: object;
  76053. }
  76054. }
  76055. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76056. /** @hidden */
  76057. export var spriteMapPixelShader: {
  76058. name: string;
  76059. shader: string;
  76060. };
  76061. }
  76062. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76063. /** @hidden */
  76064. export var spriteMapVertexShader: {
  76065. name: string;
  76066. shader: string;
  76067. };
  76068. }
  76069. declare module "babylonjs/Sprites/spriteMap" {
  76070. import { IDisposable, Scene } from "babylonjs/scene";
  76071. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76072. import { Texture } from "babylonjs/Materials/Textures/texture";
  76073. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76074. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76075. import "babylonjs/Meshes/Builders/planeBuilder";
  76076. import "babylonjs/Shaders/spriteMap.fragment";
  76077. import "babylonjs/Shaders/spriteMap.vertex";
  76078. /**
  76079. * Defines the basic options interface of a SpriteMap
  76080. */
  76081. export interface ISpriteMapOptions {
  76082. /**
  76083. * Vector2 of the number of cells in the grid.
  76084. */
  76085. stageSize?: Vector2;
  76086. /**
  76087. * Vector2 of the size of the output plane in World Units.
  76088. */
  76089. outputSize?: Vector2;
  76090. /**
  76091. * Vector3 of the position of the output plane in World Units.
  76092. */
  76093. outputPosition?: Vector3;
  76094. /**
  76095. * Vector3 of the rotation of the output plane.
  76096. */
  76097. outputRotation?: Vector3;
  76098. /**
  76099. * number of layers that the system will reserve in resources.
  76100. */
  76101. layerCount?: number;
  76102. /**
  76103. * number of max animation frames a single cell will reserve in resources.
  76104. */
  76105. maxAnimationFrames?: number;
  76106. /**
  76107. * number cell index of the base tile when the system compiles.
  76108. */
  76109. baseTile?: number;
  76110. /**
  76111. * boolean flip the sprite after its been repositioned by the framing data.
  76112. */
  76113. flipU?: boolean;
  76114. /**
  76115. * Vector3 scalar of the global RGB values of the SpriteMap.
  76116. */
  76117. colorMultiply?: Vector3;
  76118. }
  76119. /**
  76120. * Defines the IDisposable interface in order to be cleanable from resources.
  76121. */
  76122. export interface ISpriteMap extends IDisposable {
  76123. /**
  76124. * String name of the SpriteMap.
  76125. */
  76126. name: string;
  76127. /**
  76128. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76129. */
  76130. atlasJSON: ISpriteJSONAtlas;
  76131. /**
  76132. * Texture of the SpriteMap.
  76133. */
  76134. spriteSheet: Texture;
  76135. /**
  76136. * The parameters to initialize the SpriteMap with.
  76137. */
  76138. options: ISpriteMapOptions;
  76139. }
  76140. /**
  76141. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76142. */
  76143. export class SpriteMap implements ISpriteMap {
  76144. /** The Name of the spriteMap */
  76145. name: string;
  76146. /** The JSON file with the frame and meta data */
  76147. atlasJSON: ISpriteJSONAtlas;
  76148. /** The systems Sprite Sheet Texture */
  76149. spriteSheet: Texture;
  76150. /** Arguments passed with the Constructor */
  76151. options: ISpriteMapOptions;
  76152. /** Public Sprite Storage array, parsed from atlasJSON */
  76153. sprites: Array<ISpriteJSONSprite>;
  76154. /** Returns the Number of Sprites in the System */
  76155. get spriteCount(): number;
  76156. /** Returns the Position of Output Plane*/
  76157. get position(): Vector3;
  76158. /** Returns the Position of Output Plane*/
  76159. set position(v: Vector3);
  76160. /** Returns the Rotation of Output Plane*/
  76161. get rotation(): Vector3;
  76162. /** Returns the Rotation of Output Plane*/
  76163. set rotation(v: Vector3);
  76164. /** Sets the AnimationMap*/
  76165. get animationMap(): RawTexture;
  76166. /** Sets the AnimationMap*/
  76167. set animationMap(v: RawTexture);
  76168. /** Scene that the SpriteMap was created in */
  76169. private _scene;
  76170. /** Texture Buffer of Float32 that holds tile frame data*/
  76171. private _frameMap;
  76172. /** Texture Buffers of Float32 that holds tileMap data*/
  76173. private _tileMaps;
  76174. /** Texture Buffer of Float32 that holds Animation Data*/
  76175. private _animationMap;
  76176. /** Custom ShaderMaterial Central to the System*/
  76177. private _material;
  76178. /** Custom ShaderMaterial Central to the System*/
  76179. private _output;
  76180. /** Systems Time Ticker*/
  76181. private _time;
  76182. /**
  76183. * Creates a new SpriteMap
  76184. * @param name defines the SpriteMaps Name
  76185. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76186. * @param spriteSheet is the Texture that the Sprites are on.
  76187. * @param options a basic deployment configuration
  76188. * @param scene The Scene that the map is deployed on
  76189. */
  76190. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76191. /**
  76192. * Returns tileID location
  76193. * @returns Vector2 the cell position ID
  76194. */
  76195. getTileID(): Vector2;
  76196. /**
  76197. * Gets the UV location of the mouse over the SpriteMap.
  76198. * @returns Vector2 the UV position of the mouse interaction
  76199. */
  76200. getMousePosition(): Vector2;
  76201. /**
  76202. * Creates the "frame" texture Buffer
  76203. * -------------------------------------
  76204. * Structure of frames
  76205. * "filename": "Falling-Water-2.png",
  76206. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76207. * "rotated": true,
  76208. * "trimmed": true,
  76209. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76210. * "sourceSize": {"w":32,"h":32}
  76211. * @returns RawTexture of the frameMap
  76212. */
  76213. private _createFrameBuffer;
  76214. /**
  76215. * Creates the tileMap texture Buffer
  76216. * @param buffer normally and array of numbers, or a false to generate from scratch
  76217. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76218. * @returns RawTexture of the tileMap
  76219. */
  76220. private _createTileBuffer;
  76221. /**
  76222. * Modifies the data of the tileMaps
  76223. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76224. * @param pos is the iVector2 Coordinates of the Tile
  76225. * @param tile The SpriteIndex of the new Tile
  76226. */
  76227. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76228. /**
  76229. * Creates the animationMap texture Buffer
  76230. * @param buffer normally and array of numbers, or a false to generate from scratch
  76231. * @returns RawTexture of the animationMap
  76232. */
  76233. private _createTileAnimationBuffer;
  76234. /**
  76235. * Modifies the data of the animationMap
  76236. * @param cellID is the Index of the Sprite
  76237. * @param _frame is the target Animation frame
  76238. * @param toCell is the Target Index of the next frame of the animation
  76239. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76240. * @param speed is a global scalar of the time variable on the map.
  76241. */
  76242. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76243. /**
  76244. * Exports the .tilemaps file
  76245. */
  76246. saveTileMaps(): void;
  76247. /**
  76248. * Imports the .tilemaps file
  76249. * @param url of the .tilemaps file
  76250. */
  76251. loadTileMaps(url: string): void;
  76252. /**
  76253. * Release associated resources
  76254. */
  76255. dispose(): void;
  76256. }
  76257. }
  76258. declare module "babylonjs/Sprites/spritePackedManager" {
  76259. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76260. import { Scene } from "babylonjs/scene";
  76261. /**
  76262. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76263. * @see https://doc.babylonjs.com/babylon101/sprites
  76264. */
  76265. export class SpritePackedManager extends SpriteManager {
  76266. /** defines the packed manager's name */
  76267. name: string;
  76268. /**
  76269. * Creates a new sprite manager from a packed sprite sheet
  76270. * @param name defines the manager's name
  76271. * @param imgUrl defines the sprite sheet url
  76272. * @param capacity defines the maximum allowed number of sprites
  76273. * @param scene defines the hosting scene
  76274. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76275. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76276. * @param samplingMode defines the smapling mode to use with spritesheet
  76277. * @param fromPacked set to true; do not alter
  76278. */
  76279. constructor(
  76280. /** defines the packed manager's name */
  76281. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76282. }
  76283. }
  76284. declare module "babylonjs/Sprites/index" {
  76285. export * from "babylonjs/Sprites/sprite";
  76286. export * from "babylonjs/Sprites/ISprites";
  76287. export * from "babylonjs/Sprites/spriteManager";
  76288. export * from "babylonjs/Sprites/spriteMap";
  76289. export * from "babylonjs/Sprites/spritePackedManager";
  76290. export * from "babylonjs/Sprites/spriteSceneComponent";
  76291. }
  76292. declare module "babylonjs/States/index" {
  76293. export * from "babylonjs/States/alphaCullingState";
  76294. export * from "babylonjs/States/depthCullingState";
  76295. export * from "babylonjs/States/stencilState";
  76296. }
  76297. declare module "babylonjs/Misc/assetsManager" {
  76298. import { Scene } from "babylonjs/scene";
  76299. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76300. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76301. import { Skeleton } from "babylonjs/Bones/skeleton";
  76302. import { Observable } from "babylonjs/Misc/observable";
  76303. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76304. import { Texture } from "babylonjs/Materials/Textures/texture";
  76305. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76306. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76307. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76308. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76309. import { AssetContainer } from "babylonjs/assetContainer";
  76310. /**
  76311. * Defines the list of states available for a task inside a AssetsManager
  76312. */
  76313. export enum AssetTaskState {
  76314. /**
  76315. * Initialization
  76316. */
  76317. INIT = 0,
  76318. /**
  76319. * Running
  76320. */
  76321. RUNNING = 1,
  76322. /**
  76323. * Done
  76324. */
  76325. DONE = 2,
  76326. /**
  76327. * Error
  76328. */
  76329. ERROR = 3
  76330. }
  76331. /**
  76332. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76333. */
  76334. export abstract class AbstractAssetTask {
  76335. /**
  76336. * Task name
  76337. */ name: string;
  76338. /**
  76339. * Callback called when the task is successful
  76340. */
  76341. onSuccess: (task: any) => void;
  76342. /**
  76343. * Callback called when the task is not successful
  76344. */
  76345. onError: (task: any, message?: string, exception?: any) => void;
  76346. /**
  76347. * Creates a new AssetsManager
  76348. * @param name defines the name of the task
  76349. */
  76350. constructor(
  76351. /**
  76352. * Task name
  76353. */ name: string);
  76354. private _isCompleted;
  76355. private _taskState;
  76356. private _errorObject;
  76357. /**
  76358. * Get if the task is completed
  76359. */
  76360. get isCompleted(): boolean;
  76361. /**
  76362. * Gets the current state of the task
  76363. */
  76364. get taskState(): AssetTaskState;
  76365. /**
  76366. * Gets the current error object (if task is in error)
  76367. */
  76368. get errorObject(): {
  76369. message?: string;
  76370. exception?: any;
  76371. };
  76372. /**
  76373. * Internal only
  76374. * @hidden
  76375. */
  76376. _setErrorObject(message?: string, exception?: any): void;
  76377. /**
  76378. * Execute the current task
  76379. * @param scene defines the scene where you want your assets to be loaded
  76380. * @param onSuccess is a callback called when the task is successfully executed
  76381. * @param onError is a callback called if an error occurs
  76382. */
  76383. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76384. /**
  76385. * Execute the current task
  76386. * @param scene defines the scene where you want your assets to be loaded
  76387. * @param onSuccess is a callback called when the task is successfully executed
  76388. * @param onError is a callback called if an error occurs
  76389. */
  76390. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76391. /**
  76392. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76393. * This can be used with failed tasks that have the reason for failure fixed.
  76394. */
  76395. reset(): void;
  76396. private onErrorCallback;
  76397. private onDoneCallback;
  76398. }
  76399. /**
  76400. * Define the interface used by progress events raised during assets loading
  76401. */
  76402. export interface IAssetsProgressEvent {
  76403. /**
  76404. * Defines the number of remaining tasks to process
  76405. */
  76406. remainingCount: number;
  76407. /**
  76408. * Defines the total number of tasks
  76409. */
  76410. totalCount: number;
  76411. /**
  76412. * Defines the task that was just processed
  76413. */
  76414. task: AbstractAssetTask;
  76415. }
  76416. /**
  76417. * Class used to share progress information about assets loading
  76418. */
  76419. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76420. /**
  76421. * Defines the number of remaining tasks to process
  76422. */
  76423. remainingCount: number;
  76424. /**
  76425. * Defines the total number of tasks
  76426. */
  76427. totalCount: number;
  76428. /**
  76429. * Defines the task that was just processed
  76430. */
  76431. task: AbstractAssetTask;
  76432. /**
  76433. * Creates a AssetsProgressEvent
  76434. * @param remainingCount defines the number of remaining tasks to process
  76435. * @param totalCount defines the total number of tasks
  76436. * @param task defines the task that was just processed
  76437. */
  76438. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76439. }
  76440. /**
  76441. * Define a task used by AssetsManager to load assets into a container
  76442. */
  76443. export class ContainerAssetTask extends AbstractAssetTask {
  76444. /**
  76445. * Defines the name of the task
  76446. */
  76447. name: string;
  76448. /**
  76449. * Defines the list of mesh's names you want to load
  76450. */
  76451. meshesNames: any;
  76452. /**
  76453. * Defines the root url to use as a base to load your meshes and associated resources
  76454. */
  76455. rootUrl: string;
  76456. /**
  76457. * Defines the filename or File of the scene to load from
  76458. */
  76459. sceneFilename: string | File;
  76460. /**
  76461. * Get the loaded asset container
  76462. */
  76463. loadedContainer: AssetContainer;
  76464. /**
  76465. * Gets the list of loaded meshes
  76466. */
  76467. loadedMeshes: Array<AbstractMesh>;
  76468. /**
  76469. * Gets the list of loaded particle systems
  76470. */
  76471. loadedParticleSystems: Array<IParticleSystem>;
  76472. /**
  76473. * Gets the list of loaded skeletons
  76474. */
  76475. loadedSkeletons: Array<Skeleton>;
  76476. /**
  76477. * Gets the list of loaded animation groups
  76478. */
  76479. loadedAnimationGroups: Array<AnimationGroup>;
  76480. /**
  76481. * Callback called when the task is successful
  76482. */
  76483. onSuccess: (task: ContainerAssetTask) => void;
  76484. /**
  76485. * Callback called when the task is successful
  76486. */
  76487. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76488. /**
  76489. * Creates a new ContainerAssetTask
  76490. * @param name defines the name of the task
  76491. * @param meshesNames defines the list of mesh's names you want to load
  76492. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76493. * @param sceneFilename defines the filename or File of the scene to load from
  76494. */
  76495. constructor(
  76496. /**
  76497. * Defines the name of the task
  76498. */
  76499. name: string,
  76500. /**
  76501. * Defines the list of mesh's names you want to load
  76502. */
  76503. meshesNames: any,
  76504. /**
  76505. * Defines the root url to use as a base to load your meshes and associated resources
  76506. */
  76507. rootUrl: string,
  76508. /**
  76509. * Defines the filename or File of the scene to load from
  76510. */
  76511. sceneFilename: string | File);
  76512. /**
  76513. * Execute the current task
  76514. * @param scene defines the scene where you want your assets to be loaded
  76515. * @param onSuccess is a callback called when the task is successfully executed
  76516. * @param onError is a callback called if an error occurs
  76517. */
  76518. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76519. }
  76520. /**
  76521. * Define a task used by AssetsManager to load meshes
  76522. */
  76523. export class MeshAssetTask extends AbstractAssetTask {
  76524. /**
  76525. * Defines the name of the task
  76526. */
  76527. name: string;
  76528. /**
  76529. * Defines the list of mesh's names you want to load
  76530. */
  76531. meshesNames: any;
  76532. /**
  76533. * Defines the root url to use as a base to load your meshes and associated resources
  76534. */
  76535. rootUrl: string;
  76536. /**
  76537. * Defines the filename or File of the scene to load from
  76538. */
  76539. sceneFilename: string | File;
  76540. /**
  76541. * Gets the list of loaded meshes
  76542. */
  76543. loadedMeshes: Array<AbstractMesh>;
  76544. /**
  76545. * Gets the list of loaded particle systems
  76546. */
  76547. loadedParticleSystems: Array<IParticleSystem>;
  76548. /**
  76549. * Gets the list of loaded skeletons
  76550. */
  76551. loadedSkeletons: Array<Skeleton>;
  76552. /**
  76553. * Gets the list of loaded animation groups
  76554. */
  76555. loadedAnimationGroups: Array<AnimationGroup>;
  76556. /**
  76557. * Callback called when the task is successful
  76558. */
  76559. onSuccess: (task: MeshAssetTask) => void;
  76560. /**
  76561. * Callback called when the task is successful
  76562. */
  76563. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76564. /**
  76565. * Creates a new MeshAssetTask
  76566. * @param name defines the name of the task
  76567. * @param meshesNames defines the list of mesh's names you want to load
  76568. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76569. * @param sceneFilename defines the filename or File of the scene to load from
  76570. */
  76571. constructor(
  76572. /**
  76573. * Defines the name of the task
  76574. */
  76575. name: string,
  76576. /**
  76577. * Defines the list of mesh's names you want to load
  76578. */
  76579. meshesNames: any,
  76580. /**
  76581. * Defines the root url to use as a base to load your meshes and associated resources
  76582. */
  76583. rootUrl: string,
  76584. /**
  76585. * Defines the filename or File of the scene to load from
  76586. */
  76587. sceneFilename: string | File);
  76588. /**
  76589. * Execute the current task
  76590. * @param scene defines the scene where you want your assets to be loaded
  76591. * @param onSuccess is a callback called when the task is successfully executed
  76592. * @param onError is a callback called if an error occurs
  76593. */
  76594. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76595. }
  76596. /**
  76597. * Define a task used by AssetsManager to load text content
  76598. */
  76599. export class TextFileAssetTask extends AbstractAssetTask {
  76600. /**
  76601. * Defines the name of the task
  76602. */
  76603. name: string;
  76604. /**
  76605. * Defines the location of the file to load
  76606. */
  76607. url: string;
  76608. /**
  76609. * Gets the loaded text string
  76610. */
  76611. text: string;
  76612. /**
  76613. * Callback called when the task is successful
  76614. */
  76615. onSuccess: (task: TextFileAssetTask) => void;
  76616. /**
  76617. * Callback called when the task is successful
  76618. */
  76619. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76620. /**
  76621. * Creates a new TextFileAssetTask object
  76622. * @param name defines the name of the task
  76623. * @param url defines the location of the file to load
  76624. */
  76625. constructor(
  76626. /**
  76627. * Defines the name of the task
  76628. */
  76629. name: string,
  76630. /**
  76631. * Defines the location of the file to load
  76632. */
  76633. url: string);
  76634. /**
  76635. * Execute the current task
  76636. * @param scene defines the scene where you want your assets to be loaded
  76637. * @param onSuccess is a callback called when the task is successfully executed
  76638. * @param onError is a callback called if an error occurs
  76639. */
  76640. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76641. }
  76642. /**
  76643. * Define a task used by AssetsManager to load binary data
  76644. */
  76645. export class BinaryFileAssetTask extends AbstractAssetTask {
  76646. /**
  76647. * Defines the name of the task
  76648. */
  76649. name: string;
  76650. /**
  76651. * Defines the location of the file to load
  76652. */
  76653. url: string;
  76654. /**
  76655. * Gets the lodaded data (as an array buffer)
  76656. */
  76657. data: ArrayBuffer;
  76658. /**
  76659. * Callback called when the task is successful
  76660. */
  76661. onSuccess: (task: BinaryFileAssetTask) => void;
  76662. /**
  76663. * Callback called when the task is successful
  76664. */
  76665. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76666. /**
  76667. * Creates a new BinaryFileAssetTask object
  76668. * @param name defines the name of the new task
  76669. * @param url defines the location of the file to load
  76670. */
  76671. constructor(
  76672. /**
  76673. * Defines the name of the task
  76674. */
  76675. name: string,
  76676. /**
  76677. * Defines the location of the file to load
  76678. */
  76679. url: string);
  76680. /**
  76681. * Execute the current task
  76682. * @param scene defines the scene where you want your assets to be loaded
  76683. * @param onSuccess is a callback called when the task is successfully executed
  76684. * @param onError is a callback called if an error occurs
  76685. */
  76686. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76687. }
  76688. /**
  76689. * Define a task used by AssetsManager to load images
  76690. */
  76691. export class ImageAssetTask extends AbstractAssetTask {
  76692. /**
  76693. * Defines the name of the task
  76694. */
  76695. name: string;
  76696. /**
  76697. * Defines the location of the image to load
  76698. */
  76699. url: string;
  76700. /**
  76701. * Gets the loaded images
  76702. */
  76703. image: HTMLImageElement;
  76704. /**
  76705. * Callback called when the task is successful
  76706. */
  76707. onSuccess: (task: ImageAssetTask) => void;
  76708. /**
  76709. * Callback called when the task is successful
  76710. */
  76711. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76712. /**
  76713. * Creates a new ImageAssetTask
  76714. * @param name defines the name of the task
  76715. * @param url defines the location of the image to load
  76716. */
  76717. constructor(
  76718. /**
  76719. * Defines the name of the task
  76720. */
  76721. name: string,
  76722. /**
  76723. * Defines the location of the image to load
  76724. */
  76725. url: string);
  76726. /**
  76727. * Execute the current task
  76728. * @param scene defines the scene where you want your assets to be loaded
  76729. * @param onSuccess is a callback called when the task is successfully executed
  76730. * @param onError is a callback called if an error occurs
  76731. */
  76732. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76733. }
  76734. /**
  76735. * Defines the interface used by texture loading tasks
  76736. */
  76737. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76738. /**
  76739. * Gets the loaded texture
  76740. */
  76741. texture: TEX;
  76742. }
  76743. /**
  76744. * Define a task used by AssetsManager to load 2D textures
  76745. */
  76746. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76747. /**
  76748. * Defines the name of the task
  76749. */
  76750. name: string;
  76751. /**
  76752. * Defines the location of the file to load
  76753. */
  76754. url: string;
  76755. /**
  76756. * Defines if mipmap should not be generated (default is false)
  76757. */
  76758. noMipmap?: boolean | undefined;
  76759. /**
  76760. * Defines if texture must be inverted on Y axis (default is true)
  76761. */
  76762. invertY: boolean;
  76763. /**
  76764. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76765. */
  76766. samplingMode: number;
  76767. /**
  76768. * Gets the loaded texture
  76769. */
  76770. texture: Texture;
  76771. /**
  76772. * Callback called when the task is successful
  76773. */
  76774. onSuccess: (task: TextureAssetTask) => void;
  76775. /**
  76776. * Callback called when the task is successful
  76777. */
  76778. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76779. /**
  76780. * Creates a new TextureAssetTask object
  76781. * @param name defines the name of the task
  76782. * @param url defines the location of the file to load
  76783. * @param noMipmap defines if mipmap should not be generated (default is false)
  76784. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76785. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76786. */
  76787. constructor(
  76788. /**
  76789. * Defines the name of the task
  76790. */
  76791. name: string,
  76792. /**
  76793. * Defines the location of the file to load
  76794. */
  76795. url: string,
  76796. /**
  76797. * Defines if mipmap should not be generated (default is false)
  76798. */
  76799. noMipmap?: boolean | undefined,
  76800. /**
  76801. * Defines if texture must be inverted on Y axis (default is true)
  76802. */
  76803. invertY?: boolean,
  76804. /**
  76805. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76806. */
  76807. samplingMode?: number);
  76808. /**
  76809. * Execute the current task
  76810. * @param scene defines the scene where you want your assets to be loaded
  76811. * @param onSuccess is a callback called when the task is successfully executed
  76812. * @param onError is a callback called if an error occurs
  76813. */
  76814. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76815. }
  76816. /**
  76817. * Define a task used by AssetsManager to load cube textures
  76818. */
  76819. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76820. /**
  76821. * Defines the name of the task
  76822. */
  76823. name: string;
  76824. /**
  76825. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76826. */
  76827. url: string;
  76828. /**
  76829. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76830. */
  76831. extensions?: string[] | undefined;
  76832. /**
  76833. * Defines if mipmaps should not be generated (default is false)
  76834. */
  76835. noMipmap?: boolean | undefined;
  76836. /**
  76837. * Defines the explicit list of files (undefined by default)
  76838. */
  76839. files?: string[] | undefined;
  76840. /**
  76841. * Gets the loaded texture
  76842. */
  76843. texture: CubeTexture;
  76844. /**
  76845. * Callback called when the task is successful
  76846. */
  76847. onSuccess: (task: CubeTextureAssetTask) => void;
  76848. /**
  76849. * Callback called when the task is successful
  76850. */
  76851. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76852. /**
  76853. * Creates a new CubeTextureAssetTask
  76854. * @param name defines the name of the task
  76855. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76856. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76857. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76858. * @param files defines the explicit list of files (undefined by default)
  76859. */
  76860. constructor(
  76861. /**
  76862. * Defines the name of the task
  76863. */
  76864. name: string,
  76865. /**
  76866. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76867. */
  76868. url: string,
  76869. /**
  76870. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76871. */
  76872. extensions?: string[] | undefined,
  76873. /**
  76874. * Defines if mipmaps should not be generated (default is false)
  76875. */
  76876. noMipmap?: boolean | undefined,
  76877. /**
  76878. * Defines the explicit list of files (undefined by default)
  76879. */
  76880. files?: string[] | undefined);
  76881. /**
  76882. * Execute the current task
  76883. * @param scene defines the scene where you want your assets to be loaded
  76884. * @param onSuccess is a callback called when the task is successfully executed
  76885. * @param onError is a callback called if an error occurs
  76886. */
  76887. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76888. }
  76889. /**
  76890. * Define a task used by AssetsManager to load HDR cube textures
  76891. */
  76892. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76893. /**
  76894. * Defines the name of the task
  76895. */
  76896. name: string;
  76897. /**
  76898. * Defines the location of the file to load
  76899. */
  76900. url: string;
  76901. /**
  76902. * Defines the desired size (the more it increases the longer the generation will be)
  76903. */
  76904. size: number;
  76905. /**
  76906. * Defines if mipmaps should not be generated (default is false)
  76907. */
  76908. noMipmap: boolean;
  76909. /**
  76910. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76911. */
  76912. generateHarmonics: boolean;
  76913. /**
  76914. * 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)
  76915. */
  76916. gammaSpace: boolean;
  76917. /**
  76918. * Internal Use Only
  76919. */
  76920. reserved: boolean;
  76921. /**
  76922. * Gets the loaded texture
  76923. */
  76924. texture: HDRCubeTexture;
  76925. /**
  76926. * Callback called when the task is successful
  76927. */
  76928. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76929. /**
  76930. * Callback called when the task is successful
  76931. */
  76932. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  76933. /**
  76934. * Creates a new HDRCubeTextureAssetTask object
  76935. * @param name defines the name of the task
  76936. * @param url defines the location of the file to load
  76937. * @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.
  76938. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76939. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76940. * @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)
  76941. * @param reserved Internal use only
  76942. */
  76943. constructor(
  76944. /**
  76945. * Defines the name of the task
  76946. */
  76947. name: string,
  76948. /**
  76949. * Defines the location of the file to load
  76950. */
  76951. url: string,
  76952. /**
  76953. * Defines the desired size (the more it increases the longer the generation will be)
  76954. */
  76955. size: number,
  76956. /**
  76957. * Defines if mipmaps should not be generated (default is false)
  76958. */
  76959. noMipmap?: boolean,
  76960. /**
  76961. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76962. */
  76963. generateHarmonics?: boolean,
  76964. /**
  76965. * 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)
  76966. */
  76967. gammaSpace?: boolean,
  76968. /**
  76969. * Internal Use Only
  76970. */
  76971. reserved?: boolean);
  76972. /**
  76973. * Execute the current task
  76974. * @param scene defines the scene where you want your assets to be loaded
  76975. * @param onSuccess is a callback called when the task is successfully executed
  76976. * @param onError is a callback called if an error occurs
  76977. */
  76978. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76979. }
  76980. /**
  76981. * Define a task used by AssetsManager to load Equirectangular cube textures
  76982. */
  76983. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  76984. /**
  76985. * Defines the name of the task
  76986. */
  76987. name: string;
  76988. /**
  76989. * Defines the location of the file to load
  76990. */
  76991. url: string;
  76992. /**
  76993. * Defines the desired size (the more it increases the longer the generation will be)
  76994. */
  76995. size: number;
  76996. /**
  76997. * Defines if mipmaps should not be generated (default is false)
  76998. */
  76999. noMipmap: boolean;
  77000. /**
  77001. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77002. * but the standard material would require them in Gamma space) (default is true)
  77003. */
  77004. gammaSpace: boolean;
  77005. /**
  77006. * Gets the loaded texture
  77007. */
  77008. texture: EquiRectangularCubeTexture;
  77009. /**
  77010. * Callback called when the task is successful
  77011. */
  77012. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77013. /**
  77014. * Callback called when the task is successful
  77015. */
  77016. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77017. /**
  77018. * Creates a new EquiRectangularCubeTextureAssetTask object
  77019. * @param name defines the name of the task
  77020. * @param url defines the location of the file to load
  77021. * @param size defines the desired size (the more it increases the longer the generation will be)
  77022. * If the size is omitted this implies you are using a preprocessed cubemap.
  77023. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77024. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77025. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77026. * (default is true)
  77027. */
  77028. constructor(
  77029. /**
  77030. * Defines the name of the task
  77031. */
  77032. name: string,
  77033. /**
  77034. * Defines the location of the file to load
  77035. */
  77036. url: string,
  77037. /**
  77038. * Defines the desired size (the more it increases the longer the generation will be)
  77039. */
  77040. size: number,
  77041. /**
  77042. * Defines if mipmaps should not be generated (default is false)
  77043. */
  77044. noMipmap?: boolean,
  77045. /**
  77046. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77047. * but the standard material would require them in Gamma space) (default is true)
  77048. */
  77049. gammaSpace?: boolean);
  77050. /**
  77051. * Execute the current task
  77052. * @param scene defines the scene where you want your assets to be loaded
  77053. * @param onSuccess is a callback called when the task is successfully executed
  77054. * @param onError is a callback called if an error occurs
  77055. */
  77056. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77057. }
  77058. /**
  77059. * This class can be used to easily import assets into a scene
  77060. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77061. */
  77062. export class AssetsManager {
  77063. private _scene;
  77064. private _isLoading;
  77065. protected _tasks: AbstractAssetTask[];
  77066. protected _waitingTasksCount: number;
  77067. protected _totalTasksCount: number;
  77068. /**
  77069. * Callback called when all tasks are processed
  77070. */
  77071. onFinish: (tasks: AbstractAssetTask[]) => void;
  77072. /**
  77073. * Callback called when a task is successful
  77074. */
  77075. onTaskSuccess: (task: AbstractAssetTask) => void;
  77076. /**
  77077. * Callback called when a task had an error
  77078. */
  77079. onTaskError: (task: AbstractAssetTask) => void;
  77080. /**
  77081. * Callback called when a task is done (whatever the result is)
  77082. */
  77083. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77084. /**
  77085. * Observable called when all tasks are processed
  77086. */
  77087. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77088. /**
  77089. * Observable called when a task had an error
  77090. */
  77091. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77092. /**
  77093. * Observable called when all tasks were executed
  77094. */
  77095. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77096. /**
  77097. * Observable called when a task is done (whatever the result is)
  77098. */
  77099. onProgressObservable: Observable<IAssetsProgressEvent>;
  77100. /**
  77101. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77102. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77103. */
  77104. useDefaultLoadingScreen: boolean;
  77105. /**
  77106. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77107. * when all assets have been downloaded.
  77108. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77109. */
  77110. autoHideLoadingUI: boolean;
  77111. /**
  77112. * Creates a new AssetsManager
  77113. * @param scene defines the scene to work on
  77114. */
  77115. constructor(scene: Scene);
  77116. /**
  77117. * Add a ContainerAssetTask to the list of active tasks
  77118. * @param taskName defines the name of the new task
  77119. * @param meshesNames defines the name of meshes to load
  77120. * @param rootUrl defines the root url to use to locate files
  77121. * @param sceneFilename defines the filename of the scene file
  77122. * @returns a new ContainerAssetTask object
  77123. */
  77124. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77125. /**
  77126. * Add a MeshAssetTask to the list of active tasks
  77127. * @param taskName defines the name of the new task
  77128. * @param meshesNames defines the name of meshes to load
  77129. * @param rootUrl defines the root url to use to locate files
  77130. * @param sceneFilename defines the filename of the scene file
  77131. * @returns a new MeshAssetTask object
  77132. */
  77133. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77134. /**
  77135. * Add a TextFileAssetTask to the list of active tasks
  77136. * @param taskName defines the name of the new task
  77137. * @param url defines the url of the file to load
  77138. * @returns a new TextFileAssetTask object
  77139. */
  77140. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77141. /**
  77142. * Add a BinaryFileAssetTask to the list of active tasks
  77143. * @param taskName defines the name of the new task
  77144. * @param url defines the url of the file to load
  77145. * @returns a new BinaryFileAssetTask object
  77146. */
  77147. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77148. /**
  77149. * Add a ImageAssetTask to the list of active tasks
  77150. * @param taskName defines the name of the new task
  77151. * @param url defines the url of the file to load
  77152. * @returns a new ImageAssetTask object
  77153. */
  77154. addImageTask(taskName: string, url: string): ImageAssetTask;
  77155. /**
  77156. * Add a TextureAssetTask to the list of active tasks
  77157. * @param taskName defines the name of the new task
  77158. * @param url defines the url of the file to load
  77159. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77160. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77161. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77162. * @returns a new TextureAssetTask object
  77163. */
  77164. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77165. /**
  77166. * Add a CubeTextureAssetTask to the list of active tasks
  77167. * @param taskName defines the name of the new task
  77168. * @param url defines the url of the file to load
  77169. * @param extensions defines the extension to use to load the cube map (can be null)
  77170. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77171. * @param files defines the list of files to load (can be null)
  77172. * @returns a new CubeTextureAssetTask object
  77173. */
  77174. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77175. /**
  77176. *
  77177. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77178. * @param taskName defines the name of the new task
  77179. * @param url defines the url of the file to load
  77180. * @param size defines the size you want for the cubemap (can be null)
  77181. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77182. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77183. * @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)
  77184. * @param reserved Internal use only
  77185. * @returns a new HDRCubeTextureAssetTask object
  77186. */
  77187. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77188. /**
  77189. *
  77190. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77191. * @param taskName defines the name of the new task
  77192. * @param url defines the url of the file to load
  77193. * @param size defines the size you want for the cubemap (can be null)
  77194. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77195. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77196. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77197. * @returns a new EquiRectangularCubeTextureAssetTask object
  77198. */
  77199. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77200. /**
  77201. * Remove a task from the assets manager.
  77202. * @param task the task to remove
  77203. */
  77204. removeTask(task: AbstractAssetTask): void;
  77205. private _decreaseWaitingTasksCount;
  77206. private _runTask;
  77207. /**
  77208. * Reset the AssetsManager and remove all tasks
  77209. * @return the current instance of the AssetsManager
  77210. */
  77211. reset(): AssetsManager;
  77212. /**
  77213. * Start the loading process
  77214. * @return the current instance of the AssetsManager
  77215. */
  77216. load(): AssetsManager;
  77217. /**
  77218. * Start the loading process as an async operation
  77219. * @return a promise returning the list of failed tasks
  77220. */
  77221. loadAsync(): Promise<void>;
  77222. }
  77223. }
  77224. declare module "babylonjs/Misc/deferred" {
  77225. /**
  77226. * Wrapper class for promise with external resolve and reject.
  77227. */
  77228. export class Deferred<T> {
  77229. /**
  77230. * The promise associated with this deferred object.
  77231. */
  77232. readonly promise: Promise<T>;
  77233. private _resolve;
  77234. private _reject;
  77235. /**
  77236. * The resolve method of the promise associated with this deferred object.
  77237. */
  77238. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77239. /**
  77240. * The reject method of the promise associated with this deferred object.
  77241. */
  77242. get reject(): (reason?: any) => void;
  77243. /**
  77244. * Constructor for this deferred object.
  77245. */
  77246. constructor();
  77247. }
  77248. }
  77249. declare module "babylonjs/Misc/meshExploder" {
  77250. import { Mesh } from "babylonjs/Meshes/mesh";
  77251. /**
  77252. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77253. */
  77254. export class MeshExploder {
  77255. private _centerMesh;
  77256. private _meshes;
  77257. private _meshesOrigins;
  77258. private _toCenterVectors;
  77259. private _scaledDirection;
  77260. private _newPosition;
  77261. private _centerPosition;
  77262. /**
  77263. * Explodes meshes from a center mesh.
  77264. * @param meshes The meshes to explode.
  77265. * @param centerMesh The mesh to be center of explosion.
  77266. */
  77267. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77268. private _setCenterMesh;
  77269. /**
  77270. * Get class name
  77271. * @returns "MeshExploder"
  77272. */
  77273. getClassName(): string;
  77274. /**
  77275. * "Exploded meshes"
  77276. * @returns Array of meshes with the centerMesh at index 0.
  77277. */
  77278. getMeshes(): Array<Mesh>;
  77279. /**
  77280. * Explodes meshes giving a specific direction
  77281. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77282. */
  77283. explode(direction?: number): void;
  77284. }
  77285. }
  77286. declare module "babylonjs/Misc/filesInput" {
  77287. import { Engine } from "babylonjs/Engines/engine";
  77288. import { Scene } from "babylonjs/scene";
  77289. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77290. import { Nullable } from "babylonjs/types";
  77291. /**
  77292. * Class used to help managing file picking and drag'n'drop
  77293. */
  77294. export class FilesInput {
  77295. /**
  77296. * List of files ready to be loaded
  77297. */
  77298. static get FilesToLoad(): {
  77299. [key: string]: File;
  77300. };
  77301. /**
  77302. * Callback called when a file is processed
  77303. */
  77304. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77305. private _engine;
  77306. private _currentScene;
  77307. private _sceneLoadedCallback;
  77308. private _progressCallback;
  77309. private _additionalRenderLoopLogicCallback;
  77310. private _textureLoadingCallback;
  77311. private _startingProcessingFilesCallback;
  77312. private _onReloadCallback;
  77313. private _errorCallback;
  77314. private _elementToMonitor;
  77315. private _sceneFileToLoad;
  77316. private _filesToLoad;
  77317. /**
  77318. * Creates a new FilesInput
  77319. * @param engine defines the rendering engine
  77320. * @param scene defines the hosting scene
  77321. * @param sceneLoadedCallback callback called when scene is loaded
  77322. * @param progressCallback callback called to track progress
  77323. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77324. * @param textureLoadingCallback callback called when a texture is loading
  77325. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77326. * @param onReloadCallback callback called when a reload is requested
  77327. * @param errorCallback callback call if an error occurs
  77328. */
  77329. 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>);
  77330. private _dragEnterHandler;
  77331. private _dragOverHandler;
  77332. private _dropHandler;
  77333. /**
  77334. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77335. * @param elementToMonitor defines the DOM element to track
  77336. */
  77337. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77338. /** Gets the current list of files to load */
  77339. get filesToLoad(): File[];
  77340. /**
  77341. * Release all associated resources
  77342. */
  77343. dispose(): void;
  77344. private renderFunction;
  77345. private drag;
  77346. private drop;
  77347. private _traverseFolder;
  77348. private _processFiles;
  77349. /**
  77350. * Load files from a drop event
  77351. * @param event defines the drop event to use as source
  77352. */
  77353. loadFiles(event: any): void;
  77354. private _processReload;
  77355. /**
  77356. * Reload the current scene from the loaded files
  77357. */
  77358. reload(): void;
  77359. }
  77360. }
  77361. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77362. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77363. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77364. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77365. }
  77366. declare module "babylonjs/Misc/sceneOptimizer" {
  77367. import { Scene, IDisposable } from "babylonjs/scene";
  77368. import { Observable } from "babylonjs/Misc/observable";
  77369. /**
  77370. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77371. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77372. */
  77373. export class SceneOptimization {
  77374. /**
  77375. * Defines the priority of this optimization (0 by default which means first in the list)
  77376. */
  77377. priority: number;
  77378. /**
  77379. * Gets a string describing the action executed by the current optimization
  77380. * @returns description string
  77381. */
  77382. getDescription(): string;
  77383. /**
  77384. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77385. * @param scene defines the current scene where to apply this optimization
  77386. * @param optimizer defines the current optimizer
  77387. * @returns true if everything that can be done was applied
  77388. */
  77389. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77390. /**
  77391. * Creates the SceneOptimization object
  77392. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77393. * @param desc defines the description associated with the optimization
  77394. */
  77395. constructor(
  77396. /**
  77397. * Defines the priority of this optimization (0 by default which means first in the list)
  77398. */
  77399. priority?: number);
  77400. }
  77401. /**
  77402. * Defines an optimization used to reduce the size of render target textures
  77403. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77404. */
  77405. export class TextureOptimization extends SceneOptimization {
  77406. /**
  77407. * Defines the priority of this optimization (0 by default which means first in the list)
  77408. */
  77409. priority: number;
  77410. /**
  77411. * 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
  77412. */
  77413. maximumSize: number;
  77414. /**
  77415. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77416. */
  77417. step: number;
  77418. /**
  77419. * Gets a string describing the action executed by the current optimization
  77420. * @returns description string
  77421. */
  77422. getDescription(): string;
  77423. /**
  77424. * Creates the TextureOptimization object
  77425. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77426. * @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
  77427. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77428. */
  77429. constructor(
  77430. /**
  77431. * Defines the priority of this optimization (0 by default which means first in the list)
  77432. */
  77433. priority?: number,
  77434. /**
  77435. * 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
  77436. */
  77437. maximumSize?: number,
  77438. /**
  77439. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77440. */
  77441. step?: number);
  77442. /**
  77443. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77444. * @param scene defines the current scene where to apply this optimization
  77445. * @param optimizer defines the current optimizer
  77446. * @returns true if everything that can be done was applied
  77447. */
  77448. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77449. }
  77450. /**
  77451. * Defines an optimization used to increase or decrease the rendering resolution
  77452. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77453. */
  77454. export class HardwareScalingOptimization extends SceneOptimization {
  77455. /**
  77456. * Defines the priority of this optimization (0 by default which means first in the list)
  77457. */
  77458. priority: number;
  77459. /**
  77460. * Defines the maximum scale to use (2 by default)
  77461. */
  77462. maximumScale: number;
  77463. /**
  77464. * Defines the step to use between two passes (0.5 by default)
  77465. */
  77466. step: number;
  77467. private _currentScale;
  77468. private _directionOffset;
  77469. /**
  77470. * Gets a string describing the action executed by the current optimization
  77471. * @return description string
  77472. */
  77473. getDescription(): string;
  77474. /**
  77475. * Creates the HardwareScalingOptimization object
  77476. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77477. * @param maximumScale defines the maximum scale to use (2 by default)
  77478. * @param step defines the step to use between two passes (0.5 by default)
  77479. */
  77480. constructor(
  77481. /**
  77482. * Defines the priority of this optimization (0 by default which means first in the list)
  77483. */
  77484. priority?: number,
  77485. /**
  77486. * Defines the maximum scale to use (2 by default)
  77487. */
  77488. maximumScale?: number,
  77489. /**
  77490. * Defines the step to use between two passes (0.5 by default)
  77491. */
  77492. step?: number);
  77493. /**
  77494. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77495. * @param scene defines the current scene where to apply this optimization
  77496. * @param optimizer defines the current optimizer
  77497. * @returns true if everything that can be done was applied
  77498. */
  77499. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77500. }
  77501. /**
  77502. * Defines an optimization used to remove shadows
  77503. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77504. */
  77505. export class ShadowsOptimization extends SceneOptimization {
  77506. /**
  77507. * Gets a string describing the action executed by the current optimization
  77508. * @return description string
  77509. */
  77510. getDescription(): string;
  77511. /**
  77512. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77513. * @param scene defines the current scene where to apply this optimization
  77514. * @param optimizer defines the current optimizer
  77515. * @returns true if everything that can be done was applied
  77516. */
  77517. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77518. }
  77519. /**
  77520. * Defines an optimization used to turn post-processes off
  77521. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77522. */
  77523. export class PostProcessesOptimization extends SceneOptimization {
  77524. /**
  77525. * Gets a string describing the action executed by the current optimization
  77526. * @return description string
  77527. */
  77528. getDescription(): string;
  77529. /**
  77530. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77531. * @param scene defines the current scene where to apply this optimization
  77532. * @param optimizer defines the current optimizer
  77533. * @returns true if everything that can be done was applied
  77534. */
  77535. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77536. }
  77537. /**
  77538. * Defines an optimization used to turn lens flares off
  77539. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77540. */
  77541. export class LensFlaresOptimization extends SceneOptimization {
  77542. /**
  77543. * Gets a string describing the action executed by the current optimization
  77544. * @return description string
  77545. */
  77546. getDescription(): string;
  77547. /**
  77548. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77549. * @param scene defines the current scene where to apply this optimization
  77550. * @param optimizer defines the current optimizer
  77551. * @returns true if everything that can be done was applied
  77552. */
  77553. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77554. }
  77555. /**
  77556. * Defines an optimization based on user defined callback.
  77557. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77558. */
  77559. export class CustomOptimization extends SceneOptimization {
  77560. /**
  77561. * Callback called to apply the custom optimization.
  77562. */
  77563. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77564. /**
  77565. * Callback called to get custom description
  77566. */
  77567. onGetDescription: () => string;
  77568. /**
  77569. * Gets a string describing the action executed by the current optimization
  77570. * @returns description string
  77571. */
  77572. getDescription(): string;
  77573. /**
  77574. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77575. * @param scene defines the current scene where to apply this optimization
  77576. * @param optimizer defines the current optimizer
  77577. * @returns true if everything that can be done was applied
  77578. */
  77579. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77580. }
  77581. /**
  77582. * Defines an optimization used to turn particles off
  77583. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77584. */
  77585. export class ParticlesOptimization extends SceneOptimization {
  77586. /**
  77587. * Gets a string describing the action executed by the current optimization
  77588. * @return description string
  77589. */
  77590. getDescription(): string;
  77591. /**
  77592. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77593. * @param scene defines the current scene where to apply this optimization
  77594. * @param optimizer defines the current optimizer
  77595. * @returns true if everything that can be done was applied
  77596. */
  77597. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77598. }
  77599. /**
  77600. * Defines an optimization used to turn render targets off
  77601. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77602. */
  77603. export class RenderTargetsOptimization extends SceneOptimization {
  77604. /**
  77605. * Gets a string describing the action executed by the current optimization
  77606. * @return description string
  77607. */
  77608. getDescription(): string;
  77609. /**
  77610. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77611. * @param scene defines the current scene where to apply this optimization
  77612. * @param optimizer defines the current optimizer
  77613. * @returns true if everything that can be done was applied
  77614. */
  77615. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77616. }
  77617. /**
  77618. * Defines an optimization used to merge meshes with compatible materials
  77619. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77620. */
  77621. export class MergeMeshesOptimization extends SceneOptimization {
  77622. private static _UpdateSelectionTree;
  77623. /**
  77624. * Gets or sets a boolean which defines if optimization octree has to be updated
  77625. */
  77626. static get UpdateSelectionTree(): boolean;
  77627. /**
  77628. * Gets or sets a boolean which defines if optimization octree has to be updated
  77629. */
  77630. static set UpdateSelectionTree(value: boolean);
  77631. /**
  77632. * Gets a string describing the action executed by the current optimization
  77633. * @return description string
  77634. */
  77635. getDescription(): string;
  77636. private _canBeMerged;
  77637. /**
  77638. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77639. * @param scene defines the current scene where to apply this optimization
  77640. * @param optimizer defines the current optimizer
  77641. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77642. * @returns true if everything that can be done was applied
  77643. */
  77644. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77645. }
  77646. /**
  77647. * Defines a list of options used by SceneOptimizer
  77648. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77649. */
  77650. export class SceneOptimizerOptions {
  77651. /**
  77652. * Defines the target frame rate to reach (60 by default)
  77653. */
  77654. targetFrameRate: number;
  77655. /**
  77656. * Defines the interval between two checkes (2000ms by default)
  77657. */
  77658. trackerDuration: number;
  77659. /**
  77660. * Gets the list of optimizations to apply
  77661. */
  77662. optimizations: SceneOptimization[];
  77663. /**
  77664. * Creates a new list of options used by SceneOptimizer
  77665. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77666. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77667. */
  77668. constructor(
  77669. /**
  77670. * Defines the target frame rate to reach (60 by default)
  77671. */
  77672. targetFrameRate?: number,
  77673. /**
  77674. * Defines the interval between two checkes (2000ms by default)
  77675. */
  77676. trackerDuration?: number);
  77677. /**
  77678. * Add a new optimization
  77679. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77680. * @returns the current SceneOptimizerOptions
  77681. */
  77682. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77683. /**
  77684. * Add a new custom optimization
  77685. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77686. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77687. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77688. * @returns the current SceneOptimizerOptions
  77689. */
  77690. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77691. /**
  77692. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77693. * @param targetFrameRate defines the target frame rate (60 by default)
  77694. * @returns a SceneOptimizerOptions object
  77695. */
  77696. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77697. /**
  77698. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77699. * @param targetFrameRate defines the target frame rate (60 by default)
  77700. * @returns a SceneOptimizerOptions object
  77701. */
  77702. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77703. /**
  77704. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77705. * @param targetFrameRate defines the target frame rate (60 by default)
  77706. * @returns a SceneOptimizerOptions object
  77707. */
  77708. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77709. }
  77710. /**
  77711. * Class used to run optimizations in order to reach a target frame rate
  77712. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77713. */
  77714. export class SceneOptimizer implements IDisposable {
  77715. private _isRunning;
  77716. private _options;
  77717. private _scene;
  77718. private _currentPriorityLevel;
  77719. private _targetFrameRate;
  77720. private _trackerDuration;
  77721. private _currentFrameRate;
  77722. private _sceneDisposeObserver;
  77723. private _improvementMode;
  77724. /**
  77725. * Defines an observable called when the optimizer reaches the target frame rate
  77726. */
  77727. onSuccessObservable: Observable<SceneOptimizer>;
  77728. /**
  77729. * Defines an observable called when the optimizer enables an optimization
  77730. */
  77731. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77732. /**
  77733. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77734. */
  77735. onFailureObservable: Observable<SceneOptimizer>;
  77736. /**
  77737. * Gets a boolean indicating if the optimizer is in improvement mode
  77738. */
  77739. get isInImprovementMode(): boolean;
  77740. /**
  77741. * Gets the current priority level (0 at start)
  77742. */
  77743. get currentPriorityLevel(): number;
  77744. /**
  77745. * Gets the current frame rate checked by the SceneOptimizer
  77746. */
  77747. get currentFrameRate(): number;
  77748. /**
  77749. * Gets or sets the current target frame rate (60 by default)
  77750. */
  77751. get targetFrameRate(): number;
  77752. /**
  77753. * Gets or sets the current target frame rate (60 by default)
  77754. */
  77755. set targetFrameRate(value: number);
  77756. /**
  77757. * Gets or sets the current interval between two checks (every 2000ms by default)
  77758. */
  77759. get trackerDuration(): number;
  77760. /**
  77761. * Gets or sets the current interval between two checks (every 2000ms by default)
  77762. */
  77763. set trackerDuration(value: number);
  77764. /**
  77765. * Gets the list of active optimizations
  77766. */
  77767. get optimizations(): SceneOptimization[];
  77768. /**
  77769. * Creates a new SceneOptimizer
  77770. * @param scene defines the scene to work on
  77771. * @param options defines the options to use with the SceneOptimizer
  77772. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77773. * @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)
  77774. */
  77775. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77776. /**
  77777. * Stops the current optimizer
  77778. */
  77779. stop(): void;
  77780. /**
  77781. * Reset the optimizer to initial step (current priority level = 0)
  77782. */
  77783. reset(): void;
  77784. /**
  77785. * Start the optimizer. By default it will try to reach a specific framerate
  77786. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77787. */
  77788. start(): void;
  77789. private _checkCurrentState;
  77790. /**
  77791. * Release all resources
  77792. */
  77793. dispose(): void;
  77794. /**
  77795. * Helper function to create a SceneOptimizer with one single line of code
  77796. * @param scene defines the scene to work on
  77797. * @param options defines the options to use with the SceneOptimizer
  77798. * @param onSuccess defines a callback to call on success
  77799. * @param onFailure defines a callback to call on failure
  77800. * @returns the new SceneOptimizer object
  77801. */
  77802. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77803. }
  77804. }
  77805. declare module "babylonjs/Misc/sceneSerializer" {
  77806. import { Scene } from "babylonjs/scene";
  77807. /**
  77808. * Class used to serialize a scene into a string
  77809. */
  77810. export class SceneSerializer {
  77811. /**
  77812. * Clear cache used by a previous serialization
  77813. */
  77814. static ClearCache(): void;
  77815. /**
  77816. * Serialize a scene into a JSON compatible object
  77817. * @param scene defines the scene to serialize
  77818. * @returns a JSON compatible object
  77819. */
  77820. static Serialize(scene: Scene): any;
  77821. /**
  77822. * Serialize a mesh into a JSON compatible object
  77823. * @param toSerialize defines the mesh to serialize
  77824. * @param withParents defines if parents must be serialized as well
  77825. * @param withChildren defines if children must be serialized as well
  77826. * @returns a JSON compatible object
  77827. */
  77828. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77829. }
  77830. }
  77831. declare module "babylonjs/Misc/textureTools" {
  77832. import { Texture } from "babylonjs/Materials/Textures/texture";
  77833. /**
  77834. * Class used to host texture specific utilities
  77835. */
  77836. export class TextureTools {
  77837. /**
  77838. * Uses the GPU to create a copy texture rescaled at a given size
  77839. * @param texture Texture to copy from
  77840. * @param width defines the desired width
  77841. * @param height defines the desired height
  77842. * @param useBilinearMode defines if bilinear mode has to be used
  77843. * @return the generated texture
  77844. */
  77845. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77846. }
  77847. }
  77848. declare module "babylonjs/Misc/videoRecorder" {
  77849. import { Nullable } from "babylonjs/types";
  77850. import { Engine } from "babylonjs/Engines/engine";
  77851. /**
  77852. * This represents the different options available for the video capture.
  77853. */
  77854. export interface VideoRecorderOptions {
  77855. /** Defines the mime type of the video. */
  77856. mimeType: string;
  77857. /** Defines the FPS the video should be recorded at. */
  77858. fps: number;
  77859. /** Defines the chunk size for the recording data. */
  77860. recordChunckSize: number;
  77861. /** The audio tracks to attach to the recording. */
  77862. audioTracks?: MediaStreamTrack[];
  77863. }
  77864. /**
  77865. * This can help with recording videos from BabylonJS.
  77866. * This is based on the available WebRTC functionalities of the browser.
  77867. *
  77868. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77869. */
  77870. export class VideoRecorder {
  77871. private static readonly _defaultOptions;
  77872. /**
  77873. * Returns whether or not the VideoRecorder is available in your browser.
  77874. * @param engine Defines the Babylon Engine.
  77875. * @returns true if supported otherwise false.
  77876. */
  77877. static IsSupported(engine: Engine): boolean;
  77878. private readonly _options;
  77879. private _canvas;
  77880. private _mediaRecorder;
  77881. private _recordedChunks;
  77882. private _fileName;
  77883. private _resolve;
  77884. private _reject;
  77885. /**
  77886. * True when a recording is already in progress.
  77887. */
  77888. get isRecording(): boolean;
  77889. /**
  77890. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77891. * @param engine Defines the BabylonJS Engine you wish to record.
  77892. * @param options Defines options that can be used to customize the capture.
  77893. */
  77894. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77895. /**
  77896. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77897. */
  77898. stopRecording(): void;
  77899. /**
  77900. * Starts recording the canvas for a max duration specified in parameters.
  77901. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77902. * If null no automatic download will start and you can rely on the promise to get the data back.
  77903. * @param maxDuration Defines the maximum recording time in seconds.
  77904. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77905. * @return A promise callback at the end of the recording with the video data in Blob.
  77906. */
  77907. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77908. /**
  77909. * Releases internal resources used during the recording.
  77910. */
  77911. dispose(): void;
  77912. private _handleDataAvailable;
  77913. private _handleError;
  77914. private _handleStop;
  77915. }
  77916. }
  77917. declare module "babylonjs/Misc/screenshotTools" {
  77918. import { Camera } from "babylonjs/Cameras/camera";
  77919. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77920. import { Engine } from "babylonjs/Engines/engine";
  77921. /**
  77922. * Class containing a set of static utilities functions for screenshots
  77923. */
  77924. export class ScreenshotTools {
  77925. /**
  77926. * Captures a screenshot of the current rendering
  77927. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77928. * @param engine defines the rendering engine
  77929. * @param camera defines the source camera
  77930. * @param size This parameter can be set to a single number or to an object with the
  77931. * following (optional) properties: precision, width, height. If a single number is passed,
  77932. * it will be used for both width and height. If an object is passed, the screenshot size
  77933. * will be derived from the parameters. The precision property is a multiplier allowing
  77934. * rendering at a higher or lower resolution
  77935. * @param successCallback defines the callback receives a single parameter which contains the
  77936. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77937. * src parameter of an <img> to display it
  77938. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77939. * Check your browser for supported MIME types
  77940. */
  77941. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  77942. /**
  77943. * Captures a screenshot of the current rendering
  77944. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77945. * @param engine defines the rendering engine
  77946. * @param camera defines the source camera
  77947. * @param size This parameter can be set to a single number or to an object with the
  77948. * following (optional) properties: precision, width, height. If a single number is passed,
  77949. * it will be used for both width and height. If an object is passed, the screenshot size
  77950. * will be derived from the parameters. The precision property is a multiplier allowing
  77951. * rendering at a higher or lower resolution
  77952. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77953. * Check your browser for supported MIME types
  77954. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77955. * to the src parameter of an <img> to display it
  77956. */
  77957. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  77958. /**
  77959. * Generates an image screenshot from the specified camera.
  77960. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77961. * @param engine The engine to use for rendering
  77962. * @param camera The camera to use for rendering
  77963. * @param size This parameter can be set to a single number or to an object with the
  77964. * following (optional) properties: precision, width, height. If a single number is passed,
  77965. * it will be used for both width and height. If an object is passed, the screenshot size
  77966. * will be derived from the parameters. The precision property is a multiplier allowing
  77967. * rendering at a higher or lower resolution
  77968. * @param successCallback The callback receives a single parameter which contains the
  77969. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77970. * src parameter of an <img> to display it
  77971. * @param mimeType The MIME type of the screenshot image (default: image/png).
  77972. * Check your browser for supported MIME types
  77973. * @param samples Texture samples (default: 1)
  77974. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  77975. * @param fileName A name for for the downloaded file.
  77976. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  77977. */
  77978. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): void;
  77979. /**
  77980. * Generates an image screenshot from the specified camera.
  77981. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77982. * @param engine The engine to use for rendering
  77983. * @param camera The camera to use for rendering
  77984. * @param size This parameter can be set to a single number or to an object with the
  77985. * following (optional) properties: precision, width, height. If a single number is passed,
  77986. * it will be used for both width and height. If an object is passed, the screenshot size
  77987. * will be derived from the parameters. The precision property is a multiplier allowing
  77988. * rendering at a higher or lower resolution
  77989. * @param mimeType The MIME type of the screenshot image (default: image/png).
  77990. * Check your browser for supported MIME types
  77991. * @param samples Texture samples (default: 1)
  77992. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  77993. * @param fileName A name for for the downloaded file.
  77994. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  77995. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77996. * to the src parameter of an <img> to display it
  77997. */
  77998. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  77999. /**
  78000. * Gets height and width for screenshot size
  78001. * @private
  78002. */
  78003. private static _getScreenshotSize;
  78004. }
  78005. }
  78006. declare module "babylonjs/Misc/dataReader" {
  78007. /**
  78008. * Interface for a data buffer
  78009. */
  78010. export interface IDataBuffer {
  78011. /**
  78012. * Reads bytes from the data buffer.
  78013. * @param byteOffset The byte offset to read
  78014. * @param byteLength The byte length to read
  78015. * @returns A promise that resolves when the bytes are read
  78016. */
  78017. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78018. /**
  78019. * The byte length of the buffer.
  78020. */
  78021. readonly byteLength: number;
  78022. }
  78023. /**
  78024. * Utility class for reading from a data buffer
  78025. */
  78026. export class DataReader {
  78027. /**
  78028. * The data buffer associated with this data reader.
  78029. */
  78030. readonly buffer: IDataBuffer;
  78031. /**
  78032. * The current byte offset from the beginning of the data buffer.
  78033. */
  78034. byteOffset: number;
  78035. private _dataView;
  78036. private _dataByteOffset;
  78037. /**
  78038. * Constructor
  78039. * @param buffer The buffer to read
  78040. */
  78041. constructor(buffer: IDataBuffer);
  78042. /**
  78043. * Loads the given byte length.
  78044. * @param byteLength The byte length to load
  78045. * @returns A promise that resolves when the load is complete
  78046. */
  78047. loadAsync(byteLength: number): Promise<void>;
  78048. /**
  78049. * Read a unsigned 32-bit integer from the currently loaded data range.
  78050. * @returns The 32-bit integer read
  78051. */
  78052. readUint32(): number;
  78053. /**
  78054. * Read a byte array from the currently loaded data range.
  78055. * @param byteLength The byte length to read
  78056. * @returns The byte array read
  78057. */
  78058. readUint8Array(byteLength: number): Uint8Array;
  78059. /**
  78060. * Read a string from the currently loaded data range.
  78061. * @param byteLength The byte length to read
  78062. * @returns The string read
  78063. */
  78064. readString(byteLength: number): string;
  78065. /**
  78066. * Skips the given byte length the currently loaded data range.
  78067. * @param byteLength The byte length to skip
  78068. */
  78069. skipBytes(byteLength: number): void;
  78070. }
  78071. }
  78072. declare module "babylonjs/Misc/dataStorage" {
  78073. /**
  78074. * Class for storing data to local storage if available or in-memory storage otherwise
  78075. */
  78076. export class DataStorage {
  78077. private static _Storage;
  78078. private static _GetStorage;
  78079. /**
  78080. * Reads a string from the data storage
  78081. * @param key The key to read
  78082. * @param defaultValue The value if the key doesn't exist
  78083. * @returns The string value
  78084. */
  78085. static ReadString(key: string, defaultValue: string): string;
  78086. /**
  78087. * Writes a string to the data storage
  78088. * @param key The key to write
  78089. * @param value The value to write
  78090. */
  78091. static WriteString(key: string, value: string): void;
  78092. /**
  78093. * Reads a boolean from the data storage
  78094. * @param key The key to read
  78095. * @param defaultValue The value if the key doesn't exist
  78096. * @returns The boolean value
  78097. */
  78098. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78099. /**
  78100. * Writes a boolean to the data storage
  78101. * @param key The key to write
  78102. * @param value The value to write
  78103. */
  78104. static WriteBoolean(key: string, value: boolean): void;
  78105. /**
  78106. * Reads a number from the data storage
  78107. * @param key The key to read
  78108. * @param defaultValue The value if the key doesn't exist
  78109. * @returns The number value
  78110. */
  78111. static ReadNumber(key: string, defaultValue: number): number;
  78112. /**
  78113. * Writes a number to the data storage
  78114. * @param key The key to write
  78115. * @param value The value to write
  78116. */
  78117. static WriteNumber(key: string, value: number): void;
  78118. }
  78119. }
  78120. declare module "babylonjs/Misc/sceneRecorder" {
  78121. import { Scene } from "babylonjs/scene";
  78122. /**
  78123. * Class used to record delta files between 2 scene states
  78124. */
  78125. export class SceneRecorder {
  78126. private _trackedScene;
  78127. private _savedJSON;
  78128. /**
  78129. * Track a given scene. This means the current scene state will be considered the original state
  78130. * @param scene defines the scene to track
  78131. */
  78132. track(scene: Scene): void;
  78133. /**
  78134. * Get the delta between current state and original state
  78135. * @returns a string containing the delta
  78136. */
  78137. getDelta(): any;
  78138. private _compareArray;
  78139. private _compareObjects;
  78140. private _compareCollections;
  78141. private static GetShadowGeneratorById;
  78142. /**
  78143. * Apply a given delta to a given scene
  78144. * @param deltaJSON defines the JSON containing the delta
  78145. * @param scene defines the scene to apply the delta to
  78146. */
  78147. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78148. private static _ApplyPropertiesToEntity;
  78149. private static _ApplyDeltaForEntity;
  78150. }
  78151. }
  78152. declare module "babylonjs/Misc/index" {
  78153. export * from "babylonjs/Misc/andOrNotEvaluator";
  78154. export * from "babylonjs/Misc/assetsManager";
  78155. export * from "babylonjs/Misc/basis";
  78156. export * from "babylonjs/Misc/dds";
  78157. export * from "babylonjs/Misc/decorators";
  78158. export * from "babylonjs/Misc/deferred";
  78159. export * from "babylonjs/Misc/environmentTextureTools";
  78160. export * from "babylonjs/Misc/meshExploder";
  78161. export * from "babylonjs/Misc/filesInput";
  78162. export * from "babylonjs/Misc/HighDynamicRange/index";
  78163. export * from "babylonjs/Misc/khronosTextureContainer";
  78164. export * from "babylonjs/Misc/observable";
  78165. export * from "babylonjs/Misc/performanceMonitor";
  78166. export * from "babylonjs/Misc/promise";
  78167. export * from "babylonjs/Misc/sceneOptimizer";
  78168. export * from "babylonjs/Misc/sceneSerializer";
  78169. export * from "babylonjs/Misc/smartArray";
  78170. export * from "babylonjs/Misc/stringDictionary";
  78171. export * from "babylonjs/Misc/tags";
  78172. export * from "babylonjs/Misc/textureTools";
  78173. export * from "babylonjs/Misc/tga";
  78174. export * from "babylonjs/Misc/tools";
  78175. export * from "babylonjs/Misc/videoRecorder";
  78176. export * from "babylonjs/Misc/virtualJoystick";
  78177. export * from "babylonjs/Misc/workerPool";
  78178. export * from "babylonjs/Misc/logger";
  78179. export * from "babylonjs/Misc/typeStore";
  78180. export * from "babylonjs/Misc/filesInputStore";
  78181. export * from "babylonjs/Misc/deepCopier";
  78182. export * from "babylonjs/Misc/pivotTools";
  78183. export * from "babylonjs/Misc/precisionDate";
  78184. export * from "babylonjs/Misc/screenshotTools";
  78185. export * from "babylonjs/Misc/typeStore";
  78186. export * from "babylonjs/Misc/webRequest";
  78187. export * from "babylonjs/Misc/iInspectable";
  78188. export * from "babylonjs/Misc/brdfTextureTools";
  78189. export * from "babylonjs/Misc/rgbdTextureTools";
  78190. export * from "babylonjs/Misc/gradients";
  78191. export * from "babylonjs/Misc/perfCounter";
  78192. export * from "babylonjs/Misc/fileRequest";
  78193. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78194. export * from "babylonjs/Misc/retryStrategy";
  78195. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78196. export * from "babylonjs/Misc/canvasGenerator";
  78197. export * from "babylonjs/Misc/fileTools";
  78198. export * from "babylonjs/Misc/stringTools";
  78199. export * from "babylonjs/Misc/dataReader";
  78200. export * from "babylonjs/Misc/minMaxReducer";
  78201. export * from "babylonjs/Misc/depthReducer";
  78202. export * from "babylonjs/Misc/dataStorage";
  78203. export * from "babylonjs/Misc/sceneRecorder";
  78204. }
  78205. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78206. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78207. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78208. import { Observable } from "babylonjs/Misc/observable";
  78209. import { Matrix } from "babylonjs/Maths/math.vector";
  78210. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78211. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78212. /**
  78213. * An interface for all Hit test features
  78214. */
  78215. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78216. /**
  78217. * Triggered when new babylon (transformed) hit test results are available
  78218. */
  78219. onHitTestResultObservable: Observable<T[]>;
  78220. }
  78221. /**
  78222. * Options used for hit testing
  78223. */
  78224. export interface IWebXRLegacyHitTestOptions {
  78225. /**
  78226. * Only test when user interacted with the scene. Default - hit test every frame
  78227. */
  78228. testOnPointerDownOnly?: boolean;
  78229. /**
  78230. * The node to use to transform the local results to world coordinates
  78231. */
  78232. worldParentNode?: TransformNode;
  78233. }
  78234. /**
  78235. * Interface defining the babylon result of raycasting/hit-test
  78236. */
  78237. export interface IWebXRLegacyHitResult {
  78238. /**
  78239. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78240. */
  78241. transformationMatrix: Matrix;
  78242. /**
  78243. * The native hit test result
  78244. */
  78245. xrHitResult: XRHitResult | XRHitTestResult;
  78246. }
  78247. /**
  78248. * The currently-working hit-test module.
  78249. * Hit test (or Ray-casting) is used to interact with the real world.
  78250. * For further information read here - https://github.com/immersive-web/hit-test
  78251. */
  78252. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78253. /**
  78254. * options to use when constructing this feature
  78255. */
  78256. readonly options: IWebXRLegacyHitTestOptions;
  78257. private _direction;
  78258. private _mat;
  78259. private _onSelectEnabled;
  78260. private _origin;
  78261. /**
  78262. * The module's name
  78263. */
  78264. static readonly Name: string;
  78265. /**
  78266. * The (Babylon) version of this module.
  78267. * This is an integer representing the implementation version.
  78268. * This number does not correspond to the WebXR specs version
  78269. */
  78270. static readonly Version: number;
  78271. /**
  78272. * Populated with the last native XR Hit Results
  78273. */
  78274. lastNativeXRHitResults: XRHitResult[];
  78275. /**
  78276. * Triggered when new babylon (transformed) hit test results are available
  78277. */
  78278. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78279. /**
  78280. * Creates a new instance of the (legacy version) hit test feature
  78281. * @param _xrSessionManager an instance of WebXRSessionManager
  78282. * @param options options to use when constructing this feature
  78283. */
  78284. constructor(_xrSessionManager: WebXRSessionManager,
  78285. /**
  78286. * options to use when constructing this feature
  78287. */
  78288. options?: IWebXRLegacyHitTestOptions);
  78289. /**
  78290. * execute a hit test with an XR Ray
  78291. *
  78292. * @param xrSession a native xrSession that will execute this hit test
  78293. * @param xrRay the ray (position and direction) to use for ray-casting
  78294. * @param referenceSpace native XR reference space to use for the hit-test
  78295. * @param filter filter function that will filter the results
  78296. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78297. */
  78298. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78299. /**
  78300. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78301. * @param event the (select) event to use to select with
  78302. * @param referenceSpace the reference space to use for this hit test
  78303. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78304. */
  78305. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78306. /**
  78307. * attach this feature
  78308. * Will usually be called by the features manager
  78309. *
  78310. * @returns true if successful.
  78311. */
  78312. attach(): boolean;
  78313. /**
  78314. * detach this feature.
  78315. * Will usually be called by the features manager
  78316. *
  78317. * @returns true if successful.
  78318. */
  78319. detach(): boolean;
  78320. /**
  78321. * Dispose this feature and all of the resources attached
  78322. */
  78323. dispose(): void;
  78324. protected _onXRFrame(frame: XRFrame): void;
  78325. private _onHitTestResults;
  78326. private _onSelect;
  78327. }
  78328. }
  78329. declare module "babylonjs/XR/features/WebXRHitTest" {
  78330. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78331. import { Observable } from "babylonjs/Misc/observable";
  78332. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78333. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78334. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78335. /**
  78336. * Options used for hit testing (version 2)
  78337. */
  78338. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78339. /**
  78340. * Do not create a permanent hit test. Will usually be used when only
  78341. * transient inputs are needed.
  78342. */
  78343. disablePermanentHitTest?: boolean;
  78344. /**
  78345. * Enable transient (for example touch-based) hit test inspections
  78346. */
  78347. enableTransientHitTest?: boolean;
  78348. /**
  78349. * Offset ray for the permanent hit test
  78350. */
  78351. offsetRay?: Vector3;
  78352. /**
  78353. * Offset ray for the transient hit test
  78354. */
  78355. transientOffsetRay?: Vector3;
  78356. /**
  78357. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78358. */
  78359. useReferenceSpace?: boolean;
  78360. /**
  78361. * Override the default entity type(s) of the hit-test result
  78362. */
  78363. entityTypes?: XRHitTestTrackableType[];
  78364. }
  78365. /**
  78366. * Interface defining the babylon result of hit-test
  78367. */
  78368. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78369. /**
  78370. * The input source that generated this hit test (if transient)
  78371. */
  78372. inputSource?: XRInputSource;
  78373. /**
  78374. * Is this a transient hit test
  78375. */
  78376. isTransient?: boolean;
  78377. /**
  78378. * Position of the hit test result
  78379. */
  78380. position: Vector3;
  78381. /**
  78382. * Rotation of the hit test result
  78383. */
  78384. rotationQuaternion: Quaternion;
  78385. /**
  78386. * The native hit test result
  78387. */
  78388. xrHitResult: XRHitTestResult;
  78389. }
  78390. /**
  78391. * The currently-working hit-test module.
  78392. * Hit test (or Ray-casting) is used to interact with the real world.
  78393. * For further information read here - https://github.com/immersive-web/hit-test
  78394. *
  78395. * Tested on chrome (mobile) 80.
  78396. */
  78397. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78398. /**
  78399. * options to use when constructing this feature
  78400. */
  78401. readonly options: IWebXRHitTestOptions;
  78402. private _tmpMat;
  78403. private _tmpPos;
  78404. private _tmpQuat;
  78405. private _transientXrHitTestSource;
  78406. private _xrHitTestSource;
  78407. private initHitTestSource;
  78408. /**
  78409. * The module's name
  78410. */
  78411. static readonly Name: string;
  78412. /**
  78413. * The (Babylon) version of this module.
  78414. * This is an integer representing the implementation version.
  78415. * This number does not correspond to the WebXR specs version
  78416. */
  78417. static readonly Version: number;
  78418. /**
  78419. * When set to true, each hit test will have its own position/rotation objects
  78420. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78421. * the developers will clone them or copy them as they see fit.
  78422. */
  78423. autoCloneTransformation: boolean;
  78424. /**
  78425. * Triggered when new babylon (transformed) hit test results are available
  78426. */
  78427. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78428. /**
  78429. * Use this to temporarily pause hit test checks.
  78430. */
  78431. paused: boolean;
  78432. /**
  78433. * Creates a new instance of the hit test feature
  78434. * @param _xrSessionManager an instance of WebXRSessionManager
  78435. * @param options options to use when constructing this feature
  78436. */
  78437. constructor(_xrSessionManager: WebXRSessionManager,
  78438. /**
  78439. * options to use when constructing this feature
  78440. */
  78441. options?: IWebXRHitTestOptions);
  78442. /**
  78443. * attach this feature
  78444. * Will usually be called by the features manager
  78445. *
  78446. * @returns true if successful.
  78447. */
  78448. attach(): boolean;
  78449. /**
  78450. * detach this feature.
  78451. * Will usually be called by the features manager
  78452. *
  78453. * @returns true if successful.
  78454. */
  78455. detach(): boolean;
  78456. /**
  78457. * Dispose this feature and all of the resources attached
  78458. */
  78459. dispose(): void;
  78460. protected _onXRFrame(frame: XRFrame): void;
  78461. private _processWebXRHitTestResult;
  78462. }
  78463. }
  78464. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78465. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78466. import { Observable } from "babylonjs/Misc/observable";
  78467. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78468. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78469. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78470. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78471. /**
  78472. * Configuration options of the anchor system
  78473. */
  78474. export interface IWebXRAnchorSystemOptions {
  78475. /**
  78476. * a node that will be used to convert local to world coordinates
  78477. */
  78478. worldParentNode?: TransformNode;
  78479. /**
  78480. * If set to true a reference of the created anchors will be kept until the next session starts
  78481. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78482. */
  78483. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78484. }
  78485. /**
  78486. * A babylon container for an XR Anchor
  78487. */
  78488. export interface IWebXRAnchor {
  78489. /**
  78490. * A babylon-assigned ID for this anchor
  78491. */
  78492. id: number;
  78493. /**
  78494. * Transformation matrix to apply to an object attached to this anchor
  78495. */
  78496. transformationMatrix: Matrix;
  78497. /**
  78498. * The native anchor object
  78499. */
  78500. xrAnchor: XRAnchor;
  78501. /**
  78502. * if defined, this object will be constantly updated by the anchor's position and rotation
  78503. */
  78504. attachedNode?: TransformNode;
  78505. }
  78506. /**
  78507. * An implementation of the anchor system for WebXR.
  78508. * For further information see https://github.com/immersive-web/anchors/
  78509. */
  78510. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78511. private _options;
  78512. private _lastFrameDetected;
  78513. private _trackedAnchors;
  78514. private _referenceSpaceForFrameAnchors;
  78515. private _futureAnchors;
  78516. /**
  78517. * The module's name
  78518. */
  78519. static readonly Name: string;
  78520. /**
  78521. * The (Babylon) version of this module.
  78522. * This is an integer representing the implementation version.
  78523. * This number does not correspond to the WebXR specs version
  78524. */
  78525. static readonly Version: number;
  78526. /**
  78527. * Observers registered here will be executed when a new anchor was added to the session
  78528. */
  78529. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78530. /**
  78531. * Observers registered here will be executed when an anchor was removed from the session
  78532. */
  78533. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78534. /**
  78535. * Observers registered here will be executed when an existing anchor updates
  78536. * This can execute N times every frame
  78537. */
  78538. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78539. /**
  78540. * Set the reference space to use for anchor creation, when not using a hit test.
  78541. * Will default to the session's reference space if not defined
  78542. */
  78543. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78544. /**
  78545. * constructs a new anchor system
  78546. * @param _xrSessionManager an instance of WebXRSessionManager
  78547. * @param _options configuration object for this feature
  78548. */
  78549. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78550. private _tmpVector;
  78551. private _tmpQuaternion;
  78552. private _populateTmpTransformation;
  78553. /**
  78554. * Create a new anchor point using a hit test result at a specific point in the scene
  78555. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78556. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78557. *
  78558. * @param hitTestResult The hit test result to use for this anchor creation
  78559. * @param position an optional position offset for this anchor
  78560. * @param rotationQuaternion an optional rotation offset for this anchor
  78561. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78562. */
  78563. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78564. /**
  78565. * Add a new anchor at a specific position and rotation
  78566. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78567. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78568. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78569. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78570. *
  78571. * @param position the position in which to add an anchor
  78572. * @param rotationQuaternion an optional rotation for the anchor transformation
  78573. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78574. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78575. */
  78576. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78577. /**
  78578. * detach this feature.
  78579. * Will usually be called by the features manager
  78580. *
  78581. * @returns true if successful.
  78582. */
  78583. detach(): boolean;
  78584. /**
  78585. * Dispose this feature and all of the resources attached
  78586. */
  78587. dispose(): void;
  78588. protected _onXRFrame(frame: XRFrame): void;
  78589. /**
  78590. * avoiding using Array.find for global support.
  78591. * @param xrAnchor the plane to find in the array
  78592. */
  78593. private _findIndexInAnchorArray;
  78594. private _updateAnchorWithXRFrame;
  78595. private _createAnchorAtTransformation;
  78596. }
  78597. }
  78598. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78599. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78600. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78601. import { Observable } from "babylonjs/Misc/observable";
  78602. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78603. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78604. /**
  78605. * Options used in the plane detector module
  78606. */
  78607. export interface IWebXRPlaneDetectorOptions {
  78608. /**
  78609. * The node to use to transform the local results to world coordinates
  78610. */
  78611. worldParentNode?: TransformNode;
  78612. /**
  78613. * If set to true a reference of the created planes will be kept until the next session starts
  78614. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78615. */
  78616. doNotRemovePlanesOnSessionEnded?: boolean;
  78617. }
  78618. /**
  78619. * A babylon interface for a WebXR plane.
  78620. * A Plane is actually a polygon, built from N points in space
  78621. *
  78622. * Supported in chrome 79, not supported in canary 81 ATM
  78623. */
  78624. export interface IWebXRPlane {
  78625. /**
  78626. * a babylon-assigned ID for this polygon
  78627. */
  78628. id: number;
  78629. /**
  78630. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78631. */
  78632. polygonDefinition: Array<Vector3>;
  78633. /**
  78634. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78635. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78636. */
  78637. transformationMatrix: Matrix;
  78638. /**
  78639. * the native xr-plane object
  78640. */
  78641. xrPlane: XRPlane;
  78642. }
  78643. /**
  78644. * The plane detector is used to detect planes in the real world when in AR
  78645. * For more information see https://github.com/immersive-web/real-world-geometry/
  78646. */
  78647. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78648. private _options;
  78649. private _detectedPlanes;
  78650. private _enabled;
  78651. private _lastFrameDetected;
  78652. /**
  78653. * The module's name
  78654. */
  78655. static readonly Name: string;
  78656. /**
  78657. * The (Babylon) version of this module.
  78658. * This is an integer representing the implementation version.
  78659. * This number does not correspond to the WebXR specs version
  78660. */
  78661. static readonly Version: number;
  78662. /**
  78663. * Observers registered here will be executed when a new plane was added to the session
  78664. */
  78665. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78666. /**
  78667. * Observers registered here will be executed when a plane is no longer detected in the session
  78668. */
  78669. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78670. /**
  78671. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78672. * This can execute N times every frame
  78673. */
  78674. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78675. /**
  78676. * construct a new Plane Detector
  78677. * @param _xrSessionManager an instance of xr Session manager
  78678. * @param _options configuration to use when constructing this feature
  78679. */
  78680. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78681. /**
  78682. * detach this feature.
  78683. * Will usually be called by the features manager
  78684. *
  78685. * @returns true if successful.
  78686. */
  78687. detach(): boolean;
  78688. /**
  78689. * Dispose this feature and all of the resources attached
  78690. */
  78691. dispose(): void;
  78692. protected _onXRFrame(frame: XRFrame): void;
  78693. private _init;
  78694. private _updatePlaneWithXRPlane;
  78695. /**
  78696. * avoiding using Array.find for global support.
  78697. * @param xrPlane the plane to find in the array
  78698. */
  78699. private findIndexInPlaneArray;
  78700. }
  78701. }
  78702. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78703. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78704. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78705. import { Observable } from "babylonjs/Misc/observable";
  78706. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78707. /**
  78708. * Options interface for the background remover plugin
  78709. */
  78710. export interface IWebXRBackgroundRemoverOptions {
  78711. /**
  78712. * Further background meshes to disable when entering AR
  78713. */
  78714. backgroundMeshes?: AbstractMesh[];
  78715. /**
  78716. * flags to configure the removal of the environment helper.
  78717. * If not set, the entire background will be removed. If set, flags should be set as well.
  78718. */
  78719. environmentHelperRemovalFlags?: {
  78720. /**
  78721. * Should the skybox be removed (default false)
  78722. */
  78723. skyBox?: boolean;
  78724. /**
  78725. * Should the ground be removed (default false)
  78726. */
  78727. ground?: boolean;
  78728. };
  78729. /**
  78730. * don't disable the environment helper
  78731. */
  78732. ignoreEnvironmentHelper?: boolean;
  78733. }
  78734. /**
  78735. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78736. */
  78737. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78738. /**
  78739. * read-only options to be used in this module
  78740. */
  78741. readonly options: IWebXRBackgroundRemoverOptions;
  78742. /**
  78743. * The module's name
  78744. */
  78745. static readonly Name: string;
  78746. /**
  78747. * The (Babylon) version of this module.
  78748. * This is an integer representing the implementation version.
  78749. * This number does not correspond to the WebXR specs version
  78750. */
  78751. static readonly Version: number;
  78752. /**
  78753. * registered observers will be triggered when the background state changes
  78754. */
  78755. onBackgroundStateChangedObservable: Observable<boolean>;
  78756. /**
  78757. * constructs a new background remover module
  78758. * @param _xrSessionManager the session manager for this module
  78759. * @param options read-only options to be used in this module
  78760. */
  78761. constructor(_xrSessionManager: WebXRSessionManager,
  78762. /**
  78763. * read-only options to be used in this module
  78764. */
  78765. options?: IWebXRBackgroundRemoverOptions);
  78766. /**
  78767. * attach this feature
  78768. * Will usually be called by the features manager
  78769. *
  78770. * @returns true if successful.
  78771. */
  78772. attach(): boolean;
  78773. /**
  78774. * detach this feature.
  78775. * Will usually be called by the features manager
  78776. *
  78777. * @returns true if successful.
  78778. */
  78779. detach(): boolean;
  78780. /**
  78781. * Dispose this feature and all of the resources attached
  78782. */
  78783. dispose(): void;
  78784. protected _onXRFrame(_xrFrame: XRFrame): void;
  78785. private _setBackgroundState;
  78786. }
  78787. }
  78788. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78789. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78790. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78791. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78792. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78793. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78794. import { Nullable } from "babylonjs/types";
  78795. /**
  78796. * Options for the controller physics feature
  78797. */
  78798. export class IWebXRControllerPhysicsOptions {
  78799. /**
  78800. * Should the headset get its own impostor
  78801. */
  78802. enableHeadsetImpostor?: boolean;
  78803. /**
  78804. * Optional parameters for the headset impostor
  78805. */
  78806. headsetImpostorParams?: {
  78807. /**
  78808. * The type of impostor to create. Default is sphere
  78809. */
  78810. impostorType: number;
  78811. /**
  78812. * the size of the impostor. Defaults to 10cm
  78813. */
  78814. impostorSize?: number | {
  78815. width: number;
  78816. height: number;
  78817. depth: number;
  78818. };
  78819. /**
  78820. * Friction definitions
  78821. */
  78822. friction?: number;
  78823. /**
  78824. * Restitution
  78825. */
  78826. restitution?: number;
  78827. };
  78828. /**
  78829. * The physics properties of the future impostors
  78830. */
  78831. physicsProperties?: {
  78832. /**
  78833. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78834. * Note that this requires a physics engine that supports mesh impostors!
  78835. */
  78836. useControllerMesh?: boolean;
  78837. /**
  78838. * The type of impostor to create. Default is sphere
  78839. */
  78840. impostorType?: number;
  78841. /**
  78842. * the size of the impostor. Defaults to 10cm
  78843. */
  78844. impostorSize?: number | {
  78845. width: number;
  78846. height: number;
  78847. depth: number;
  78848. };
  78849. /**
  78850. * Friction definitions
  78851. */
  78852. friction?: number;
  78853. /**
  78854. * Restitution
  78855. */
  78856. restitution?: number;
  78857. };
  78858. /**
  78859. * the xr input to use with this pointer selection
  78860. */
  78861. xrInput: WebXRInput;
  78862. }
  78863. /**
  78864. * Add physics impostor to your webxr controllers,
  78865. * including naive calculation of their linear and angular velocity
  78866. */
  78867. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78868. private readonly _options;
  78869. private _attachController;
  78870. private _controllers;
  78871. private _debugMode;
  78872. private _delta;
  78873. private _headsetImpostor?;
  78874. private _headsetMesh?;
  78875. private _lastTimestamp;
  78876. private _tmpQuaternion;
  78877. private _tmpVector;
  78878. /**
  78879. * The module's name
  78880. */
  78881. static readonly Name: string;
  78882. /**
  78883. * The (Babylon) version of this module.
  78884. * This is an integer representing the implementation version.
  78885. * This number does not correspond to the webxr specs version
  78886. */
  78887. static readonly Version: number;
  78888. /**
  78889. * Construct a new Controller Physics Feature
  78890. * @param _xrSessionManager the corresponding xr session manager
  78891. * @param _options options to create this feature with
  78892. */
  78893. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78894. /**
  78895. * @hidden
  78896. * enable debugging - will show console outputs and the impostor mesh
  78897. */
  78898. _enablePhysicsDebug(): void;
  78899. /**
  78900. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78901. * @param xrController the controller to add
  78902. */
  78903. addController(xrController: WebXRInputSource): void;
  78904. /**
  78905. * attach this feature
  78906. * Will usually be called by the features manager
  78907. *
  78908. * @returns true if successful.
  78909. */
  78910. attach(): boolean;
  78911. /**
  78912. * detach this feature.
  78913. * Will usually be called by the features manager
  78914. *
  78915. * @returns true if successful.
  78916. */
  78917. detach(): boolean;
  78918. /**
  78919. * Get the headset impostor, if enabled
  78920. * @returns the impostor
  78921. */
  78922. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78923. /**
  78924. * Get the physics impostor of a specific controller.
  78925. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78926. * @param controller the controller or the controller id of which to get the impostor
  78927. * @returns the impostor or null
  78928. */
  78929. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  78930. /**
  78931. * Update the physics properties provided in the constructor
  78932. * @param newProperties the new properties object
  78933. */
  78934. setPhysicsProperties(newProperties: {
  78935. impostorType?: number;
  78936. impostorSize?: number | {
  78937. width: number;
  78938. height: number;
  78939. depth: number;
  78940. };
  78941. friction?: number;
  78942. restitution?: number;
  78943. }): void;
  78944. protected _onXRFrame(_xrFrame: any): void;
  78945. private _detachController;
  78946. }
  78947. }
  78948. declare module "babylonjs/XR/features/index" {
  78949. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  78950. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  78951. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  78952. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  78953. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  78954. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  78955. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  78956. export * from "babylonjs/XR/features/WebXRHitTest";
  78957. }
  78958. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  78959. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78960. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78961. import { Scene } from "babylonjs/scene";
  78962. /**
  78963. * The motion controller class for all microsoft mixed reality controllers
  78964. */
  78965. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  78966. protected readonly _mapping: {
  78967. defaultButton: {
  78968. valueNodeName: string;
  78969. unpressedNodeName: string;
  78970. pressedNodeName: string;
  78971. };
  78972. defaultAxis: {
  78973. valueNodeName: string;
  78974. minNodeName: string;
  78975. maxNodeName: string;
  78976. };
  78977. buttons: {
  78978. "xr-standard-trigger": {
  78979. rootNodeName: string;
  78980. componentProperty: string;
  78981. states: string[];
  78982. };
  78983. "xr-standard-squeeze": {
  78984. rootNodeName: string;
  78985. componentProperty: string;
  78986. states: string[];
  78987. };
  78988. "xr-standard-touchpad": {
  78989. rootNodeName: string;
  78990. labelAnchorNodeName: string;
  78991. touchPointNodeName: string;
  78992. };
  78993. "xr-standard-thumbstick": {
  78994. rootNodeName: string;
  78995. componentProperty: string;
  78996. states: string[];
  78997. };
  78998. };
  78999. axes: {
  79000. "xr-standard-touchpad": {
  79001. "x-axis": {
  79002. rootNodeName: string;
  79003. };
  79004. "y-axis": {
  79005. rootNodeName: string;
  79006. };
  79007. };
  79008. "xr-standard-thumbstick": {
  79009. "x-axis": {
  79010. rootNodeName: string;
  79011. };
  79012. "y-axis": {
  79013. rootNodeName: string;
  79014. };
  79015. };
  79016. };
  79017. };
  79018. /**
  79019. * The base url used to load the left and right controller models
  79020. */
  79021. static MODEL_BASE_URL: string;
  79022. /**
  79023. * The name of the left controller model file
  79024. */
  79025. static MODEL_LEFT_FILENAME: string;
  79026. /**
  79027. * The name of the right controller model file
  79028. */
  79029. static MODEL_RIGHT_FILENAME: string;
  79030. profileId: string;
  79031. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79032. protected _getFilenameAndPath(): {
  79033. filename: string;
  79034. path: string;
  79035. };
  79036. protected _getModelLoadingConstraints(): boolean;
  79037. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79038. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79039. protected _updateModel(): void;
  79040. }
  79041. }
  79042. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79043. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79044. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79045. import { Scene } from "babylonjs/scene";
  79046. /**
  79047. * The motion controller class for oculus touch (quest, rift).
  79048. * This class supports legacy mapping as well the standard xr mapping
  79049. */
  79050. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79051. private _forceLegacyControllers;
  79052. private _modelRootNode;
  79053. /**
  79054. * The base url used to load the left and right controller models
  79055. */
  79056. static MODEL_BASE_URL: string;
  79057. /**
  79058. * The name of the left controller model file
  79059. */
  79060. static MODEL_LEFT_FILENAME: string;
  79061. /**
  79062. * The name of the right controller model file
  79063. */
  79064. static MODEL_RIGHT_FILENAME: string;
  79065. /**
  79066. * Base Url for the Quest controller model.
  79067. */
  79068. static QUEST_MODEL_BASE_URL: string;
  79069. profileId: string;
  79070. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79071. protected _getFilenameAndPath(): {
  79072. filename: string;
  79073. path: string;
  79074. };
  79075. protected _getModelLoadingConstraints(): boolean;
  79076. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79077. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79078. protected _updateModel(): void;
  79079. /**
  79080. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79081. * between the touch and touch 2.
  79082. */
  79083. private _isQuest;
  79084. }
  79085. }
  79086. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79087. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79088. import { Scene } from "babylonjs/scene";
  79089. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79090. /**
  79091. * The motion controller class for the standard HTC-Vive controllers
  79092. */
  79093. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79094. private _modelRootNode;
  79095. /**
  79096. * The base url used to load the left and right controller models
  79097. */
  79098. static MODEL_BASE_URL: string;
  79099. /**
  79100. * File name for the controller model.
  79101. */
  79102. static MODEL_FILENAME: string;
  79103. profileId: string;
  79104. /**
  79105. * Create a new Vive motion controller object
  79106. * @param scene the scene to use to create this controller
  79107. * @param gamepadObject the corresponding gamepad object
  79108. * @param handedness the handedness of the controller
  79109. */
  79110. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79111. protected _getFilenameAndPath(): {
  79112. filename: string;
  79113. path: string;
  79114. };
  79115. protected _getModelLoadingConstraints(): boolean;
  79116. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79117. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79118. protected _updateModel(): void;
  79119. }
  79120. }
  79121. declare module "babylonjs/XR/motionController/index" {
  79122. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79123. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79124. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79125. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79126. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79127. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79128. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79129. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79130. }
  79131. declare module "babylonjs/XR/index" {
  79132. export * from "babylonjs/XR/webXRCamera";
  79133. export * from "babylonjs/XR/webXREnterExitUI";
  79134. export * from "babylonjs/XR/webXRExperienceHelper";
  79135. export * from "babylonjs/XR/webXRInput";
  79136. export * from "babylonjs/XR/webXRInputSource";
  79137. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79138. export * from "babylonjs/XR/webXRTypes";
  79139. export * from "babylonjs/XR/webXRSessionManager";
  79140. export * from "babylonjs/XR/webXRDefaultExperience";
  79141. export * from "babylonjs/XR/webXRFeaturesManager";
  79142. export * from "babylonjs/XR/features/index";
  79143. export * from "babylonjs/XR/motionController/index";
  79144. }
  79145. declare module "babylonjs/index" {
  79146. export * from "babylonjs/abstractScene";
  79147. export * from "babylonjs/Actions/index";
  79148. export * from "babylonjs/Animations/index";
  79149. export * from "babylonjs/assetContainer";
  79150. export * from "babylonjs/Audio/index";
  79151. export * from "babylonjs/Behaviors/index";
  79152. export * from "babylonjs/Bones/index";
  79153. export * from "babylonjs/Cameras/index";
  79154. export * from "babylonjs/Collisions/index";
  79155. export * from "babylonjs/Culling/index";
  79156. export * from "babylonjs/Debug/index";
  79157. export * from "babylonjs/DeviceInput/index";
  79158. export * from "babylonjs/Engines/index";
  79159. export * from "babylonjs/Events/index";
  79160. export * from "babylonjs/Gamepads/index";
  79161. export * from "babylonjs/Gizmos/index";
  79162. export * from "babylonjs/Helpers/index";
  79163. export * from "babylonjs/Instrumentation/index";
  79164. export * from "babylonjs/Layers/index";
  79165. export * from "babylonjs/LensFlares/index";
  79166. export * from "babylonjs/Lights/index";
  79167. export * from "babylonjs/Loading/index";
  79168. export * from "babylonjs/Materials/index";
  79169. export * from "babylonjs/Maths/index";
  79170. export * from "babylonjs/Meshes/index";
  79171. export * from "babylonjs/Morph/index";
  79172. export * from "babylonjs/Navigation/index";
  79173. export * from "babylonjs/node";
  79174. export * from "babylonjs/Offline/index";
  79175. export * from "babylonjs/Particles/index";
  79176. export * from "babylonjs/Physics/index";
  79177. export * from "babylonjs/PostProcesses/index";
  79178. export * from "babylonjs/Probes/index";
  79179. export * from "babylonjs/Rendering/index";
  79180. export * from "babylonjs/scene";
  79181. export * from "babylonjs/sceneComponent";
  79182. export * from "babylonjs/Sprites/index";
  79183. export * from "babylonjs/States/index";
  79184. export * from "babylonjs/Misc/index";
  79185. export * from "babylonjs/XR/index";
  79186. export * from "babylonjs/types";
  79187. }
  79188. declare module "babylonjs/Animations/pathCursor" {
  79189. import { Vector3 } from "babylonjs/Maths/math.vector";
  79190. import { Path2 } from "babylonjs/Maths/math.path";
  79191. /**
  79192. * A cursor which tracks a point on a path
  79193. */
  79194. export class PathCursor {
  79195. private path;
  79196. /**
  79197. * Stores path cursor callbacks for when an onchange event is triggered
  79198. */
  79199. private _onchange;
  79200. /**
  79201. * The value of the path cursor
  79202. */
  79203. value: number;
  79204. /**
  79205. * The animation array of the path cursor
  79206. */
  79207. animations: Animation[];
  79208. /**
  79209. * Initializes the path cursor
  79210. * @param path The path to track
  79211. */
  79212. constructor(path: Path2);
  79213. /**
  79214. * Gets the cursor point on the path
  79215. * @returns A point on the path cursor at the cursor location
  79216. */
  79217. getPoint(): Vector3;
  79218. /**
  79219. * Moves the cursor ahead by the step amount
  79220. * @param step The amount to move the cursor forward
  79221. * @returns This path cursor
  79222. */
  79223. moveAhead(step?: number): PathCursor;
  79224. /**
  79225. * Moves the cursor behind by the step amount
  79226. * @param step The amount to move the cursor back
  79227. * @returns This path cursor
  79228. */
  79229. moveBack(step?: number): PathCursor;
  79230. /**
  79231. * Moves the cursor by the step amount
  79232. * If the step amount is greater than one, an exception is thrown
  79233. * @param step The amount to move the cursor
  79234. * @returns This path cursor
  79235. */
  79236. move(step: number): PathCursor;
  79237. /**
  79238. * Ensures that the value is limited between zero and one
  79239. * @returns This path cursor
  79240. */
  79241. private ensureLimits;
  79242. /**
  79243. * Runs onchange callbacks on change (used by the animation engine)
  79244. * @returns This path cursor
  79245. */
  79246. private raiseOnChange;
  79247. /**
  79248. * Executes a function on change
  79249. * @param f A path cursor onchange callback
  79250. * @returns This path cursor
  79251. */
  79252. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79253. }
  79254. }
  79255. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79256. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79257. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79258. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79259. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79260. }
  79261. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79262. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79263. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79264. }
  79265. declare module "babylonjs/Engines/Processors/index" {
  79266. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79267. export * from "babylonjs/Engines/Processors/Expressions/index";
  79268. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79269. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79270. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79271. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79272. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79273. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79274. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79275. }
  79276. declare module "babylonjs/Legacy/legacy" {
  79277. import * as Babylon from "babylonjs/index";
  79278. export * from "babylonjs/index";
  79279. }
  79280. declare module "babylonjs/Shaders/blur.fragment" {
  79281. /** @hidden */
  79282. export var blurPixelShader: {
  79283. name: string;
  79284. shader: string;
  79285. };
  79286. }
  79287. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79288. /** @hidden */
  79289. export var pointCloudVertexDeclaration: {
  79290. name: string;
  79291. shader: string;
  79292. };
  79293. }
  79294. declare module "babylonjs" {
  79295. export * from "babylonjs/Legacy/legacy";
  79296. }
  79297. declare module BABYLON {
  79298. /** Alias type for value that can be null */
  79299. export type Nullable<T> = T | null;
  79300. /**
  79301. * Alias type for number that are floats
  79302. * @ignorenaming
  79303. */
  79304. export type float = number;
  79305. /**
  79306. * Alias type for number that are doubles.
  79307. * @ignorenaming
  79308. */
  79309. export type double = number;
  79310. /**
  79311. * Alias type for number that are integer
  79312. * @ignorenaming
  79313. */
  79314. export type int = number;
  79315. /** Alias type for number array or Float32Array */
  79316. export type FloatArray = number[] | Float32Array;
  79317. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79318. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79319. /**
  79320. * Alias for types that can be used by a Buffer or VertexBuffer.
  79321. */
  79322. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79323. /**
  79324. * Alias type for primitive types
  79325. * @ignorenaming
  79326. */
  79327. type Primitive = undefined | null | boolean | string | number | Function;
  79328. /**
  79329. * Type modifier to make all the properties of an object Readonly
  79330. */
  79331. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79332. /**
  79333. * Type modifier to make all the properties of an object Readonly recursively
  79334. */
  79335. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79336. /**
  79337. * Type modifier to make object properties readonly.
  79338. */
  79339. export type DeepImmutableObject<T> = {
  79340. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79341. };
  79342. /** @hidden */
  79343. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79344. }
  79345. }
  79346. declare module BABYLON {
  79347. /**
  79348. * A class serves as a medium between the observable and its observers
  79349. */
  79350. export class EventState {
  79351. /**
  79352. * Create a new EventState
  79353. * @param mask defines the mask associated with this state
  79354. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79355. * @param target defines the original target of the state
  79356. * @param currentTarget defines the current target of the state
  79357. */
  79358. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79359. /**
  79360. * Initialize the current event state
  79361. * @param mask defines the mask associated with this state
  79362. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79363. * @param target defines the original target of the state
  79364. * @param currentTarget defines the current target of the state
  79365. * @returns the current event state
  79366. */
  79367. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79368. /**
  79369. * An Observer can set this property to true to prevent subsequent observers of being notified
  79370. */
  79371. skipNextObservers: boolean;
  79372. /**
  79373. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79374. */
  79375. mask: number;
  79376. /**
  79377. * The object that originally notified the event
  79378. */
  79379. target?: any;
  79380. /**
  79381. * The current object in the bubbling phase
  79382. */
  79383. currentTarget?: any;
  79384. /**
  79385. * This will be populated with the return value of the last function that was executed.
  79386. * If it is the first function in the callback chain it will be the event data.
  79387. */
  79388. lastReturnValue?: any;
  79389. }
  79390. /**
  79391. * Represent an Observer registered to a given Observable object.
  79392. */
  79393. export class Observer<T> {
  79394. /**
  79395. * Defines the callback to call when the observer is notified
  79396. */
  79397. callback: (eventData: T, eventState: EventState) => void;
  79398. /**
  79399. * Defines the mask of the observer (used to filter notifications)
  79400. */
  79401. mask: number;
  79402. /**
  79403. * Defines the current scope used to restore the JS context
  79404. */
  79405. scope: any;
  79406. /** @hidden */
  79407. _willBeUnregistered: boolean;
  79408. /**
  79409. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79410. */
  79411. unregisterOnNextCall: boolean;
  79412. /**
  79413. * Creates a new observer
  79414. * @param callback defines the callback to call when the observer is notified
  79415. * @param mask defines the mask of the observer (used to filter notifications)
  79416. * @param scope defines the current scope used to restore the JS context
  79417. */
  79418. constructor(
  79419. /**
  79420. * Defines the callback to call when the observer is notified
  79421. */
  79422. callback: (eventData: T, eventState: EventState) => void,
  79423. /**
  79424. * Defines the mask of the observer (used to filter notifications)
  79425. */
  79426. mask: number,
  79427. /**
  79428. * Defines the current scope used to restore the JS context
  79429. */
  79430. scope?: any);
  79431. }
  79432. /**
  79433. * Represent a list of observers registered to multiple Observables object.
  79434. */
  79435. export class MultiObserver<T> {
  79436. private _observers;
  79437. private _observables;
  79438. /**
  79439. * Release associated resources
  79440. */
  79441. dispose(): void;
  79442. /**
  79443. * Raise a callback when one of the observable will notify
  79444. * @param observables defines a list of observables to watch
  79445. * @param callback defines the callback to call on notification
  79446. * @param mask defines the mask used to filter notifications
  79447. * @param scope defines the current scope used to restore the JS context
  79448. * @returns the new MultiObserver
  79449. */
  79450. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79451. }
  79452. /**
  79453. * The Observable class is a simple implementation of the Observable pattern.
  79454. *
  79455. * 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.
  79456. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79457. * 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).
  79458. * 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.
  79459. */
  79460. export class Observable<T> {
  79461. private _observers;
  79462. private _eventState;
  79463. private _onObserverAdded;
  79464. /**
  79465. * Gets the list of observers
  79466. */
  79467. get observers(): Array<Observer<T>>;
  79468. /**
  79469. * Creates a new observable
  79470. * @param onObserverAdded defines a callback to call when a new observer is added
  79471. */
  79472. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79473. /**
  79474. * Create a new Observer with the specified callback
  79475. * @param callback the callback that will be executed for that Observer
  79476. * @param mask the mask used to filter observers
  79477. * @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.
  79478. * @param scope optional scope for the callback to be called from
  79479. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79480. * @returns the new observer created for the callback
  79481. */
  79482. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79483. /**
  79484. * Create a new Observer with the specified callback and unregisters after the next notification
  79485. * @param callback the callback that will be executed for that Observer
  79486. * @returns the new observer created for the callback
  79487. */
  79488. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79489. /**
  79490. * Remove an Observer from the Observable object
  79491. * @param observer the instance of the Observer to remove
  79492. * @returns false if it doesn't belong to this Observable
  79493. */
  79494. remove(observer: Nullable<Observer<T>>): boolean;
  79495. /**
  79496. * Remove a callback from the Observable object
  79497. * @param callback the callback to remove
  79498. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79499. * @returns false if it doesn't belong to this Observable
  79500. */
  79501. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79502. private _deferUnregister;
  79503. private _remove;
  79504. /**
  79505. * Moves the observable to the top of the observer list making it get called first when notified
  79506. * @param observer the observer to move
  79507. */
  79508. makeObserverTopPriority(observer: Observer<T>): void;
  79509. /**
  79510. * Moves the observable to the bottom of the observer list making it get called last when notified
  79511. * @param observer the observer to move
  79512. */
  79513. makeObserverBottomPriority(observer: Observer<T>): void;
  79514. /**
  79515. * Notify all Observers by calling their respective callback with the given data
  79516. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79517. * @param eventData defines the data to send to all observers
  79518. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79519. * @param target defines the original target of the state
  79520. * @param currentTarget defines the current target of the state
  79521. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79522. */
  79523. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79524. /**
  79525. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79526. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79527. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79528. * and it is crucial that all callbacks will be executed.
  79529. * The order of the callbacks is kept, callbacks are not executed parallel.
  79530. *
  79531. * @param eventData The data to be sent to each callback
  79532. * @param mask is used to filter observers defaults to -1
  79533. * @param target defines the callback target (see EventState)
  79534. * @param currentTarget defines he current object in the bubbling phase
  79535. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79536. */
  79537. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79538. /**
  79539. * Notify a specific observer
  79540. * @param observer defines the observer to notify
  79541. * @param eventData defines the data to be sent to each callback
  79542. * @param mask is used to filter observers defaults to -1
  79543. */
  79544. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79545. /**
  79546. * Gets a boolean indicating if the observable has at least one observer
  79547. * @returns true is the Observable has at least one Observer registered
  79548. */
  79549. hasObservers(): boolean;
  79550. /**
  79551. * Clear the list of observers
  79552. */
  79553. clear(): void;
  79554. /**
  79555. * Clone the current observable
  79556. * @returns a new observable
  79557. */
  79558. clone(): Observable<T>;
  79559. /**
  79560. * Does this observable handles observer registered with a given mask
  79561. * @param mask defines the mask to be tested
  79562. * @return whether or not one observer registered with the given mask is handeled
  79563. **/
  79564. hasSpecificMask(mask?: number): boolean;
  79565. }
  79566. }
  79567. declare module BABYLON {
  79568. /**
  79569. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  79570. * Babylon.js
  79571. */
  79572. export class DomManagement {
  79573. /**
  79574. * Checks if the window object exists
  79575. * @returns true if the window object exists
  79576. */
  79577. static IsWindowObjectExist(): boolean;
  79578. /**
  79579. * Checks if the navigator object exists
  79580. * @returns true if the navigator object exists
  79581. */
  79582. static IsNavigatorAvailable(): boolean;
  79583. /**
  79584. * Check if the document object exists
  79585. * @returns true if the document object exists
  79586. */
  79587. static IsDocumentAvailable(): boolean;
  79588. /**
  79589. * Extracts text content from a DOM element hierarchy
  79590. * @param element defines the root element
  79591. * @returns a string
  79592. */
  79593. static GetDOMTextContent(element: HTMLElement): string;
  79594. }
  79595. }
  79596. declare module BABYLON {
  79597. /**
  79598. * Logger used througouht the application to allow configuration of
  79599. * the log level required for the messages.
  79600. */
  79601. export class Logger {
  79602. /**
  79603. * No log
  79604. */
  79605. static readonly NoneLogLevel: number;
  79606. /**
  79607. * Only message logs
  79608. */
  79609. static readonly MessageLogLevel: number;
  79610. /**
  79611. * Only warning logs
  79612. */
  79613. static readonly WarningLogLevel: number;
  79614. /**
  79615. * Only error logs
  79616. */
  79617. static readonly ErrorLogLevel: number;
  79618. /**
  79619. * All logs
  79620. */
  79621. static readonly AllLogLevel: number;
  79622. private static _LogCache;
  79623. /**
  79624. * Gets a value indicating the number of loading errors
  79625. * @ignorenaming
  79626. */
  79627. static errorsCount: number;
  79628. /**
  79629. * Callback called when a new log is added
  79630. */
  79631. static OnNewCacheEntry: (entry: string) => void;
  79632. private static _AddLogEntry;
  79633. private static _FormatMessage;
  79634. private static _LogDisabled;
  79635. private static _LogEnabled;
  79636. private static _WarnDisabled;
  79637. private static _WarnEnabled;
  79638. private static _ErrorDisabled;
  79639. private static _ErrorEnabled;
  79640. /**
  79641. * Log a message to the console
  79642. */
  79643. static Log: (message: string) => void;
  79644. /**
  79645. * Write a warning message to the console
  79646. */
  79647. static Warn: (message: string) => void;
  79648. /**
  79649. * Write an error message to the console
  79650. */
  79651. static Error: (message: string) => void;
  79652. /**
  79653. * Gets current log cache (list of logs)
  79654. */
  79655. static get LogCache(): string;
  79656. /**
  79657. * Clears the log cache
  79658. */
  79659. static ClearLogCache(): void;
  79660. /**
  79661. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  79662. */
  79663. static set LogLevels(level: number);
  79664. }
  79665. }
  79666. declare module BABYLON {
  79667. /** @hidden */
  79668. export class _TypeStore {
  79669. /** @hidden */
  79670. static RegisteredTypes: {
  79671. [key: string]: Object;
  79672. };
  79673. /** @hidden */
  79674. static GetClass(fqdn: string): any;
  79675. }
  79676. }
  79677. declare module BABYLON {
  79678. /**
  79679. * Helper to manipulate strings
  79680. */
  79681. export class StringTools {
  79682. /**
  79683. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  79684. * @param str Source string
  79685. * @param suffix Suffix to search for in the source string
  79686. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  79687. */
  79688. static EndsWith(str: string, suffix: string): boolean;
  79689. /**
  79690. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  79691. * @param str Source string
  79692. * @param suffix Suffix to search for in the source string
  79693. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  79694. */
  79695. static StartsWith(str: string, suffix: string): boolean;
  79696. /**
  79697. * Decodes a buffer into a string
  79698. * @param buffer The buffer to decode
  79699. * @returns The decoded string
  79700. */
  79701. static Decode(buffer: Uint8Array | Uint16Array): string;
  79702. /**
  79703. * Encode a buffer to a base64 string
  79704. * @param buffer defines the buffer to encode
  79705. * @returns the encoded string
  79706. */
  79707. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  79708. /**
  79709. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  79710. * @param num the number to convert and pad
  79711. * @param length the expected length of the string
  79712. * @returns the padded string
  79713. */
  79714. static PadNumber(num: number, length: number): string;
  79715. }
  79716. }
  79717. declare module BABYLON {
  79718. /**
  79719. * Class containing a set of static utilities functions for deep copy.
  79720. */
  79721. export class DeepCopier {
  79722. /**
  79723. * Tries to copy an object by duplicating every property
  79724. * @param source defines the source object
  79725. * @param destination defines the target object
  79726. * @param doNotCopyList defines a list of properties to avoid
  79727. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  79728. */
  79729. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  79730. }
  79731. }
  79732. declare module BABYLON {
  79733. /**
  79734. * Class containing a set of static utilities functions for precision date
  79735. */
  79736. export class PrecisionDate {
  79737. /**
  79738. * Gets either window.performance.now() if supported or Date.now() else
  79739. */
  79740. static get Now(): number;
  79741. }
  79742. }
  79743. declare module BABYLON {
  79744. /** @hidden */
  79745. export class _DevTools {
  79746. static WarnImport(name: string): string;
  79747. }
  79748. }
  79749. declare module BABYLON {
  79750. /**
  79751. * Interface used to define the mechanism to get data from the network
  79752. */
  79753. export interface IWebRequest {
  79754. /**
  79755. * Returns client's response url
  79756. */
  79757. responseURL: string;
  79758. /**
  79759. * Returns client's status
  79760. */
  79761. status: number;
  79762. /**
  79763. * Returns client's status as a text
  79764. */
  79765. statusText: string;
  79766. }
  79767. }
  79768. declare module BABYLON {
  79769. /**
  79770. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  79771. */
  79772. export class WebRequest implements IWebRequest {
  79773. private _xhr;
  79774. /**
  79775. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  79776. * i.e. when loading files, where the server/service expects an Authorization header
  79777. */
  79778. static CustomRequestHeaders: {
  79779. [key: string]: string;
  79780. };
  79781. /**
  79782. * Add callback functions in this array to update all the requests before they get sent to the network
  79783. */
  79784. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  79785. private _injectCustomRequestHeaders;
  79786. /**
  79787. * Gets or sets a function to be called when loading progress changes
  79788. */
  79789. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  79790. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  79791. /**
  79792. * Returns client's state
  79793. */
  79794. get readyState(): number;
  79795. /**
  79796. * Returns client's status
  79797. */
  79798. get status(): number;
  79799. /**
  79800. * Returns client's status as a text
  79801. */
  79802. get statusText(): string;
  79803. /**
  79804. * Returns client's response
  79805. */
  79806. get response(): any;
  79807. /**
  79808. * Returns client's response url
  79809. */
  79810. get responseURL(): string;
  79811. /**
  79812. * Returns client's response as text
  79813. */
  79814. get responseText(): string;
  79815. /**
  79816. * Gets or sets the expected response type
  79817. */
  79818. get responseType(): XMLHttpRequestResponseType;
  79819. set responseType(value: XMLHttpRequestResponseType);
  79820. /** @hidden */
  79821. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  79822. /** @hidden */
  79823. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  79824. /**
  79825. * Cancels any network activity
  79826. */
  79827. abort(): void;
  79828. /**
  79829. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  79830. * @param body defines an optional request body
  79831. */
  79832. send(body?: Document | BodyInit | null): void;
  79833. /**
  79834. * Sets the request method, request URL
  79835. * @param method defines the method to use (GET, POST, etc..)
  79836. * @param url defines the url to connect with
  79837. */
  79838. open(method: string, url: string): void;
  79839. /**
  79840. * Sets the value of a request header.
  79841. * @param name The name of the header whose value is to be set
  79842. * @param value The value to set as the body of the header
  79843. */
  79844. setRequestHeader(name: string, value: string): void;
  79845. /**
  79846. * Get the string containing the text of a particular header's value.
  79847. * @param name The name of the header
  79848. * @returns The string containing the text of the given header name
  79849. */
  79850. getResponseHeader(name: string): Nullable<string>;
  79851. }
  79852. }
  79853. declare module BABYLON {
  79854. /**
  79855. * File request interface
  79856. */
  79857. export interface IFileRequest {
  79858. /**
  79859. * Raised when the request is complete (success or error).
  79860. */
  79861. onCompleteObservable: Observable<IFileRequest>;
  79862. /**
  79863. * Aborts the request for a file.
  79864. */
  79865. abort: () => void;
  79866. }
  79867. }
  79868. declare module BABYLON {
  79869. /**
  79870. * Define options used to create a render target texture
  79871. */
  79872. export class RenderTargetCreationOptions {
  79873. /**
  79874. * Specifies is mipmaps must be generated
  79875. */
  79876. generateMipMaps?: boolean;
  79877. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  79878. generateDepthBuffer?: boolean;
  79879. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  79880. generateStencilBuffer?: boolean;
  79881. /** Defines texture type (int by default) */
  79882. type?: number;
  79883. /** Defines sampling mode (trilinear by default) */
  79884. samplingMode?: number;
  79885. /** Defines format (RGBA by default) */
  79886. format?: number;
  79887. }
  79888. }
  79889. declare module BABYLON {
  79890. /** Defines the cross module used constants to avoid circular dependncies */
  79891. export class Constants {
  79892. /** Defines that alpha blending is disabled */
  79893. static readonly ALPHA_DISABLE: number;
  79894. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  79895. static readonly ALPHA_ADD: number;
  79896. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  79897. static readonly ALPHA_COMBINE: number;
  79898. /** Defines that alpha blending is DEST - SRC * DEST */
  79899. static readonly ALPHA_SUBTRACT: number;
  79900. /** Defines that alpha blending is SRC * DEST */
  79901. static readonly ALPHA_MULTIPLY: number;
  79902. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  79903. static readonly ALPHA_MAXIMIZED: number;
  79904. /** Defines that alpha blending is SRC + DEST */
  79905. static readonly ALPHA_ONEONE: number;
  79906. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  79907. static readonly ALPHA_PREMULTIPLIED: number;
  79908. /**
  79909. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  79910. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  79911. */
  79912. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  79913. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  79914. static readonly ALPHA_INTERPOLATE: number;
  79915. /**
  79916. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  79917. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  79918. */
  79919. static readonly ALPHA_SCREENMODE: number;
  79920. /**
  79921. * Defines that alpha blending is SRC + DST
  79922. * Alpha will be set to SRC ALPHA + DST ALPHA
  79923. */
  79924. static readonly ALPHA_ONEONE_ONEONE: number;
  79925. /**
  79926. * Defines that alpha blending is SRC * DST ALPHA + DST
  79927. * Alpha will be set to 0
  79928. */
  79929. static readonly ALPHA_ALPHATOCOLOR: number;
  79930. /**
  79931. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  79932. */
  79933. static readonly ALPHA_REVERSEONEMINUS: number;
  79934. /**
  79935. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  79936. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  79937. */
  79938. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  79939. /**
  79940. * Defines that alpha blending is SRC + DST
  79941. * Alpha will be set to SRC ALPHA
  79942. */
  79943. static readonly ALPHA_ONEONE_ONEZERO: number;
  79944. /**
  79945. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  79946. * Alpha will be set to DST ALPHA
  79947. */
  79948. static readonly ALPHA_EXCLUSION: number;
  79949. /** Defines that alpha blending equation a SUM */
  79950. static readonly ALPHA_EQUATION_ADD: number;
  79951. /** Defines that alpha blending equation a SUBSTRACTION */
  79952. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  79953. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  79954. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  79955. /** Defines that alpha blending equation a MAX operation */
  79956. static readonly ALPHA_EQUATION_MAX: number;
  79957. /** Defines that alpha blending equation a MIN operation */
  79958. static readonly ALPHA_EQUATION_MIN: number;
  79959. /**
  79960. * Defines that alpha blending equation a DARKEN operation:
  79961. * It takes the min of the src and sums the alpha channels.
  79962. */
  79963. static readonly ALPHA_EQUATION_DARKEN: number;
  79964. /** Defines that the ressource is not delayed*/
  79965. static readonly DELAYLOADSTATE_NONE: number;
  79966. /** Defines that the ressource was successfully delay loaded */
  79967. static readonly DELAYLOADSTATE_LOADED: number;
  79968. /** Defines that the ressource is currently delay loading */
  79969. static readonly DELAYLOADSTATE_LOADING: number;
  79970. /** Defines that the ressource is delayed and has not started loading */
  79971. static readonly DELAYLOADSTATE_NOTLOADED: number;
  79972. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  79973. static readonly NEVER: number;
  79974. /** 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 */
  79975. static readonly ALWAYS: number;
  79976. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  79977. static readonly LESS: number;
  79978. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  79979. static readonly EQUAL: number;
  79980. /** 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 */
  79981. static readonly LEQUAL: number;
  79982. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  79983. static readonly GREATER: number;
  79984. /** 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 */
  79985. static readonly GEQUAL: number;
  79986. /** 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 */
  79987. static readonly NOTEQUAL: number;
  79988. /** Passed to stencilOperation to specify that stencil value must be kept */
  79989. static readonly KEEP: number;
  79990. /** Passed to stencilOperation to specify that stencil value must be replaced */
  79991. static readonly REPLACE: number;
  79992. /** Passed to stencilOperation to specify that stencil value must be incremented */
  79993. static readonly INCR: number;
  79994. /** Passed to stencilOperation to specify that stencil value must be decremented */
  79995. static readonly DECR: number;
  79996. /** Passed to stencilOperation to specify that stencil value must be inverted */
  79997. static readonly INVERT: number;
  79998. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  79999. static readonly INCR_WRAP: number;
  80000. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80001. static readonly DECR_WRAP: number;
  80002. /** Texture is not repeating outside of 0..1 UVs */
  80003. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80004. /** Texture is repeating outside of 0..1 UVs */
  80005. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80006. /** Texture is repeating and mirrored */
  80007. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80008. /** ALPHA */
  80009. static readonly TEXTUREFORMAT_ALPHA: number;
  80010. /** LUMINANCE */
  80011. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80012. /** LUMINANCE_ALPHA */
  80013. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80014. /** RGB */
  80015. static readonly TEXTUREFORMAT_RGB: number;
  80016. /** RGBA */
  80017. static readonly TEXTUREFORMAT_RGBA: number;
  80018. /** RED */
  80019. static readonly TEXTUREFORMAT_RED: number;
  80020. /** RED (2nd reference) */
  80021. static readonly TEXTUREFORMAT_R: number;
  80022. /** RG */
  80023. static readonly TEXTUREFORMAT_RG: number;
  80024. /** RED_INTEGER */
  80025. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80026. /** RED_INTEGER (2nd reference) */
  80027. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80028. /** RG_INTEGER */
  80029. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80030. /** RGB_INTEGER */
  80031. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80032. /** RGBA_INTEGER */
  80033. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80034. /** UNSIGNED_BYTE */
  80035. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80036. /** UNSIGNED_BYTE (2nd reference) */
  80037. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80038. /** FLOAT */
  80039. static readonly TEXTURETYPE_FLOAT: number;
  80040. /** HALF_FLOAT */
  80041. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80042. /** BYTE */
  80043. static readonly TEXTURETYPE_BYTE: number;
  80044. /** SHORT */
  80045. static readonly TEXTURETYPE_SHORT: number;
  80046. /** UNSIGNED_SHORT */
  80047. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80048. /** INT */
  80049. static readonly TEXTURETYPE_INT: number;
  80050. /** UNSIGNED_INT */
  80051. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80052. /** UNSIGNED_SHORT_4_4_4_4 */
  80053. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80054. /** UNSIGNED_SHORT_5_5_5_1 */
  80055. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80056. /** UNSIGNED_SHORT_5_6_5 */
  80057. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80058. /** UNSIGNED_INT_2_10_10_10_REV */
  80059. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80060. /** UNSIGNED_INT_24_8 */
  80061. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80062. /** UNSIGNED_INT_10F_11F_11F_REV */
  80063. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80064. /** UNSIGNED_INT_5_9_9_9_REV */
  80065. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80066. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80067. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80068. /** nearest is mag = nearest and min = nearest and no mip */
  80069. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80070. /** mag = nearest and min = nearest and mip = none */
  80071. static readonly TEXTURE_NEAREST_NEAREST: number;
  80072. /** Bilinear is mag = linear and min = linear and no mip */
  80073. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80074. /** mag = linear and min = linear and mip = none */
  80075. static readonly TEXTURE_LINEAR_LINEAR: number;
  80076. /** Trilinear is mag = linear and min = linear and mip = linear */
  80077. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80078. /** Trilinear is mag = linear and min = linear and mip = linear */
  80079. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80080. /** mag = nearest and min = nearest and mip = nearest */
  80081. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80082. /** mag = nearest and min = linear and mip = nearest */
  80083. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80084. /** mag = nearest and min = linear and mip = linear */
  80085. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80086. /** mag = nearest and min = linear and mip = none */
  80087. static readonly TEXTURE_NEAREST_LINEAR: number;
  80088. /** nearest is mag = nearest and min = nearest and mip = linear */
  80089. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80090. /** mag = linear and min = nearest and mip = nearest */
  80091. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80092. /** mag = linear and min = nearest and mip = linear */
  80093. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80094. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80095. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80096. /** mag = linear and min = nearest and mip = none */
  80097. static readonly TEXTURE_LINEAR_NEAREST: number;
  80098. /** Explicit coordinates mode */
  80099. static readonly TEXTURE_EXPLICIT_MODE: number;
  80100. /** Spherical coordinates mode */
  80101. static readonly TEXTURE_SPHERICAL_MODE: number;
  80102. /** Planar coordinates mode */
  80103. static readonly TEXTURE_PLANAR_MODE: number;
  80104. /** Cubic coordinates mode */
  80105. static readonly TEXTURE_CUBIC_MODE: number;
  80106. /** Projection coordinates mode */
  80107. static readonly TEXTURE_PROJECTION_MODE: number;
  80108. /** Skybox coordinates mode */
  80109. static readonly TEXTURE_SKYBOX_MODE: number;
  80110. /** Inverse Cubic coordinates mode */
  80111. static readonly TEXTURE_INVCUBIC_MODE: number;
  80112. /** Equirectangular coordinates mode */
  80113. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80114. /** Equirectangular Fixed coordinates mode */
  80115. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80116. /** Equirectangular Fixed Mirrored coordinates mode */
  80117. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80118. /** Offline (baking) quality for texture filtering */
  80119. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80120. /** High quality for texture filtering */
  80121. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80122. /** Medium quality for texture filtering */
  80123. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80124. /** Low quality for texture filtering */
  80125. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80126. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80127. static readonly SCALEMODE_FLOOR: number;
  80128. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80129. static readonly SCALEMODE_NEAREST: number;
  80130. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80131. static readonly SCALEMODE_CEILING: number;
  80132. /**
  80133. * The dirty texture flag value
  80134. */
  80135. static readonly MATERIAL_TextureDirtyFlag: number;
  80136. /**
  80137. * The dirty light flag value
  80138. */
  80139. static readonly MATERIAL_LightDirtyFlag: number;
  80140. /**
  80141. * The dirty fresnel flag value
  80142. */
  80143. static readonly MATERIAL_FresnelDirtyFlag: number;
  80144. /**
  80145. * The dirty attribute flag value
  80146. */
  80147. static readonly MATERIAL_AttributesDirtyFlag: number;
  80148. /**
  80149. * The dirty misc flag value
  80150. */
  80151. static readonly MATERIAL_MiscDirtyFlag: number;
  80152. /**
  80153. * The all dirty flag value
  80154. */
  80155. static readonly MATERIAL_AllDirtyFlag: number;
  80156. /**
  80157. * Returns the triangle fill mode
  80158. */
  80159. static readonly MATERIAL_TriangleFillMode: number;
  80160. /**
  80161. * Returns the wireframe mode
  80162. */
  80163. static readonly MATERIAL_WireFrameFillMode: number;
  80164. /**
  80165. * Returns the point fill mode
  80166. */
  80167. static readonly MATERIAL_PointFillMode: number;
  80168. /**
  80169. * Returns the point list draw mode
  80170. */
  80171. static readonly MATERIAL_PointListDrawMode: number;
  80172. /**
  80173. * Returns the line list draw mode
  80174. */
  80175. static readonly MATERIAL_LineListDrawMode: number;
  80176. /**
  80177. * Returns the line loop draw mode
  80178. */
  80179. static readonly MATERIAL_LineLoopDrawMode: number;
  80180. /**
  80181. * Returns the line strip draw mode
  80182. */
  80183. static readonly MATERIAL_LineStripDrawMode: number;
  80184. /**
  80185. * Returns the triangle strip draw mode
  80186. */
  80187. static readonly MATERIAL_TriangleStripDrawMode: number;
  80188. /**
  80189. * Returns the triangle fan draw mode
  80190. */
  80191. static readonly MATERIAL_TriangleFanDrawMode: number;
  80192. /**
  80193. * Stores the clock-wise side orientation
  80194. */
  80195. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80196. /**
  80197. * Stores the counter clock-wise side orientation
  80198. */
  80199. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80200. /**
  80201. * Nothing
  80202. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80203. */
  80204. static readonly ACTION_NothingTrigger: number;
  80205. /**
  80206. * On pick
  80207. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80208. */
  80209. static readonly ACTION_OnPickTrigger: number;
  80210. /**
  80211. * On left pick
  80212. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80213. */
  80214. static readonly ACTION_OnLeftPickTrigger: number;
  80215. /**
  80216. * On right pick
  80217. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80218. */
  80219. static readonly ACTION_OnRightPickTrigger: number;
  80220. /**
  80221. * On center pick
  80222. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80223. */
  80224. static readonly ACTION_OnCenterPickTrigger: number;
  80225. /**
  80226. * On pick down
  80227. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80228. */
  80229. static readonly ACTION_OnPickDownTrigger: number;
  80230. /**
  80231. * On double pick
  80232. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80233. */
  80234. static readonly ACTION_OnDoublePickTrigger: number;
  80235. /**
  80236. * On pick up
  80237. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80238. */
  80239. static readonly ACTION_OnPickUpTrigger: number;
  80240. /**
  80241. * On pick out.
  80242. * This trigger will only be raised if you also declared a OnPickDown
  80243. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80244. */
  80245. static readonly ACTION_OnPickOutTrigger: number;
  80246. /**
  80247. * On long press
  80248. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80249. */
  80250. static readonly ACTION_OnLongPressTrigger: number;
  80251. /**
  80252. * On pointer over
  80253. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80254. */
  80255. static readonly ACTION_OnPointerOverTrigger: number;
  80256. /**
  80257. * On pointer out
  80258. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80259. */
  80260. static readonly ACTION_OnPointerOutTrigger: number;
  80261. /**
  80262. * On every frame
  80263. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80264. */
  80265. static readonly ACTION_OnEveryFrameTrigger: number;
  80266. /**
  80267. * On intersection enter
  80268. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80269. */
  80270. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80271. /**
  80272. * On intersection exit
  80273. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80274. */
  80275. static readonly ACTION_OnIntersectionExitTrigger: number;
  80276. /**
  80277. * On key down
  80278. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80279. */
  80280. static readonly ACTION_OnKeyDownTrigger: number;
  80281. /**
  80282. * On key up
  80283. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80284. */
  80285. static readonly ACTION_OnKeyUpTrigger: number;
  80286. /**
  80287. * Billboard mode will only apply to Y axis
  80288. */
  80289. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80290. /**
  80291. * Billboard mode will apply to all axes
  80292. */
  80293. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80294. /**
  80295. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80296. */
  80297. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80298. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80299. * Test order :
  80300. * Is the bounding sphere outside the frustum ?
  80301. * If not, are the bounding box vertices outside the frustum ?
  80302. * It not, then the cullable object is in the frustum.
  80303. */
  80304. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80305. /** Culling strategy : Bounding Sphere Only.
  80306. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80307. * It's also less accurate than the standard because some not visible objects can still be selected.
  80308. * Test : is the bounding sphere outside the frustum ?
  80309. * If not, then the cullable object is in the frustum.
  80310. */
  80311. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80312. /** Culling strategy : Optimistic Inclusion.
  80313. * This in an inclusion test first, then the standard exclusion test.
  80314. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80315. * 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.
  80316. * Anyway, it's as accurate as the standard strategy.
  80317. * Test :
  80318. * Is the cullable object bounding sphere center in the frustum ?
  80319. * If not, apply the default culling strategy.
  80320. */
  80321. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80322. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80323. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80324. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80325. * 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.
  80326. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80327. * Test :
  80328. * Is the cullable object bounding sphere center in the frustum ?
  80329. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80330. */
  80331. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80332. /**
  80333. * No logging while loading
  80334. */
  80335. static readonly SCENELOADER_NO_LOGGING: number;
  80336. /**
  80337. * Minimal logging while loading
  80338. */
  80339. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80340. /**
  80341. * Summary logging while loading
  80342. */
  80343. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80344. /**
  80345. * Detailled logging while loading
  80346. */
  80347. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80348. /**
  80349. * Prepass texture index for color
  80350. */
  80351. static readonly PREPASS_COLOR_INDEX: number;
  80352. /**
  80353. * Prepass texture index for irradiance
  80354. */
  80355. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80356. /**
  80357. * Prepass texture index for depth + normal
  80358. */
  80359. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80360. /**
  80361. * Prepass texture index for albedo
  80362. */
  80363. static readonly PREPASS_ALBEDO_INDEX: number;
  80364. }
  80365. }
  80366. declare module BABYLON {
  80367. /**
  80368. * This represents the required contract to create a new type of texture loader.
  80369. */
  80370. export interface IInternalTextureLoader {
  80371. /**
  80372. * Defines wether the loader supports cascade loading the different faces.
  80373. */
  80374. supportCascades: boolean;
  80375. /**
  80376. * This returns if the loader support the current file information.
  80377. * @param extension defines the file extension of the file being loaded
  80378. * @param mimeType defines the optional mime type of the file being loaded
  80379. * @returns true if the loader can load the specified file
  80380. */
  80381. canLoad(extension: string, mimeType?: string): boolean;
  80382. /**
  80383. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80384. * @param data contains the texture data
  80385. * @param texture defines the BabylonJS internal texture
  80386. * @param createPolynomials will be true if polynomials have been requested
  80387. * @param onLoad defines the callback to trigger once the texture is ready
  80388. * @param onError defines the callback to trigger in case of error
  80389. */
  80390. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80391. /**
  80392. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80393. * @param data contains the texture data
  80394. * @param texture defines the BabylonJS internal texture
  80395. * @param callback defines the method to call once ready to upload
  80396. */
  80397. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80398. }
  80399. }
  80400. declare module BABYLON {
  80401. /**
  80402. * Class used to store and describe the pipeline context associated with an effect
  80403. */
  80404. export interface IPipelineContext {
  80405. /**
  80406. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80407. */
  80408. isAsync: boolean;
  80409. /**
  80410. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80411. */
  80412. isReady: boolean;
  80413. /** @hidden */
  80414. _getVertexShaderCode(): string | null;
  80415. /** @hidden */
  80416. _getFragmentShaderCode(): string | null;
  80417. /** @hidden */
  80418. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80419. }
  80420. }
  80421. declare module BABYLON {
  80422. /**
  80423. * Class used to store gfx data (like WebGLBuffer)
  80424. */
  80425. export class DataBuffer {
  80426. /**
  80427. * Gets or sets the number of objects referencing this buffer
  80428. */
  80429. references: number;
  80430. /** Gets or sets the size of the underlying buffer */
  80431. capacity: number;
  80432. /**
  80433. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80434. */
  80435. is32Bits: boolean;
  80436. /**
  80437. * Gets the underlying buffer
  80438. */
  80439. get underlyingResource(): any;
  80440. }
  80441. }
  80442. declare module BABYLON {
  80443. /** @hidden */
  80444. export interface IShaderProcessor {
  80445. attributeProcessor?: (attribute: string) => string;
  80446. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80447. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80448. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80449. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80450. lineProcessor?: (line: string, isFragment: boolean) => string;
  80451. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80452. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80453. }
  80454. }
  80455. declare module BABYLON {
  80456. /** @hidden */
  80457. export interface ProcessingOptions {
  80458. defines: string[];
  80459. indexParameters: any;
  80460. isFragment: boolean;
  80461. shouldUseHighPrecisionShader: boolean;
  80462. supportsUniformBuffers: boolean;
  80463. shadersRepository: string;
  80464. includesShadersStore: {
  80465. [key: string]: string;
  80466. };
  80467. processor?: IShaderProcessor;
  80468. version: string;
  80469. platformName: string;
  80470. lookForClosingBracketForUniformBuffer?: boolean;
  80471. }
  80472. }
  80473. declare module BABYLON {
  80474. /** @hidden */
  80475. export class ShaderCodeNode {
  80476. line: string;
  80477. children: ShaderCodeNode[];
  80478. additionalDefineKey?: string;
  80479. additionalDefineValue?: string;
  80480. isValid(preprocessors: {
  80481. [key: string]: string;
  80482. }): boolean;
  80483. process(preprocessors: {
  80484. [key: string]: string;
  80485. }, options: ProcessingOptions): string;
  80486. }
  80487. }
  80488. declare module BABYLON {
  80489. /** @hidden */
  80490. export class ShaderCodeCursor {
  80491. private _lines;
  80492. lineIndex: number;
  80493. get currentLine(): string;
  80494. get canRead(): boolean;
  80495. set lines(value: string[]);
  80496. }
  80497. }
  80498. declare module BABYLON {
  80499. /** @hidden */
  80500. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80501. process(preprocessors: {
  80502. [key: string]: string;
  80503. }, options: ProcessingOptions): string;
  80504. }
  80505. }
  80506. declare module BABYLON {
  80507. /** @hidden */
  80508. export class ShaderDefineExpression {
  80509. isTrue(preprocessors: {
  80510. [key: string]: string;
  80511. }): boolean;
  80512. private static _OperatorPriority;
  80513. private static _Stack;
  80514. static postfixToInfix(postfix: string[]): string;
  80515. static infixToPostfix(infix: string): string[];
  80516. }
  80517. }
  80518. declare module BABYLON {
  80519. /** @hidden */
  80520. export class ShaderCodeTestNode extends ShaderCodeNode {
  80521. testExpression: ShaderDefineExpression;
  80522. isValid(preprocessors: {
  80523. [key: string]: string;
  80524. }): boolean;
  80525. }
  80526. }
  80527. declare module BABYLON {
  80528. /** @hidden */
  80529. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80530. define: string;
  80531. not: boolean;
  80532. constructor(define: string, not?: boolean);
  80533. isTrue(preprocessors: {
  80534. [key: string]: string;
  80535. }): boolean;
  80536. }
  80537. }
  80538. declare module BABYLON {
  80539. /** @hidden */
  80540. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80541. leftOperand: ShaderDefineExpression;
  80542. rightOperand: ShaderDefineExpression;
  80543. isTrue(preprocessors: {
  80544. [key: string]: string;
  80545. }): boolean;
  80546. }
  80547. }
  80548. declare module BABYLON {
  80549. /** @hidden */
  80550. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80551. leftOperand: ShaderDefineExpression;
  80552. rightOperand: ShaderDefineExpression;
  80553. isTrue(preprocessors: {
  80554. [key: string]: string;
  80555. }): boolean;
  80556. }
  80557. }
  80558. declare module BABYLON {
  80559. /** @hidden */
  80560. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  80561. define: string;
  80562. operand: string;
  80563. testValue: string;
  80564. constructor(define: string, operand: string, testValue: string);
  80565. isTrue(preprocessors: {
  80566. [key: string]: string;
  80567. }): boolean;
  80568. }
  80569. }
  80570. declare module BABYLON {
  80571. /**
  80572. * Class used to enable access to offline support
  80573. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  80574. */
  80575. export interface IOfflineProvider {
  80576. /**
  80577. * Gets a boolean indicating if scene must be saved in the database
  80578. */
  80579. enableSceneOffline: boolean;
  80580. /**
  80581. * Gets a boolean indicating if textures must be saved in the database
  80582. */
  80583. enableTexturesOffline: boolean;
  80584. /**
  80585. * Open the offline support and make it available
  80586. * @param successCallback defines the callback to call on success
  80587. * @param errorCallback defines the callback to call on error
  80588. */
  80589. open(successCallback: () => void, errorCallback: () => void): void;
  80590. /**
  80591. * Loads an image from the offline support
  80592. * @param url defines the url to load from
  80593. * @param image defines the target DOM image
  80594. */
  80595. loadImage(url: string, image: HTMLImageElement): void;
  80596. /**
  80597. * Loads a file from offline support
  80598. * @param url defines the URL to load from
  80599. * @param sceneLoaded defines a callback to call on success
  80600. * @param progressCallBack defines a callback to call when progress changed
  80601. * @param errorCallback defines a callback to call on error
  80602. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  80603. */
  80604. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  80605. }
  80606. }
  80607. declare module BABYLON {
  80608. /**
  80609. * Class used to help managing file picking and drag'n'drop
  80610. * File Storage
  80611. */
  80612. export class FilesInputStore {
  80613. /**
  80614. * List of files ready to be loaded
  80615. */
  80616. static FilesToLoad: {
  80617. [key: string]: File;
  80618. };
  80619. }
  80620. }
  80621. declare module BABYLON {
  80622. /**
  80623. * Class used to define a retry strategy when error happens while loading assets
  80624. */
  80625. export class RetryStrategy {
  80626. /**
  80627. * Function used to defines an exponential back off strategy
  80628. * @param maxRetries defines the maximum number of retries (3 by default)
  80629. * @param baseInterval defines the interval between retries
  80630. * @returns the strategy function to use
  80631. */
  80632. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80633. }
  80634. }
  80635. declare module BABYLON {
  80636. /**
  80637. * @ignore
  80638. * Application error to support additional information when loading a file
  80639. */
  80640. export abstract class BaseError extends Error {
  80641. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  80642. }
  80643. }
  80644. declare module BABYLON {
  80645. /** @ignore */
  80646. export class LoadFileError extends BaseError {
  80647. request?: WebRequest;
  80648. file?: File;
  80649. /**
  80650. * Creates a new LoadFileError
  80651. * @param message defines the message of the error
  80652. * @param request defines the optional web request
  80653. * @param file defines the optional file
  80654. */
  80655. constructor(message: string, object?: WebRequest | File);
  80656. }
  80657. /** @ignore */
  80658. export class RequestFileError extends BaseError {
  80659. request: WebRequest;
  80660. /**
  80661. * Creates a new LoadFileError
  80662. * @param message defines the message of the error
  80663. * @param request defines the optional web request
  80664. */
  80665. constructor(message: string, request: WebRequest);
  80666. }
  80667. /** @ignore */
  80668. export class ReadFileError extends BaseError {
  80669. file: File;
  80670. /**
  80671. * Creates a new ReadFileError
  80672. * @param message defines the message of the error
  80673. * @param file defines the optional file
  80674. */
  80675. constructor(message: string, file: File);
  80676. }
  80677. /**
  80678. * @hidden
  80679. */
  80680. export class FileTools {
  80681. /**
  80682. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  80683. */
  80684. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  80685. /**
  80686. * Gets or sets the base URL to use to load assets
  80687. */
  80688. static BaseUrl: string;
  80689. /**
  80690. * Default behaviour for cors in the application.
  80691. * It can be a string if the expected behavior is identical in the entire app.
  80692. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  80693. */
  80694. static CorsBehavior: string | ((url: string | string[]) => string);
  80695. /**
  80696. * Gets or sets a function used to pre-process url before using them to load assets
  80697. */
  80698. static PreprocessUrl: (url: string) => string;
  80699. /**
  80700. * Removes unwanted characters from an url
  80701. * @param url defines the url to clean
  80702. * @returns the cleaned url
  80703. */
  80704. private static _CleanUrl;
  80705. /**
  80706. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  80707. * @param url define the url we are trying
  80708. * @param element define the dom element where to configure the cors policy
  80709. */
  80710. static SetCorsBehavior(url: string | string[], element: {
  80711. crossOrigin: string | null;
  80712. }): void;
  80713. /**
  80714. * Loads an image as an HTMLImageElement.
  80715. * @param input url string, ArrayBuffer, or Blob to load
  80716. * @param onLoad callback called when the image successfully loads
  80717. * @param onError callback called when the image fails to load
  80718. * @param offlineProvider offline provider for caching
  80719. * @param mimeType optional mime type
  80720. * @returns the HTMLImageElement of the loaded image
  80721. */
  80722. 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>;
  80723. /**
  80724. * Reads a file from a File object
  80725. * @param file defines the file to load
  80726. * @param onSuccess defines the callback to call when data is loaded
  80727. * @param onProgress defines the callback to call during loading process
  80728. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  80729. * @param onError defines the callback to call when an error occurs
  80730. * @returns a file request object
  80731. */
  80732. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  80733. /**
  80734. * Loads a file from a url
  80735. * @param url url to load
  80736. * @param onSuccess callback called when the file successfully loads
  80737. * @param onProgress callback called while file is loading (if the server supports this mode)
  80738. * @param offlineProvider defines the offline provider for caching
  80739. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80740. * @param onError callback called when the file fails to load
  80741. * @returns a file request object
  80742. */
  80743. 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;
  80744. /**
  80745. * Loads a file
  80746. * @param url url to load
  80747. * @param onSuccess callback called when the file successfully loads
  80748. * @param onProgress callback called while file is loading (if the server supports this mode)
  80749. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80750. * @param onError callback called when the file fails to load
  80751. * @param onOpened callback called when the web request is opened
  80752. * @returns a file request object
  80753. */
  80754. 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;
  80755. /**
  80756. * Checks if the loaded document was accessed via `file:`-Protocol.
  80757. * @returns boolean
  80758. */
  80759. static IsFileURL(): boolean;
  80760. }
  80761. }
  80762. declare module BABYLON {
  80763. /** @hidden */
  80764. export class ShaderProcessor {
  80765. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  80766. private static _ProcessPrecision;
  80767. private static _ExtractOperation;
  80768. private static _BuildSubExpression;
  80769. private static _BuildExpression;
  80770. private static _MoveCursorWithinIf;
  80771. private static _MoveCursor;
  80772. private static _EvaluatePreProcessors;
  80773. private static _PreparePreProcessors;
  80774. private static _ProcessShaderConversion;
  80775. private static _ProcessIncludes;
  80776. /**
  80777. * Loads a file from a url
  80778. * @param url url to load
  80779. * @param onSuccess callback called when the file successfully loads
  80780. * @param onProgress callback called while file is loading (if the server supports this mode)
  80781. * @param offlineProvider defines the offline provider for caching
  80782. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80783. * @param onError callback called when the file fails to load
  80784. * @returns a file request object
  80785. * @hidden
  80786. */
  80787. 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;
  80788. }
  80789. }
  80790. declare module BABYLON {
  80791. /**
  80792. * @hidden
  80793. */
  80794. export interface IColor4Like {
  80795. r: float;
  80796. g: float;
  80797. b: float;
  80798. a: float;
  80799. }
  80800. /**
  80801. * @hidden
  80802. */
  80803. export interface IColor3Like {
  80804. r: float;
  80805. g: float;
  80806. b: float;
  80807. }
  80808. /**
  80809. * @hidden
  80810. */
  80811. export interface IVector4Like {
  80812. x: float;
  80813. y: float;
  80814. z: float;
  80815. w: float;
  80816. }
  80817. /**
  80818. * @hidden
  80819. */
  80820. export interface IVector3Like {
  80821. x: float;
  80822. y: float;
  80823. z: float;
  80824. }
  80825. /**
  80826. * @hidden
  80827. */
  80828. export interface IVector2Like {
  80829. x: float;
  80830. y: float;
  80831. }
  80832. /**
  80833. * @hidden
  80834. */
  80835. export interface IMatrixLike {
  80836. toArray(): DeepImmutable<Float32Array | Array<number>>;
  80837. updateFlag: int;
  80838. }
  80839. /**
  80840. * @hidden
  80841. */
  80842. export interface IViewportLike {
  80843. x: float;
  80844. y: float;
  80845. width: float;
  80846. height: float;
  80847. }
  80848. /**
  80849. * @hidden
  80850. */
  80851. export interface IPlaneLike {
  80852. normal: IVector3Like;
  80853. d: float;
  80854. normalize(): void;
  80855. }
  80856. }
  80857. declare module BABYLON {
  80858. /**
  80859. * Interface used to define common properties for effect fallbacks
  80860. */
  80861. export interface IEffectFallbacks {
  80862. /**
  80863. * Removes the defines that should be removed when falling back.
  80864. * @param currentDefines defines the current define statements for the shader.
  80865. * @param effect defines the current effect we try to compile
  80866. * @returns The resulting defines with defines of the current rank removed.
  80867. */
  80868. reduce(currentDefines: string, effect: Effect): string;
  80869. /**
  80870. * Removes the fallback from the bound mesh.
  80871. */
  80872. unBindMesh(): void;
  80873. /**
  80874. * Checks to see if more fallbacks are still availible.
  80875. */
  80876. hasMoreFallbacks: boolean;
  80877. }
  80878. }
  80879. declare module BABYLON {
  80880. /**
  80881. * Class used to evalaute queries containing `and` and `or` operators
  80882. */
  80883. export class AndOrNotEvaluator {
  80884. /**
  80885. * Evaluate a query
  80886. * @param query defines the query to evaluate
  80887. * @param evaluateCallback defines the callback used to filter result
  80888. * @returns true if the query matches
  80889. */
  80890. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  80891. private static _HandleParenthesisContent;
  80892. private static _SimplifyNegation;
  80893. }
  80894. }
  80895. declare module BABYLON {
  80896. /**
  80897. * Class used to store custom tags
  80898. */
  80899. export class Tags {
  80900. /**
  80901. * Adds support for tags on the given object
  80902. * @param obj defines the object to use
  80903. */
  80904. static EnableFor(obj: any): void;
  80905. /**
  80906. * Removes tags support
  80907. * @param obj defines the object to use
  80908. */
  80909. static DisableFor(obj: any): void;
  80910. /**
  80911. * Gets a boolean indicating if the given object has tags
  80912. * @param obj defines the object to use
  80913. * @returns a boolean
  80914. */
  80915. static HasTags(obj: any): boolean;
  80916. /**
  80917. * Gets the tags available on a given object
  80918. * @param obj defines the object to use
  80919. * @param asString defines if the tags must be returned as a string instead of an array of strings
  80920. * @returns the tags
  80921. */
  80922. static GetTags(obj: any, asString?: boolean): any;
  80923. /**
  80924. * Adds tags to an object
  80925. * @param obj defines the object to use
  80926. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  80927. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  80928. */
  80929. static AddTagsTo(obj: any, tagsString: string): void;
  80930. /**
  80931. * @hidden
  80932. */
  80933. static _AddTagTo(obj: any, tag: string): void;
  80934. /**
  80935. * Removes specific tags from a specific object
  80936. * @param obj defines the object to use
  80937. * @param tagsString defines the tags to remove
  80938. */
  80939. static RemoveTagsFrom(obj: any, tagsString: string): void;
  80940. /**
  80941. * @hidden
  80942. */
  80943. static _RemoveTagFrom(obj: any, tag: string): void;
  80944. /**
  80945. * Defines if tags hosted on an object match a given query
  80946. * @param obj defines the object to use
  80947. * @param tagsQuery defines the tag query
  80948. * @returns a boolean
  80949. */
  80950. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  80951. }
  80952. }
  80953. declare module BABYLON {
  80954. /**
  80955. * Scalar computation library
  80956. */
  80957. export class Scalar {
  80958. /**
  80959. * Two pi constants convenient for computation.
  80960. */
  80961. static TwoPi: number;
  80962. /**
  80963. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  80964. * @param a number
  80965. * @param b number
  80966. * @param epsilon (default = 1.401298E-45)
  80967. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  80968. */
  80969. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  80970. /**
  80971. * Returns a string : the upper case translation of the number i to hexadecimal.
  80972. * @param i number
  80973. * @returns the upper case translation of the number i to hexadecimal.
  80974. */
  80975. static ToHex(i: number): string;
  80976. /**
  80977. * Returns -1 if value is negative and +1 is value is positive.
  80978. * @param value the value
  80979. * @returns the value itself if it's equal to zero.
  80980. */
  80981. static Sign(value: number): number;
  80982. /**
  80983. * Returns the value itself if it's between min and max.
  80984. * Returns min if the value is lower than min.
  80985. * Returns max if the value is greater than max.
  80986. * @param value the value to clmap
  80987. * @param min the min value to clamp to (default: 0)
  80988. * @param max the max value to clamp to (default: 1)
  80989. * @returns the clamped value
  80990. */
  80991. static Clamp(value: number, min?: number, max?: number): number;
  80992. /**
  80993. * the log2 of value.
  80994. * @param value the value to compute log2 of
  80995. * @returns the log2 of value.
  80996. */
  80997. static Log2(value: number): number;
  80998. /**
  80999. * Loops the value, so that it is never larger than length and never smaller than 0.
  81000. *
  81001. * This is similar to the modulo operator but it works with floating point numbers.
  81002. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81003. * With t = 5 and length = 2.5, the result would be 0.0.
  81004. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81005. * @param value the value
  81006. * @param length the length
  81007. * @returns the looped value
  81008. */
  81009. static Repeat(value: number, length: number): number;
  81010. /**
  81011. * Normalize the value between 0.0 and 1.0 using min and max values
  81012. * @param value value to normalize
  81013. * @param min max to normalize between
  81014. * @param max min to normalize between
  81015. * @returns the normalized value
  81016. */
  81017. static Normalize(value: number, min: number, max: number): number;
  81018. /**
  81019. * Denormalize the value from 0.0 and 1.0 using min and max values
  81020. * @param normalized value to denormalize
  81021. * @param min max to denormalize between
  81022. * @param max min to denormalize between
  81023. * @returns the denormalized value
  81024. */
  81025. static Denormalize(normalized: number, min: number, max: number): number;
  81026. /**
  81027. * Calculates the shortest difference between two given angles given in degrees.
  81028. * @param current current angle in degrees
  81029. * @param target target angle in degrees
  81030. * @returns the delta
  81031. */
  81032. static DeltaAngle(current: number, target: number): number;
  81033. /**
  81034. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81035. * @param tx value
  81036. * @param length length
  81037. * @returns The returned value will move back and forth between 0 and length
  81038. */
  81039. static PingPong(tx: number, length: number): number;
  81040. /**
  81041. * Interpolates between min and max with smoothing at the limits.
  81042. *
  81043. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81044. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81045. * @param from from
  81046. * @param to to
  81047. * @param tx value
  81048. * @returns the smooth stepped value
  81049. */
  81050. static SmoothStep(from: number, to: number, tx: number): number;
  81051. /**
  81052. * Moves a value current towards target.
  81053. *
  81054. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81055. * Negative values of maxDelta pushes the value away from target.
  81056. * @param current current value
  81057. * @param target target value
  81058. * @param maxDelta max distance to move
  81059. * @returns resulting value
  81060. */
  81061. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81062. /**
  81063. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81064. *
  81065. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81066. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81067. * @param current current value
  81068. * @param target target value
  81069. * @param maxDelta max distance to move
  81070. * @returns resulting angle
  81071. */
  81072. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81073. /**
  81074. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81075. * @param start start value
  81076. * @param end target value
  81077. * @param amount amount to lerp between
  81078. * @returns the lerped value
  81079. */
  81080. static Lerp(start: number, end: number, amount: number): number;
  81081. /**
  81082. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81083. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81084. * @param start start value
  81085. * @param end target value
  81086. * @param amount amount to lerp between
  81087. * @returns the lerped value
  81088. */
  81089. static LerpAngle(start: number, end: number, amount: number): number;
  81090. /**
  81091. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81092. * @param a start value
  81093. * @param b target value
  81094. * @param value value between a and b
  81095. * @returns the inverseLerp value
  81096. */
  81097. static InverseLerp(a: number, b: number, value: number): number;
  81098. /**
  81099. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81100. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81101. * @param value1 spline value
  81102. * @param tangent1 spline value
  81103. * @param value2 spline value
  81104. * @param tangent2 spline value
  81105. * @param amount input value
  81106. * @returns hermite result
  81107. */
  81108. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81109. /**
  81110. * Returns a random float number between and min and max values
  81111. * @param min min value of random
  81112. * @param max max value of random
  81113. * @returns random value
  81114. */
  81115. static RandomRange(min: number, max: number): number;
  81116. /**
  81117. * This function returns percentage of a number in a given range.
  81118. *
  81119. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81120. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81121. * @param number to convert to percentage
  81122. * @param min min range
  81123. * @param max max range
  81124. * @returns the percentage
  81125. */
  81126. static RangeToPercent(number: number, min: number, max: number): number;
  81127. /**
  81128. * This function returns number that corresponds to the percentage in a given range.
  81129. *
  81130. * PercentToRange(0.34,0,100) will return 34.
  81131. * @param percent to convert to number
  81132. * @param min min range
  81133. * @param max max range
  81134. * @returns the number
  81135. */
  81136. static PercentToRange(percent: number, min: number, max: number): number;
  81137. /**
  81138. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81139. * @param angle The angle to normalize in radian.
  81140. * @return The converted angle.
  81141. */
  81142. static NormalizeRadians(angle: number): number;
  81143. }
  81144. }
  81145. declare module BABYLON {
  81146. /**
  81147. * Constant used to convert a value to gamma space
  81148. * @ignorenaming
  81149. */
  81150. export const ToGammaSpace: number;
  81151. /**
  81152. * Constant used to convert a value to linear space
  81153. * @ignorenaming
  81154. */
  81155. export const ToLinearSpace = 2.2;
  81156. /**
  81157. * Constant used to define the minimal number value in Babylon.js
  81158. * @ignorenaming
  81159. */
  81160. let Epsilon: number;
  81161. }
  81162. declare module BABYLON {
  81163. /**
  81164. * Class used to represent a viewport on screen
  81165. */
  81166. export class Viewport {
  81167. /** viewport left coordinate */
  81168. x: number;
  81169. /** viewport top coordinate */
  81170. y: number;
  81171. /**viewport width */
  81172. width: number;
  81173. /** viewport height */
  81174. height: number;
  81175. /**
  81176. * Creates a Viewport object located at (x, y) and sized (width, height)
  81177. * @param x defines viewport left coordinate
  81178. * @param y defines viewport top coordinate
  81179. * @param width defines the viewport width
  81180. * @param height defines the viewport height
  81181. */
  81182. constructor(
  81183. /** viewport left coordinate */
  81184. x: number,
  81185. /** viewport top coordinate */
  81186. y: number,
  81187. /**viewport width */
  81188. width: number,
  81189. /** viewport height */
  81190. height: number);
  81191. /**
  81192. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81193. * @param renderWidth defines the rendering width
  81194. * @param renderHeight defines the rendering height
  81195. * @returns a new Viewport
  81196. */
  81197. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81198. /**
  81199. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81200. * @param renderWidth defines the rendering width
  81201. * @param renderHeight defines the rendering height
  81202. * @param ref defines the target viewport
  81203. * @returns the current viewport
  81204. */
  81205. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81206. /**
  81207. * Returns a new Viewport copied from the current one
  81208. * @returns a new Viewport
  81209. */
  81210. clone(): Viewport;
  81211. }
  81212. }
  81213. declare module BABYLON {
  81214. /**
  81215. * Class containing a set of static utilities functions for arrays.
  81216. */
  81217. export class ArrayTools {
  81218. /**
  81219. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81220. * @param size the number of element to construct and put in the array
  81221. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81222. * @returns a new array filled with new objects
  81223. */
  81224. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81225. }
  81226. }
  81227. declare module BABYLON {
  81228. /**
  81229. * Represents a plane by the equation ax + by + cz + d = 0
  81230. */
  81231. export class Plane {
  81232. private static _TmpMatrix;
  81233. /**
  81234. * Normal of the plane (a,b,c)
  81235. */
  81236. normal: Vector3;
  81237. /**
  81238. * d component of the plane
  81239. */
  81240. d: number;
  81241. /**
  81242. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81243. * @param a a component of the plane
  81244. * @param b b component of the plane
  81245. * @param c c component of the plane
  81246. * @param d d component of the plane
  81247. */
  81248. constructor(a: number, b: number, c: number, d: number);
  81249. /**
  81250. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81251. */
  81252. asArray(): number[];
  81253. /**
  81254. * @returns a new plane copied from the current Plane.
  81255. */
  81256. clone(): Plane;
  81257. /**
  81258. * @returns the string "Plane".
  81259. */
  81260. getClassName(): string;
  81261. /**
  81262. * @returns the Plane hash code.
  81263. */
  81264. getHashCode(): number;
  81265. /**
  81266. * Normalize the current Plane in place.
  81267. * @returns the updated Plane.
  81268. */
  81269. normalize(): Plane;
  81270. /**
  81271. * Applies a transformation the plane and returns the result
  81272. * @param transformation the transformation matrix to be applied to the plane
  81273. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81274. */
  81275. transform(transformation: DeepImmutable<Matrix>): Plane;
  81276. /**
  81277. * Compute the dot product between the point and the plane normal
  81278. * @param point point to calculate the dot product with
  81279. * @returns the dot product (float) of the point coordinates and the plane normal.
  81280. */
  81281. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81282. /**
  81283. * Updates the current Plane from the plane defined by the three given points.
  81284. * @param point1 one of the points used to contruct the plane
  81285. * @param point2 one of the points used to contruct the plane
  81286. * @param point3 one of the points used to contruct the plane
  81287. * @returns the updated Plane.
  81288. */
  81289. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81290. /**
  81291. * Checks if the plane is facing a given direction
  81292. * @param direction the direction to check if the plane is facing
  81293. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81294. * @returns True is the vector "direction" is the same side than the plane normal.
  81295. */
  81296. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81297. /**
  81298. * Calculates the distance to a point
  81299. * @param point point to calculate distance to
  81300. * @returns the signed distance (float) from the given point to the Plane.
  81301. */
  81302. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81303. /**
  81304. * Creates a plane from an array
  81305. * @param array the array to create a plane from
  81306. * @returns a new Plane from the given array.
  81307. */
  81308. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81309. /**
  81310. * Creates a plane from three points
  81311. * @param point1 point used to create the plane
  81312. * @param point2 point used to create the plane
  81313. * @param point3 point used to create the plane
  81314. * @returns a new Plane defined by the three given points.
  81315. */
  81316. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81317. /**
  81318. * Creates a plane from an origin point and a normal
  81319. * @param origin origin of the plane to be constructed
  81320. * @param normal normal of the plane to be constructed
  81321. * @returns a new Plane the normal vector to this plane at the given origin point.
  81322. * Note : the vector "normal" is updated because normalized.
  81323. */
  81324. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81325. /**
  81326. * Calculates the distance from a plane and a point
  81327. * @param origin origin of the plane to be constructed
  81328. * @param normal normal of the plane to be constructed
  81329. * @param point point to calculate distance to
  81330. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81331. */
  81332. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81333. }
  81334. }
  81335. declare module BABYLON {
  81336. /** @hidden */
  81337. export class PerformanceConfigurator {
  81338. /** @hidden */
  81339. static MatrixUse64Bits: boolean;
  81340. /** @hidden */
  81341. static MatrixTrackPrecisionChange: boolean;
  81342. /** @hidden */
  81343. static MatrixCurrentType: any;
  81344. /** @hidden */
  81345. static MatrixTrackedMatrices: Array<any> | null;
  81346. /** @hidden */
  81347. static SetMatrixPrecision(use64bits: boolean): void;
  81348. }
  81349. }
  81350. declare module BABYLON {
  81351. /**
  81352. * Class representing a vector containing 2 coordinates
  81353. */
  81354. export class Vector2 {
  81355. /** defines the first coordinate */
  81356. x: number;
  81357. /** defines the second coordinate */
  81358. y: number;
  81359. /**
  81360. * Creates a new Vector2 from the given x and y coordinates
  81361. * @param x defines the first coordinate
  81362. * @param y defines the second coordinate
  81363. */
  81364. constructor(
  81365. /** defines the first coordinate */
  81366. x?: number,
  81367. /** defines the second coordinate */
  81368. y?: number);
  81369. /**
  81370. * Gets a string with the Vector2 coordinates
  81371. * @returns a string with the Vector2 coordinates
  81372. */
  81373. toString(): string;
  81374. /**
  81375. * Gets class name
  81376. * @returns the string "Vector2"
  81377. */
  81378. getClassName(): string;
  81379. /**
  81380. * Gets current vector hash code
  81381. * @returns the Vector2 hash code as a number
  81382. */
  81383. getHashCode(): number;
  81384. /**
  81385. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81386. * @param array defines the source array
  81387. * @param index defines the offset in source array
  81388. * @returns the current Vector2
  81389. */
  81390. toArray(array: FloatArray, index?: number): Vector2;
  81391. /**
  81392. * Update the current vector from an array
  81393. * @param array defines the destination array
  81394. * @param index defines the offset in the destination array
  81395. * @returns the current Vector3
  81396. */
  81397. fromArray(array: FloatArray, index?: number): Vector2;
  81398. /**
  81399. * Copy the current vector to an array
  81400. * @returns a new array with 2 elements: the Vector2 coordinates.
  81401. */
  81402. asArray(): number[];
  81403. /**
  81404. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81405. * @param source defines the source Vector2
  81406. * @returns the current updated Vector2
  81407. */
  81408. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81409. /**
  81410. * Sets the Vector2 coordinates with the given floats
  81411. * @param x defines the first coordinate
  81412. * @param y defines the second coordinate
  81413. * @returns the current updated Vector2
  81414. */
  81415. copyFromFloats(x: number, y: number): Vector2;
  81416. /**
  81417. * Sets the Vector2 coordinates with the given floats
  81418. * @param x defines the first coordinate
  81419. * @param y defines the second coordinate
  81420. * @returns the current updated Vector2
  81421. */
  81422. set(x: number, y: number): Vector2;
  81423. /**
  81424. * Add another vector with the current one
  81425. * @param otherVector defines the other vector
  81426. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81427. */
  81428. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81429. /**
  81430. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81431. * @param otherVector defines the other vector
  81432. * @param result defines the target vector
  81433. * @returns the unmodified current Vector2
  81434. */
  81435. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81436. /**
  81437. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81438. * @param otherVector defines the other vector
  81439. * @returns the current updated Vector2
  81440. */
  81441. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81442. /**
  81443. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81444. * @param otherVector defines the other vector
  81445. * @returns a new Vector2
  81446. */
  81447. addVector3(otherVector: Vector3): Vector2;
  81448. /**
  81449. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81450. * @param otherVector defines the other vector
  81451. * @returns a new Vector2
  81452. */
  81453. subtract(otherVector: Vector2): Vector2;
  81454. /**
  81455. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81456. * @param otherVector defines the other vector
  81457. * @param result defines the target vector
  81458. * @returns the unmodified current Vector2
  81459. */
  81460. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81461. /**
  81462. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81463. * @param otherVector defines the other vector
  81464. * @returns the current updated Vector2
  81465. */
  81466. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81467. /**
  81468. * Multiplies in place the current Vector2 coordinates by the given ones
  81469. * @param otherVector defines the other vector
  81470. * @returns the current updated Vector2
  81471. */
  81472. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81473. /**
  81474. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81475. * @param otherVector defines the other vector
  81476. * @returns a new Vector2
  81477. */
  81478. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81479. /**
  81480. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81481. * @param otherVector defines the other vector
  81482. * @param result defines the target vector
  81483. * @returns the unmodified current Vector2
  81484. */
  81485. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81486. /**
  81487. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81488. * @param x defines the first coordinate
  81489. * @param y defines the second coordinate
  81490. * @returns a new Vector2
  81491. */
  81492. multiplyByFloats(x: number, y: number): Vector2;
  81493. /**
  81494. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81495. * @param otherVector defines the other vector
  81496. * @returns a new Vector2
  81497. */
  81498. divide(otherVector: Vector2): Vector2;
  81499. /**
  81500. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81501. * @param otherVector defines the other vector
  81502. * @param result defines the target vector
  81503. * @returns the unmodified current Vector2
  81504. */
  81505. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81506. /**
  81507. * Divides the current Vector2 coordinates by the given ones
  81508. * @param otherVector defines the other vector
  81509. * @returns the current updated Vector2
  81510. */
  81511. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81512. /**
  81513. * Gets a new Vector2 with current Vector2 negated coordinates
  81514. * @returns a new Vector2
  81515. */
  81516. negate(): Vector2;
  81517. /**
  81518. * Negate this vector in place
  81519. * @returns this
  81520. */
  81521. negateInPlace(): Vector2;
  81522. /**
  81523. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81524. * @param result defines the Vector3 object where to store the result
  81525. * @returns the current Vector2
  81526. */
  81527. negateToRef(result: Vector2): Vector2;
  81528. /**
  81529. * Multiply the Vector2 coordinates by scale
  81530. * @param scale defines the scaling factor
  81531. * @returns the current updated Vector2
  81532. */
  81533. scaleInPlace(scale: number): Vector2;
  81534. /**
  81535. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81536. * @param scale defines the scaling factor
  81537. * @returns a new Vector2
  81538. */
  81539. scale(scale: number): Vector2;
  81540. /**
  81541. * Scale the current Vector2 values by a factor to a given Vector2
  81542. * @param scale defines the scale factor
  81543. * @param result defines the Vector2 object where to store the result
  81544. * @returns the unmodified current Vector2
  81545. */
  81546. scaleToRef(scale: number, result: Vector2): Vector2;
  81547. /**
  81548. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81549. * @param scale defines the scale factor
  81550. * @param result defines the Vector2 object where to store the result
  81551. * @returns the unmodified current Vector2
  81552. */
  81553. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  81554. /**
  81555. * Gets a boolean if two vectors are equals
  81556. * @param otherVector defines the other vector
  81557. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  81558. */
  81559. equals(otherVector: DeepImmutable<Vector2>): boolean;
  81560. /**
  81561. * Gets a boolean if two vectors are equals (using an epsilon value)
  81562. * @param otherVector defines the other vector
  81563. * @param epsilon defines the minimal distance to consider equality
  81564. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  81565. */
  81566. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  81567. /**
  81568. * Gets a new Vector2 from current Vector2 floored values
  81569. * @returns a new Vector2
  81570. */
  81571. floor(): Vector2;
  81572. /**
  81573. * Gets a new Vector2 from current Vector2 floored values
  81574. * @returns a new Vector2
  81575. */
  81576. fract(): Vector2;
  81577. /**
  81578. * Gets the length of the vector
  81579. * @returns the vector length (float)
  81580. */
  81581. length(): number;
  81582. /**
  81583. * Gets the vector squared length
  81584. * @returns the vector squared length (float)
  81585. */
  81586. lengthSquared(): number;
  81587. /**
  81588. * Normalize the vector
  81589. * @returns the current updated Vector2
  81590. */
  81591. normalize(): Vector2;
  81592. /**
  81593. * Gets a new Vector2 copied from the Vector2
  81594. * @returns a new Vector2
  81595. */
  81596. clone(): Vector2;
  81597. /**
  81598. * Gets a new Vector2(0, 0)
  81599. * @returns a new Vector2
  81600. */
  81601. static Zero(): Vector2;
  81602. /**
  81603. * Gets a new Vector2(1, 1)
  81604. * @returns a new Vector2
  81605. */
  81606. static One(): Vector2;
  81607. /**
  81608. * Gets a new Vector2 set from the given index element of the given array
  81609. * @param array defines the data source
  81610. * @param offset defines the offset in the data source
  81611. * @returns a new Vector2
  81612. */
  81613. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  81614. /**
  81615. * Sets "result" from the given index element of the given array
  81616. * @param array defines the data source
  81617. * @param offset defines the offset in the data source
  81618. * @param result defines the target vector
  81619. */
  81620. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  81621. /**
  81622. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81623. * @param value1 defines 1st point of control
  81624. * @param value2 defines 2nd point of control
  81625. * @param value3 defines 3rd point of control
  81626. * @param value4 defines 4th point of control
  81627. * @param amount defines the interpolation factor
  81628. * @returns a new Vector2
  81629. */
  81630. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81631. /**
  81632. * 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".
  81633. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  81634. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  81635. * @param value defines the value to clamp
  81636. * @param min defines the lower limit
  81637. * @param max defines the upper limit
  81638. * @returns a new Vector2
  81639. */
  81640. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  81641. /**
  81642. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  81643. * @param value1 defines the 1st control point
  81644. * @param tangent1 defines the outgoing tangent
  81645. * @param value2 defines the 2nd control point
  81646. * @param tangent2 defines the incoming tangent
  81647. * @param amount defines the interpolation factor
  81648. * @returns a new Vector2
  81649. */
  81650. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  81651. /**
  81652. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  81653. * @param start defines the start vector
  81654. * @param end defines the end vector
  81655. * @param amount defines the interpolation factor
  81656. * @returns a new Vector2
  81657. */
  81658. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  81659. /**
  81660. * Gets the dot product of the vector "left" and the vector "right"
  81661. * @param left defines first vector
  81662. * @param right defines second vector
  81663. * @returns the dot product (float)
  81664. */
  81665. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  81666. /**
  81667. * Returns a new Vector2 equal to the normalized given vector
  81668. * @param vector defines the vector to normalize
  81669. * @returns a new Vector2
  81670. */
  81671. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  81672. /**
  81673. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  81674. * @param left defines 1st vector
  81675. * @param right defines 2nd vector
  81676. * @returns a new Vector2
  81677. */
  81678. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  81679. /**
  81680. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  81681. * @param left defines 1st vector
  81682. * @param right defines 2nd vector
  81683. * @returns a new Vector2
  81684. */
  81685. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  81686. /**
  81687. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  81688. * @param vector defines the vector to transform
  81689. * @param transformation defines the matrix to apply
  81690. * @returns a new Vector2
  81691. */
  81692. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  81693. /**
  81694. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  81695. * @param vector defines the vector to transform
  81696. * @param transformation defines the matrix to apply
  81697. * @param result defines the target vector
  81698. */
  81699. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  81700. /**
  81701. * Determines if a given vector is included in a triangle
  81702. * @param p defines the vector to test
  81703. * @param p0 defines 1st triangle point
  81704. * @param p1 defines 2nd triangle point
  81705. * @param p2 defines 3rd triangle point
  81706. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  81707. */
  81708. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  81709. /**
  81710. * Gets the distance between the vectors "value1" and "value2"
  81711. * @param value1 defines first vector
  81712. * @param value2 defines second vector
  81713. * @returns the distance between vectors
  81714. */
  81715. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  81716. /**
  81717. * Returns the squared distance between the vectors "value1" and "value2"
  81718. * @param value1 defines first vector
  81719. * @param value2 defines second vector
  81720. * @returns the squared distance between vectors
  81721. */
  81722. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  81723. /**
  81724. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  81725. * @param value1 defines first vector
  81726. * @param value2 defines second vector
  81727. * @returns a new Vector2
  81728. */
  81729. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  81730. /**
  81731. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  81732. * @param p defines the middle point
  81733. * @param segA defines one point of the segment
  81734. * @param segB defines the other point of the segment
  81735. * @returns the shortest distance
  81736. */
  81737. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  81738. }
  81739. /**
  81740. * Class used to store (x,y,z) vector representation
  81741. * A Vector3 is the main object used in 3D geometry
  81742. * It can represent etiher the coordinates of a point the space, either a direction
  81743. * Reminder: js uses a left handed forward facing system
  81744. */
  81745. export class Vector3 {
  81746. private static _UpReadOnly;
  81747. private static _ZeroReadOnly;
  81748. /** @hidden */
  81749. _x: number;
  81750. /** @hidden */
  81751. _y: number;
  81752. /** @hidden */
  81753. _z: number;
  81754. /** @hidden */
  81755. _isDirty: boolean;
  81756. /** Gets or sets the x coordinate */
  81757. get x(): number;
  81758. set x(value: number);
  81759. /** Gets or sets the y coordinate */
  81760. get y(): number;
  81761. set y(value: number);
  81762. /** Gets or sets the z coordinate */
  81763. get z(): number;
  81764. set z(value: number);
  81765. /**
  81766. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  81767. * @param x defines the first coordinates (on X axis)
  81768. * @param y defines the second coordinates (on Y axis)
  81769. * @param z defines the third coordinates (on Z axis)
  81770. */
  81771. constructor(x?: number, y?: number, z?: number);
  81772. /**
  81773. * Creates a string representation of the Vector3
  81774. * @returns a string with the Vector3 coordinates.
  81775. */
  81776. toString(): string;
  81777. /**
  81778. * Gets the class name
  81779. * @returns the string "Vector3"
  81780. */
  81781. getClassName(): string;
  81782. /**
  81783. * Creates the Vector3 hash code
  81784. * @returns a number which tends to be unique between Vector3 instances
  81785. */
  81786. getHashCode(): number;
  81787. /**
  81788. * Creates an array containing three elements : the coordinates of the Vector3
  81789. * @returns a new array of numbers
  81790. */
  81791. asArray(): number[];
  81792. /**
  81793. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  81794. * @param array defines the destination array
  81795. * @param index defines the offset in the destination array
  81796. * @returns the current Vector3
  81797. */
  81798. toArray(array: FloatArray, index?: number): Vector3;
  81799. /**
  81800. * Update the current vector from an array
  81801. * @param array defines the destination array
  81802. * @param index defines the offset in the destination array
  81803. * @returns the current Vector3
  81804. */
  81805. fromArray(array: FloatArray, index?: number): Vector3;
  81806. /**
  81807. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  81808. * @returns a new Quaternion object, computed from the Vector3 coordinates
  81809. */
  81810. toQuaternion(): Quaternion;
  81811. /**
  81812. * Adds the given vector to the current Vector3
  81813. * @param otherVector defines the second operand
  81814. * @returns the current updated Vector3
  81815. */
  81816. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81817. /**
  81818. * Adds the given coordinates to the current Vector3
  81819. * @param x defines the x coordinate of the operand
  81820. * @param y defines the y coordinate of the operand
  81821. * @param z defines the z coordinate of the operand
  81822. * @returns the current updated Vector3
  81823. */
  81824. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  81825. /**
  81826. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  81827. * @param otherVector defines the second operand
  81828. * @returns the resulting Vector3
  81829. */
  81830. add(otherVector: DeepImmutable<Vector3>): Vector3;
  81831. /**
  81832. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  81833. * @param otherVector defines the second operand
  81834. * @param result defines the Vector3 object where to store the result
  81835. * @returns the current Vector3
  81836. */
  81837. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81838. /**
  81839. * Subtract the given vector from the current Vector3
  81840. * @param otherVector defines the second operand
  81841. * @returns the current updated Vector3
  81842. */
  81843. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81844. /**
  81845. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  81846. * @param otherVector defines the second operand
  81847. * @returns the resulting Vector3
  81848. */
  81849. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  81850. /**
  81851. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  81852. * @param otherVector defines the second operand
  81853. * @param result defines the Vector3 object where to store the result
  81854. * @returns the current Vector3
  81855. */
  81856. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81857. /**
  81858. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  81859. * @param x defines the x coordinate of the operand
  81860. * @param y defines the y coordinate of the operand
  81861. * @param z defines the z coordinate of the operand
  81862. * @returns the resulting Vector3
  81863. */
  81864. subtractFromFloats(x: number, y: number, z: number): Vector3;
  81865. /**
  81866. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  81867. * @param x defines the x coordinate of the operand
  81868. * @param y defines the y coordinate of the operand
  81869. * @param z defines the z coordinate of the operand
  81870. * @param result defines the Vector3 object where to store the result
  81871. * @returns the current Vector3
  81872. */
  81873. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  81874. /**
  81875. * Gets a new Vector3 set with the current Vector3 negated coordinates
  81876. * @returns a new Vector3
  81877. */
  81878. negate(): Vector3;
  81879. /**
  81880. * Negate this vector in place
  81881. * @returns this
  81882. */
  81883. negateInPlace(): Vector3;
  81884. /**
  81885. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  81886. * @param result defines the Vector3 object where to store the result
  81887. * @returns the current Vector3
  81888. */
  81889. negateToRef(result: Vector3): Vector3;
  81890. /**
  81891. * Multiplies the Vector3 coordinates by the float "scale"
  81892. * @param scale defines the multiplier factor
  81893. * @returns the current updated Vector3
  81894. */
  81895. scaleInPlace(scale: number): Vector3;
  81896. /**
  81897. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  81898. * @param scale defines the multiplier factor
  81899. * @returns a new Vector3
  81900. */
  81901. scale(scale: number): Vector3;
  81902. /**
  81903. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  81904. * @param scale defines the multiplier factor
  81905. * @param result defines the Vector3 object where to store the result
  81906. * @returns the current Vector3
  81907. */
  81908. scaleToRef(scale: number, result: Vector3): Vector3;
  81909. /**
  81910. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  81911. * @param scale defines the scale factor
  81912. * @param result defines the Vector3 object where to store the result
  81913. * @returns the unmodified current Vector3
  81914. */
  81915. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  81916. /**
  81917. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  81918. * @param origin defines the origin of the projection ray
  81919. * @param plane defines the plane to project to
  81920. * @returns the projected vector3
  81921. */
  81922. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  81923. /**
  81924. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  81925. * @param origin defines the origin of the projection ray
  81926. * @param plane defines the plane to project to
  81927. * @param result defines the Vector3 where to store the result
  81928. */
  81929. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  81930. /**
  81931. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  81932. * @param otherVector defines the second operand
  81933. * @returns true if both vectors are equals
  81934. */
  81935. equals(otherVector: DeepImmutable<Vector3>): boolean;
  81936. /**
  81937. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  81938. * @param otherVector defines the second operand
  81939. * @param epsilon defines the minimal distance to define values as equals
  81940. * @returns true if both vectors are distant less than epsilon
  81941. */
  81942. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  81943. /**
  81944. * Returns true if the current Vector3 coordinates equals the given floats
  81945. * @param x defines the x coordinate of the operand
  81946. * @param y defines the y coordinate of the operand
  81947. * @param z defines the z coordinate of the operand
  81948. * @returns true if both vectors are equals
  81949. */
  81950. equalsToFloats(x: number, y: number, z: number): boolean;
  81951. /**
  81952. * Multiplies the current Vector3 coordinates by the given ones
  81953. * @param otherVector defines the second operand
  81954. * @returns the current updated Vector3
  81955. */
  81956. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81957. /**
  81958. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  81959. * @param otherVector defines the second operand
  81960. * @returns the new Vector3
  81961. */
  81962. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  81963. /**
  81964. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  81965. * @param otherVector defines the second operand
  81966. * @param result defines the Vector3 object where to store the result
  81967. * @returns the current Vector3
  81968. */
  81969. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81970. /**
  81971. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  81972. * @param x defines the x coordinate of the operand
  81973. * @param y defines the y coordinate of the operand
  81974. * @param z defines the z coordinate of the operand
  81975. * @returns the new Vector3
  81976. */
  81977. multiplyByFloats(x: number, y: number, z: number): Vector3;
  81978. /**
  81979. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  81980. * @param otherVector defines the second operand
  81981. * @returns the new Vector3
  81982. */
  81983. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  81984. /**
  81985. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  81986. * @param otherVector defines the second operand
  81987. * @param result defines the Vector3 object where to store the result
  81988. * @returns the current Vector3
  81989. */
  81990. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81991. /**
  81992. * Divides the current Vector3 coordinates by the given ones.
  81993. * @param otherVector defines the second operand
  81994. * @returns the current updated Vector3
  81995. */
  81996. divideInPlace(otherVector: Vector3): Vector3;
  81997. /**
  81998. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  81999. * @param other defines the second operand
  82000. * @returns the current updated Vector3
  82001. */
  82002. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82003. /**
  82004. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82005. * @param other defines the second operand
  82006. * @returns the current updated Vector3
  82007. */
  82008. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82009. /**
  82010. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82011. * @param x defines the x coordinate of the operand
  82012. * @param y defines the y coordinate of the operand
  82013. * @param z defines the z coordinate of the operand
  82014. * @returns the current updated Vector3
  82015. */
  82016. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82017. /**
  82018. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82019. * @param x defines the x coordinate of the operand
  82020. * @param y defines the y coordinate of the operand
  82021. * @param z defines the z coordinate of the operand
  82022. * @returns the current updated Vector3
  82023. */
  82024. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82025. /**
  82026. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82027. * Check if is non uniform within a certain amount of decimal places to account for this
  82028. * @param epsilon the amount the values can differ
  82029. * @returns if the the vector is non uniform to a certain number of decimal places
  82030. */
  82031. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82032. /**
  82033. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82034. */
  82035. get isNonUniform(): boolean;
  82036. /**
  82037. * Gets a new Vector3 from current Vector3 floored values
  82038. * @returns a new Vector3
  82039. */
  82040. floor(): Vector3;
  82041. /**
  82042. * Gets a new Vector3 from current Vector3 floored values
  82043. * @returns a new Vector3
  82044. */
  82045. fract(): Vector3;
  82046. /**
  82047. * Gets the length of the Vector3
  82048. * @returns the length of the Vector3
  82049. */
  82050. length(): number;
  82051. /**
  82052. * Gets the squared length of the Vector3
  82053. * @returns squared length of the Vector3
  82054. */
  82055. lengthSquared(): number;
  82056. /**
  82057. * Normalize the current Vector3.
  82058. * Please note that this is an in place operation.
  82059. * @returns the current updated Vector3
  82060. */
  82061. normalize(): Vector3;
  82062. /**
  82063. * Reorders the x y z properties of the vector in place
  82064. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82065. * @returns the current updated vector
  82066. */
  82067. reorderInPlace(order: string): this;
  82068. /**
  82069. * Rotates the vector around 0,0,0 by a quaternion
  82070. * @param quaternion the rotation quaternion
  82071. * @param result vector to store the result
  82072. * @returns the resulting vector
  82073. */
  82074. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82075. /**
  82076. * Rotates a vector around a given point
  82077. * @param quaternion the rotation quaternion
  82078. * @param point the point to rotate around
  82079. * @param result vector to store the result
  82080. * @returns the resulting vector
  82081. */
  82082. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82083. /**
  82084. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82085. * The cross product is then orthogonal to both current and "other"
  82086. * @param other defines the right operand
  82087. * @returns the cross product
  82088. */
  82089. cross(other: Vector3): Vector3;
  82090. /**
  82091. * Normalize the current Vector3 with the given input length.
  82092. * Please note that this is an in place operation.
  82093. * @param len the length of the vector
  82094. * @returns the current updated Vector3
  82095. */
  82096. normalizeFromLength(len: number): Vector3;
  82097. /**
  82098. * Normalize the current Vector3 to a new vector
  82099. * @returns the new Vector3
  82100. */
  82101. normalizeToNew(): Vector3;
  82102. /**
  82103. * Normalize the current Vector3 to the reference
  82104. * @param reference define the Vector3 to update
  82105. * @returns the updated Vector3
  82106. */
  82107. normalizeToRef(reference: Vector3): Vector3;
  82108. /**
  82109. * Creates a new Vector3 copied from the current Vector3
  82110. * @returns the new Vector3
  82111. */
  82112. clone(): Vector3;
  82113. /**
  82114. * Copies the given vector coordinates to the current Vector3 ones
  82115. * @param source defines the source Vector3
  82116. * @returns the current updated Vector3
  82117. */
  82118. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82119. /**
  82120. * Copies the given floats to the current Vector3 coordinates
  82121. * @param x defines the x coordinate of the operand
  82122. * @param y defines the y coordinate of the operand
  82123. * @param z defines the z coordinate of the operand
  82124. * @returns the current updated Vector3
  82125. */
  82126. copyFromFloats(x: number, y: number, z: number): Vector3;
  82127. /**
  82128. * Copies the given floats to the current Vector3 coordinates
  82129. * @param x defines the x coordinate of the operand
  82130. * @param y defines the y coordinate of the operand
  82131. * @param z defines the z coordinate of the operand
  82132. * @returns the current updated Vector3
  82133. */
  82134. set(x: number, y: number, z: number): Vector3;
  82135. /**
  82136. * Copies the given float to the current Vector3 coordinates
  82137. * @param v defines the x, y and z coordinates of the operand
  82138. * @returns the current updated Vector3
  82139. */
  82140. setAll(v: number): Vector3;
  82141. /**
  82142. * Get the clip factor between two vectors
  82143. * @param vector0 defines the first operand
  82144. * @param vector1 defines the second operand
  82145. * @param axis defines the axis to use
  82146. * @param size defines the size along the axis
  82147. * @returns the clip factor
  82148. */
  82149. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82150. /**
  82151. * Get angle between two vectors
  82152. * @param vector0 angle between vector0 and vector1
  82153. * @param vector1 angle between vector0 and vector1
  82154. * @param normal direction of the normal
  82155. * @return the angle between vector0 and vector1
  82156. */
  82157. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82158. /**
  82159. * Returns a new Vector3 set from the index "offset" of the given array
  82160. * @param array defines the source array
  82161. * @param offset defines the offset in the source array
  82162. * @returns the new Vector3
  82163. */
  82164. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82165. /**
  82166. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82167. * @param array defines the source array
  82168. * @param offset defines the offset in the source array
  82169. * @returns the new Vector3
  82170. * @deprecated Please use FromArray instead.
  82171. */
  82172. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82173. /**
  82174. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82175. * @param array defines the source array
  82176. * @param offset defines the offset in the source array
  82177. * @param result defines the Vector3 where to store the result
  82178. */
  82179. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82180. /**
  82181. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82182. * @param array defines the source array
  82183. * @param offset defines the offset in the source array
  82184. * @param result defines the Vector3 where to store the result
  82185. * @deprecated Please use FromArrayToRef instead.
  82186. */
  82187. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82188. /**
  82189. * Sets the given vector "result" with the given floats.
  82190. * @param x defines the x coordinate of the source
  82191. * @param y defines the y coordinate of the source
  82192. * @param z defines the z coordinate of the source
  82193. * @param result defines the Vector3 where to store the result
  82194. */
  82195. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82196. /**
  82197. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82198. * @returns a new empty Vector3
  82199. */
  82200. static Zero(): Vector3;
  82201. /**
  82202. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82203. * @returns a new unit Vector3
  82204. */
  82205. static One(): Vector3;
  82206. /**
  82207. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82208. * @returns a new up Vector3
  82209. */
  82210. static Up(): Vector3;
  82211. /**
  82212. * Gets a up Vector3 that must not be updated
  82213. */
  82214. static get UpReadOnly(): DeepImmutable<Vector3>;
  82215. /**
  82216. * Gets a zero Vector3 that must not be updated
  82217. */
  82218. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82219. /**
  82220. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82221. * @returns a new down Vector3
  82222. */
  82223. static Down(): Vector3;
  82224. /**
  82225. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82226. * @param rightHandedSystem is the scene right-handed (negative z)
  82227. * @returns a new forward Vector3
  82228. */
  82229. static Forward(rightHandedSystem?: boolean): Vector3;
  82230. /**
  82231. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82232. * @param rightHandedSystem is the scene right-handed (negative-z)
  82233. * @returns a new forward Vector3
  82234. */
  82235. static Backward(rightHandedSystem?: boolean): Vector3;
  82236. /**
  82237. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82238. * @returns a new right Vector3
  82239. */
  82240. static Right(): Vector3;
  82241. /**
  82242. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82243. * @returns a new left Vector3
  82244. */
  82245. static Left(): Vector3;
  82246. /**
  82247. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82248. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82249. * @param vector defines the Vector3 to transform
  82250. * @param transformation defines the transformation matrix
  82251. * @returns the transformed Vector3
  82252. */
  82253. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82254. /**
  82255. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82256. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82257. * @param vector defines the Vector3 to transform
  82258. * @param transformation defines the transformation matrix
  82259. * @param result defines the Vector3 where to store the result
  82260. */
  82261. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82262. /**
  82263. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82264. * This method computes tranformed coordinates only, not transformed direction vectors
  82265. * @param x define the x coordinate of the source vector
  82266. * @param y define the y coordinate of the source vector
  82267. * @param z define the z coordinate of the source vector
  82268. * @param transformation defines the transformation matrix
  82269. * @param result defines the Vector3 where to store the result
  82270. */
  82271. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82272. /**
  82273. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82274. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82275. * @param vector defines the Vector3 to transform
  82276. * @param transformation defines the transformation matrix
  82277. * @returns the new Vector3
  82278. */
  82279. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82280. /**
  82281. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82282. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82283. * @param vector defines the Vector3 to transform
  82284. * @param transformation defines the transformation matrix
  82285. * @param result defines the Vector3 where to store the result
  82286. */
  82287. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82288. /**
  82289. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82290. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82291. * @param x define the x coordinate of the source vector
  82292. * @param y define the y coordinate of the source vector
  82293. * @param z define the z coordinate of the source vector
  82294. * @param transformation defines the transformation matrix
  82295. * @param result defines the Vector3 where to store the result
  82296. */
  82297. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82298. /**
  82299. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82300. * @param value1 defines the first control point
  82301. * @param value2 defines the second control point
  82302. * @param value3 defines the third control point
  82303. * @param value4 defines the fourth control point
  82304. * @param amount defines the amount on the spline to use
  82305. * @returns the new Vector3
  82306. */
  82307. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82308. /**
  82309. * 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"
  82310. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82311. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82312. * @param value defines the current value
  82313. * @param min defines the lower range value
  82314. * @param max defines the upper range value
  82315. * @returns the new Vector3
  82316. */
  82317. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82318. /**
  82319. * 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"
  82320. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82321. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82322. * @param value defines the current value
  82323. * @param min defines the lower range value
  82324. * @param max defines the upper range value
  82325. * @param result defines the Vector3 where to store the result
  82326. */
  82327. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82328. /**
  82329. * Checks if a given vector is inside a specific range
  82330. * @param v defines the vector to test
  82331. * @param min defines the minimum range
  82332. * @param max defines the maximum range
  82333. */
  82334. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82335. /**
  82336. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82337. * @param value1 defines the first control point
  82338. * @param tangent1 defines the first tangent vector
  82339. * @param value2 defines the second control point
  82340. * @param tangent2 defines the second tangent vector
  82341. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82342. * @returns the new Vector3
  82343. */
  82344. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82345. /**
  82346. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82347. * @param start defines the start value
  82348. * @param end defines the end value
  82349. * @param amount max defines amount between both (between 0 and 1)
  82350. * @returns the new Vector3
  82351. */
  82352. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82353. /**
  82354. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82355. * @param start defines the start value
  82356. * @param end defines the end value
  82357. * @param amount max defines amount between both (between 0 and 1)
  82358. * @param result defines the Vector3 where to store the result
  82359. */
  82360. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82361. /**
  82362. * Returns the dot product (float) between the vectors "left" and "right"
  82363. * @param left defines the left operand
  82364. * @param right defines the right operand
  82365. * @returns the dot product
  82366. */
  82367. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82368. /**
  82369. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82370. * The cross product is then orthogonal to both "left" and "right"
  82371. * @param left defines the left operand
  82372. * @param right defines the right operand
  82373. * @returns the cross product
  82374. */
  82375. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82376. /**
  82377. * Sets the given vector "result" with the cross product of "left" and "right"
  82378. * The cross product is then orthogonal to both "left" and "right"
  82379. * @param left defines the left operand
  82380. * @param right defines the right operand
  82381. * @param result defines the Vector3 where to store the result
  82382. */
  82383. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82384. /**
  82385. * Returns a new Vector3 as the normalization of the given vector
  82386. * @param vector defines the Vector3 to normalize
  82387. * @returns the new Vector3
  82388. */
  82389. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82390. /**
  82391. * Sets the given vector "result" with the normalization of the given first vector
  82392. * @param vector defines the Vector3 to normalize
  82393. * @param result defines the Vector3 where to store the result
  82394. */
  82395. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82396. /**
  82397. * Project a Vector3 onto screen space
  82398. * @param vector defines the Vector3 to project
  82399. * @param world defines the world matrix to use
  82400. * @param transform defines the transform (view x projection) matrix to use
  82401. * @param viewport defines the screen viewport to use
  82402. * @returns the new Vector3
  82403. */
  82404. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82405. /** @hidden */
  82406. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82407. /**
  82408. * Unproject from screen space to object space
  82409. * @param source defines the screen space Vector3 to use
  82410. * @param viewportWidth defines the current width of the viewport
  82411. * @param viewportHeight defines the current height of the viewport
  82412. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82413. * @param transform defines the transform (view x projection) matrix to use
  82414. * @returns the new Vector3
  82415. */
  82416. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82417. /**
  82418. * Unproject from screen space to object space
  82419. * @param source defines the screen space Vector3 to use
  82420. * @param viewportWidth defines the current width of the viewport
  82421. * @param viewportHeight defines the current height of the viewport
  82422. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82423. * @param view defines the view matrix to use
  82424. * @param projection defines the projection matrix to use
  82425. * @returns the new Vector3
  82426. */
  82427. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82428. /**
  82429. * Unproject from screen space to object space
  82430. * @param source defines the screen space Vector3 to use
  82431. * @param viewportWidth defines the current width of the viewport
  82432. * @param viewportHeight defines the current height of the viewport
  82433. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82434. * @param view defines the view matrix to use
  82435. * @param projection defines the projection matrix to use
  82436. * @param result defines the Vector3 where to store the result
  82437. */
  82438. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82439. /**
  82440. * Unproject from screen space to object space
  82441. * @param sourceX defines the screen space x coordinate to use
  82442. * @param sourceY defines the screen space y coordinate to use
  82443. * @param sourceZ defines the screen space z coordinate to use
  82444. * @param viewportWidth defines the current width of the viewport
  82445. * @param viewportHeight defines the current height of the viewport
  82446. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82447. * @param view defines the view matrix to use
  82448. * @param projection defines the projection matrix to use
  82449. * @param result defines the Vector3 where to store the result
  82450. */
  82451. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82452. /**
  82453. * Gets the minimal coordinate values between two Vector3
  82454. * @param left defines the first operand
  82455. * @param right defines the second operand
  82456. * @returns the new Vector3
  82457. */
  82458. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82459. /**
  82460. * Gets the maximal coordinate values between two Vector3
  82461. * @param left defines the first operand
  82462. * @param right defines the second operand
  82463. * @returns the new Vector3
  82464. */
  82465. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82466. /**
  82467. * Returns the distance between the vectors "value1" and "value2"
  82468. * @param value1 defines the first operand
  82469. * @param value2 defines the second operand
  82470. * @returns the distance
  82471. */
  82472. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82473. /**
  82474. * Returns the squared distance between the vectors "value1" and "value2"
  82475. * @param value1 defines the first operand
  82476. * @param value2 defines the second operand
  82477. * @returns the squared distance
  82478. */
  82479. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82480. /**
  82481. * Returns a new Vector3 located at the center between "value1" and "value2"
  82482. * @param value1 defines the first operand
  82483. * @param value2 defines the second operand
  82484. * @returns the new Vector3
  82485. */
  82486. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82487. /**
  82488. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82489. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82490. * to something in order to rotate it from its local system to the given target system
  82491. * Note: axis1, axis2 and axis3 are normalized during this operation
  82492. * @param axis1 defines the first axis
  82493. * @param axis2 defines the second axis
  82494. * @param axis3 defines the third axis
  82495. * @returns a new Vector3
  82496. */
  82497. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82498. /**
  82499. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82500. * @param axis1 defines the first axis
  82501. * @param axis2 defines the second axis
  82502. * @param axis3 defines the third axis
  82503. * @param ref defines the Vector3 where to store the result
  82504. */
  82505. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82506. }
  82507. /**
  82508. * Vector4 class created for EulerAngle class conversion to Quaternion
  82509. */
  82510. export class Vector4 {
  82511. /** x value of the vector */
  82512. x: number;
  82513. /** y value of the vector */
  82514. y: number;
  82515. /** z value of the vector */
  82516. z: number;
  82517. /** w value of the vector */
  82518. w: number;
  82519. /**
  82520. * Creates a Vector4 object from the given floats.
  82521. * @param x x value of the vector
  82522. * @param y y value of the vector
  82523. * @param z z value of the vector
  82524. * @param w w value of the vector
  82525. */
  82526. constructor(
  82527. /** x value of the vector */
  82528. x: number,
  82529. /** y value of the vector */
  82530. y: number,
  82531. /** z value of the vector */
  82532. z: number,
  82533. /** w value of the vector */
  82534. w: number);
  82535. /**
  82536. * Returns the string with the Vector4 coordinates.
  82537. * @returns a string containing all the vector values
  82538. */
  82539. toString(): string;
  82540. /**
  82541. * Returns the string "Vector4".
  82542. * @returns "Vector4"
  82543. */
  82544. getClassName(): string;
  82545. /**
  82546. * Returns the Vector4 hash code.
  82547. * @returns a unique hash code
  82548. */
  82549. getHashCode(): number;
  82550. /**
  82551. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82552. * @returns the resulting array
  82553. */
  82554. asArray(): number[];
  82555. /**
  82556. * Populates the given array from the given index with the Vector4 coordinates.
  82557. * @param array array to populate
  82558. * @param index index of the array to start at (default: 0)
  82559. * @returns the Vector4.
  82560. */
  82561. toArray(array: FloatArray, index?: number): Vector4;
  82562. /**
  82563. * Update the current vector from an array
  82564. * @param array defines the destination array
  82565. * @param index defines the offset in the destination array
  82566. * @returns the current Vector3
  82567. */
  82568. fromArray(array: FloatArray, index?: number): Vector4;
  82569. /**
  82570. * Adds the given vector to the current Vector4.
  82571. * @param otherVector the vector to add
  82572. * @returns the updated Vector4.
  82573. */
  82574. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82575. /**
  82576. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  82577. * @param otherVector the vector to add
  82578. * @returns the resulting vector
  82579. */
  82580. add(otherVector: DeepImmutable<Vector4>): Vector4;
  82581. /**
  82582. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  82583. * @param otherVector the vector to add
  82584. * @param result the vector to store the result
  82585. * @returns the current Vector4.
  82586. */
  82587. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82588. /**
  82589. * Subtract in place the given vector from the current Vector4.
  82590. * @param otherVector the vector to subtract
  82591. * @returns the updated Vector4.
  82592. */
  82593. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82594. /**
  82595. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  82596. * @param otherVector the vector to add
  82597. * @returns the new vector with the result
  82598. */
  82599. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  82600. /**
  82601. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  82602. * @param otherVector the vector to subtract
  82603. * @param result the vector to store the result
  82604. * @returns the current Vector4.
  82605. */
  82606. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82607. /**
  82608. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82609. */
  82610. /**
  82611. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82612. * @param x value to subtract
  82613. * @param y value to subtract
  82614. * @param z value to subtract
  82615. * @param w value to subtract
  82616. * @returns new vector containing the result
  82617. */
  82618. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82619. /**
  82620. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82621. * @param x value to subtract
  82622. * @param y value to subtract
  82623. * @param z value to subtract
  82624. * @param w value to subtract
  82625. * @param result the vector to store the result in
  82626. * @returns the current Vector4.
  82627. */
  82628. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82629. /**
  82630. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82631. * @returns a new vector with the negated values
  82632. */
  82633. negate(): Vector4;
  82634. /**
  82635. * Negate this vector in place
  82636. * @returns this
  82637. */
  82638. negateInPlace(): Vector4;
  82639. /**
  82640. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  82641. * @param result defines the Vector3 object where to store the result
  82642. * @returns the current Vector4
  82643. */
  82644. negateToRef(result: Vector4): Vector4;
  82645. /**
  82646. * Multiplies the current Vector4 coordinates by scale (float).
  82647. * @param scale the number to scale with
  82648. * @returns the updated Vector4.
  82649. */
  82650. scaleInPlace(scale: number): Vector4;
  82651. /**
  82652. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  82653. * @param scale the number to scale with
  82654. * @returns a new vector with the result
  82655. */
  82656. scale(scale: number): Vector4;
  82657. /**
  82658. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  82659. * @param scale the number to scale with
  82660. * @param result a vector to store the result in
  82661. * @returns the current Vector4.
  82662. */
  82663. scaleToRef(scale: number, result: Vector4): Vector4;
  82664. /**
  82665. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  82666. * @param scale defines the scale factor
  82667. * @param result defines the Vector4 object where to store the result
  82668. * @returns the unmodified current Vector4
  82669. */
  82670. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  82671. /**
  82672. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  82673. * @param otherVector the vector to compare against
  82674. * @returns true if they are equal
  82675. */
  82676. equals(otherVector: DeepImmutable<Vector4>): boolean;
  82677. /**
  82678. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  82679. * @param otherVector vector to compare against
  82680. * @param epsilon (Default: very small number)
  82681. * @returns true if they are equal
  82682. */
  82683. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  82684. /**
  82685. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  82686. * @param x x value to compare against
  82687. * @param y y value to compare against
  82688. * @param z z value to compare against
  82689. * @param w w value to compare against
  82690. * @returns true if equal
  82691. */
  82692. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  82693. /**
  82694. * Multiplies in place the current Vector4 by the given one.
  82695. * @param otherVector vector to multiple with
  82696. * @returns the updated Vector4.
  82697. */
  82698. multiplyInPlace(otherVector: Vector4): Vector4;
  82699. /**
  82700. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  82701. * @param otherVector vector to multiple with
  82702. * @returns resulting new vector
  82703. */
  82704. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  82705. /**
  82706. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  82707. * @param otherVector vector to multiple with
  82708. * @param result vector to store the result
  82709. * @returns the current Vector4.
  82710. */
  82711. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82712. /**
  82713. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  82714. * @param x x value multiply with
  82715. * @param y y value multiply with
  82716. * @param z z value multiply with
  82717. * @param w w value multiply with
  82718. * @returns resulting new vector
  82719. */
  82720. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  82721. /**
  82722. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  82723. * @param otherVector vector to devide with
  82724. * @returns resulting new vector
  82725. */
  82726. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  82727. /**
  82728. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  82729. * @param otherVector vector to devide with
  82730. * @param result vector to store the result
  82731. * @returns the current Vector4.
  82732. */
  82733. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82734. /**
  82735. * Divides the current Vector3 coordinates by the given ones.
  82736. * @param otherVector vector to devide with
  82737. * @returns the updated Vector3.
  82738. */
  82739. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82740. /**
  82741. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  82742. * @param other defines the second operand
  82743. * @returns the current updated Vector4
  82744. */
  82745. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  82746. /**
  82747. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  82748. * @param other defines the second operand
  82749. * @returns the current updated Vector4
  82750. */
  82751. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  82752. /**
  82753. * Gets a new Vector4 from current Vector4 floored values
  82754. * @returns a new Vector4
  82755. */
  82756. floor(): Vector4;
  82757. /**
  82758. * Gets a new Vector4 from current Vector3 floored values
  82759. * @returns a new Vector4
  82760. */
  82761. fract(): Vector4;
  82762. /**
  82763. * Returns the Vector4 length (float).
  82764. * @returns the length
  82765. */
  82766. length(): number;
  82767. /**
  82768. * Returns the Vector4 squared length (float).
  82769. * @returns the length squared
  82770. */
  82771. lengthSquared(): number;
  82772. /**
  82773. * Normalizes in place the Vector4.
  82774. * @returns the updated Vector4.
  82775. */
  82776. normalize(): Vector4;
  82777. /**
  82778. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  82779. * @returns this converted to a new vector3
  82780. */
  82781. toVector3(): Vector3;
  82782. /**
  82783. * Returns a new Vector4 copied from the current one.
  82784. * @returns the new cloned vector
  82785. */
  82786. clone(): Vector4;
  82787. /**
  82788. * Updates the current Vector4 with the given one coordinates.
  82789. * @param source the source vector to copy from
  82790. * @returns the updated Vector4.
  82791. */
  82792. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  82793. /**
  82794. * Updates the current Vector4 coordinates with the given floats.
  82795. * @param x float to copy from
  82796. * @param y float to copy from
  82797. * @param z float to copy from
  82798. * @param w float to copy from
  82799. * @returns the updated Vector4.
  82800. */
  82801. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82802. /**
  82803. * Updates the current Vector4 coordinates with the given floats.
  82804. * @param x float to set from
  82805. * @param y float to set from
  82806. * @param z float to set from
  82807. * @param w float to set from
  82808. * @returns the updated Vector4.
  82809. */
  82810. set(x: number, y: number, z: number, w: number): Vector4;
  82811. /**
  82812. * Copies the given float to the current Vector3 coordinates
  82813. * @param v defines the x, y, z and w coordinates of the operand
  82814. * @returns the current updated Vector3
  82815. */
  82816. setAll(v: number): Vector4;
  82817. /**
  82818. * Returns a new Vector4 set from the starting index of the given array.
  82819. * @param array the array to pull values from
  82820. * @param offset the offset into the array to start at
  82821. * @returns the new vector
  82822. */
  82823. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  82824. /**
  82825. * Updates the given vector "result" from the starting index of the given array.
  82826. * @param array the array to pull values from
  82827. * @param offset the offset into the array to start at
  82828. * @param result the vector to store the result in
  82829. */
  82830. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  82831. /**
  82832. * Updates the given vector "result" from the starting index of the given Float32Array.
  82833. * @param array the array to pull values from
  82834. * @param offset the offset into the array to start at
  82835. * @param result the vector to store the result in
  82836. */
  82837. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  82838. /**
  82839. * Updates the given vector "result" coordinates from the given floats.
  82840. * @param x float to set from
  82841. * @param y float to set from
  82842. * @param z float to set from
  82843. * @param w float to set from
  82844. * @param result the vector to the floats in
  82845. */
  82846. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  82847. /**
  82848. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  82849. * @returns the new vector
  82850. */
  82851. static Zero(): Vector4;
  82852. /**
  82853. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  82854. * @returns the new vector
  82855. */
  82856. static One(): Vector4;
  82857. /**
  82858. * Returns a new normalized Vector4 from the given one.
  82859. * @param vector the vector to normalize
  82860. * @returns the vector
  82861. */
  82862. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  82863. /**
  82864. * Updates the given vector "result" from the normalization of the given one.
  82865. * @param vector the vector to normalize
  82866. * @param result the vector to store the result in
  82867. */
  82868. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  82869. /**
  82870. * Returns a vector with the minimum values from the left and right vectors
  82871. * @param left left vector to minimize
  82872. * @param right right vector to minimize
  82873. * @returns a new vector with the minimum of the left and right vector values
  82874. */
  82875. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  82876. /**
  82877. * Returns a vector with the maximum values from the left and right vectors
  82878. * @param left left vector to maximize
  82879. * @param right right vector to maximize
  82880. * @returns a new vector with the maximum of the left and right vector values
  82881. */
  82882. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  82883. /**
  82884. * Returns the distance (float) between the vectors "value1" and "value2".
  82885. * @param value1 value to calulate the distance between
  82886. * @param value2 value to calulate the distance between
  82887. * @return the distance between the two vectors
  82888. */
  82889. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  82890. /**
  82891. * Returns the squared distance (float) between the vectors "value1" and "value2".
  82892. * @param value1 value to calulate the distance between
  82893. * @param value2 value to calulate the distance between
  82894. * @return the distance between the two vectors squared
  82895. */
  82896. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  82897. /**
  82898. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  82899. * @param value1 value to calulate the center between
  82900. * @param value2 value to calulate the center between
  82901. * @return the center between the two vectors
  82902. */
  82903. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  82904. /**
  82905. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  82906. * This methods computes transformed normalized direction vectors only.
  82907. * @param vector the vector to transform
  82908. * @param transformation the transformation matrix to apply
  82909. * @returns the new vector
  82910. */
  82911. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  82912. /**
  82913. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  82914. * This methods computes transformed normalized direction vectors only.
  82915. * @param vector the vector to transform
  82916. * @param transformation the transformation matrix to apply
  82917. * @param result the vector to store the result in
  82918. */
  82919. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  82920. /**
  82921. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  82922. * This methods computes transformed normalized direction vectors only.
  82923. * @param x value to transform
  82924. * @param y value to transform
  82925. * @param z value to transform
  82926. * @param w value to transform
  82927. * @param transformation the transformation matrix to apply
  82928. * @param result the vector to store the results in
  82929. */
  82930. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  82931. /**
  82932. * Creates a new Vector4 from a Vector3
  82933. * @param source defines the source data
  82934. * @param w defines the 4th component (default is 0)
  82935. * @returns a new Vector4
  82936. */
  82937. static FromVector3(source: Vector3, w?: number): Vector4;
  82938. }
  82939. /**
  82940. * Class used to store quaternion data
  82941. * @see https://en.wikipedia.org/wiki/Quaternion
  82942. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  82943. */
  82944. export class Quaternion {
  82945. /** @hidden */
  82946. _x: number;
  82947. /** @hidden */
  82948. _y: number;
  82949. /** @hidden */
  82950. _z: number;
  82951. /** @hidden */
  82952. _w: number;
  82953. /** @hidden */
  82954. _isDirty: boolean;
  82955. /** Gets or sets the x coordinate */
  82956. get x(): number;
  82957. set x(value: number);
  82958. /** Gets or sets the y coordinate */
  82959. get y(): number;
  82960. set y(value: number);
  82961. /** Gets or sets the z coordinate */
  82962. get z(): number;
  82963. set z(value: number);
  82964. /** Gets or sets the w coordinate */
  82965. get w(): number;
  82966. set w(value: number);
  82967. /**
  82968. * Creates a new Quaternion from the given floats
  82969. * @param x defines the first component (0 by default)
  82970. * @param y defines the second component (0 by default)
  82971. * @param z defines the third component (0 by default)
  82972. * @param w defines the fourth component (1.0 by default)
  82973. */
  82974. constructor(x?: number, y?: number, z?: number, w?: number);
  82975. /**
  82976. * Gets a string representation for the current quaternion
  82977. * @returns a string with the Quaternion coordinates
  82978. */
  82979. toString(): string;
  82980. /**
  82981. * Gets the class name of the quaternion
  82982. * @returns the string "Quaternion"
  82983. */
  82984. getClassName(): string;
  82985. /**
  82986. * Gets a hash code for this quaternion
  82987. * @returns the quaternion hash code
  82988. */
  82989. getHashCode(): number;
  82990. /**
  82991. * Copy the quaternion to an array
  82992. * @returns a new array populated with 4 elements from the quaternion coordinates
  82993. */
  82994. asArray(): number[];
  82995. /**
  82996. * Check if two quaternions are equals
  82997. * @param otherQuaternion defines the second operand
  82998. * @return true if the current quaternion and the given one coordinates are strictly equals
  82999. */
  83000. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83001. /**
  83002. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83003. * @param otherQuaternion defines the other quaternion
  83004. * @param epsilon defines the minimal distance to consider equality
  83005. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83006. */
  83007. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83008. /**
  83009. * Clone the current quaternion
  83010. * @returns a new quaternion copied from the current one
  83011. */
  83012. clone(): Quaternion;
  83013. /**
  83014. * Copy a quaternion to the current one
  83015. * @param other defines the other quaternion
  83016. * @returns the updated current quaternion
  83017. */
  83018. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83019. /**
  83020. * Updates the current quaternion with the given float coordinates
  83021. * @param x defines the x coordinate
  83022. * @param y defines the y coordinate
  83023. * @param z defines the z coordinate
  83024. * @param w defines the w coordinate
  83025. * @returns the updated current quaternion
  83026. */
  83027. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83028. /**
  83029. * Updates the current quaternion from the given float coordinates
  83030. * @param x defines the x coordinate
  83031. * @param y defines the y coordinate
  83032. * @param z defines the z coordinate
  83033. * @param w defines the w coordinate
  83034. * @returns the updated current quaternion
  83035. */
  83036. set(x: number, y: number, z: number, w: number): Quaternion;
  83037. /**
  83038. * Adds two quaternions
  83039. * @param other defines the second operand
  83040. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83041. */
  83042. add(other: DeepImmutable<Quaternion>): Quaternion;
  83043. /**
  83044. * Add a quaternion to the current one
  83045. * @param other defines the quaternion to add
  83046. * @returns the current quaternion
  83047. */
  83048. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83049. /**
  83050. * Subtract two quaternions
  83051. * @param other defines the second operand
  83052. * @returns a new quaternion as the subtraction result of the given one from the current one
  83053. */
  83054. subtract(other: Quaternion): Quaternion;
  83055. /**
  83056. * Multiplies the current quaternion by a scale factor
  83057. * @param value defines the scale factor
  83058. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83059. */
  83060. scale(value: number): Quaternion;
  83061. /**
  83062. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83063. * @param scale defines the scale factor
  83064. * @param result defines the Quaternion object where to store the result
  83065. * @returns the unmodified current quaternion
  83066. */
  83067. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83068. /**
  83069. * Multiplies in place the current quaternion by a scale factor
  83070. * @param value defines the scale factor
  83071. * @returns the current modified quaternion
  83072. */
  83073. scaleInPlace(value: number): Quaternion;
  83074. /**
  83075. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83076. * @param scale defines the scale factor
  83077. * @param result defines the Quaternion object where to store the result
  83078. * @returns the unmodified current quaternion
  83079. */
  83080. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83081. /**
  83082. * Multiplies two quaternions
  83083. * @param q1 defines the second operand
  83084. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83085. */
  83086. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83087. /**
  83088. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83089. * @param q1 defines the second operand
  83090. * @param result defines the target quaternion
  83091. * @returns the current quaternion
  83092. */
  83093. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83094. /**
  83095. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83096. * @param q1 defines the second operand
  83097. * @returns the currentupdated quaternion
  83098. */
  83099. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83100. /**
  83101. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83102. * @param ref defines the target quaternion
  83103. * @returns the current quaternion
  83104. */
  83105. conjugateToRef(ref: Quaternion): Quaternion;
  83106. /**
  83107. * Conjugates in place (1-q) the current quaternion
  83108. * @returns the current updated quaternion
  83109. */
  83110. conjugateInPlace(): Quaternion;
  83111. /**
  83112. * Conjugates in place (1-q) the current quaternion
  83113. * @returns a new quaternion
  83114. */
  83115. conjugate(): Quaternion;
  83116. /**
  83117. * Gets length of current quaternion
  83118. * @returns the quaternion length (float)
  83119. */
  83120. length(): number;
  83121. /**
  83122. * Normalize in place the current quaternion
  83123. * @returns the current updated quaternion
  83124. */
  83125. normalize(): Quaternion;
  83126. /**
  83127. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83128. * @param order is a reserved parameter and is ignore for now
  83129. * @returns a new Vector3 containing the Euler angles
  83130. */
  83131. toEulerAngles(order?: string): Vector3;
  83132. /**
  83133. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83134. * @param result defines the vector which will be filled with the Euler angles
  83135. * @param order is a reserved parameter and is ignore for now
  83136. * @returns the current unchanged quaternion
  83137. */
  83138. toEulerAnglesToRef(result: Vector3): Quaternion;
  83139. /**
  83140. * Updates the given rotation matrix with the current quaternion values
  83141. * @param result defines the target matrix
  83142. * @returns the current unchanged quaternion
  83143. */
  83144. toRotationMatrix(result: Matrix): Quaternion;
  83145. /**
  83146. * Updates the current quaternion from the given rotation matrix values
  83147. * @param matrix defines the source matrix
  83148. * @returns the current updated quaternion
  83149. */
  83150. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83151. /**
  83152. * Creates a new quaternion from a rotation matrix
  83153. * @param matrix defines the source matrix
  83154. * @returns a new quaternion created from the given rotation matrix values
  83155. */
  83156. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83157. /**
  83158. * Updates the given quaternion with the given rotation matrix values
  83159. * @param matrix defines the source matrix
  83160. * @param result defines the target quaternion
  83161. */
  83162. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83163. /**
  83164. * Returns the dot product (float) between the quaternions "left" and "right"
  83165. * @param left defines the left operand
  83166. * @param right defines the right operand
  83167. * @returns the dot product
  83168. */
  83169. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83170. /**
  83171. * Checks if the two quaternions are close to each other
  83172. * @param quat0 defines the first quaternion to check
  83173. * @param quat1 defines the second quaternion to check
  83174. * @returns true if the two quaternions are close to each other
  83175. */
  83176. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83177. /**
  83178. * Creates an empty quaternion
  83179. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83180. */
  83181. static Zero(): Quaternion;
  83182. /**
  83183. * Inverse a given quaternion
  83184. * @param q defines the source quaternion
  83185. * @returns a new quaternion as the inverted current quaternion
  83186. */
  83187. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83188. /**
  83189. * Inverse a given quaternion
  83190. * @param q defines the source quaternion
  83191. * @param result the quaternion the result will be stored in
  83192. * @returns the result quaternion
  83193. */
  83194. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83195. /**
  83196. * Creates an identity quaternion
  83197. * @returns the identity quaternion
  83198. */
  83199. static Identity(): Quaternion;
  83200. /**
  83201. * Gets a boolean indicating if the given quaternion is identity
  83202. * @param quaternion defines the quaternion to check
  83203. * @returns true if the quaternion is identity
  83204. */
  83205. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83206. /**
  83207. * Creates a quaternion from a rotation around an axis
  83208. * @param axis defines the axis to use
  83209. * @param angle defines the angle to use
  83210. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83211. */
  83212. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83213. /**
  83214. * Creates a rotation around an axis and stores it into the given quaternion
  83215. * @param axis defines the axis to use
  83216. * @param angle defines the angle to use
  83217. * @param result defines the target quaternion
  83218. * @returns the target quaternion
  83219. */
  83220. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83221. /**
  83222. * Creates a new quaternion from data stored into an array
  83223. * @param array defines the data source
  83224. * @param offset defines the offset in the source array where the data starts
  83225. * @returns a new quaternion
  83226. */
  83227. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83228. /**
  83229. * Updates the given quaternion "result" from the starting index of the given array.
  83230. * @param array the array to pull values from
  83231. * @param offset the offset into the array to start at
  83232. * @param result the quaternion to store the result in
  83233. */
  83234. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83235. /**
  83236. * Create a quaternion from Euler rotation angles
  83237. * @param x Pitch
  83238. * @param y Yaw
  83239. * @param z Roll
  83240. * @returns the new Quaternion
  83241. */
  83242. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83243. /**
  83244. * Updates a quaternion from Euler rotation angles
  83245. * @param x Pitch
  83246. * @param y Yaw
  83247. * @param z Roll
  83248. * @param result the quaternion to store the result
  83249. * @returns the updated quaternion
  83250. */
  83251. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83252. /**
  83253. * Create a quaternion from Euler rotation vector
  83254. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83255. * @returns the new Quaternion
  83256. */
  83257. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83258. /**
  83259. * Updates a quaternion from Euler rotation vector
  83260. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83261. * @param result the quaternion to store the result
  83262. * @returns the updated quaternion
  83263. */
  83264. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83265. /**
  83266. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83267. * @param yaw defines the rotation around Y axis
  83268. * @param pitch defines the rotation around X axis
  83269. * @param roll defines the rotation around Z axis
  83270. * @returns the new quaternion
  83271. */
  83272. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83273. /**
  83274. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83275. * @param yaw defines the rotation around Y axis
  83276. * @param pitch defines the rotation around X axis
  83277. * @param roll defines the rotation around Z axis
  83278. * @param result defines the target quaternion
  83279. */
  83280. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83281. /**
  83282. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83283. * @param alpha defines the rotation around first axis
  83284. * @param beta defines the rotation around second axis
  83285. * @param gamma defines the rotation around third axis
  83286. * @returns the new quaternion
  83287. */
  83288. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83289. /**
  83290. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83291. * @param alpha defines the rotation around first axis
  83292. * @param beta defines the rotation around second axis
  83293. * @param gamma defines the rotation around third axis
  83294. * @param result defines the target quaternion
  83295. */
  83296. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83297. /**
  83298. * 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)
  83299. * @param axis1 defines the first axis
  83300. * @param axis2 defines the second axis
  83301. * @param axis3 defines the third axis
  83302. * @returns the new quaternion
  83303. */
  83304. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83305. /**
  83306. * 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
  83307. * @param axis1 defines the first axis
  83308. * @param axis2 defines the second axis
  83309. * @param axis3 defines the third axis
  83310. * @param ref defines the target quaternion
  83311. */
  83312. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83313. /**
  83314. * Interpolates between two quaternions
  83315. * @param left defines first quaternion
  83316. * @param right defines second quaternion
  83317. * @param amount defines the gradient to use
  83318. * @returns the new interpolated quaternion
  83319. */
  83320. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83321. /**
  83322. * Interpolates between two quaternions and stores it into a target quaternion
  83323. * @param left defines first quaternion
  83324. * @param right defines second quaternion
  83325. * @param amount defines the gradient to use
  83326. * @param result defines the target quaternion
  83327. */
  83328. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83329. /**
  83330. * Interpolate between two quaternions using Hermite interpolation
  83331. * @param value1 defines first quaternion
  83332. * @param tangent1 defines the incoming tangent
  83333. * @param value2 defines second quaternion
  83334. * @param tangent2 defines the outgoing tangent
  83335. * @param amount defines the target quaternion
  83336. * @returns the new interpolated quaternion
  83337. */
  83338. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83339. }
  83340. /**
  83341. * Class used to store matrix data (4x4)
  83342. */
  83343. export class Matrix {
  83344. /**
  83345. * Gets the precision of matrix computations
  83346. */
  83347. static get Use64Bits(): boolean;
  83348. private static _updateFlagSeed;
  83349. private static _identityReadOnly;
  83350. private _isIdentity;
  83351. private _isIdentityDirty;
  83352. private _isIdentity3x2;
  83353. private _isIdentity3x2Dirty;
  83354. /**
  83355. * Gets the update flag of the matrix which is an unique number for the matrix.
  83356. * It will be incremented every time the matrix data change.
  83357. * You can use it to speed the comparison between two versions of the same matrix.
  83358. */
  83359. updateFlag: number;
  83360. private readonly _m;
  83361. /**
  83362. * Gets the internal data of the matrix
  83363. */
  83364. get m(): DeepImmutable<Float32Array | Array<number>>;
  83365. /** @hidden */
  83366. _markAsUpdated(): void;
  83367. /** @hidden */
  83368. private _updateIdentityStatus;
  83369. /**
  83370. * Creates an empty matrix (filled with zeros)
  83371. */
  83372. constructor();
  83373. /**
  83374. * Check if the current matrix is identity
  83375. * @returns true is the matrix is the identity matrix
  83376. */
  83377. isIdentity(): boolean;
  83378. /**
  83379. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83380. * @returns true is the matrix is the identity matrix
  83381. */
  83382. isIdentityAs3x2(): boolean;
  83383. /**
  83384. * Gets the determinant of the matrix
  83385. * @returns the matrix determinant
  83386. */
  83387. determinant(): number;
  83388. /**
  83389. * Returns the matrix as a Float32Array or Array<number>
  83390. * @returns the matrix underlying array
  83391. */
  83392. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83393. /**
  83394. * Returns the matrix as a Float32Array or Array<number>
  83395. * @returns the matrix underlying array.
  83396. */
  83397. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83398. /**
  83399. * Inverts the current matrix in place
  83400. * @returns the current inverted matrix
  83401. */
  83402. invert(): Matrix;
  83403. /**
  83404. * Sets all the matrix elements to zero
  83405. * @returns the current matrix
  83406. */
  83407. reset(): Matrix;
  83408. /**
  83409. * Adds the current matrix with a second one
  83410. * @param other defines the matrix to add
  83411. * @returns a new matrix as the addition of the current matrix and the given one
  83412. */
  83413. add(other: DeepImmutable<Matrix>): Matrix;
  83414. /**
  83415. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83416. * @param other defines the matrix to add
  83417. * @param result defines the target matrix
  83418. * @returns the current matrix
  83419. */
  83420. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83421. /**
  83422. * Adds in place the given matrix to the current matrix
  83423. * @param other defines the second operand
  83424. * @returns the current updated matrix
  83425. */
  83426. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83427. /**
  83428. * Sets the given matrix to the current inverted Matrix
  83429. * @param other defines the target matrix
  83430. * @returns the unmodified current matrix
  83431. */
  83432. invertToRef(other: Matrix): Matrix;
  83433. /**
  83434. * add a value at the specified position in the current Matrix
  83435. * @param index the index of the value within the matrix. between 0 and 15.
  83436. * @param value the value to be added
  83437. * @returns the current updated matrix
  83438. */
  83439. addAtIndex(index: number, value: number): Matrix;
  83440. /**
  83441. * mutiply the specified position in the current Matrix by a value
  83442. * @param index the index of the value within the matrix. between 0 and 15.
  83443. * @param value the value to be added
  83444. * @returns the current updated matrix
  83445. */
  83446. multiplyAtIndex(index: number, value: number): Matrix;
  83447. /**
  83448. * Inserts the translation vector (using 3 floats) in the current matrix
  83449. * @param x defines the 1st component of the translation
  83450. * @param y defines the 2nd component of the translation
  83451. * @param z defines the 3rd component of the translation
  83452. * @returns the current updated matrix
  83453. */
  83454. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83455. /**
  83456. * Adds the translation vector (using 3 floats) in the current matrix
  83457. * @param x defines the 1st component of the translation
  83458. * @param y defines the 2nd component of the translation
  83459. * @param z defines the 3rd component of the translation
  83460. * @returns the current updated matrix
  83461. */
  83462. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83463. /**
  83464. * Inserts the translation vector in the current matrix
  83465. * @param vector3 defines the translation to insert
  83466. * @returns the current updated matrix
  83467. */
  83468. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83469. /**
  83470. * Gets the translation value of the current matrix
  83471. * @returns a new Vector3 as the extracted translation from the matrix
  83472. */
  83473. getTranslation(): Vector3;
  83474. /**
  83475. * Fill a Vector3 with the extracted translation from the matrix
  83476. * @param result defines the Vector3 where to store the translation
  83477. * @returns the current matrix
  83478. */
  83479. getTranslationToRef(result: Vector3): Matrix;
  83480. /**
  83481. * Remove rotation and scaling part from the matrix
  83482. * @returns the updated matrix
  83483. */
  83484. removeRotationAndScaling(): Matrix;
  83485. /**
  83486. * Multiply two matrices
  83487. * @param other defines the second operand
  83488. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83489. */
  83490. multiply(other: DeepImmutable<Matrix>): Matrix;
  83491. /**
  83492. * Copy the current matrix from the given one
  83493. * @param other defines the source matrix
  83494. * @returns the current updated matrix
  83495. */
  83496. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83497. /**
  83498. * Populates the given array from the starting index with the current matrix values
  83499. * @param array defines the target array
  83500. * @param offset defines the offset in the target array where to start storing values
  83501. * @returns the current matrix
  83502. */
  83503. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83504. /**
  83505. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83506. * @param other defines the second operand
  83507. * @param result defines the matrix where to store the multiplication
  83508. * @returns the current matrix
  83509. */
  83510. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83511. /**
  83512. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83513. * @param other defines the second operand
  83514. * @param result defines the array where to store the multiplication
  83515. * @param offset defines the offset in the target array where to start storing values
  83516. * @returns the current matrix
  83517. */
  83518. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83519. /**
  83520. * Check equality between this matrix and a second one
  83521. * @param value defines the second matrix to compare
  83522. * @returns true is the current matrix and the given one values are strictly equal
  83523. */
  83524. equals(value: DeepImmutable<Matrix>): boolean;
  83525. /**
  83526. * Clone the current matrix
  83527. * @returns a new matrix from the current matrix
  83528. */
  83529. clone(): Matrix;
  83530. /**
  83531. * Returns the name of the current matrix class
  83532. * @returns the string "Matrix"
  83533. */
  83534. getClassName(): string;
  83535. /**
  83536. * Gets the hash code of the current matrix
  83537. * @returns the hash code
  83538. */
  83539. getHashCode(): number;
  83540. /**
  83541. * Decomposes the current Matrix into a translation, rotation and scaling components
  83542. * @param scale defines the scale vector3 given as a reference to update
  83543. * @param rotation defines the rotation quaternion given as a reference to update
  83544. * @param translation defines the translation vector3 given as a reference to update
  83545. * @returns true if operation was successful
  83546. */
  83547. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83548. /**
  83549. * Gets specific row of the matrix
  83550. * @param index defines the number of the row to get
  83551. * @returns the index-th row of the current matrix as a new Vector4
  83552. */
  83553. getRow(index: number): Nullable<Vector4>;
  83554. /**
  83555. * Sets the index-th row of the current matrix to the vector4 values
  83556. * @param index defines the number of the row to set
  83557. * @param row defines the target vector4
  83558. * @returns the updated current matrix
  83559. */
  83560. setRow(index: number, row: Vector4): Matrix;
  83561. /**
  83562. * Compute the transpose of the matrix
  83563. * @returns the new transposed matrix
  83564. */
  83565. transpose(): Matrix;
  83566. /**
  83567. * Compute the transpose of the matrix and store it in a given matrix
  83568. * @param result defines the target matrix
  83569. * @returns the current matrix
  83570. */
  83571. transposeToRef(result: Matrix): Matrix;
  83572. /**
  83573. * Sets the index-th row of the current matrix with the given 4 x float values
  83574. * @param index defines the row index
  83575. * @param x defines the x component to set
  83576. * @param y defines the y component to set
  83577. * @param z defines the z component to set
  83578. * @param w defines the w component to set
  83579. * @returns the updated current matrix
  83580. */
  83581. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  83582. /**
  83583. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  83584. * @param scale defines the scale factor
  83585. * @returns a new matrix
  83586. */
  83587. scale(scale: number): Matrix;
  83588. /**
  83589. * Scale the current matrix values by a factor to a given result matrix
  83590. * @param scale defines the scale factor
  83591. * @param result defines the matrix to store the result
  83592. * @returns the current matrix
  83593. */
  83594. scaleToRef(scale: number, result: Matrix): Matrix;
  83595. /**
  83596. * Scale the current matrix values by a factor and add the result to a given matrix
  83597. * @param scale defines the scale factor
  83598. * @param result defines the Matrix to store the result
  83599. * @returns the current matrix
  83600. */
  83601. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  83602. /**
  83603. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  83604. * @param ref matrix to store the result
  83605. */
  83606. toNormalMatrix(ref: Matrix): void;
  83607. /**
  83608. * Gets only rotation part of the current matrix
  83609. * @returns a new matrix sets to the extracted rotation matrix from the current one
  83610. */
  83611. getRotationMatrix(): Matrix;
  83612. /**
  83613. * Extracts the rotation matrix from the current one and sets it as the given "result"
  83614. * @param result defines the target matrix to store data to
  83615. * @returns the current matrix
  83616. */
  83617. getRotationMatrixToRef(result: Matrix): Matrix;
  83618. /**
  83619. * Toggles model matrix from being right handed to left handed in place and vice versa
  83620. */
  83621. toggleModelMatrixHandInPlace(): void;
  83622. /**
  83623. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83624. */
  83625. toggleProjectionMatrixHandInPlace(): void;
  83626. /**
  83627. * Creates a matrix from an array
  83628. * @param array defines the source array
  83629. * @param offset defines an offset in the source array
  83630. * @returns a new Matrix set from the starting index of the given array
  83631. */
  83632. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83633. /**
  83634. * Copy the content of an array into a given matrix
  83635. * @param array defines the source array
  83636. * @param offset defines an offset in the source array
  83637. * @param result defines the target matrix
  83638. */
  83639. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  83640. /**
  83641. * Stores an array into a matrix after having multiplied each component by a given factor
  83642. * @param array defines the source array
  83643. * @param offset defines the offset in the source array
  83644. * @param scale defines the scaling factor
  83645. * @param result defines the target matrix
  83646. */
  83647. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  83648. /**
  83649. * Gets an identity matrix that must not be updated
  83650. */
  83651. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  83652. /**
  83653. * Stores a list of values (16) inside a given matrix
  83654. * @param initialM11 defines 1st value of 1st row
  83655. * @param initialM12 defines 2nd value of 1st row
  83656. * @param initialM13 defines 3rd value of 1st row
  83657. * @param initialM14 defines 4th value of 1st row
  83658. * @param initialM21 defines 1st value of 2nd row
  83659. * @param initialM22 defines 2nd value of 2nd row
  83660. * @param initialM23 defines 3rd value of 2nd row
  83661. * @param initialM24 defines 4th value of 2nd row
  83662. * @param initialM31 defines 1st value of 3rd row
  83663. * @param initialM32 defines 2nd value of 3rd row
  83664. * @param initialM33 defines 3rd value of 3rd row
  83665. * @param initialM34 defines 4th value of 3rd row
  83666. * @param initialM41 defines 1st value of 4th row
  83667. * @param initialM42 defines 2nd value of 4th row
  83668. * @param initialM43 defines 3rd value of 4th row
  83669. * @param initialM44 defines 4th value of 4th row
  83670. * @param result defines the target matrix
  83671. */
  83672. 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;
  83673. /**
  83674. * Creates new matrix from a list of values (16)
  83675. * @param initialM11 defines 1st value of 1st row
  83676. * @param initialM12 defines 2nd value of 1st row
  83677. * @param initialM13 defines 3rd value of 1st row
  83678. * @param initialM14 defines 4th value of 1st row
  83679. * @param initialM21 defines 1st value of 2nd row
  83680. * @param initialM22 defines 2nd value of 2nd row
  83681. * @param initialM23 defines 3rd value of 2nd row
  83682. * @param initialM24 defines 4th value of 2nd row
  83683. * @param initialM31 defines 1st value of 3rd row
  83684. * @param initialM32 defines 2nd value of 3rd row
  83685. * @param initialM33 defines 3rd value of 3rd row
  83686. * @param initialM34 defines 4th value of 3rd row
  83687. * @param initialM41 defines 1st value of 4th row
  83688. * @param initialM42 defines 2nd value of 4th row
  83689. * @param initialM43 defines 3rd value of 4th row
  83690. * @param initialM44 defines 4th value of 4th row
  83691. * @returns the new matrix
  83692. */
  83693. 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;
  83694. /**
  83695. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  83696. * @param scale defines the scale vector3
  83697. * @param rotation defines the rotation quaternion
  83698. * @param translation defines the translation vector3
  83699. * @returns a new matrix
  83700. */
  83701. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  83702. /**
  83703. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  83704. * @param scale defines the scale vector3
  83705. * @param rotation defines the rotation quaternion
  83706. * @param translation defines the translation vector3
  83707. * @param result defines the target matrix
  83708. */
  83709. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  83710. /**
  83711. * Creates a new identity matrix
  83712. * @returns a new identity matrix
  83713. */
  83714. static Identity(): Matrix;
  83715. /**
  83716. * Creates a new identity matrix and stores the result in a given matrix
  83717. * @param result defines the target matrix
  83718. */
  83719. static IdentityToRef(result: Matrix): void;
  83720. /**
  83721. * Creates a new zero matrix
  83722. * @returns a new zero matrix
  83723. */
  83724. static Zero(): Matrix;
  83725. /**
  83726. * Creates a new rotation matrix for "angle" radians around the X axis
  83727. * @param angle defines the angle (in radians) to use
  83728. * @return the new matrix
  83729. */
  83730. static RotationX(angle: number): Matrix;
  83731. /**
  83732. * Creates a new matrix as the invert of a given matrix
  83733. * @param source defines the source matrix
  83734. * @returns the new matrix
  83735. */
  83736. static Invert(source: DeepImmutable<Matrix>): Matrix;
  83737. /**
  83738. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  83739. * @param angle defines the angle (in radians) to use
  83740. * @param result defines the target matrix
  83741. */
  83742. static RotationXToRef(angle: number, result: Matrix): void;
  83743. /**
  83744. * Creates a new rotation matrix for "angle" radians around the Y axis
  83745. * @param angle defines the angle (in radians) to use
  83746. * @return the new matrix
  83747. */
  83748. static RotationY(angle: number): Matrix;
  83749. /**
  83750. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  83751. * @param angle defines the angle (in radians) to use
  83752. * @param result defines the target matrix
  83753. */
  83754. static RotationYToRef(angle: number, result: Matrix): void;
  83755. /**
  83756. * Creates a new rotation matrix for "angle" radians around the Z axis
  83757. * @param angle defines the angle (in radians) to use
  83758. * @return the new matrix
  83759. */
  83760. static RotationZ(angle: number): Matrix;
  83761. /**
  83762. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  83763. * @param angle defines the angle (in radians) to use
  83764. * @param result defines the target matrix
  83765. */
  83766. static RotationZToRef(angle: number, result: Matrix): void;
  83767. /**
  83768. * Creates a new rotation matrix for "angle" radians around the given axis
  83769. * @param axis defines the axis to use
  83770. * @param angle defines the angle (in radians) to use
  83771. * @return the new matrix
  83772. */
  83773. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  83774. /**
  83775. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  83776. * @param axis defines the axis to use
  83777. * @param angle defines the angle (in radians) to use
  83778. * @param result defines the target matrix
  83779. */
  83780. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  83781. /**
  83782. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  83783. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  83784. * @param from defines the vector to align
  83785. * @param to defines the vector to align to
  83786. * @param result defines the target matrix
  83787. */
  83788. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  83789. /**
  83790. * Creates a rotation matrix
  83791. * @param yaw defines the yaw angle in radians (Y axis)
  83792. * @param pitch defines the pitch angle in radians (X axis)
  83793. * @param roll defines the roll angle in radians (Z axis)
  83794. * @returns the new rotation matrix
  83795. */
  83796. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  83797. /**
  83798. * Creates a rotation matrix and stores it in a given matrix
  83799. * @param yaw defines the yaw angle in radians (Y axis)
  83800. * @param pitch defines the pitch angle in radians (X axis)
  83801. * @param roll defines the roll angle in radians (Z axis)
  83802. * @param result defines the target matrix
  83803. */
  83804. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  83805. /**
  83806. * Creates a scaling matrix
  83807. * @param x defines the scale factor on X axis
  83808. * @param y defines the scale factor on Y axis
  83809. * @param z defines the scale factor on Z axis
  83810. * @returns the new matrix
  83811. */
  83812. static Scaling(x: number, y: number, z: number): Matrix;
  83813. /**
  83814. * Creates a scaling matrix and stores it in a given matrix
  83815. * @param x defines the scale factor on X axis
  83816. * @param y defines the scale factor on Y axis
  83817. * @param z defines the scale factor on Z axis
  83818. * @param result defines the target matrix
  83819. */
  83820. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  83821. /**
  83822. * Creates a translation matrix
  83823. * @param x defines the translation on X axis
  83824. * @param y defines the translation on Y axis
  83825. * @param z defines the translationon Z axis
  83826. * @returns the new matrix
  83827. */
  83828. static Translation(x: number, y: number, z: number): Matrix;
  83829. /**
  83830. * Creates a translation matrix and stores it in a given matrix
  83831. * @param x defines the translation on X axis
  83832. * @param y defines the translation on Y axis
  83833. * @param z defines the translationon Z axis
  83834. * @param result defines the target matrix
  83835. */
  83836. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  83837. /**
  83838. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  83839. * @param startValue defines the start value
  83840. * @param endValue defines the end value
  83841. * @param gradient defines the gradient factor
  83842. * @returns the new matrix
  83843. */
  83844. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  83845. /**
  83846. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  83847. * @param startValue defines the start value
  83848. * @param endValue defines the end value
  83849. * @param gradient defines the gradient factor
  83850. * @param result defines the Matrix object where to store data
  83851. */
  83852. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  83853. /**
  83854. * Builds a new matrix whose values are computed by:
  83855. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  83856. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  83857. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  83858. * @param startValue defines the first matrix
  83859. * @param endValue defines the second matrix
  83860. * @param gradient defines the gradient between the two matrices
  83861. * @returns the new matrix
  83862. */
  83863. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  83864. /**
  83865. * Update a matrix to values which are computed by:
  83866. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  83867. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  83868. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  83869. * @param startValue defines the first matrix
  83870. * @param endValue defines the second matrix
  83871. * @param gradient defines the gradient between the two matrices
  83872. * @param result defines the target matrix
  83873. */
  83874. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  83875. /**
  83876. * 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"
  83877. * This function works in left handed mode
  83878. * @param eye defines the final position of the entity
  83879. * @param target defines where the entity should look at
  83880. * @param up defines the up vector for the entity
  83881. * @returns the new matrix
  83882. */
  83883. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  83884. /**
  83885. * 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".
  83886. * This function works in left handed mode
  83887. * @param eye defines the final position of the entity
  83888. * @param target defines where the entity should look at
  83889. * @param up defines the up vector for the entity
  83890. * @param result defines the target matrix
  83891. */
  83892. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  83893. /**
  83894. * 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"
  83895. * This function works in right handed mode
  83896. * @param eye defines the final position of the entity
  83897. * @param target defines where the entity should look at
  83898. * @param up defines the up vector for the entity
  83899. * @returns the new matrix
  83900. */
  83901. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  83902. /**
  83903. * 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".
  83904. * This function works in right handed mode
  83905. * @param eye defines the final position of the entity
  83906. * @param target defines where the entity should look at
  83907. * @param up defines the up vector for the entity
  83908. * @param result defines the target matrix
  83909. */
  83910. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  83911. /**
  83912. * Create a left-handed orthographic projection matrix
  83913. * @param width defines the viewport width
  83914. * @param height defines the viewport height
  83915. * @param znear defines the near clip plane
  83916. * @param zfar defines the far clip plane
  83917. * @returns a new matrix as a left-handed orthographic projection matrix
  83918. */
  83919. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  83920. /**
  83921. * Store a left-handed orthographic projection to a given matrix
  83922. * @param width defines the viewport width
  83923. * @param height defines the viewport height
  83924. * @param znear defines the near clip plane
  83925. * @param zfar defines the far clip plane
  83926. * @param result defines the target matrix
  83927. */
  83928. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  83929. /**
  83930. * Create a left-handed orthographic projection matrix
  83931. * @param left defines the viewport left coordinate
  83932. * @param right defines the viewport right coordinate
  83933. * @param bottom defines the viewport bottom coordinate
  83934. * @param top defines the viewport top coordinate
  83935. * @param znear defines the near clip plane
  83936. * @param zfar defines the far clip plane
  83937. * @returns a new matrix as a left-handed orthographic projection matrix
  83938. */
  83939. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  83940. /**
  83941. * Stores a left-handed orthographic projection into a given matrix
  83942. * @param left defines the viewport left coordinate
  83943. * @param right defines the viewport right coordinate
  83944. * @param bottom defines the viewport bottom coordinate
  83945. * @param top defines the viewport top coordinate
  83946. * @param znear defines the near clip plane
  83947. * @param zfar defines the far clip plane
  83948. * @param result defines the target matrix
  83949. */
  83950. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  83951. /**
  83952. * Creates a right-handed orthographic projection matrix
  83953. * @param left defines the viewport left coordinate
  83954. * @param right defines the viewport right coordinate
  83955. * @param bottom defines the viewport bottom coordinate
  83956. * @param top defines the viewport top coordinate
  83957. * @param znear defines the near clip plane
  83958. * @param zfar defines the far clip plane
  83959. * @returns a new matrix as a right-handed orthographic projection matrix
  83960. */
  83961. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  83962. /**
  83963. * Stores a right-handed orthographic projection into a given matrix
  83964. * @param left defines the viewport left coordinate
  83965. * @param right defines the viewport right coordinate
  83966. * @param bottom defines the viewport bottom coordinate
  83967. * @param top defines the viewport top coordinate
  83968. * @param znear defines the near clip plane
  83969. * @param zfar defines the far clip plane
  83970. * @param result defines the target matrix
  83971. */
  83972. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  83973. /**
  83974. * Creates a left-handed perspective projection matrix
  83975. * @param width defines the viewport width
  83976. * @param height defines the viewport height
  83977. * @param znear defines the near clip plane
  83978. * @param zfar defines the far clip plane
  83979. * @returns a new matrix as a left-handed perspective projection matrix
  83980. */
  83981. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  83982. /**
  83983. * Creates a left-handed perspective projection matrix
  83984. * @param fov defines the horizontal field of view
  83985. * @param aspect defines the aspect ratio
  83986. * @param znear defines the near clip plane
  83987. * @param zfar defines the far clip plane
  83988. * @returns a new matrix as a left-handed perspective projection matrix
  83989. */
  83990. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  83991. /**
  83992. * Stores a left-handed perspective projection into a given matrix
  83993. * @param fov defines the horizontal field of view
  83994. * @param aspect defines the aspect ratio
  83995. * @param znear defines the near clip plane
  83996. * @param zfar defines the far clip plane
  83997. * @param result defines the target matrix
  83998. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83999. */
  84000. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84001. /**
  84002. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84003. * @param fov defines the horizontal field of view
  84004. * @param aspect defines the aspect ratio
  84005. * @param znear defines the near clip plane
  84006. * @param zfar not used as infinity is used as far clip
  84007. * @param result defines the target matrix
  84008. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84009. */
  84010. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84011. /**
  84012. * Creates a right-handed perspective projection matrix
  84013. * @param fov defines the horizontal field of view
  84014. * @param aspect defines the aspect ratio
  84015. * @param znear defines the near clip plane
  84016. * @param zfar defines the far clip plane
  84017. * @returns a new matrix as a right-handed perspective projection matrix
  84018. */
  84019. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84020. /**
  84021. * Stores a right-handed perspective projection into a given matrix
  84022. * @param fov defines the horizontal field of view
  84023. * @param aspect defines the aspect ratio
  84024. * @param znear defines the near clip plane
  84025. * @param zfar defines the far clip plane
  84026. * @param result defines the target matrix
  84027. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84028. */
  84029. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84030. /**
  84031. * Stores a right-handed perspective projection into a given matrix
  84032. * @param fov defines the horizontal field of view
  84033. * @param aspect defines the aspect ratio
  84034. * @param znear defines the near clip plane
  84035. * @param zfar not used as infinity is used as far clip
  84036. * @param result defines the target matrix
  84037. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84038. */
  84039. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84040. /**
  84041. * Stores a perspective projection for WebVR info a given matrix
  84042. * @param fov defines the field of view
  84043. * @param znear defines the near clip plane
  84044. * @param zfar defines the far clip plane
  84045. * @param result defines the target matrix
  84046. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84047. */
  84048. static PerspectiveFovWebVRToRef(fov: {
  84049. upDegrees: number;
  84050. downDegrees: number;
  84051. leftDegrees: number;
  84052. rightDegrees: number;
  84053. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84054. /**
  84055. * Computes a complete transformation matrix
  84056. * @param viewport defines the viewport to use
  84057. * @param world defines the world matrix
  84058. * @param view defines the view matrix
  84059. * @param projection defines the projection matrix
  84060. * @param zmin defines the near clip plane
  84061. * @param zmax defines the far clip plane
  84062. * @returns the transformation matrix
  84063. */
  84064. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84065. /**
  84066. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84067. * @param matrix defines the matrix to use
  84068. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84069. */
  84070. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84071. /**
  84072. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84073. * @param matrix defines the matrix to use
  84074. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84075. */
  84076. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84077. /**
  84078. * Compute the transpose of a given matrix
  84079. * @param matrix defines the matrix to transpose
  84080. * @returns the new matrix
  84081. */
  84082. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84083. /**
  84084. * Compute the transpose of a matrix and store it in a target matrix
  84085. * @param matrix defines the matrix to transpose
  84086. * @param result defines the target matrix
  84087. */
  84088. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84089. /**
  84090. * Computes a reflection matrix from a plane
  84091. * @param plane defines the reflection plane
  84092. * @returns a new matrix
  84093. */
  84094. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84095. /**
  84096. * Computes a reflection matrix from a plane
  84097. * @param plane defines the reflection plane
  84098. * @param result defines the target matrix
  84099. */
  84100. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84101. /**
  84102. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84103. * @param xaxis defines the value of the 1st axis
  84104. * @param yaxis defines the value of the 2nd axis
  84105. * @param zaxis defines the value of the 3rd axis
  84106. * @param result defines the target matrix
  84107. */
  84108. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84109. /**
  84110. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84111. * @param quat defines the quaternion to use
  84112. * @param result defines the target matrix
  84113. */
  84114. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84115. }
  84116. /**
  84117. * @hidden
  84118. */
  84119. export class TmpVectors {
  84120. static Vector2: Vector2[];
  84121. static Vector3: Vector3[];
  84122. static Vector4: Vector4[];
  84123. static Quaternion: Quaternion[];
  84124. static Matrix: Matrix[];
  84125. }
  84126. }
  84127. declare module BABYLON {
  84128. /**
  84129. * Defines potential orientation for back face culling
  84130. */
  84131. export enum Orientation {
  84132. /**
  84133. * Clockwise
  84134. */
  84135. CW = 0,
  84136. /** Counter clockwise */
  84137. CCW = 1
  84138. }
  84139. /** Class used to represent a Bezier curve */
  84140. export class BezierCurve {
  84141. /**
  84142. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84143. * @param t defines the time
  84144. * @param x1 defines the left coordinate on X axis
  84145. * @param y1 defines the left coordinate on Y axis
  84146. * @param x2 defines the right coordinate on X axis
  84147. * @param y2 defines the right coordinate on Y axis
  84148. * @returns the interpolated value
  84149. */
  84150. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84151. }
  84152. /**
  84153. * Defines angle representation
  84154. */
  84155. export class Angle {
  84156. private _radians;
  84157. /**
  84158. * Creates an Angle object of "radians" radians (float).
  84159. * @param radians the angle in radians
  84160. */
  84161. constructor(radians: number);
  84162. /**
  84163. * Get value in degrees
  84164. * @returns the Angle value in degrees (float)
  84165. */
  84166. degrees(): number;
  84167. /**
  84168. * Get value in radians
  84169. * @returns the Angle value in radians (float)
  84170. */
  84171. radians(): number;
  84172. /**
  84173. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84174. * @param a defines first point as the origin
  84175. * @param b defines point
  84176. * @returns a new Angle
  84177. */
  84178. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84179. /**
  84180. * Gets a new Angle object from the given float in radians
  84181. * @param radians defines the angle value in radians
  84182. * @returns a new Angle
  84183. */
  84184. static FromRadians(radians: number): Angle;
  84185. /**
  84186. * Gets a new Angle object from the given float in degrees
  84187. * @param degrees defines the angle value in degrees
  84188. * @returns a new Angle
  84189. */
  84190. static FromDegrees(degrees: number): Angle;
  84191. }
  84192. /**
  84193. * This represents an arc in a 2d space.
  84194. */
  84195. export class Arc2 {
  84196. /** Defines the start point of the arc */
  84197. startPoint: Vector2;
  84198. /** Defines the mid point of the arc */
  84199. midPoint: Vector2;
  84200. /** Defines the end point of the arc */
  84201. endPoint: Vector2;
  84202. /**
  84203. * Defines the center point of the arc.
  84204. */
  84205. centerPoint: Vector2;
  84206. /**
  84207. * Defines the radius of the arc.
  84208. */
  84209. radius: number;
  84210. /**
  84211. * Defines the angle of the arc (from mid point to end point).
  84212. */
  84213. angle: Angle;
  84214. /**
  84215. * Defines the start angle of the arc (from start point to middle point).
  84216. */
  84217. startAngle: Angle;
  84218. /**
  84219. * Defines the orientation of the arc (clock wise/counter clock wise).
  84220. */
  84221. orientation: Orientation;
  84222. /**
  84223. * Creates an Arc object from the three given points : start, middle and end.
  84224. * @param startPoint Defines the start point of the arc
  84225. * @param midPoint Defines the midlle point of the arc
  84226. * @param endPoint Defines the end point of the arc
  84227. */
  84228. constructor(
  84229. /** Defines the start point of the arc */
  84230. startPoint: Vector2,
  84231. /** Defines the mid point of the arc */
  84232. midPoint: Vector2,
  84233. /** Defines the end point of the arc */
  84234. endPoint: Vector2);
  84235. }
  84236. /**
  84237. * Represents a 2D path made up of multiple 2D points
  84238. */
  84239. export class Path2 {
  84240. private _points;
  84241. private _length;
  84242. /**
  84243. * If the path start and end point are the same
  84244. */
  84245. closed: boolean;
  84246. /**
  84247. * Creates a Path2 object from the starting 2D coordinates x and y.
  84248. * @param x the starting points x value
  84249. * @param y the starting points y value
  84250. */
  84251. constructor(x: number, y: number);
  84252. /**
  84253. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84254. * @param x the added points x value
  84255. * @param y the added points y value
  84256. * @returns the updated Path2.
  84257. */
  84258. addLineTo(x: number, y: number): Path2;
  84259. /**
  84260. * 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.
  84261. * @param midX middle point x value
  84262. * @param midY middle point y value
  84263. * @param endX end point x value
  84264. * @param endY end point y value
  84265. * @param numberOfSegments (default: 36)
  84266. * @returns the updated Path2.
  84267. */
  84268. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84269. /**
  84270. * Closes the Path2.
  84271. * @returns the Path2.
  84272. */
  84273. close(): Path2;
  84274. /**
  84275. * Gets the sum of the distance between each sequential point in the path
  84276. * @returns the Path2 total length (float).
  84277. */
  84278. length(): number;
  84279. /**
  84280. * Gets the points which construct the path
  84281. * @returns the Path2 internal array of points.
  84282. */
  84283. getPoints(): Vector2[];
  84284. /**
  84285. * Retreives the point at the distance aways from the starting point
  84286. * @param normalizedLengthPosition the length along the path to retreive the point from
  84287. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84288. */
  84289. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84290. /**
  84291. * Creates a new path starting from an x and y position
  84292. * @param x starting x value
  84293. * @param y starting y value
  84294. * @returns a new Path2 starting at the coordinates (x, y).
  84295. */
  84296. static StartingAt(x: number, y: number): Path2;
  84297. }
  84298. /**
  84299. * Represents a 3D path made up of multiple 3D points
  84300. */
  84301. export class Path3D {
  84302. /**
  84303. * an array of Vector3, the curve axis of the Path3D
  84304. */
  84305. path: Vector3[];
  84306. private _curve;
  84307. private _distances;
  84308. private _tangents;
  84309. private _normals;
  84310. private _binormals;
  84311. private _raw;
  84312. private _alignTangentsWithPath;
  84313. private readonly _pointAtData;
  84314. /**
  84315. * new Path3D(path, normal, raw)
  84316. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84317. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84318. * @param path an array of Vector3, the curve axis of the Path3D
  84319. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84320. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84321. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84322. */
  84323. constructor(
  84324. /**
  84325. * an array of Vector3, the curve axis of the Path3D
  84326. */
  84327. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84328. /**
  84329. * Returns the Path3D array of successive Vector3 designing its curve.
  84330. * @returns the Path3D array of successive Vector3 designing its curve.
  84331. */
  84332. getCurve(): Vector3[];
  84333. /**
  84334. * Returns the Path3D array of successive Vector3 designing its curve.
  84335. * @returns the Path3D array of successive Vector3 designing its curve.
  84336. */
  84337. getPoints(): Vector3[];
  84338. /**
  84339. * @returns the computed length (float) of the path.
  84340. */
  84341. length(): number;
  84342. /**
  84343. * Returns an array populated with tangent vectors on each Path3D curve point.
  84344. * @returns an array populated with tangent vectors on each Path3D curve point.
  84345. */
  84346. getTangents(): Vector3[];
  84347. /**
  84348. * Returns an array populated with normal vectors on each Path3D curve point.
  84349. * @returns an array populated with normal vectors on each Path3D curve point.
  84350. */
  84351. getNormals(): Vector3[];
  84352. /**
  84353. * Returns an array populated with binormal vectors on each Path3D curve point.
  84354. * @returns an array populated with binormal vectors on each Path3D curve point.
  84355. */
  84356. getBinormals(): Vector3[];
  84357. /**
  84358. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84359. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84360. */
  84361. getDistances(): number[];
  84362. /**
  84363. * Returns an interpolated point along this path
  84364. * @param position the position of the point along this path, from 0.0 to 1.0
  84365. * @returns a new Vector3 as the point
  84366. */
  84367. getPointAt(position: number): Vector3;
  84368. /**
  84369. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84370. * @param position the position of the point along this path, from 0.0 to 1.0
  84371. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84372. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84373. */
  84374. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84375. /**
  84376. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84377. * @param position the position of the point along this path, from 0.0 to 1.0
  84378. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84379. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84380. */
  84381. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84382. /**
  84383. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84384. * @param position the position of the point along this path, from 0.0 to 1.0
  84385. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84386. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84387. */
  84388. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84389. /**
  84390. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84391. * @param position the position of the point along this path, from 0.0 to 1.0
  84392. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84393. */
  84394. getDistanceAt(position: number): number;
  84395. /**
  84396. * Returns the array index of the previous point of an interpolated point along this path
  84397. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84398. * @returns the array index
  84399. */
  84400. getPreviousPointIndexAt(position: number): number;
  84401. /**
  84402. * 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)
  84403. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84404. * @returns the sub position
  84405. */
  84406. getSubPositionAt(position: number): number;
  84407. /**
  84408. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84409. * @param target the vector of which to get the closest position to
  84410. * @returns the position of the closest virtual point on this path to the target vector
  84411. */
  84412. getClosestPositionTo(target: Vector3): number;
  84413. /**
  84414. * Returns a sub path (slice) of this path
  84415. * @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
  84416. * @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
  84417. * @returns a sub path (slice) of this path
  84418. */
  84419. slice(start?: number, end?: number): Path3D;
  84420. /**
  84421. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84422. * @param path path which all values are copied into the curves points
  84423. * @param firstNormal which should be projected onto the curve
  84424. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84425. * @returns the same object updated.
  84426. */
  84427. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84428. private _compute;
  84429. private _getFirstNonNullVector;
  84430. private _getLastNonNullVector;
  84431. private _normalVector;
  84432. /**
  84433. * Updates the point at data for an interpolated point along this curve
  84434. * @param position the position of the point along this curve, from 0.0 to 1.0
  84435. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84436. * @returns the (updated) point at data
  84437. */
  84438. private _updatePointAtData;
  84439. /**
  84440. * Updates the point at data from the specified parameters
  84441. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84442. * @param point the interpolated point
  84443. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84444. */
  84445. private _setPointAtData;
  84446. /**
  84447. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84448. */
  84449. private _updateInterpolationMatrix;
  84450. }
  84451. /**
  84452. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84453. * A Curve3 is designed from a series of successive Vector3.
  84454. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84455. */
  84456. export class Curve3 {
  84457. private _points;
  84458. private _length;
  84459. /**
  84460. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84461. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84462. * @param v1 (Vector3) the control point
  84463. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84464. * @param nbPoints (integer) the wanted number of points in the curve
  84465. * @returns the created Curve3
  84466. */
  84467. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84468. /**
  84469. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84470. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84471. * @param v1 (Vector3) the first control point
  84472. * @param v2 (Vector3) the second control point
  84473. * @param v3 (Vector3) the end point of the Cubic Bezier
  84474. * @param nbPoints (integer) the wanted number of points in the curve
  84475. * @returns the created Curve3
  84476. */
  84477. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84478. /**
  84479. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84480. * @param p1 (Vector3) the origin point of the Hermite Spline
  84481. * @param t1 (Vector3) the tangent vector at the origin point
  84482. * @param p2 (Vector3) the end point of the Hermite Spline
  84483. * @param t2 (Vector3) the tangent vector at the end point
  84484. * @param nbPoints (integer) the wanted number of points in the curve
  84485. * @returns the created Curve3
  84486. */
  84487. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84488. /**
  84489. * Returns a Curve3 object along a CatmullRom Spline curve :
  84490. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84491. * @param nbPoints (integer) the wanted number of points between each curve control points
  84492. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84493. * @returns the created Curve3
  84494. */
  84495. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84496. /**
  84497. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84498. * A Curve3 is designed from a series of successive Vector3.
  84499. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84500. * @param points points which make up the curve
  84501. */
  84502. constructor(points: Vector3[]);
  84503. /**
  84504. * @returns the Curve3 stored array of successive Vector3
  84505. */
  84506. getPoints(): Vector3[];
  84507. /**
  84508. * @returns the computed length (float) of the curve.
  84509. */
  84510. length(): number;
  84511. /**
  84512. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84513. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84514. * curveA and curveB keep unchanged.
  84515. * @param curve the curve to continue from this curve
  84516. * @returns the newly constructed curve
  84517. */
  84518. continue(curve: DeepImmutable<Curve3>): Curve3;
  84519. private _computeLength;
  84520. }
  84521. }
  84522. declare module BABYLON {
  84523. /**
  84524. * This represents the main contract an easing function should follow.
  84525. * Easing functions are used throughout the animation system.
  84526. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84527. */
  84528. export interface IEasingFunction {
  84529. /**
  84530. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84531. * of the easing function.
  84532. * The link below provides some of the most common examples of easing functions.
  84533. * @see https://easings.net/
  84534. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84535. * @returns the corresponding value on the curve defined by the easing function
  84536. */
  84537. ease(gradient: number): number;
  84538. }
  84539. /**
  84540. * Base class used for every default easing function.
  84541. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84542. */
  84543. export class EasingFunction implements IEasingFunction {
  84544. /**
  84545. * Interpolation follows the mathematical formula associated with the easing function.
  84546. */
  84547. static readonly EASINGMODE_EASEIN: number;
  84548. /**
  84549. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84550. */
  84551. static readonly EASINGMODE_EASEOUT: number;
  84552. /**
  84553. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  84554. */
  84555. static readonly EASINGMODE_EASEINOUT: number;
  84556. private _easingMode;
  84557. /**
  84558. * Sets the easing mode of the current function.
  84559. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  84560. */
  84561. setEasingMode(easingMode: number): void;
  84562. /**
  84563. * Gets the current easing mode.
  84564. * @returns the easing mode
  84565. */
  84566. getEasingMode(): number;
  84567. /**
  84568. * @hidden
  84569. */
  84570. easeInCore(gradient: number): number;
  84571. /**
  84572. * Given an input gradient between 0 and 1, this returns the corresponding value
  84573. * of the easing function.
  84574. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84575. * @returns the corresponding value on the curve defined by the easing function
  84576. */
  84577. ease(gradient: number): number;
  84578. }
  84579. /**
  84580. * Easing function with a circle shape (see link below).
  84581. * @see https://easings.net/#easeInCirc
  84582. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84583. */
  84584. export class CircleEase extends EasingFunction implements IEasingFunction {
  84585. /** @hidden */
  84586. easeInCore(gradient: number): number;
  84587. }
  84588. /**
  84589. * Easing function with a ease back shape (see link below).
  84590. * @see https://easings.net/#easeInBack
  84591. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84592. */
  84593. export class BackEase extends EasingFunction implements IEasingFunction {
  84594. /** Defines the amplitude of the function */
  84595. amplitude: number;
  84596. /**
  84597. * Instantiates a back ease easing
  84598. * @see https://easings.net/#easeInBack
  84599. * @param amplitude Defines the amplitude of the function
  84600. */
  84601. constructor(
  84602. /** Defines the amplitude of the function */
  84603. amplitude?: number);
  84604. /** @hidden */
  84605. easeInCore(gradient: number): number;
  84606. }
  84607. /**
  84608. * Easing function with a bouncing shape (see link below).
  84609. * @see https://easings.net/#easeInBounce
  84610. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84611. */
  84612. export class BounceEase extends EasingFunction implements IEasingFunction {
  84613. /** Defines the number of bounces */
  84614. bounces: number;
  84615. /** Defines the amplitude of the bounce */
  84616. bounciness: number;
  84617. /**
  84618. * Instantiates a bounce easing
  84619. * @see https://easings.net/#easeInBounce
  84620. * @param bounces Defines the number of bounces
  84621. * @param bounciness Defines the amplitude of the bounce
  84622. */
  84623. constructor(
  84624. /** Defines the number of bounces */
  84625. bounces?: number,
  84626. /** Defines the amplitude of the bounce */
  84627. bounciness?: number);
  84628. /** @hidden */
  84629. easeInCore(gradient: number): number;
  84630. }
  84631. /**
  84632. * Easing function with a power of 3 shape (see link below).
  84633. * @see https://easings.net/#easeInCubic
  84634. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84635. */
  84636. export class CubicEase extends EasingFunction implements IEasingFunction {
  84637. /** @hidden */
  84638. easeInCore(gradient: number): number;
  84639. }
  84640. /**
  84641. * Easing function with an elastic shape (see link below).
  84642. * @see https://easings.net/#easeInElastic
  84643. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84644. */
  84645. export class ElasticEase extends EasingFunction implements IEasingFunction {
  84646. /** Defines the number of oscillations*/
  84647. oscillations: number;
  84648. /** Defines the amplitude of the oscillations*/
  84649. springiness: number;
  84650. /**
  84651. * Instantiates an elastic easing function
  84652. * @see https://easings.net/#easeInElastic
  84653. * @param oscillations Defines the number of oscillations
  84654. * @param springiness Defines the amplitude of the oscillations
  84655. */
  84656. constructor(
  84657. /** Defines the number of oscillations*/
  84658. oscillations?: number,
  84659. /** Defines the amplitude of the oscillations*/
  84660. springiness?: number);
  84661. /** @hidden */
  84662. easeInCore(gradient: number): number;
  84663. }
  84664. /**
  84665. * Easing function with an exponential shape (see link below).
  84666. * @see https://easings.net/#easeInExpo
  84667. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84668. */
  84669. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  84670. /** Defines the exponent of the function */
  84671. exponent: number;
  84672. /**
  84673. * Instantiates an exponential easing function
  84674. * @see https://easings.net/#easeInExpo
  84675. * @param exponent Defines the exponent of the function
  84676. */
  84677. constructor(
  84678. /** Defines the exponent of the function */
  84679. exponent?: number);
  84680. /** @hidden */
  84681. easeInCore(gradient: number): number;
  84682. }
  84683. /**
  84684. * Easing function with a power shape (see link below).
  84685. * @see https://easings.net/#easeInQuad
  84686. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84687. */
  84688. export class PowerEase extends EasingFunction implements IEasingFunction {
  84689. /** Defines the power of the function */
  84690. power: number;
  84691. /**
  84692. * Instantiates an power base easing function
  84693. * @see https://easings.net/#easeInQuad
  84694. * @param power Defines the power of the function
  84695. */
  84696. constructor(
  84697. /** Defines the power of the function */
  84698. power?: number);
  84699. /** @hidden */
  84700. easeInCore(gradient: number): number;
  84701. }
  84702. /**
  84703. * Easing function with a power of 2 shape (see link below).
  84704. * @see https://easings.net/#easeInQuad
  84705. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84706. */
  84707. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  84708. /** @hidden */
  84709. easeInCore(gradient: number): number;
  84710. }
  84711. /**
  84712. * Easing function with a power of 4 shape (see link below).
  84713. * @see https://easings.net/#easeInQuart
  84714. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84715. */
  84716. export class QuarticEase extends EasingFunction implements IEasingFunction {
  84717. /** @hidden */
  84718. easeInCore(gradient: number): number;
  84719. }
  84720. /**
  84721. * Easing function with a power of 5 shape (see link below).
  84722. * @see https://easings.net/#easeInQuint
  84723. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84724. */
  84725. export class QuinticEase extends EasingFunction implements IEasingFunction {
  84726. /** @hidden */
  84727. easeInCore(gradient: number): number;
  84728. }
  84729. /**
  84730. * Easing function with a sin shape (see link below).
  84731. * @see https://easings.net/#easeInSine
  84732. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84733. */
  84734. export class SineEase extends EasingFunction implements IEasingFunction {
  84735. /** @hidden */
  84736. easeInCore(gradient: number): number;
  84737. }
  84738. /**
  84739. * Easing function with a bezier shape (see link below).
  84740. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  84741. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84742. */
  84743. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  84744. /** Defines the x component of the start tangent in the bezier curve */
  84745. x1: number;
  84746. /** Defines the y component of the start tangent in the bezier curve */
  84747. y1: number;
  84748. /** Defines the x component of the end tangent in the bezier curve */
  84749. x2: number;
  84750. /** Defines the y component of the end tangent in the bezier curve */
  84751. y2: number;
  84752. /**
  84753. * Instantiates a bezier function
  84754. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  84755. * @param x1 Defines the x component of the start tangent in the bezier curve
  84756. * @param y1 Defines the y component of the start tangent in the bezier curve
  84757. * @param x2 Defines the x component of the end tangent in the bezier curve
  84758. * @param y2 Defines the y component of the end tangent in the bezier curve
  84759. */
  84760. constructor(
  84761. /** Defines the x component of the start tangent in the bezier curve */
  84762. x1?: number,
  84763. /** Defines the y component of the start tangent in the bezier curve */
  84764. y1?: number,
  84765. /** Defines the x component of the end tangent in the bezier curve */
  84766. x2?: number,
  84767. /** Defines the y component of the end tangent in the bezier curve */
  84768. y2?: number);
  84769. /** @hidden */
  84770. easeInCore(gradient: number): number;
  84771. }
  84772. }
  84773. declare module BABYLON {
  84774. /**
  84775. * Class used to hold a RBG color
  84776. */
  84777. export class Color3 {
  84778. /**
  84779. * Defines the red component (between 0 and 1, default is 0)
  84780. */
  84781. r: number;
  84782. /**
  84783. * Defines the green component (between 0 and 1, default is 0)
  84784. */
  84785. g: number;
  84786. /**
  84787. * Defines the blue component (between 0 and 1, default is 0)
  84788. */
  84789. b: number;
  84790. /**
  84791. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  84792. * @param r defines the red component (between 0 and 1, default is 0)
  84793. * @param g defines the green component (between 0 and 1, default is 0)
  84794. * @param b defines the blue component (between 0 and 1, default is 0)
  84795. */
  84796. constructor(
  84797. /**
  84798. * Defines the red component (between 0 and 1, default is 0)
  84799. */
  84800. r?: number,
  84801. /**
  84802. * Defines the green component (between 0 and 1, default is 0)
  84803. */
  84804. g?: number,
  84805. /**
  84806. * Defines the blue component (between 0 and 1, default is 0)
  84807. */
  84808. b?: number);
  84809. /**
  84810. * Creates a string with the Color3 current values
  84811. * @returns the string representation of the Color3 object
  84812. */
  84813. toString(): string;
  84814. /**
  84815. * Returns the string "Color3"
  84816. * @returns "Color3"
  84817. */
  84818. getClassName(): string;
  84819. /**
  84820. * Compute the Color3 hash code
  84821. * @returns an unique number that can be used to hash Color3 objects
  84822. */
  84823. getHashCode(): number;
  84824. /**
  84825. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  84826. * @param array defines the array where to store the r,g,b components
  84827. * @param index defines an optional index in the target array to define where to start storing values
  84828. * @returns the current Color3 object
  84829. */
  84830. toArray(array: FloatArray, index?: number): Color3;
  84831. /**
  84832. * Update the current color with values stored in an array from the starting index of the given array
  84833. * @param array defines the source array
  84834. * @param offset defines an offset in the source array
  84835. * @returns the current Color3 object
  84836. */
  84837. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  84838. /**
  84839. * Returns a new Color4 object from the current Color3 and the given alpha
  84840. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  84841. * @returns a new Color4 object
  84842. */
  84843. toColor4(alpha?: number): Color4;
  84844. /**
  84845. * Returns a new array populated with 3 numeric elements : red, green and blue values
  84846. * @returns the new array
  84847. */
  84848. asArray(): number[];
  84849. /**
  84850. * Returns the luminance value
  84851. * @returns a float value
  84852. */
  84853. toLuminance(): number;
  84854. /**
  84855. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  84856. * @param otherColor defines the second operand
  84857. * @returns the new Color3 object
  84858. */
  84859. multiply(otherColor: DeepImmutable<Color3>): Color3;
  84860. /**
  84861. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  84862. * @param otherColor defines the second operand
  84863. * @param result defines the Color3 object where to store the result
  84864. * @returns the current Color3
  84865. */
  84866. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84867. /**
  84868. * Determines equality between Color3 objects
  84869. * @param otherColor defines the second operand
  84870. * @returns true if the rgb values are equal to the given ones
  84871. */
  84872. equals(otherColor: DeepImmutable<Color3>): boolean;
  84873. /**
  84874. * Determines equality between the current Color3 object and a set of r,b,g values
  84875. * @param r defines the red component to check
  84876. * @param g defines the green component to check
  84877. * @param b defines the blue component to check
  84878. * @returns true if the rgb values are equal to the given ones
  84879. */
  84880. equalsFloats(r: number, g: number, b: number): boolean;
  84881. /**
  84882. * Multiplies in place each rgb value by scale
  84883. * @param scale defines the scaling factor
  84884. * @returns the updated Color3
  84885. */
  84886. scale(scale: number): Color3;
  84887. /**
  84888. * Multiplies the rgb values by scale and stores the result into "result"
  84889. * @param scale defines the scaling factor
  84890. * @param result defines the Color3 object where to store the result
  84891. * @returns the unmodified current Color3
  84892. */
  84893. scaleToRef(scale: number, result: Color3): Color3;
  84894. /**
  84895. * Scale the current Color3 values by a factor and add the result to a given Color3
  84896. * @param scale defines the scale factor
  84897. * @param result defines color to store the result into
  84898. * @returns the unmodified current Color3
  84899. */
  84900. scaleAndAddToRef(scale: number, result: Color3): Color3;
  84901. /**
  84902. * Clamps the rgb values by the min and max values and stores the result into "result"
  84903. * @param min defines minimum clamping value (default is 0)
  84904. * @param max defines maximum clamping value (default is 1)
  84905. * @param result defines color to store the result into
  84906. * @returns the original Color3
  84907. */
  84908. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  84909. /**
  84910. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  84911. * @param otherColor defines the second operand
  84912. * @returns the new Color3
  84913. */
  84914. add(otherColor: DeepImmutable<Color3>): Color3;
  84915. /**
  84916. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  84917. * @param otherColor defines the second operand
  84918. * @param result defines Color3 object to store the result into
  84919. * @returns the unmodified current Color3
  84920. */
  84921. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84922. /**
  84923. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  84924. * @param otherColor defines the second operand
  84925. * @returns the new Color3
  84926. */
  84927. subtract(otherColor: DeepImmutable<Color3>): Color3;
  84928. /**
  84929. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  84930. * @param otherColor defines the second operand
  84931. * @param result defines Color3 object to store the result into
  84932. * @returns the unmodified current Color3
  84933. */
  84934. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84935. /**
  84936. * Copy the current object
  84937. * @returns a new Color3 copied the current one
  84938. */
  84939. clone(): Color3;
  84940. /**
  84941. * Copies the rgb values from the source in the current Color3
  84942. * @param source defines the source Color3 object
  84943. * @returns the updated Color3 object
  84944. */
  84945. copyFrom(source: DeepImmutable<Color3>): Color3;
  84946. /**
  84947. * Updates the Color3 rgb values from the given floats
  84948. * @param r defines the red component to read from
  84949. * @param g defines the green component to read from
  84950. * @param b defines the blue component to read from
  84951. * @returns the current Color3 object
  84952. */
  84953. copyFromFloats(r: number, g: number, b: number): Color3;
  84954. /**
  84955. * Updates the Color3 rgb values from the given floats
  84956. * @param r defines the red component to read from
  84957. * @param g defines the green component to read from
  84958. * @param b defines the blue component to read from
  84959. * @returns the current Color3 object
  84960. */
  84961. set(r: number, g: number, b: number): Color3;
  84962. /**
  84963. * Compute the Color3 hexadecimal code as a string
  84964. * @returns a string containing the hexadecimal representation of the Color3 object
  84965. */
  84966. toHexString(): string;
  84967. /**
  84968. * Computes a new Color3 converted from the current one to linear space
  84969. * @returns a new Color3 object
  84970. */
  84971. toLinearSpace(): Color3;
  84972. /**
  84973. * Converts current color in rgb space to HSV values
  84974. * @returns a new color3 representing the HSV values
  84975. */
  84976. toHSV(): Color3;
  84977. /**
  84978. * Converts current color in rgb space to HSV values
  84979. * @param result defines the Color3 where to store the HSV values
  84980. */
  84981. toHSVToRef(result: Color3): void;
  84982. /**
  84983. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  84984. * @param convertedColor defines the Color3 object where to store the linear space version
  84985. * @returns the unmodified Color3
  84986. */
  84987. toLinearSpaceToRef(convertedColor: Color3): Color3;
  84988. /**
  84989. * Computes a new Color3 converted from the current one to gamma space
  84990. * @returns a new Color3 object
  84991. */
  84992. toGammaSpace(): Color3;
  84993. /**
  84994. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  84995. * @param convertedColor defines the Color3 object where to store the gamma space version
  84996. * @returns the unmodified Color3
  84997. */
  84998. toGammaSpaceToRef(convertedColor: Color3): Color3;
  84999. private static _BlackReadOnly;
  85000. /**
  85001. * Convert Hue, saturation and value to a Color3 (RGB)
  85002. * @param hue defines the hue
  85003. * @param saturation defines the saturation
  85004. * @param value defines the value
  85005. * @param result defines the Color3 where to store the RGB values
  85006. */
  85007. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85008. /**
  85009. * Creates a new Color3 from the string containing valid hexadecimal values
  85010. * @param hex defines a string containing valid hexadecimal values
  85011. * @returns a new Color3 object
  85012. */
  85013. static FromHexString(hex: string): Color3;
  85014. /**
  85015. * Creates a new Color3 from the starting index of the given array
  85016. * @param array defines the source array
  85017. * @param offset defines an offset in the source array
  85018. * @returns a new Color3 object
  85019. */
  85020. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85021. /**
  85022. * Creates a new Color3 from the starting index element of the given array
  85023. * @param array defines the source array to read from
  85024. * @param offset defines the offset in the source array
  85025. * @param result defines the target Color3 object
  85026. */
  85027. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85028. /**
  85029. * Creates a new Color3 from integer values (< 256)
  85030. * @param r defines the red component to read from (value between 0 and 255)
  85031. * @param g defines the green component to read from (value between 0 and 255)
  85032. * @param b defines the blue component to read from (value between 0 and 255)
  85033. * @returns a new Color3 object
  85034. */
  85035. static FromInts(r: number, g: number, b: number): Color3;
  85036. /**
  85037. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85038. * @param start defines the start Color3 value
  85039. * @param end defines the end Color3 value
  85040. * @param amount defines the gradient value between start and end
  85041. * @returns a new Color3 object
  85042. */
  85043. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85044. /**
  85045. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85046. * @param left defines the start value
  85047. * @param right defines the end value
  85048. * @param amount defines the gradient factor
  85049. * @param result defines the Color3 object where to store the result
  85050. */
  85051. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85052. /**
  85053. * Returns a Color3 value containing a red color
  85054. * @returns a new Color3 object
  85055. */
  85056. static Red(): Color3;
  85057. /**
  85058. * Returns a Color3 value containing a green color
  85059. * @returns a new Color3 object
  85060. */
  85061. static Green(): Color3;
  85062. /**
  85063. * Returns a Color3 value containing a blue color
  85064. * @returns a new Color3 object
  85065. */
  85066. static Blue(): Color3;
  85067. /**
  85068. * Returns a Color3 value containing a black color
  85069. * @returns a new Color3 object
  85070. */
  85071. static Black(): Color3;
  85072. /**
  85073. * Gets a Color3 value containing a black color that must not be updated
  85074. */
  85075. static get BlackReadOnly(): DeepImmutable<Color3>;
  85076. /**
  85077. * Returns a Color3 value containing a white color
  85078. * @returns a new Color3 object
  85079. */
  85080. static White(): Color3;
  85081. /**
  85082. * Returns a Color3 value containing a purple color
  85083. * @returns a new Color3 object
  85084. */
  85085. static Purple(): Color3;
  85086. /**
  85087. * Returns a Color3 value containing a magenta color
  85088. * @returns a new Color3 object
  85089. */
  85090. static Magenta(): Color3;
  85091. /**
  85092. * Returns a Color3 value containing a yellow color
  85093. * @returns a new Color3 object
  85094. */
  85095. static Yellow(): Color3;
  85096. /**
  85097. * Returns a Color3 value containing a gray color
  85098. * @returns a new Color3 object
  85099. */
  85100. static Gray(): Color3;
  85101. /**
  85102. * Returns a Color3 value containing a teal color
  85103. * @returns a new Color3 object
  85104. */
  85105. static Teal(): Color3;
  85106. /**
  85107. * Returns a Color3 value containing a random color
  85108. * @returns a new Color3 object
  85109. */
  85110. static Random(): Color3;
  85111. }
  85112. /**
  85113. * Class used to hold a RBGA color
  85114. */
  85115. export class Color4 {
  85116. /**
  85117. * Defines the red component (between 0 and 1, default is 0)
  85118. */
  85119. r: number;
  85120. /**
  85121. * Defines the green component (between 0 and 1, default is 0)
  85122. */
  85123. g: number;
  85124. /**
  85125. * Defines the blue component (between 0 and 1, default is 0)
  85126. */
  85127. b: number;
  85128. /**
  85129. * Defines the alpha component (between 0 and 1, default is 1)
  85130. */
  85131. a: number;
  85132. /**
  85133. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85134. * @param r defines the red component (between 0 and 1, default is 0)
  85135. * @param g defines the green component (between 0 and 1, default is 0)
  85136. * @param b defines the blue component (between 0 and 1, default is 0)
  85137. * @param a defines the alpha component (between 0 and 1, default is 1)
  85138. */
  85139. constructor(
  85140. /**
  85141. * Defines the red component (between 0 and 1, default is 0)
  85142. */
  85143. r?: number,
  85144. /**
  85145. * Defines the green component (between 0 and 1, default is 0)
  85146. */
  85147. g?: number,
  85148. /**
  85149. * Defines the blue component (between 0 and 1, default is 0)
  85150. */
  85151. b?: number,
  85152. /**
  85153. * Defines the alpha component (between 0 and 1, default is 1)
  85154. */
  85155. a?: number);
  85156. /**
  85157. * Adds in place the given Color4 values to the current Color4 object
  85158. * @param right defines the second operand
  85159. * @returns the current updated Color4 object
  85160. */
  85161. addInPlace(right: DeepImmutable<Color4>): Color4;
  85162. /**
  85163. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85164. * @returns the new array
  85165. */
  85166. asArray(): number[];
  85167. /**
  85168. * Stores from the starting index in the given array the Color4 successive values
  85169. * @param array defines the array where to store the r,g,b components
  85170. * @param index defines an optional index in the target array to define where to start storing values
  85171. * @returns the current Color4 object
  85172. */
  85173. toArray(array: number[], index?: number): Color4;
  85174. /**
  85175. * Update the current color with values stored in an array from the starting index of the given array
  85176. * @param array defines the source array
  85177. * @param offset defines an offset in the source array
  85178. * @returns the current Color4 object
  85179. */
  85180. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85181. /**
  85182. * Determines equality between Color4 objects
  85183. * @param otherColor defines the second operand
  85184. * @returns true if the rgba values are equal to the given ones
  85185. */
  85186. equals(otherColor: DeepImmutable<Color4>): boolean;
  85187. /**
  85188. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85189. * @param right defines the second operand
  85190. * @returns a new Color4 object
  85191. */
  85192. add(right: DeepImmutable<Color4>): Color4;
  85193. /**
  85194. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85195. * @param right defines the second operand
  85196. * @returns a new Color4 object
  85197. */
  85198. subtract(right: DeepImmutable<Color4>): Color4;
  85199. /**
  85200. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85201. * @param right defines the second operand
  85202. * @param result defines the Color4 object where to store the result
  85203. * @returns the current Color4 object
  85204. */
  85205. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85206. /**
  85207. * Creates a new Color4 with the current Color4 values multiplied by scale
  85208. * @param scale defines the scaling factor to apply
  85209. * @returns a new Color4 object
  85210. */
  85211. scale(scale: number): Color4;
  85212. /**
  85213. * Multiplies the current Color4 values by scale and stores the result in "result"
  85214. * @param scale defines the scaling factor to apply
  85215. * @param result defines the Color4 object where to store the result
  85216. * @returns the current unmodified Color4
  85217. */
  85218. scaleToRef(scale: number, result: Color4): Color4;
  85219. /**
  85220. * Scale the current Color4 values by a factor and add the result to a given Color4
  85221. * @param scale defines the scale factor
  85222. * @param result defines the Color4 object where to store the result
  85223. * @returns the unmodified current Color4
  85224. */
  85225. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85226. /**
  85227. * Clamps the rgb values by the min and max values and stores the result into "result"
  85228. * @param min defines minimum clamping value (default is 0)
  85229. * @param max defines maximum clamping value (default is 1)
  85230. * @param result defines color to store the result into.
  85231. * @returns the cuurent Color4
  85232. */
  85233. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85234. /**
  85235. * Multipy an Color4 value by another and return a new Color4 object
  85236. * @param color defines the Color4 value to multiply by
  85237. * @returns a new Color4 object
  85238. */
  85239. multiply(color: Color4): Color4;
  85240. /**
  85241. * Multipy a Color4 value by another and push the result in a reference value
  85242. * @param color defines the Color4 value to multiply by
  85243. * @param result defines the Color4 to fill the result in
  85244. * @returns the result Color4
  85245. */
  85246. multiplyToRef(color: Color4, result: Color4): Color4;
  85247. /**
  85248. * Creates a string with the Color4 current values
  85249. * @returns the string representation of the Color4 object
  85250. */
  85251. toString(): string;
  85252. /**
  85253. * Returns the string "Color4"
  85254. * @returns "Color4"
  85255. */
  85256. getClassName(): string;
  85257. /**
  85258. * Compute the Color4 hash code
  85259. * @returns an unique number that can be used to hash Color4 objects
  85260. */
  85261. getHashCode(): number;
  85262. /**
  85263. * Creates a new Color4 copied from the current one
  85264. * @returns a new Color4 object
  85265. */
  85266. clone(): Color4;
  85267. /**
  85268. * Copies the given Color4 values into the current one
  85269. * @param source defines the source Color4 object
  85270. * @returns the current updated Color4 object
  85271. */
  85272. copyFrom(source: Color4): Color4;
  85273. /**
  85274. * Copies the given float values into the current one
  85275. * @param r defines the red component to read from
  85276. * @param g defines the green component to read from
  85277. * @param b defines the blue component to read from
  85278. * @param a defines the alpha component to read from
  85279. * @returns the current updated Color4 object
  85280. */
  85281. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85282. /**
  85283. * Copies the given float values into the current one
  85284. * @param r defines the red component to read from
  85285. * @param g defines the green component to read from
  85286. * @param b defines the blue component to read from
  85287. * @param a defines the alpha component to read from
  85288. * @returns the current updated Color4 object
  85289. */
  85290. set(r: number, g: number, b: number, a: number): Color4;
  85291. /**
  85292. * Compute the Color4 hexadecimal code as a string
  85293. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85294. * @returns a string containing the hexadecimal representation of the Color4 object
  85295. */
  85296. toHexString(returnAsColor3?: boolean): string;
  85297. /**
  85298. * Computes a new Color4 converted from the current one to linear space
  85299. * @returns a new Color4 object
  85300. */
  85301. toLinearSpace(): Color4;
  85302. /**
  85303. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85304. * @param convertedColor defines the Color4 object where to store the linear space version
  85305. * @returns the unmodified Color4
  85306. */
  85307. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85308. /**
  85309. * Computes a new Color4 converted from the current one to gamma space
  85310. * @returns a new Color4 object
  85311. */
  85312. toGammaSpace(): Color4;
  85313. /**
  85314. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85315. * @param convertedColor defines the Color4 object where to store the gamma space version
  85316. * @returns the unmodified Color4
  85317. */
  85318. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85319. /**
  85320. * Creates a new Color4 from the string containing valid hexadecimal values
  85321. * @param hex defines a string containing valid hexadecimal values
  85322. * @returns a new Color4 object
  85323. */
  85324. static FromHexString(hex: string): Color4;
  85325. /**
  85326. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85327. * @param left defines the start value
  85328. * @param right defines the end value
  85329. * @param amount defines the gradient factor
  85330. * @returns a new Color4 object
  85331. */
  85332. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85333. /**
  85334. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85335. * @param left defines the start value
  85336. * @param right defines the end value
  85337. * @param amount defines the gradient factor
  85338. * @param result defines the Color4 object where to store data
  85339. */
  85340. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85341. /**
  85342. * Creates a new Color4 from a Color3 and an alpha value
  85343. * @param color3 defines the source Color3 to read from
  85344. * @param alpha defines the alpha component (1.0 by default)
  85345. * @returns a new Color4 object
  85346. */
  85347. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85348. /**
  85349. * Creates a new Color4 from the starting index element of the given array
  85350. * @param array defines the source array to read from
  85351. * @param offset defines the offset in the source array
  85352. * @returns a new Color4 object
  85353. */
  85354. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85355. /**
  85356. * Creates a new Color4 from the starting index element of the given array
  85357. * @param array defines the source array to read from
  85358. * @param offset defines the offset in the source array
  85359. * @param result defines the target Color4 object
  85360. */
  85361. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85362. /**
  85363. * Creates a new Color3 from integer values (< 256)
  85364. * @param r defines the red component to read from (value between 0 and 255)
  85365. * @param g defines the green component to read from (value between 0 and 255)
  85366. * @param b defines the blue component to read from (value between 0 and 255)
  85367. * @param a defines the alpha component to read from (value between 0 and 255)
  85368. * @returns a new Color3 object
  85369. */
  85370. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85371. /**
  85372. * Check the content of a given array and convert it to an array containing RGBA data
  85373. * If the original array was already containing count * 4 values then it is returned directly
  85374. * @param colors defines the array to check
  85375. * @param count defines the number of RGBA data to expect
  85376. * @returns an array containing count * 4 values (RGBA)
  85377. */
  85378. static CheckColors4(colors: number[], count: number): number[];
  85379. }
  85380. /**
  85381. * @hidden
  85382. */
  85383. export class TmpColors {
  85384. static Color3: Color3[];
  85385. static Color4: Color4[];
  85386. }
  85387. }
  85388. declare module BABYLON {
  85389. /**
  85390. * Defines an interface which represents an animation key frame
  85391. */
  85392. export interface IAnimationKey {
  85393. /**
  85394. * Frame of the key frame
  85395. */
  85396. frame: number;
  85397. /**
  85398. * Value at the specifies key frame
  85399. */
  85400. value: any;
  85401. /**
  85402. * The input tangent for the cubic hermite spline
  85403. */
  85404. inTangent?: any;
  85405. /**
  85406. * The output tangent for the cubic hermite spline
  85407. */
  85408. outTangent?: any;
  85409. /**
  85410. * The animation interpolation type
  85411. */
  85412. interpolation?: AnimationKeyInterpolation;
  85413. }
  85414. /**
  85415. * Enum for the animation key frame interpolation type
  85416. */
  85417. export enum AnimationKeyInterpolation {
  85418. /**
  85419. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85420. */
  85421. STEP = 1
  85422. }
  85423. }
  85424. declare module BABYLON {
  85425. /**
  85426. * Represents the range of an animation
  85427. */
  85428. export class AnimationRange {
  85429. /**The name of the animation range**/
  85430. name: string;
  85431. /**The starting frame of the animation */
  85432. from: number;
  85433. /**The ending frame of the animation*/
  85434. to: number;
  85435. /**
  85436. * Initializes the range of an animation
  85437. * @param name The name of the animation range
  85438. * @param from The starting frame of the animation
  85439. * @param to The ending frame of the animation
  85440. */
  85441. constructor(
  85442. /**The name of the animation range**/
  85443. name: string,
  85444. /**The starting frame of the animation */
  85445. from: number,
  85446. /**The ending frame of the animation*/
  85447. to: number);
  85448. /**
  85449. * Makes a copy of the animation range
  85450. * @returns A copy of the animation range
  85451. */
  85452. clone(): AnimationRange;
  85453. }
  85454. }
  85455. declare module BABYLON {
  85456. /**
  85457. * Composed of a frame, and an action function
  85458. */
  85459. export class AnimationEvent {
  85460. /** The frame for which the event is triggered **/
  85461. frame: number;
  85462. /** The event to perform when triggered **/
  85463. action: (currentFrame: number) => void;
  85464. /** Specifies if the event should be triggered only once**/
  85465. onlyOnce?: boolean | undefined;
  85466. /**
  85467. * Specifies if the animation event is done
  85468. */
  85469. isDone: boolean;
  85470. /**
  85471. * Initializes the animation event
  85472. * @param frame The frame for which the event is triggered
  85473. * @param action The event to perform when triggered
  85474. * @param onlyOnce Specifies if the event should be triggered only once
  85475. */
  85476. constructor(
  85477. /** The frame for which the event is triggered **/
  85478. frame: number,
  85479. /** The event to perform when triggered **/
  85480. action: (currentFrame: number) => void,
  85481. /** Specifies if the event should be triggered only once**/
  85482. onlyOnce?: boolean | undefined);
  85483. /** @hidden */
  85484. _clone(): AnimationEvent;
  85485. }
  85486. }
  85487. declare module BABYLON {
  85488. /**
  85489. * Interface used to define a behavior
  85490. */
  85491. export interface Behavior<T> {
  85492. /** gets or sets behavior's name */
  85493. name: string;
  85494. /**
  85495. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85496. */
  85497. init(): void;
  85498. /**
  85499. * Called when the behavior is attached to a target
  85500. * @param target defines the target where the behavior is attached to
  85501. */
  85502. attach(target: T): void;
  85503. /**
  85504. * Called when the behavior is detached from its target
  85505. */
  85506. detach(): void;
  85507. }
  85508. /**
  85509. * Interface implemented by classes supporting behaviors
  85510. */
  85511. export interface IBehaviorAware<T> {
  85512. /**
  85513. * Attach a behavior
  85514. * @param behavior defines the behavior to attach
  85515. * @returns the current host
  85516. */
  85517. addBehavior(behavior: Behavior<T>): T;
  85518. /**
  85519. * Remove a behavior from the current object
  85520. * @param behavior defines the behavior to detach
  85521. * @returns the current host
  85522. */
  85523. removeBehavior(behavior: Behavior<T>): T;
  85524. /**
  85525. * Gets a behavior using its name to search
  85526. * @param name defines the name to search
  85527. * @returns the behavior or null if not found
  85528. */
  85529. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85530. }
  85531. }
  85532. declare module BABYLON {
  85533. /**
  85534. * Defines an array and its length.
  85535. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85536. */
  85537. export interface ISmartArrayLike<T> {
  85538. /**
  85539. * The data of the array.
  85540. */
  85541. data: Array<T>;
  85542. /**
  85543. * The active length of the array.
  85544. */
  85545. length: number;
  85546. }
  85547. /**
  85548. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85549. */
  85550. export class SmartArray<T> implements ISmartArrayLike<T> {
  85551. /**
  85552. * The full set of data from the array.
  85553. */
  85554. data: Array<T>;
  85555. /**
  85556. * The active length of the array.
  85557. */
  85558. length: number;
  85559. protected _id: number;
  85560. /**
  85561. * Instantiates a Smart Array.
  85562. * @param capacity defines the default capacity of the array.
  85563. */
  85564. constructor(capacity: number);
  85565. /**
  85566. * Pushes a value at the end of the active data.
  85567. * @param value defines the object to push in the array.
  85568. */
  85569. push(value: T): void;
  85570. /**
  85571. * Iterates over the active data and apply the lambda to them.
  85572. * @param func defines the action to apply on each value.
  85573. */
  85574. forEach(func: (content: T) => void): void;
  85575. /**
  85576. * Sorts the full sets of data.
  85577. * @param compareFn defines the comparison function to apply.
  85578. */
  85579. sort(compareFn: (a: T, b: T) => number): void;
  85580. /**
  85581. * Resets the active data to an empty array.
  85582. */
  85583. reset(): void;
  85584. /**
  85585. * Releases all the data from the array as well as the array.
  85586. */
  85587. dispose(): void;
  85588. /**
  85589. * Concats the active data with a given array.
  85590. * @param array defines the data to concatenate with.
  85591. */
  85592. concat(array: any): void;
  85593. /**
  85594. * Returns the position of a value in the active data.
  85595. * @param value defines the value to find the index for
  85596. * @returns the index if found in the active data otherwise -1
  85597. */
  85598. indexOf(value: T): number;
  85599. /**
  85600. * Returns whether an element is part of the active data.
  85601. * @param value defines the value to look for
  85602. * @returns true if found in the active data otherwise false
  85603. */
  85604. contains(value: T): boolean;
  85605. private static _GlobalId;
  85606. }
  85607. /**
  85608. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85609. * The data in this array can only be present once
  85610. */
  85611. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  85612. private _duplicateId;
  85613. /**
  85614. * Pushes a value at the end of the active data.
  85615. * THIS DOES NOT PREVENT DUPPLICATE DATA
  85616. * @param value defines the object to push in the array.
  85617. */
  85618. push(value: T): void;
  85619. /**
  85620. * Pushes a value at the end of the active data.
  85621. * If the data is already present, it won t be added again
  85622. * @param value defines the object to push in the array.
  85623. * @returns true if added false if it was already present
  85624. */
  85625. pushNoDuplicate(value: T): boolean;
  85626. /**
  85627. * Resets the active data to an empty array.
  85628. */
  85629. reset(): void;
  85630. /**
  85631. * Concats the active data with a given array.
  85632. * This ensures no dupplicate will be present in the result.
  85633. * @param array defines the data to concatenate with.
  85634. */
  85635. concatWithNoDuplicate(array: any): void;
  85636. }
  85637. }
  85638. declare module BABYLON {
  85639. /**
  85640. * @ignore
  85641. * This is a list of all the different input types that are available in the application.
  85642. * Fo instance: ArcRotateCameraGamepadInput...
  85643. */
  85644. export var CameraInputTypes: {};
  85645. /**
  85646. * This is the contract to implement in order to create a new input class.
  85647. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  85648. */
  85649. export interface ICameraInput<TCamera extends Camera> {
  85650. /**
  85651. * Defines the camera the input is attached to.
  85652. */
  85653. camera: Nullable<TCamera>;
  85654. /**
  85655. * Gets the class name of the current intput.
  85656. * @returns the class name
  85657. */
  85658. getClassName(): string;
  85659. /**
  85660. * Get the friendly name associated with the input class.
  85661. * @returns the input friendly name
  85662. */
  85663. getSimpleName(): string;
  85664. /**
  85665. * Attach the input controls to a specific dom element to get the input from.
  85666. * @param element Defines the element the controls should be listened from
  85667. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85668. */
  85669. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  85670. /**
  85671. * Detach the current controls from the specified dom element.
  85672. * @param element Defines the element to stop listening the inputs from
  85673. */
  85674. detachControl(element: Nullable<HTMLElement>): void;
  85675. /**
  85676. * Update the current camera state depending on the inputs that have been used this frame.
  85677. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  85678. */
  85679. checkInputs?: () => void;
  85680. }
  85681. /**
  85682. * Represents a map of input types to input instance or input index to input instance.
  85683. */
  85684. export interface CameraInputsMap<TCamera extends Camera> {
  85685. /**
  85686. * Accessor to the input by input type.
  85687. */
  85688. [name: string]: ICameraInput<TCamera>;
  85689. /**
  85690. * Accessor to the input by input index.
  85691. */
  85692. [idx: number]: ICameraInput<TCamera>;
  85693. }
  85694. /**
  85695. * This represents the input manager used within a camera.
  85696. * It helps dealing with all the different kind of input attached to a camera.
  85697. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  85698. */
  85699. export class CameraInputsManager<TCamera extends Camera> {
  85700. /**
  85701. * Defines the list of inputs attahed to the camera.
  85702. */
  85703. attached: CameraInputsMap<TCamera>;
  85704. /**
  85705. * Defines the dom element the camera is collecting inputs from.
  85706. * This is null if the controls have not been attached.
  85707. */
  85708. attachedElement: Nullable<HTMLElement>;
  85709. /**
  85710. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85711. */
  85712. noPreventDefault: boolean;
  85713. /**
  85714. * Defined the camera the input manager belongs to.
  85715. */
  85716. camera: TCamera;
  85717. /**
  85718. * Update the current camera state depending on the inputs that have been used this frame.
  85719. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  85720. */
  85721. checkInputs: () => void;
  85722. /**
  85723. * Instantiate a new Camera Input Manager.
  85724. * @param camera Defines the camera the input manager blongs to
  85725. */
  85726. constructor(camera: TCamera);
  85727. /**
  85728. * Add an input method to a camera
  85729. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  85730. * @param input camera input method
  85731. */
  85732. add(input: ICameraInput<TCamera>): void;
  85733. /**
  85734. * Remove a specific input method from a camera
  85735. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  85736. * @param inputToRemove camera input method
  85737. */
  85738. remove(inputToRemove: ICameraInput<TCamera>): void;
  85739. /**
  85740. * Remove a specific input type from a camera
  85741. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  85742. * @param inputType the type of the input to remove
  85743. */
  85744. removeByType(inputType: string): void;
  85745. private _addCheckInputs;
  85746. /**
  85747. * Attach the input controls to the currently attached dom element to listen the events from.
  85748. * @param input Defines the input to attach
  85749. */
  85750. attachInput(input: ICameraInput<TCamera>): void;
  85751. /**
  85752. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  85753. * @param element Defines the dom element to collect the events from
  85754. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85755. */
  85756. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  85757. /**
  85758. * Detach the current manager inputs controls from a specific dom element.
  85759. * @param element Defines the dom element to collect the events from
  85760. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  85761. */
  85762. detachElement(element: HTMLElement, disconnect?: boolean): void;
  85763. /**
  85764. * Rebuild the dynamic inputCheck function from the current list of
  85765. * defined inputs in the manager.
  85766. */
  85767. rebuildInputCheck(): void;
  85768. /**
  85769. * Remove all attached input methods from a camera
  85770. */
  85771. clear(): void;
  85772. /**
  85773. * Serialize the current input manager attached to a camera.
  85774. * This ensures than once parsed,
  85775. * the input associated to the camera will be identical to the current ones
  85776. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  85777. */
  85778. serialize(serializedCamera: any): void;
  85779. /**
  85780. * Parses an input manager serialized JSON to restore the previous list of inputs
  85781. * and states associated to a camera.
  85782. * @param parsedCamera Defines the JSON to parse
  85783. */
  85784. parse(parsedCamera: any): void;
  85785. }
  85786. }
  85787. declare module BABYLON {
  85788. /**
  85789. * Class used to store data that will be store in GPU memory
  85790. */
  85791. export class Buffer {
  85792. private _engine;
  85793. private _buffer;
  85794. /** @hidden */
  85795. _data: Nullable<DataArray>;
  85796. private _updatable;
  85797. private _instanced;
  85798. private _divisor;
  85799. /**
  85800. * Gets the byte stride.
  85801. */
  85802. readonly byteStride: number;
  85803. /**
  85804. * Constructor
  85805. * @param engine the engine
  85806. * @param data the data to use for this buffer
  85807. * @param updatable whether the data is updatable
  85808. * @param stride the stride (optional)
  85809. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  85810. * @param instanced whether the buffer is instanced (optional)
  85811. * @param useBytes set to true if the stride in in bytes (optional)
  85812. * @param divisor sets an optional divisor for instances (1 by default)
  85813. */
  85814. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  85815. /**
  85816. * Create a new VertexBuffer based on the current buffer
  85817. * @param kind defines the vertex buffer kind (position, normal, etc.)
  85818. * @param offset defines offset in the buffer (0 by default)
  85819. * @param size defines the size in floats of attributes (position is 3 for instance)
  85820. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  85821. * @param instanced defines if the vertex buffer contains indexed data
  85822. * @param useBytes defines if the offset and stride are in bytes *
  85823. * @param divisor sets an optional divisor for instances (1 by default)
  85824. * @returns the new vertex buffer
  85825. */
  85826. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  85827. /**
  85828. * Gets a boolean indicating if the Buffer is updatable?
  85829. * @returns true if the buffer is updatable
  85830. */
  85831. isUpdatable(): boolean;
  85832. /**
  85833. * Gets current buffer's data
  85834. * @returns a DataArray or null
  85835. */
  85836. getData(): Nullable<DataArray>;
  85837. /**
  85838. * Gets underlying native buffer
  85839. * @returns underlying native buffer
  85840. */
  85841. getBuffer(): Nullable<DataBuffer>;
  85842. /**
  85843. * Gets the stride in float32 units (i.e. byte stride / 4).
  85844. * May not be an integer if the byte stride is not divisible by 4.
  85845. * @returns the stride in float32 units
  85846. * @deprecated Please use byteStride instead.
  85847. */
  85848. getStrideSize(): number;
  85849. /**
  85850. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  85851. * @param data defines the data to store
  85852. */
  85853. create(data?: Nullable<DataArray>): void;
  85854. /** @hidden */
  85855. _rebuild(): void;
  85856. /**
  85857. * Update current buffer data
  85858. * @param data defines the data to store
  85859. */
  85860. update(data: DataArray): void;
  85861. /**
  85862. * Updates the data directly.
  85863. * @param data the new data
  85864. * @param offset the new offset
  85865. * @param vertexCount the vertex count (optional)
  85866. * @param useBytes set to true if the offset is in bytes
  85867. */
  85868. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  85869. /**
  85870. * Release all resources
  85871. */
  85872. dispose(): void;
  85873. }
  85874. /**
  85875. * Specialized buffer used to store vertex data
  85876. */
  85877. export class VertexBuffer {
  85878. /** @hidden */
  85879. _buffer: Buffer;
  85880. private _kind;
  85881. private _size;
  85882. private _ownsBuffer;
  85883. private _instanced;
  85884. private _instanceDivisor;
  85885. /**
  85886. * The byte type.
  85887. */
  85888. static readonly BYTE: number;
  85889. /**
  85890. * The unsigned byte type.
  85891. */
  85892. static readonly UNSIGNED_BYTE: number;
  85893. /**
  85894. * The short type.
  85895. */
  85896. static readonly SHORT: number;
  85897. /**
  85898. * The unsigned short type.
  85899. */
  85900. static readonly UNSIGNED_SHORT: number;
  85901. /**
  85902. * The integer type.
  85903. */
  85904. static readonly INT: number;
  85905. /**
  85906. * The unsigned integer type.
  85907. */
  85908. static readonly UNSIGNED_INT: number;
  85909. /**
  85910. * The float type.
  85911. */
  85912. static readonly FLOAT: number;
  85913. /**
  85914. * Gets or sets the instance divisor when in instanced mode
  85915. */
  85916. get instanceDivisor(): number;
  85917. set instanceDivisor(value: number);
  85918. /**
  85919. * Gets the byte stride.
  85920. */
  85921. readonly byteStride: number;
  85922. /**
  85923. * Gets the byte offset.
  85924. */
  85925. readonly byteOffset: number;
  85926. /**
  85927. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  85928. */
  85929. readonly normalized: boolean;
  85930. /**
  85931. * Gets the data type of each component in the array.
  85932. */
  85933. readonly type: number;
  85934. /**
  85935. * Constructor
  85936. * @param engine the engine
  85937. * @param data the data to use for this vertex buffer
  85938. * @param kind the vertex buffer kind
  85939. * @param updatable whether the data is updatable
  85940. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  85941. * @param stride the stride (optional)
  85942. * @param instanced whether the buffer is instanced (optional)
  85943. * @param offset the offset of the data (optional)
  85944. * @param size the number of components (optional)
  85945. * @param type the type of the component (optional)
  85946. * @param normalized whether the data contains normalized data (optional)
  85947. * @param useBytes set to true if stride and offset are in bytes (optional)
  85948. * @param divisor defines the instance divisor to use (1 by default)
  85949. */
  85950. 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);
  85951. /** @hidden */
  85952. _rebuild(): void;
  85953. /**
  85954. * Returns the kind of the VertexBuffer (string)
  85955. * @returns a string
  85956. */
  85957. getKind(): string;
  85958. /**
  85959. * Gets a boolean indicating if the VertexBuffer is updatable?
  85960. * @returns true if the buffer is updatable
  85961. */
  85962. isUpdatable(): boolean;
  85963. /**
  85964. * Gets current buffer's data
  85965. * @returns a DataArray or null
  85966. */
  85967. getData(): Nullable<DataArray>;
  85968. /**
  85969. * Gets underlying native buffer
  85970. * @returns underlying native buffer
  85971. */
  85972. getBuffer(): Nullable<DataBuffer>;
  85973. /**
  85974. * Gets the stride in float32 units (i.e. byte stride / 4).
  85975. * May not be an integer if the byte stride is not divisible by 4.
  85976. * @returns the stride in float32 units
  85977. * @deprecated Please use byteStride instead.
  85978. */
  85979. getStrideSize(): number;
  85980. /**
  85981. * Returns the offset as a multiple of the type byte length.
  85982. * @returns the offset in bytes
  85983. * @deprecated Please use byteOffset instead.
  85984. */
  85985. getOffset(): number;
  85986. /**
  85987. * Returns the number of components per vertex attribute (integer)
  85988. * @returns the size in float
  85989. */
  85990. getSize(): number;
  85991. /**
  85992. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  85993. * @returns true if this buffer is instanced
  85994. */
  85995. getIsInstanced(): boolean;
  85996. /**
  85997. * Returns the instancing divisor, zero for non-instanced (integer).
  85998. * @returns a number
  85999. */
  86000. getInstanceDivisor(): number;
  86001. /**
  86002. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86003. * @param data defines the data to store
  86004. */
  86005. create(data?: DataArray): void;
  86006. /**
  86007. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86008. * This function will create a new buffer if the current one is not updatable
  86009. * @param data defines the data to store
  86010. */
  86011. update(data: DataArray): void;
  86012. /**
  86013. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86014. * Returns the directly updated WebGLBuffer.
  86015. * @param data the new data
  86016. * @param offset the new offset
  86017. * @param useBytes set to true if the offset is in bytes
  86018. */
  86019. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86020. /**
  86021. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86022. */
  86023. dispose(): void;
  86024. /**
  86025. * Enumerates each value of this vertex buffer as numbers.
  86026. * @param count the number of values to enumerate
  86027. * @param callback the callback function called for each value
  86028. */
  86029. forEach(count: number, callback: (value: number, index: number) => void): void;
  86030. /**
  86031. * Positions
  86032. */
  86033. static readonly PositionKind: string;
  86034. /**
  86035. * Normals
  86036. */
  86037. static readonly NormalKind: string;
  86038. /**
  86039. * Tangents
  86040. */
  86041. static readonly TangentKind: string;
  86042. /**
  86043. * Texture coordinates
  86044. */
  86045. static readonly UVKind: string;
  86046. /**
  86047. * Texture coordinates 2
  86048. */
  86049. static readonly UV2Kind: string;
  86050. /**
  86051. * Texture coordinates 3
  86052. */
  86053. static readonly UV3Kind: string;
  86054. /**
  86055. * Texture coordinates 4
  86056. */
  86057. static readonly UV4Kind: string;
  86058. /**
  86059. * Texture coordinates 5
  86060. */
  86061. static readonly UV5Kind: string;
  86062. /**
  86063. * Texture coordinates 6
  86064. */
  86065. static readonly UV6Kind: string;
  86066. /**
  86067. * Colors
  86068. */
  86069. static readonly ColorKind: string;
  86070. /**
  86071. * Matrix indices (for bones)
  86072. */
  86073. static readonly MatricesIndicesKind: string;
  86074. /**
  86075. * Matrix weights (for bones)
  86076. */
  86077. static readonly MatricesWeightsKind: string;
  86078. /**
  86079. * Additional matrix indices (for bones)
  86080. */
  86081. static readonly MatricesIndicesExtraKind: string;
  86082. /**
  86083. * Additional matrix weights (for bones)
  86084. */
  86085. static readonly MatricesWeightsExtraKind: string;
  86086. /**
  86087. * Deduces the stride given a kind.
  86088. * @param kind The kind string to deduce
  86089. * @returns The deduced stride
  86090. */
  86091. static DeduceStride(kind: string): number;
  86092. /**
  86093. * Gets the byte length of the given type.
  86094. * @param type the type
  86095. * @returns the number of bytes
  86096. */
  86097. static GetTypeByteLength(type: number): number;
  86098. /**
  86099. * Enumerates each value of the given parameters as numbers.
  86100. * @param data the data to enumerate
  86101. * @param byteOffset the byte offset of the data
  86102. * @param byteStride the byte stride of the data
  86103. * @param componentCount the number of components per element
  86104. * @param componentType the type of the component
  86105. * @param count the number of values to enumerate
  86106. * @param normalized whether the data is normalized
  86107. * @param callback the callback function called for each value
  86108. */
  86109. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86110. private static _GetFloatValue;
  86111. }
  86112. }
  86113. declare module BABYLON {
  86114. /**
  86115. * @hidden
  86116. */
  86117. export class IntersectionInfo {
  86118. bu: Nullable<number>;
  86119. bv: Nullable<number>;
  86120. distance: number;
  86121. faceId: number;
  86122. subMeshId: number;
  86123. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86124. }
  86125. }
  86126. declare module BABYLON {
  86127. /**
  86128. * Class used to store bounding sphere information
  86129. */
  86130. export class BoundingSphere {
  86131. /**
  86132. * Gets the center of the bounding sphere in local space
  86133. */
  86134. readonly center: Vector3;
  86135. /**
  86136. * Radius of the bounding sphere in local space
  86137. */
  86138. radius: number;
  86139. /**
  86140. * Gets the center of the bounding sphere in world space
  86141. */
  86142. readonly centerWorld: Vector3;
  86143. /**
  86144. * Radius of the bounding sphere in world space
  86145. */
  86146. radiusWorld: number;
  86147. /**
  86148. * Gets the minimum vector in local space
  86149. */
  86150. readonly minimum: Vector3;
  86151. /**
  86152. * Gets the maximum vector in local space
  86153. */
  86154. readonly maximum: Vector3;
  86155. private _worldMatrix;
  86156. private static readonly TmpVector3;
  86157. /**
  86158. * Creates a new bounding sphere
  86159. * @param min defines the minimum vector (in local space)
  86160. * @param max defines the maximum vector (in local space)
  86161. * @param worldMatrix defines the new world matrix
  86162. */
  86163. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86164. /**
  86165. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86166. * @param min defines the new minimum vector (in local space)
  86167. * @param max defines the new maximum vector (in local space)
  86168. * @param worldMatrix defines the new world matrix
  86169. */
  86170. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86171. /**
  86172. * Scale the current bounding sphere by applying a scale factor
  86173. * @param factor defines the scale factor to apply
  86174. * @returns the current bounding box
  86175. */
  86176. scale(factor: number): BoundingSphere;
  86177. /**
  86178. * Gets the world matrix of the bounding box
  86179. * @returns a matrix
  86180. */
  86181. getWorldMatrix(): DeepImmutable<Matrix>;
  86182. /** @hidden */
  86183. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86184. /**
  86185. * Tests if the bounding sphere is intersecting the frustum planes
  86186. * @param frustumPlanes defines the frustum planes to test
  86187. * @returns true if there is an intersection
  86188. */
  86189. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86190. /**
  86191. * Tests if the bounding sphere center is in between the frustum planes.
  86192. * Used for optimistic fast inclusion.
  86193. * @param frustumPlanes defines the frustum planes to test
  86194. * @returns true if the sphere center is in between the frustum planes
  86195. */
  86196. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86197. /**
  86198. * Tests if a point is inside the bounding sphere
  86199. * @param point defines the point to test
  86200. * @returns true if the point is inside the bounding sphere
  86201. */
  86202. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86203. /**
  86204. * Checks if two sphere intersct
  86205. * @param sphere0 sphere 0
  86206. * @param sphere1 sphere 1
  86207. * @returns true if the speres intersect
  86208. */
  86209. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86210. }
  86211. }
  86212. declare module BABYLON {
  86213. /**
  86214. * Class used to store bounding box information
  86215. */
  86216. export class BoundingBox implements ICullable {
  86217. /**
  86218. * Gets the 8 vectors representing the bounding box in local space
  86219. */
  86220. readonly vectors: Vector3[];
  86221. /**
  86222. * Gets the center of the bounding box in local space
  86223. */
  86224. readonly center: Vector3;
  86225. /**
  86226. * Gets the center of the bounding box in world space
  86227. */
  86228. readonly centerWorld: Vector3;
  86229. /**
  86230. * Gets the extend size in local space
  86231. */
  86232. readonly extendSize: Vector3;
  86233. /**
  86234. * Gets the extend size in world space
  86235. */
  86236. readonly extendSizeWorld: Vector3;
  86237. /**
  86238. * Gets the OBB (object bounding box) directions
  86239. */
  86240. readonly directions: Vector3[];
  86241. /**
  86242. * Gets the 8 vectors representing the bounding box in world space
  86243. */
  86244. readonly vectorsWorld: Vector3[];
  86245. /**
  86246. * Gets the minimum vector in world space
  86247. */
  86248. readonly minimumWorld: Vector3;
  86249. /**
  86250. * Gets the maximum vector in world space
  86251. */
  86252. readonly maximumWorld: Vector3;
  86253. /**
  86254. * Gets the minimum vector in local space
  86255. */
  86256. readonly minimum: Vector3;
  86257. /**
  86258. * Gets the maximum vector in local space
  86259. */
  86260. readonly maximum: Vector3;
  86261. private _worldMatrix;
  86262. private static readonly TmpVector3;
  86263. /**
  86264. * @hidden
  86265. */
  86266. _tag: number;
  86267. /**
  86268. * Creates a new bounding box
  86269. * @param min defines the minimum vector (in local space)
  86270. * @param max defines the maximum vector (in local space)
  86271. * @param worldMatrix defines the new world matrix
  86272. */
  86273. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86274. /**
  86275. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86276. * @param min defines the new minimum vector (in local space)
  86277. * @param max defines the new maximum vector (in local space)
  86278. * @param worldMatrix defines the new world matrix
  86279. */
  86280. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86281. /**
  86282. * Scale the current bounding box by applying a scale factor
  86283. * @param factor defines the scale factor to apply
  86284. * @returns the current bounding box
  86285. */
  86286. scale(factor: number): BoundingBox;
  86287. /**
  86288. * Gets the world matrix of the bounding box
  86289. * @returns a matrix
  86290. */
  86291. getWorldMatrix(): DeepImmutable<Matrix>;
  86292. /** @hidden */
  86293. _update(world: DeepImmutable<Matrix>): void;
  86294. /**
  86295. * Tests if the bounding box is intersecting the frustum planes
  86296. * @param frustumPlanes defines the frustum planes to test
  86297. * @returns true if there is an intersection
  86298. */
  86299. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86300. /**
  86301. * Tests if the bounding box is entirely inside the frustum planes
  86302. * @param frustumPlanes defines the frustum planes to test
  86303. * @returns true if there is an inclusion
  86304. */
  86305. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86306. /**
  86307. * Tests if a point is inside the bounding box
  86308. * @param point defines the point to test
  86309. * @returns true if the point is inside the bounding box
  86310. */
  86311. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86312. /**
  86313. * Tests if the bounding box intersects with a bounding sphere
  86314. * @param sphere defines the sphere to test
  86315. * @returns true if there is an intersection
  86316. */
  86317. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86318. /**
  86319. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86320. * @param min defines the min vector to use
  86321. * @param max defines the max vector to use
  86322. * @returns true if there is an intersection
  86323. */
  86324. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86325. /**
  86326. * Tests if two bounding boxes are intersections
  86327. * @param box0 defines the first box to test
  86328. * @param box1 defines the second box to test
  86329. * @returns true if there is an intersection
  86330. */
  86331. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86332. /**
  86333. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86334. * @param minPoint defines the minimum vector of the bounding box
  86335. * @param maxPoint defines the maximum vector of the bounding box
  86336. * @param sphereCenter defines the sphere center
  86337. * @param sphereRadius defines the sphere radius
  86338. * @returns true if there is an intersection
  86339. */
  86340. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86341. /**
  86342. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86343. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86344. * @param frustumPlanes defines the frustum planes to test
  86345. * @return true if there is an inclusion
  86346. */
  86347. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86348. /**
  86349. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86350. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86351. * @param frustumPlanes defines the frustum planes to test
  86352. * @return true if there is an intersection
  86353. */
  86354. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86355. }
  86356. }
  86357. declare module BABYLON {
  86358. /** @hidden */
  86359. export class Collider {
  86360. /** Define if a collision was found */
  86361. collisionFound: boolean;
  86362. /**
  86363. * Define last intersection point in local space
  86364. */
  86365. intersectionPoint: Vector3;
  86366. /**
  86367. * Define last collided mesh
  86368. */
  86369. collidedMesh: Nullable<AbstractMesh>;
  86370. private _collisionPoint;
  86371. private _planeIntersectionPoint;
  86372. private _tempVector;
  86373. private _tempVector2;
  86374. private _tempVector3;
  86375. private _tempVector4;
  86376. private _edge;
  86377. private _baseToVertex;
  86378. private _destinationPoint;
  86379. private _slidePlaneNormal;
  86380. private _displacementVector;
  86381. /** @hidden */
  86382. _radius: Vector3;
  86383. /** @hidden */
  86384. _retry: number;
  86385. private _velocity;
  86386. private _basePoint;
  86387. private _epsilon;
  86388. /** @hidden */
  86389. _velocityWorldLength: number;
  86390. /** @hidden */
  86391. _basePointWorld: Vector3;
  86392. private _velocityWorld;
  86393. private _normalizedVelocity;
  86394. /** @hidden */
  86395. _initialVelocity: Vector3;
  86396. /** @hidden */
  86397. _initialPosition: Vector3;
  86398. private _nearestDistance;
  86399. private _collisionMask;
  86400. get collisionMask(): number;
  86401. set collisionMask(mask: number);
  86402. /**
  86403. * Gets the plane normal used to compute the sliding response (in local space)
  86404. */
  86405. get slidePlaneNormal(): Vector3;
  86406. /** @hidden */
  86407. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86408. /** @hidden */
  86409. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86410. /** @hidden */
  86411. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86412. /** @hidden */
  86413. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86414. /** @hidden */
  86415. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86416. /** @hidden */
  86417. _getResponse(pos: Vector3, vel: Vector3): void;
  86418. }
  86419. }
  86420. declare module BABYLON {
  86421. /**
  86422. * Interface for cullable objects
  86423. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86424. */
  86425. export interface ICullable {
  86426. /**
  86427. * Checks if the object or part of the object is in the frustum
  86428. * @param frustumPlanes Camera near/planes
  86429. * @returns true if the object is in frustum otherwise false
  86430. */
  86431. isInFrustum(frustumPlanes: Plane[]): boolean;
  86432. /**
  86433. * Checks if a cullable object (mesh...) is in the camera frustum
  86434. * Unlike isInFrustum this cheks the full bounding box
  86435. * @param frustumPlanes Camera near/planes
  86436. * @returns true if the object is in frustum otherwise false
  86437. */
  86438. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86439. }
  86440. /**
  86441. * Info for a bounding data of a mesh
  86442. */
  86443. export class BoundingInfo implements ICullable {
  86444. /**
  86445. * Bounding box for the mesh
  86446. */
  86447. readonly boundingBox: BoundingBox;
  86448. /**
  86449. * Bounding sphere for the mesh
  86450. */
  86451. readonly boundingSphere: BoundingSphere;
  86452. private _isLocked;
  86453. private static readonly TmpVector3;
  86454. /**
  86455. * Constructs bounding info
  86456. * @param minimum min vector of the bounding box/sphere
  86457. * @param maximum max vector of the bounding box/sphere
  86458. * @param worldMatrix defines the new world matrix
  86459. */
  86460. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86461. /**
  86462. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86463. * @param min defines the new minimum vector (in local space)
  86464. * @param max defines the new maximum vector (in local space)
  86465. * @param worldMatrix defines the new world matrix
  86466. */
  86467. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86468. /**
  86469. * min vector of the bounding box/sphere
  86470. */
  86471. get minimum(): Vector3;
  86472. /**
  86473. * max vector of the bounding box/sphere
  86474. */
  86475. get maximum(): Vector3;
  86476. /**
  86477. * If the info is locked and won't be updated to avoid perf overhead
  86478. */
  86479. get isLocked(): boolean;
  86480. set isLocked(value: boolean);
  86481. /**
  86482. * Updates the bounding sphere and box
  86483. * @param world world matrix to be used to update
  86484. */
  86485. update(world: DeepImmutable<Matrix>): void;
  86486. /**
  86487. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86488. * @param center New center of the bounding info
  86489. * @param extend New extend of the bounding info
  86490. * @returns the current bounding info
  86491. */
  86492. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86493. /**
  86494. * Scale the current bounding info by applying a scale factor
  86495. * @param factor defines the scale factor to apply
  86496. * @returns the current bounding info
  86497. */
  86498. scale(factor: number): BoundingInfo;
  86499. /**
  86500. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86501. * @param frustumPlanes defines the frustum to test
  86502. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86503. * @returns true if the bounding info is in the frustum planes
  86504. */
  86505. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86506. /**
  86507. * Gets the world distance between the min and max points of the bounding box
  86508. */
  86509. get diagonalLength(): number;
  86510. /**
  86511. * Checks if a cullable object (mesh...) is in the camera frustum
  86512. * Unlike isInFrustum this cheks the full bounding box
  86513. * @param frustumPlanes Camera near/planes
  86514. * @returns true if the object is in frustum otherwise false
  86515. */
  86516. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86517. /** @hidden */
  86518. _checkCollision(collider: Collider): boolean;
  86519. /**
  86520. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86521. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86522. * @param point the point to check intersection with
  86523. * @returns if the point intersects
  86524. */
  86525. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86526. /**
  86527. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86528. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86529. * @param boundingInfo the bounding info to check intersection with
  86530. * @param precise if the intersection should be done using OBB
  86531. * @returns if the bounding info intersects
  86532. */
  86533. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86534. }
  86535. }
  86536. declare module BABYLON {
  86537. /**
  86538. * Extracts minimum and maximum values from a list of indexed positions
  86539. * @param positions defines the positions to use
  86540. * @param indices defines the indices to the positions
  86541. * @param indexStart defines the start index
  86542. * @param indexCount defines the end index
  86543. * @param bias defines bias value to add to the result
  86544. * @return minimum and maximum values
  86545. */
  86546. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86547. minimum: Vector3;
  86548. maximum: Vector3;
  86549. };
  86550. /**
  86551. * Extracts minimum and maximum values from a list of positions
  86552. * @param positions defines the positions to use
  86553. * @param start defines the start index in the positions array
  86554. * @param count defines the number of positions to handle
  86555. * @param bias defines bias value to add to the result
  86556. * @param stride defines the stride size to use (distance between two positions in the positions array)
  86557. * @return minimum and maximum values
  86558. */
  86559. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  86560. minimum: Vector3;
  86561. maximum: Vector3;
  86562. };
  86563. }
  86564. declare module BABYLON {
  86565. /** @hidden */
  86566. export class WebGLDataBuffer extends DataBuffer {
  86567. private _buffer;
  86568. constructor(resource: WebGLBuffer);
  86569. get underlyingResource(): any;
  86570. }
  86571. }
  86572. declare module BABYLON {
  86573. /** @hidden */
  86574. export class WebGLPipelineContext implements IPipelineContext {
  86575. engine: ThinEngine;
  86576. program: Nullable<WebGLProgram>;
  86577. context?: WebGLRenderingContext;
  86578. vertexShader?: WebGLShader;
  86579. fragmentShader?: WebGLShader;
  86580. isParallelCompiled: boolean;
  86581. onCompiled?: () => void;
  86582. transformFeedback?: WebGLTransformFeedback | null;
  86583. vertexCompilationError: Nullable<string>;
  86584. fragmentCompilationError: Nullable<string>;
  86585. programLinkError: Nullable<string>;
  86586. programValidationError: Nullable<string>;
  86587. get isAsync(): boolean;
  86588. get isReady(): boolean;
  86589. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  86590. _getVertexShaderCode(): string | null;
  86591. _getFragmentShaderCode(): string | null;
  86592. }
  86593. }
  86594. declare module BABYLON {
  86595. interface ThinEngine {
  86596. /**
  86597. * Create an uniform buffer
  86598. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86599. * @param elements defines the content of the uniform buffer
  86600. * @returns the webGL uniform buffer
  86601. */
  86602. createUniformBuffer(elements: FloatArray): DataBuffer;
  86603. /**
  86604. * Create a dynamic uniform buffer
  86605. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86606. * @param elements defines the content of the uniform buffer
  86607. * @returns the webGL uniform buffer
  86608. */
  86609. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  86610. /**
  86611. * Update an existing uniform buffer
  86612. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86613. * @param uniformBuffer defines the target uniform buffer
  86614. * @param elements defines the content to update
  86615. * @param offset defines the offset in the uniform buffer where update should start
  86616. * @param count defines the size of the data to update
  86617. */
  86618. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  86619. /**
  86620. * Bind an uniform buffer to the current webGL context
  86621. * @param buffer defines the buffer to bind
  86622. */
  86623. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86624. /**
  86625. * Bind a buffer to the current webGL context at a given location
  86626. * @param buffer defines the buffer to bind
  86627. * @param location defines the index where to bind the buffer
  86628. */
  86629. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86630. /**
  86631. * Bind a specific block at a given index in a specific shader program
  86632. * @param pipelineContext defines the pipeline context to use
  86633. * @param blockName defines the block name
  86634. * @param index defines the index where to bind the block
  86635. */
  86636. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  86637. }
  86638. }
  86639. declare module BABYLON {
  86640. /**
  86641. * Uniform buffer objects.
  86642. *
  86643. * Handles blocks of uniform on the GPU.
  86644. *
  86645. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86646. *
  86647. * For more information, please refer to :
  86648. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86649. */
  86650. export class UniformBuffer {
  86651. private _engine;
  86652. private _buffer;
  86653. private _data;
  86654. private _bufferData;
  86655. private _dynamic?;
  86656. private _uniformLocations;
  86657. private _uniformSizes;
  86658. private _uniformLocationPointer;
  86659. private _needSync;
  86660. private _noUBO;
  86661. private _currentEffect;
  86662. /** @hidden */
  86663. _alreadyBound: boolean;
  86664. private static _MAX_UNIFORM_SIZE;
  86665. private static _tempBuffer;
  86666. /**
  86667. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  86668. * This is dynamic to allow compat with webgl 1 and 2.
  86669. * You will need to pass the name of the uniform as well as the value.
  86670. */
  86671. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  86672. /**
  86673. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  86674. * This is dynamic to allow compat with webgl 1 and 2.
  86675. * You will need to pass the name of the uniform as well as the value.
  86676. */
  86677. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  86678. /**
  86679. * Lambda to Update a single float in a uniform buffer.
  86680. * This is dynamic to allow compat with webgl 1 and 2.
  86681. * You will need to pass the name of the uniform as well as the value.
  86682. */
  86683. updateFloat: (name: string, x: number) => void;
  86684. /**
  86685. * Lambda to Update a vec2 of float in a uniform buffer.
  86686. * This is dynamic to allow compat with webgl 1 and 2.
  86687. * You will need to pass the name of the uniform as well as the value.
  86688. */
  86689. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  86690. /**
  86691. * Lambda to Update a vec3 of float in a uniform buffer.
  86692. * This is dynamic to allow compat with webgl 1 and 2.
  86693. * You will need to pass the name of the uniform as well as the value.
  86694. */
  86695. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  86696. /**
  86697. * Lambda to Update a vec4 of float in a uniform buffer.
  86698. * This is dynamic to allow compat with webgl 1 and 2.
  86699. * You will need to pass the name of the uniform as well as the value.
  86700. */
  86701. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  86702. /**
  86703. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  86704. * This is dynamic to allow compat with webgl 1 and 2.
  86705. * You will need to pass the name of the uniform as well as the value.
  86706. */
  86707. updateMatrix: (name: string, mat: Matrix) => void;
  86708. /**
  86709. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  86710. * This is dynamic to allow compat with webgl 1 and 2.
  86711. * You will need to pass the name of the uniform as well as the value.
  86712. */
  86713. updateVector3: (name: string, vector: Vector3) => void;
  86714. /**
  86715. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  86716. * This is dynamic to allow compat with webgl 1 and 2.
  86717. * You will need to pass the name of the uniform as well as the value.
  86718. */
  86719. updateVector4: (name: string, vector: Vector4) => void;
  86720. /**
  86721. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  86722. * This is dynamic to allow compat with webgl 1 and 2.
  86723. * You will need to pass the name of the uniform as well as the value.
  86724. */
  86725. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  86726. /**
  86727. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  86728. * This is dynamic to allow compat with webgl 1 and 2.
  86729. * You will need to pass the name of the uniform as well as the value.
  86730. */
  86731. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  86732. /**
  86733. * Instantiates a new Uniform buffer objects.
  86734. *
  86735. * Handles blocks of uniform on the GPU.
  86736. *
  86737. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86738. *
  86739. * For more information, please refer to :
  86740. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86741. * @param engine Define the engine the buffer is associated with
  86742. * @param data Define the data contained in the buffer
  86743. * @param dynamic Define if the buffer is updatable
  86744. */
  86745. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  86746. /**
  86747. * Indicates if the buffer is using the WebGL2 UBO implementation,
  86748. * or just falling back on setUniformXXX calls.
  86749. */
  86750. get useUbo(): boolean;
  86751. /**
  86752. * Indicates if the WebGL underlying uniform buffer is in sync
  86753. * with the javascript cache data.
  86754. */
  86755. get isSync(): boolean;
  86756. /**
  86757. * Indicates if the WebGL underlying uniform buffer is dynamic.
  86758. * Also, a dynamic UniformBuffer will disable cache verification and always
  86759. * update the underlying WebGL uniform buffer to the GPU.
  86760. * @returns if Dynamic, otherwise false
  86761. */
  86762. isDynamic(): boolean;
  86763. /**
  86764. * The data cache on JS side.
  86765. * @returns the underlying data as a float array
  86766. */
  86767. getData(): Float32Array;
  86768. /**
  86769. * The underlying WebGL Uniform buffer.
  86770. * @returns the webgl buffer
  86771. */
  86772. getBuffer(): Nullable<DataBuffer>;
  86773. /**
  86774. * std140 layout specifies how to align data within an UBO structure.
  86775. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  86776. * for specs.
  86777. */
  86778. private _fillAlignment;
  86779. /**
  86780. * Adds an uniform in the buffer.
  86781. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  86782. * for the layout to be correct !
  86783. * @param name Name of the uniform, as used in the uniform block in the shader.
  86784. * @param size Data size, or data directly.
  86785. */
  86786. addUniform(name: string, size: number | number[]): void;
  86787. /**
  86788. * Adds a Matrix 4x4 to the uniform buffer.
  86789. * @param name Name of the uniform, as used in the uniform block in the shader.
  86790. * @param mat A 4x4 matrix.
  86791. */
  86792. addMatrix(name: string, mat: Matrix): void;
  86793. /**
  86794. * Adds a vec2 to the uniform buffer.
  86795. * @param name Name of the uniform, as used in the uniform block in the shader.
  86796. * @param x Define the x component value of the vec2
  86797. * @param y Define the y component value of the vec2
  86798. */
  86799. addFloat2(name: string, x: number, y: number): void;
  86800. /**
  86801. * Adds a vec3 to the uniform buffer.
  86802. * @param name Name of the uniform, as used in the uniform block in the shader.
  86803. * @param x Define the x component value of the vec3
  86804. * @param y Define the y component value of the vec3
  86805. * @param z Define the z component value of the vec3
  86806. */
  86807. addFloat3(name: string, x: number, y: number, z: number): void;
  86808. /**
  86809. * Adds a vec3 to the uniform buffer.
  86810. * @param name Name of the uniform, as used in the uniform block in the shader.
  86811. * @param color Define the vec3 from a Color
  86812. */
  86813. addColor3(name: string, color: Color3): void;
  86814. /**
  86815. * Adds a vec4 to the uniform buffer.
  86816. * @param name Name of the uniform, as used in the uniform block in the shader.
  86817. * @param color Define the rgb components from a Color
  86818. * @param alpha Define the a component of the vec4
  86819. */
  86820. addColor4(name: string, color: Color3, alpha: number): void;
  86821. /**
  86822. * Adds a vec3 to the uniform buffer.
  86823. * @param name Name of the uniform, as used in the uniform block in the shader.
  86824. * @param vector Define the vec3 components from a Vector
  86825. */
  86826. addVector3(name: string, vector: Vector3): void;
  86827. /**
  86828. * Adds a Matrix 3x3 to the uniform buffer.
  86829. * @param name Name of the uniform, as used in the uniform block in the shader.
  86830. */
  86831. addMatrix3x3(name: string): void;
  86832. /**
  86833. * Adds a Matrix 2x2 to the uniform buffer.
  86834. * @param name Name of the uniform, as used in the uniform block in the shader.
  86835. */
  86836. addMatrix2x2(name: string): void;
  86837. /**
  86838. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  86839. */
  86840. create(): void;
  86841. /** @hidden */
  86842. _rebuild(): void;
  86843. /**
  86844. * Updates the WebGL Uniform Buffer on the GPU.
  86845. * If the `dynamic` flag is set to true, no cache comparison is done.
  86846. * Otherwise, the buffer will be updated only if the cache differs.
  86847. */
  86848. update(): void;
  86849. /**
  86850. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  86851. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  86852. * @param data Define the flattened data
  86853. * @param size Define the size of the data.
  86854. */
  86855. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  86856. private _valueCache;
  86857. private _cacheMatrix;
  86858. private _updateMatrix3x3ForUniform;
  86859. private _updateMatrix3x3ForEffect;
  86860. private _updateMatrix2x2ForEffect;
  86861. private _updateMatrix2x2ForUniform;
  86862. private _updateFloatForEffect;
  86863. private _updateFloatForUniform;
  86864. private _updateFloat2ForEffect;
  86865. private _updateFloat2ForUniform;
  86866. private _updateFloat3ForEffect;
  86867. private _updateFloat3ForUniform;
  86868. private _updateFloat4ForEffect;
  86869. private _updateFloat4ForUniform;
  86870. private _updateMatrixForEffect;
  86871. private _updateMatrixForUniform;
  86872. private _updateVector3ForEffect;
  86873. private _updateVector3ForUniform;
  86874. private _updateVector4ForEffect;
  86875. private _updateVector4ForUniform;
  86876. private _updateColor3ForEffect;
  86877. private _updateColor3ForUniform;
  86878. private _updateColor4ForEffect;
  86879. private _updateColor4ForUniform;
  86880. /**
  86881. * Sets a sampler uniform on the effect.
  86882. * @param name Define the name of the sampler.
  86883. * @param texture Define the texture to set in the sampler
  86884. */
  86885. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  86886. /**
  86887. * Directly updates the value of the uniform in the cache AND on the GPU.
  86888. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  86889. * @param data Define the flattened data
  86890. */
  86891. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  86892. /**
  86893. * Binds this uniform buffer to an effect.
  86894. * @param effect Define the effect to bind the buffer to
  86895. * @param name Name of the uniform block in the shader.
  86896. */
  86897. bindToEffect(effect: Effect, name: string): void;
  86898. /**
  86899. * Disposes the uniform buffer.
  86900. */
  86901. dispose(): void;
  86902. }
  86903. }
  86904. declare module BABYLON {
  86905. /**
  86906. * Enum that determines the text-wrapping mode to use.
  86907. */
  86908. export enum InspectableType {
  86909. /**
  86910. * Checkbox for booleans
  86911. */
  86912. Checkbox = 0,
  86913. /**
  86914. * Sliders for numbers
  86915. */
  86916. Slider = 1,
  86917. /**
  86918. * Vector3
  86919. */
  86920. Vector3 = 2,
  86921. /**
  86922. * Quaternions
  86923. */
  86924. Quaternion = 3,
  86925. /**
  86926. * Color3
  86927. */
  86928. Color3 = 4,
  86929. /**
  86930. * String
  86931. */
  86932. String = 5
  86933. }
  86934. /**
  86935. * Interface used to define custom inspectable properties.
  86936. * This interface is used by the inspector to display custom property grids
  86937. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  86938. */
  86939. export interface IInspectable {
  86940. /**
  86941. * Gets the label to display
  86942. */
  86943. label: string;
  86944. /**
  86945. * Gets the name of the property to edit
  86946. */
  86947. propertyName: string;
  86948. /**
  86949. * Gets the type of the editor to use
  86950. */
  86951. type: InspectableType;
  86952. /**
  86953. * Gets the minimum value of the property when using in "slider" mode
  86954. */
  86955. min?: number;
  86956. /**
  86957. * Gets the maximum value of the property when using in "slider" mode
  86958. */
  86959. max?: number;
  86960. /**
  86961. * Gets the setp to use when using in "slider" mode
  86962. */
  86963. step?: number;
  86964. }
  86965. }
  86966. declare module BABYLON {
  86967. /**
  86968. * Class used to provide helper for timing
  86969. */
  86970. export class TimingTools {
  86971. /**
  86972. * Polyfill for setImmediate
  86973. * @param action defines the action to execute after the current execution block
  86974. */
  86975. static SetImmediate(action: () => void): void;
  86976. }
  86977. }
  86978. declare module BABYLON {
  86979. /**
  86980. * Class used to enable instatition of objects by class name
  86981. */
  86982. export class InstantiationTools {
  86983. /**
  86984. * Use this object to register external classes like custom textures or material
  86985. * to allow the laoders to instantiate them
  86986. */
  86987. static RegisteredExternalClasses: {
  86988. [key: string]: Object;
  86989. };
  86990. /**
  86991. * Tries to instantiate a new object from a given class name
  86992. * @param className defines the class name to instantiate
  86993. * @returns the new object or null if the system was not able to do the instantiation
  86994. */
  86995. static Instantiate(className: string): any;
  86996. }
  86997. }
  86998. declare module BABYLON {
  86999. /**
  87000. * Define options used to create a depth texture
  87001. */
  87002. export class DepthTextureCreationOptions {
  87003. /** Specifies whether or not a stencil should be allocated in the texture */
  87004. generateStencil?: boolean;
  87005. /** Specifies whether or not bilinear filtering is enable on the texture */
  87006. bilinearFiltering?: boolean;
  87007. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87008. comparisonFunction?: number;
  87009. /** Specifies if the created texture is a cube texture */
  87010. isCube?: boolean;
  87011. }
  87012. }
  87013. declare module BABYLON {
  87014. interface ThinEngine {
  87015. /**
  87016. * Creates a depth stencil cube texture.
  87017. * This is only available in WebGL 2.
  87018. * @param size The size of face edge in the cube texture.
  87019. * @param options The options defining the cube texture.
  87020. * @returns The cube texture
  87021. */
  87022. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87023. /**
  87024. * Creates a cube texture
  87025. * @param rootUrl defines the url where the files to load is located
  87026. * @param scene defines the current scene
  87027. * @param files defines the list of files to load (1 per face)
  87028. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87029. * @param onLoad defines an optional callback raised when the texture is loaded
  87030. * @param onError defines an optional callback raised if there is an issue to load the texture
  87031. * @param format defines the format of the data
  87032. * @param forcedExtension defines the extension to use to pick the right loader
  87033. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87034. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87035. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87036. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87037. * @returns the cube texture as an InternalTexture
  87038. */
  87039. 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;
  87040. /**
  87041. * Creates a cube texture
  87042. * @param rootUrl defines the url where the files to load is located
  87043. * @param scene defines the current scene
  87044. * @param files defines the list of files to load (1 per face)
  87045. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87046. * @param onLoad defines an optional callback raised when the texture is loaded
  87047. * @param onError defines an optional callback raised if there is an issue to load the texture
  87048. * @param format defines the format of the data
  87049. * @param forcedExtension defines the extension to use to pick the right loader
  87050. * @returns the cube texture as an InternalTexture
  87051. */
  87052. 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;
  87053. /**
  87054. * Creates a cube texture
  87055. * @param rootUrl defines the url where the files to load is located
  87056. * @param scene defines the current scene
  87057. * @param files defines the list of files to load (1 per face)
  87058. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87059. * @param onLoad defines an optional callback raised when the texture is loaded
  87060. * @param onError defines an optional callback raised if there is an issue to load the texture
  87061. * @param format defines the format of the data
  87062. * @param forcedExtension defines the extension to use to pick the right loader
  87063. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87064. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87065. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87066. * @returns the cube texture as an InternalTexture
  87067. */
  87068. 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;
  87069. /** @hidden */
  87070. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87071. /** @hidden */
  87072. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87073. /** @hidden */
  87074. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87075. /** @hidden */
  87076. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87077. /**
  87078. * @hidden
  87079. */
  87080. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87081. }
  87082. }
  87083. declare module BABYLON {
  87084. /**
  87085. * Class for creating a cube texture
  87086. */
  87087. export class CubeTexture extends BaseTexture {
  87088. private _delayedOnLoad;
  87089. /**
  87090. * Observable triggered once the texture has been loaded.
  87091. */
  87092. onLoadObservable: Observable<CubeTexture>;
  87093. /**
  87094. * The url of the texture
  87095. */
  87096. url: string;
  87097. /**
  87098. * Gets or sets the center of the bounding box associated with the cube texture.
  87099. * It must define where the camera used to render the texture was set
  87100. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87101. */
  87102. boundingBoxPosition: Vector3;
  87103. private _boundingBoxSize;
  87104. /**
  87105. * Gets or sets the size of the bounding box associated with the cube texture
  87106. * When defined, the cubemap will switch to local mode
  87107. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87108. * @example https://www.babylonjs-playground.com/#RNASML
  87109. */
  87110. set boundingBoxSize(value: Vector3);
  87111. /**
  87112. * Returns the bounding box size
  87113. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87114. */
  87115. get boundingBoxSize(): Vector3;
  87116. protected _rotationY: number;
  87117. /**
  87118. * Sets texture matrix rotation angle around Y axis in radians.
  87119. */
  87120. set rotationY(value: number);
  87121. /**
  87122. * Gets texture matrix rotation angle around Y axis radians.
  87123. */
  87124. get rotationY(): number;
  87125. /**
  87126. * Are mip maps generated for this texture or not.
  87127. */
  87128. get noMipmap(): boolean;
  87129. private _noMipmap;
  87130. private _files;
  87131. protected _forcedExtension: Nullable<string>;
  87132. private _extensions;
  87133. private _textureMatrix;
  87134. private _format;
  87135. private _createPolynomials;
  87136. /**
  87137. * Creates a cube texture from an array of image urls
  87138. * @param files defines an array of image urls
  87139. * @param scene defines the hosting scene
  87140. * @param noMipmap specifies if mip maps are not used
  87141. * @returns a cube texture
  87142. */
  87143. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87144. /**
  87145. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87146. * @param url defines the url of the prefiltered texture
  87147. * @param scene defines the scene the texture is attached to
  87148. * @param forcedExtension defines the extension of the file if different from the url
  87149. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87150. * @return the prefiltered texture
  87151. */
  87152. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87153. /**
  87154. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87155. * as prefiltered data.
  87156. * @param rootUrl defines the url of the texture or the root name of the six images
  87157. * @param null defines the scene or engine the texture is attached to
  87158. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87159. * @param noMipmap defines if mipmaps should be created or not
  87160. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87161. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87162. * @param onError defines a callback triggered in case of error during load
  87163. * @param format defines the internal format to use for the texture once loaded
  87164. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87165. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87166. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87167. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87168. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87169. * @return the cube texture
  87170. */
  87171. 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);
  87172. /**
  87173. * Get the current class name of the texture useful for serialization or dynamic coding.
  87174. * @returns "CubeTexture"
  87175. */
  87176. getClassName(): string;
  87177. /**
  87178. * Update the url (and optional buffer) of this texture if url was null during construction.
  87179. * @param url the url of the texture
  87180. * @param forcedExtension defines the extension to use
  87181. * @param onLoad callback called when the texture is loaded (defaults to null)
  87182. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87183. */
  87184. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87185. /**
  87186. * Delays loading of the cube texture
  87187. * @param forcedExtension defines the extension to use
  87188. */
  87189. delayLoad(forcedExtension?: string): void;
  87190. /**
  87191. * Returns the reflection texture matrix
  87192. * @returns the reflection texture matrix
  87193. */
  87194. getReflectionTextureMatrix(): Matrix;
  87195. /**
  87196. * Sets the reflection texture matrix
  87197. * @param value Reflection texture matrix
  87198. */
  87199. setReflectionTextureMatrix(value: Matrix): void;
  87200. /**
  87201. * Parses text to create a cube texture
  87202. * @param parsedTexture define the serialized text to read from
  87203. * @param scene defines the hosting scene
  87204. * @param rootUrl defines the root url of the cube texture
  87205. * @returns a cube texture
  87206. */
  87207. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87208. /**
  87209. * Makes a clone, or deep copy, of the cube texture
  87210. * @returns a new cube texture
  87211. */
  87212. clone(): CubeTexture;
  87213. }
  87214. }
  87215. declare module BABYLON {
  87216. /**
  87217. * Manages the defines for the Material
  87218. */
  87219. export class MaterialDefines {
  87220. /** @hidden */
  87221. protected _keys: string[];
  87222. private _isDirty;
  87223. /** @hidden */
  87224. _renderId: number;
  87225. /** @hidden */
  87226. _areLightsDirty: boolean;
  87227. /** @hidden */
  87228. _areLightsDisposed: boolean;
  87229. /** @hidden */
  87230. _areAttributesDirty: boolean;
  87231. /** @hidden */
  87232. _areTexturesDirty: boolean;
  87233. /** @hidden */
  87234. _areFresnelDirty: boolean;
  87235. /** @hidden */
  87236. _areMiscDirty: boolean;
  87237. /** @hidden */
  87238. _areImageProcessingDirty: boolean;
  87239. /** @hidden */
  87240. _normals: boolean;
  87241. /** @hidden */
  87242. _uvs: boolean;
  87243. /** @hidden */
  87244. _needNormals: boolean;
  87245. /** @hidden */
  87246. _needUVs: boolean;
  87247. [id: string]: any;
  87248. /**
  87249. * Specifies if the material needs to be re-calculated
  87250. */
  87251. get isDirty(): boolean;
  87252. /**
  87253. * Marks the material to indicate that it has been re-calculated
  87254. */
  87255. markAsProcessed(): void;
  87256. /**
  87257. * Marks the material to indicate that it needs to be re-calculated
  87258. */
  87259. markAsUnprocessed(): void;
  87260. /**
  87261. * Marks the material to indicate all of its defines need to be re-calculated
  87262. */
  87263. markAllAsDirty(): void;
  87264. /**
  87265. * Marks the material to indicate that image processing needs to be re-calculated
  87266. */
  87267. markAsImageProcessingDirty(): void;
  87268. /**
  87269. * Marks the material to indicate the lights need to be re-calculated
  87270. * @param disposed Defines whether the light is dirty due to dispose or not
  87271. */
  87272. markAsLightDirty(disposed?: boolean): void;
  87273. /**
  87274. * Marks the attribute state as changed
  87275. */
  87276. markAsAttributesDirty(): void;
  87277. /**
  87278. * Marks the texture state as changed
  87279. */
  87280. markAsTexturesDirty(): void;
  87281. /**
  87282. * Marks the fresnel state as changed
  87283. */
  87284. markAsFresnelDirty(): void;
  87285. /**
  87286. * Marks the misc state as changed
  87287. */
  87288. markAsMiscDirty(): void;
  87289. /**
  87290. * Rebuilds the material defines
  87291. */
  87292. rebuild(): void;
  87293. /**
  87294. * Specifies if two material defines are equal
  87295. * @param other - A material define instance to compare to
  87296. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87297. */
  87298. isEqual(other: MaterialDefines): boolean;
  87299. /**
  87300. * Clones this instance's defines to another instance
  87301. * @param other - material defines to clone values to
  87302. */
  87303. cloneTo(other: MaterialDefines): void;
  87304. /**
  87305. * Resets the material define values
  87306. */
  87307. reset(): void;
  87308. /**
  87309. * Converts the material define values to a string
  87310. * @returns - String of material define information
  87311. */
  87312. toString(): string;
  87313. }
  87314. }
  87315. declare module BABYLON {
  87316. /**
  87317. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87318. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87319. * 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;
  87320. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87321. */
  87322. export class ColorCurves {
  87323. private _dirty;
  87324. private _tempColor;
  87325. private _globalCurve;
  87326. private _highlightsCurve;
  87327. private _midtonesCurve;
  87328. private _shadowsCurve;
  87329. private _positiveCurve;
  87330. private _negativeCurve;
  87331. private _globalHue;
  87332. private _globalDensity;
  87333. private _globalSaturation;
  87334. private _globalExposure;
  87335. /**
  87336. * Gets the global Hue value.
  87337. * 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).
  87338. */
  87339. get globalHue(): number;
  87340. /**
  87341. * Sets the global Hue value.
  87342. * 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).
  87343. */
  87344. set globalHue(value: number);
  87345. /**
  87346. * Gets the global Density value.
  87347. * 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.
  87348. * Values less than zero provide a filter of opposite hue.
  87349. */
  87350. get globalDensity(): number;
  87351. /**
  87352. * Sets the global Density value.
  87353. * 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.
  87354. * Values less than zero provide a filter of opposite hue.
  87355. */
  87356. set globalDensity(value: number);
  87357. /**
  87358. * Gets the global Saturation value.
  87359. * 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.
  87360. */
  87361. get globalSaturation(): number;
  87362. /**
  87363. * Sets the global Saturation value.
  87364. * 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.
  87365. */
  87366. set globalSaturation(value: number);
  87367. /**
  87368. * Gets the global Exposure value.
  87369. * 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.
  87370. */
  87371. get globalExposure(): number;
  87372. /**
  87373. * Sets the global Exposure value.
  87374. * 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.
  87375. */
  87376. set globalExposure(value: number);
  87377. private _highlightsHue;
  87378. private _highlightsDensity;
  87379. private _highlightsSaturation;
  87380. private _highlightsExposure;
  87381. /**
  87382. * Gets the highlights Hue value.
  87383. * 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).
  87384. */
  87385. get highlightsHue(): number;
  87386. /**
  87387. * Sets the highlights Hue value.
  87388. * 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).
  87389. */
  87390. set highlightsHue(value: number);
  87391. /**
  87392. * Gets the highlights Density value.
  87393. * 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.
  87394. * Values less than zero provide a filter of opposite hue.
  87395. */
  87396. get highlightsDensity(): number;
  87397. /**
  87398. * Sets the highlights Density value.
  87399. * 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.
  87400. * Values less than zero provide a filter of opposite hue.
  87401. */
  87402. set highlightsDensity(value: number);
  87403. /**
  87404. * Gets the highlights Saturation value.
  87405. * 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.
  87406. */
  87407. get highlightsSaturation(): number;
  87408. /**
  87409. * Sets the highlights Saturation value.
  87410. * 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.
  87411. */
  87412. set highlightsSaturation(value: number);
  87413. /**
  87414. * Gets the highlights Exposure value.
  87415. * 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.
  87416. */
  87417. get highlightsExposure(): number;
  87418. /**
  87419. * Sets the highlights Exposure value.
  87420. * 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.
  87421. */
  87422. set highlightsExposure(value: number);
  87423. private _midtonesHue;
  87424. private _midtonesDensity;
  87425. private _midtonesSaturation;
  87426. private _midtonesExposure;
  87427. /**
  87428. * Gets the midtones Hue value.
  87429. * 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).
  87430. */
  87431. get midtonesHue(): number;
  87432. /**
  87433. * Sets the midtones Hue value.
  87434. * 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).
  87435. */
  87436. set midtonesHue(value: number);
  87437. /**
  87438. * Gets the midtones Density value.
  87439. * 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.
  87440. * Values less than zero provide a filter of opposite hue.
  87441. */
  87442. get midtonesDensity(): number;
  87443. /**
  87444. * Sets the midtones Density value.
  87445. * 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.
  87446. * Values less than zero provide a filter of opposite hue.
  87447. */
  87448. set midtonesDensity(value: number);
  87449. /**
  87450. * Gets the midtones Saturation value.
  87451. * 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.
  87452. */
  87453. get midtonesSaturation(): number;
  87454. /**
  87455. * Sets the midtones Saturation value.
  87456. * 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.
  87457. */
  87458. set midtonesSaturation(value: number);
  87459. /**
  87460. * Gets the midtones Exposure value.
  87461. * 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.
  87462. */
  87463. get midtonesExposure(): number;
  87464. /**
  87465. * Sets the midtones Exposure value.
  87466. * 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.
  87467. */
  87468. set midtonesExposure(value: number);
  87469. private _shadowsHue;
  87470. private _shadowsDensity;
  87471. private _shadowsSaturation;
  87472. private _shadowsExposure;
  87473. /**
  87474. * Gets the shadows Hue value.
  87475. * 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).
  87476. */
  87477. get shadowsHue(): number;
  87478. /**
  87479. * Sets the shadows Hue value.
  87480. * 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).
  87481. */
  87482. set shadowsHue(value: number);
  87483. /**
  87484. * Gets the shadows Density value.
  87485. * 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.
  87486. * Values less than zero provide a filter of opposite hue.
  87487. */
  87488. get shadowsDensity(): number;
  87489. /**
  87490. * Sets the shadows Density value.
  87491. * 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.
  87492. * Values less than zero provide a filter of opposite hue.
  87493. */
  87494. set shadowsDensity(value: number);
  87495. /**
  87496. * Gets the shadows Saturation value.
  87497. * 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.
  87498. */
  87499. get shadowsSaturation(): number;
  87500. /**
  87501. * Sets the shadows Saturation value.
  87502. * 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.
  87503. */
  87504. set shadowsSaturation(value: number);
  87505. /**
  87506. * Gets the shadows Exposure value.
  87507. * 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.
  87508. */
  87509. get shadowsExposure(): number;
  87510. /**
  87511. * Sets the shadows Exposure value.
  87512. * 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.
  87513. */
  87514. set shadowsExposure(value: number);
  87515. /**
  87516. * Returns the class name
  87517. * @returns The class name
  87518. */
  87519. getClassName(): string;
  87520. /**
  87521. * Binds the color curves to the shader.
  87522. * @param colorCurves The color curve to bind
  87523. * @param effect The effect to bind to
  87524. * @param positiveUniform The positive uniform shader parameter
  87525. * @param neutralUniform The neutral uniform shader parameter
  87526. * @param negativeUniform The negative uniform shader parameter
  87527. */
  87528. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87529. /**
  87530. * Prepare the list of uniforms associated with the ColorCurves effects.
  87531. * @param uniformsList The list of uniforms used in the effect
  87532. */
  87533. static PrepareUniforms(uniformsList: string[]): void;
  87534. /**
  87535. * Returns color grading data based on a hue, density, saturation and exposure value.
  87536. * @param filterHue The hue of the color filter.
  87537. * @param filterDensity The density of the color filter.
  87538. * @param saturation The saturation.
  87539. * @param exposure The exposure.
  87540. * @param result The result data container.
  87541. */
  87542. private getColorGradingDataToRef;
  87543. /**
  87544. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87545. * @param value The input slider value in range [-100,100].
  87546. * @returns Adjusted value.
  87547. */
  87548. private static applyColorGradingSliderNonlinear;
  87549. /**
  87550. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87551. * @param hue The hue (H) input.
  87552. * @param saturation The saturation (S) input.
  87553. * @param brightness The brightness (B) input.
  87554. * @result An RGBA color represented as Vector4.
  87555. */
  87556. private static fromHSBToRef;
  87557. /**
  87558. * Returns a value clamped between min and max
  87559. * @param value The value to clamp
  87560. * @param min The minimum of value
  87561. * @param max The maximum of value
  87562. * @returns The clamped value.
  87563. */
  87564. private static clamp;
  87565. /**
  87566. * Clones the current color curve instance.
  87567. * @return The cloned curves
  87568. */
  87569. clone(): ColorCurves;
  87570. /**
  87571. * Serializes the current color curve instance to a json representation.
  87572. * @return a JSON representation
  87573. */
  87574. serialize(): any;
  87575. /**
  87576. * Parses the color curve from a json representation.
  87577. * @param source the JSON source to parse
  87578. * @return The parsed curves
  87579. */
  87580. static Parse(source: any): ColorCurves;
  87581. }
  87582. }
  87583. declare module BABYLON {
  87584. /**
  87585. * Interface to follow in your material defines to integrate easily the
  87586. * Image proccessing functions.
  87587. * @hidden
  87588. */
  87589. export interface IImageProcessingConfigurationDefines {
  87590. IMAGEPROCESSING: boolean;
  87591. VIGNETTE: boolean;
  87592. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87593. VIGNETTEBLENDMODEOPAQUE: boolean;
  87594. TONEMAPPING: boolean;
  87595. TONEMAPPING_ACES: boolean;
  87596. CONTRAST: boolean;
  87597. EXPOSURE: boolean;
  87598. COLORCURVES: boolean;
  87599. COLORGRADING: boolean;
  87600. COLORGRADING3D: boolean;
  87601. SAMPLER3DGREENDEPTH: boolean;
  87602. SAMPLER3DBGRMAP: boolean;
  87603. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87604. }
  87605. /**
  87606. * @hidden
  87607. */
  87608. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  87609. IMAGEPROCESSING: boolean;
  87610. VIGNETTE: boolean;
  87611. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87612. VIGNETTEBLENDMODEOPAQUE: boolean;
  87613. TONEMAPPING: boolean;
  87614. TONEMAPPING_ACES: boolean;
  87615. CONTRAST: boolean;
  87616. COLORCURVES: boolean;
  87617. COLORGRADING: boolean;
  87618. COLORGRADING3D: boolean;
  87619. SAMPLER3DGREENDEPTH: boolean;
  87620. SAMPLER3DBGRMAP: boolean;
  87621. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87622. EXPOSURE: boolean;
  87623. constructor();
  87624. }
  87625. /**
  87626. * This groups together the common properties used for image processing either in direct forward pass
  87627. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87628. * or not.
  87629. */
  87630. export class ImageProcessingConfiguration {
  87631. /**
  87632. * Default tone mapping applied in BabylonJS.
  87633. */
  87634. static readonly TONEMAPPING_STANDARD: number;
  87635. /**
  87636. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  87637. * to other engines rendering to increase portability.
  87638. */
  87639. static readonly TONEMAPPING_ACES: number;
  87640. /**
  87641. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  87642. */
  87643. colorCurves: Nullable<ColorCurves>;
  87644. private _colorCurvesEnabled;
  87645. /**
  87646. * Gets wether the color curves effect is enabled.
  87647. */
  87648. get colorCurvesEnabled(): boolean;
  87649. /**
  87650. * Sets wether the color curves effect is enabled.
  87651. */
  87652. set colorCurvesEnabled(value: boolean);
  87653. private _colorGradingTexture;
  87654. /**
  87655. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87656. */
  87657. get colorGradingTexture(): Nullable<BaseTexture>;
  87658. /**
  87659. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87660. */
  87661. set colorGradingTexture(value: Nullable<BaseTexture>);
  87662. private _colorGradingEnabled;
  87663. /**
  87664. * Gets wether the color grading effect is enabled.
  87665. */
  87666. get colorGradingEnabled(): boolean;
  87667. /**
  87668. * Sets wether the color grading effect is enabled.
  87669. */
  87670. set colorGradingEnabled(value: boolean);
  87671. private _colorGradingWithGreenDepth;
  87672. /**
  87673. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  87674. */
  87675. get colorGradingWithGreenDepth(): boolean;
  87676. /**
  87677. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  87678. */
  87679. set colorGradingWithGreenDepth(value: boolean);
  87680. private _colorGradingBGR;
  87681. /**
  87682. * Gets wether the color grading texture contains BGR values.
  87683. */
  87684. get colorGradingBGR(): boolean;
  87685. /**
  87686. * Sets wether the color grading texture contains BGR values.
  87687. */
  87688. set colorGradingBGR(value: boolean);
  87689. /** @hidden */
  87690. _exposure: number;
  87691. /**
  87692. * Gets the Exposure used in the effect.
  87693. */
  87694. get exposure(): number;
  87695. /**
  87696. * Sets the Exposure used in the effect.
  87697. */
  87698. set exposure(value: number);
  87699. private _toneMappingEnabled;
  87700. /**
  87701. * Gets wether the tone mapping effect is enabled.
  87702. */
  87703. get toneMappingEnabled(): boolean;
  87704. /**
  87705. * Sets wether the tone mapping effect is enabled.
  87706. */
  87707. set toneMappingEnabled(value: boolean);
  87708. private _toneMappingType;
  87709. /**
  87710. * Gets the type of tone mapping effect.
  87711. */
  87712. get toneMappingType(): number;
  87713. /**
  87714. * Sets the type of tone mapping effect used in BabylonJS.
  87715. */
  87716. set toneMappingType(value: number);
  87717. protected _contrast: number;
  87718. /**
  87719. * Gets the contrast used in the effect.
  87720. */
  87721. get contrast(): number;
  87722. /**
  87723. * Sets the contrast used in the effect.
  87724. */
  87725. set contrast(value: number);
  87726. /**
  87727. * Vignette stretch size.
  87728. */
  87729. vignetteStretch: number;
  87730. /**
  87731. * Vignette centre X Offset.
  87732. */
  87733. vignetteCentreX: number;
  87734. /**
  87735. * Vignette centre Y Offset.
  87736. */
  87737. vignetteCentreY: number;
  87738. /**
  87739. * Vignette weight or intensity of the vignette effect.
  87740. */
  87741. vignetteWeight: number;
  87742. /**
  87743. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  87744. * if vignetteEnabled is set to true.
  87745. */
  87746. vignetteColor: Color4;
  87747. /**
  87748. * Camera field of view used by the Vignette effect.
  87749. */
  87750. vignetteCameraFov: number;
  87751. private _vignetteBlendMode;
  87752. /**
  87753. * Gets the vignette blend mode allowing different kind of effect.
  87754. */
  87755. get vignetteBlendMode(): number;
  87756. /**
  87757. * Sets the vignette blend mode allowing different kind of effect.
  87758. */
  87759. set vignetteBlendMode(value: number);
  87760. private _vignetteEnabled;
  87761. /**
  87762. * Gets wether the vignette effect is enabled.
  87763. */
  87764. get vignetteEnabled(): boolean;
  87765. /**
  87766. * Sets wether the vignette effect is enabled.
  87767. */
  87768. set vignetteEnabled(value: boolean);
  87769. private _applyByPostProcess;
  87770. /**
  87771. * Gets wether the image processing is applied through a post process or not.
  87772. */
  87773. get applyByPostProcess(): boolean;
  87774. /**
  87775. * Sets wether the image processing is applied through a post process or not.
  87776. */
  87777. set applyByPostProcess(value: boolean);
  87778. private _isEnabled;
  87779. /**
  87780. * Gets wether the image processing is enabled or not.
  87781. */
  87782. get isEnabled(): boolean;
  87783. /**
  87784. * Sets wether the image processing is enabled or not.
  87785. */
  87786. set isEnabled(value: boolean);
  87787. /**
  87788. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  87789. */
  87790. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  87791. /**
  87792. * Method called each time the image processing information changes requires to recompile the effect.
  87793. */
  87794. protected _updateParameters(): void;
  87795. /**
  87796. * Gets the current class name.
  87797. * @return "ImageProcessingConfiguration"
  87798. */
  87799. getClassName(): string;
  87800. /**
  87801. * Prepare the list of uniforms associated with the Image Processing effects.
  87802. * @param uniforms The list of uniforms used in the effect
  87803. * @param defines the list of defines currently in use
  87804. */
  87805. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  87806. /**
  87807. * Prepare the list of samplers associated with the Image Processing effects.
  87808. * @param samplersList The list of uniforms used in the effect
  87809. * @param defines the list of defines currently in use
  87810. */
  87811. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  87812. /**
  87813. * Prepare the list of defines associated to the shader.
  87814. * @param defines the list of defines to complete
  87815. * @param forPostProcess Define if we are currently in post process mode or not
  87816. */
  87817. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  87818. /**
  87819. * Returns true if all the image processing information are ready.
  87820. * @returns True if ready, otherwise, false
  87821. */
  87822. isReady(): boolean;
  87823. /**
  87824. * Binds the image processing to the shader.
  87825. * @param effect The effect to bind to
  87826. * @param overrideAspectRatio Override the aspect ratio of the effect
  87827. */
  87828. bind(effect: Effect, overrideAspectRatio?: number): void;
  87829. /**
  87830. * Clones the current image processing instance.
  87831. * @return The cloned image processing
  87832. */
  87833. clone(): ImageProcessingConfiguration;
  87834. /**
  87835. * Serializes the current image processing instance to a json representation.
  87836. * @return a JSON representation
  87837. */
  87838. serialize(): any;
  87839. /**
  87840. * Parses the image processing from a json representation.
  87841. * @param source the JSON source to parse
  87842. * @return The parsed image processing
  87843. */
  87844. static Parse(source: any): ImageProcessingConfiguration;
  87845. private static _VIGNETTEMODE_MULTIPLY;
  87846. private static _VIGNETTEMODE_OPAQUE;
  87847. /**
  87848. * Used to apply the vignette as a mix with the pixel color.
  87849. */
  87850. static get VIGNETTEMODE_MULTIPLY(): number;
  87851. /**
  87852. * Used to apply the vignette as a replacement of the pixel color.
  87853. */
  87854. static get VIGNETTEMODE_OPAQUE(): number;
  87855. }
  87856. }
  87857. declare module BABYLON {
  87858. /** @hidden */
  87859. export var postprocessVertexShader: {
  87860. name: string;
  87861. shader: string;
  87862. };
  87863. }
  87864. declare module BABYLON {
  87865. interface ThinEngine {
  87866. /**
  87867. * Creates a new render target texture
  87868. * @param size defines the size of the texture
  87869. * @param options defines the options used to create the texture
  87870. * @returns a new render target texture stored in an InternalTexture
  87871. */
  87872. createRenderTargetTexture(size: number | {
  87873. width: number;
  87874. height: number;
  87875. layers?: number;
  87876. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  87877. /**
  87878. * Creates a depth stencil texture.
  87879. * This is only available in WebGL 2 or with the depth texture extension available.
  87880. * @param size The size of face edge in the texture.
  87881. * @param options The options defining the texture.
  87882. * @returns The texture
  87883. */
  87884. createDepthStencilTexture(size: number | {
  87885. width: number;
  87886. height: number;
  87887. layers?: number;
  87888. }, options: DepthTextureCreationOptions): InternalTexture;
  87889. /** @hidden */
  87890. _createDepthStencilTexture(size: number | {
  87891. width: number;
  87892. height: number;
  87893. layers?: number;
  87894. }, options: DepthTextureCreationOptions): InternalTexture;
  87895. }
  87896. }
  87897. declare module BABYLON {
  87898. /**
  87899. * Defines the kind of connection point for node based material
  87900. */
  87901. export enum NodeMaterialBlockConnectionPointTypes {
  87902. /** Float */
  87903. Float = 1,
  87904. /** Int */
  87905. Int = 2,
  87906. /** Vector2 */
  87907. Vector2 = 4,
  87908. /** Vector3 */
  87909. Vector3 = 8,
  87910. /** Vector4 */
  87911. Vector4 = 16,
  87912. /** Color3 */
  87913. Color3 = 32,
  87914. /** Color4 */
  87915. Color4 = 64,
  87916. /** Matrix */
  87917. Matrix = 128,
  87918. /** Custom object */
  87919. Object = 256,
  87920. /** Detect type based on connection */
  87921. AutoDetect = 1024,
  87922. /** Output type that will be defined by input type */
  87923. BasedOnInput = 2048
  87924. }
  87925. }
  87926. declare module BABYLON {
  87927. /**
  87928. * Enum used to define the target of a block
  87929. */
  87930. export enum NodeMaterialBlockTargets {
  87931. /** Vertex shader */
  87932. Vertex = 1,
  87933. /** Fragment shader */
  87934. Fragment = 2,
  87935. /** Neutral */
  87936. Neutral = 4,
  87937. /** Vertex and Fragment */
  87938. VertexAndFragment = 3
  87939. }
  87940. }
  87941. declare module BABYLON {
  87942. /**
  87943. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  87944. */
  87945. export enum NodeMaterialBlockConnectionPointMode {
  87946. /** Value is an uniform */
  87947. Uniform = 0,
  87948. /** Value is a mesh attribute */
  87949. Attribute = 1,
  87950. /** Value is a varying between vertex and fragment shaders */
  87951. Varying = 2,
  87952. /** Mode is undefined */
  87953. Undefined = 3
  87954. }
  87955. }
  87956. declare module BABYLON {
  87957. /**
  87958. * Enum used to define system values e.g. values automatically provided by the system
  87959. */
  87960. export enum NodeMaterialSystemValues {
  87961. /** World */
  87962. World = 1,
  87963. /** View */
  87964. View = 2,
  87965. /** Projection */
  87966. Projection = 3,
  87967. /** ViewProjection */
  87968. ViewProjection = 4,
  87969. /** WorldView */
  87970. WorldView = 5,
  87971. /** WorldViewProjection */
  87972. WorldViewProjection = 6,
  87973. /** CameraPosition */
  87974. CameraPosition = 7,
  87975. /** Fog Color */
  87976. FogColor = 8,
  87977. /** Delta time */
  87978. DeltaTime = 9
  87979. }
  87980. }
  87981. declare module BABYLON {
  87982. /** Defines supported spaces */
  87983. export enum Space {
  87984. /** Local (object) space */
  87985. LOCAL = 0,
  87986. /** World space */
  87987. WORLD = 1,
  87988. /** Bone space */
  87989. BONE = 2
  87990. }
  87991. /** Defines the 3 main axes */
  87992. export class Axis {
  87993. /** X axis */
  87994. static X: Vector3;
  87995. /** Y axis */
  87996. static Y: Vector3;
  87997. /** Z axis */
  87998. static Z: Vector3;
  87999. }
  88000. }
  88001. declare module BABYLON {
  88002. /**
  88003. * Represents a camera frustum
  88004. */
  88005. export class Frustum {
  88006. /**
  88007. * Gets the planes representing the frustum
  88008. * @param transform matrix to be applied to the returned planes
  88009. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88010. */
  88011. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88012. /**
  88013. * Gets the near frustum plane transformed by the transform matrix
  88014. * @param transform transformation matrix to be applied to the resulting frustum plane
  88015. * @param frustumPlane the resuling frustum plane
  88016. */
  88017. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88018. /**
  88019. * Gets the far frustum plane transformed by the transform matrix
  88020. * @param transform transformation matrix to be applied to the resulting frustum plane
  88021. * @param frustumPlane the resuling frustum plane
  88022. */
  88023. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88024. /**
  88025. * Gets the left frustum plane transformed by the transform matrix
  88026. * @param transform transformation matrix to be applied to the resulting frustum plane
  88027. * @param frustumPlane the resuling frustum plane
  88028. */
  88029. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88030. /**
  88031. * Gets the right frustum plane transformed by the transform matrix
  88032. * @param transform transformation matrix to be applied to the resulting frustum plane
  88033. * @param frustumPlane the resuling frustum plane
  88034. */
  88035. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88036. /**
  88037. * Gets the top frustum plane transformed by the transform matrix
  88038. * @param transform transformation matrix to be applied to the resulting frustum plane
  88039. * @param frustumPlane the resuling frustum plane
  88040. */
  88041. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88042. /**
  88043. * Gets the bottom frustum plane transformed by the transform matrix
  88044. * @param transform transformation matrix to be applied to the resulting frustum plane
  88045. * @param frustumPlane the resuling frustum plane
  88046. */
  88047. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88048. /**
  88049. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88050. * @param transform transformation matrix to be applied to the resulting frustum planes
  88051. * @param frustumPlanes the resuling frustum planes
  88052. */
  88053. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88054. }
  88055. }
  88056. declare module BABYLON {
  88057. /**
  88058. * Interface for the size containing width and height
  88059. */
  88060. export interface ISize {
  88061. /**
  88062. * Width
  88063. */
  88064. width: number;
  88065. /**
  88066. * Heighht
  88067. */
  88068. height: number;
  88069. }
  88070. /**
  88071. * Size containing widht and height
  88072. */
  88073. export class Size implements ISize {
  88074. /**
  88075. * Width
  88076. */
  88077. width: number;
  88078. /**
  88079. * Height
  88080. */
  88081. height: number;
  88082. /**
  88083. * Creates a Size object from the given width and height (floats).
  88084. * @param width width of the new size
  88085. * @param height height of the new size
  88086. */
  88087. constructor(width: number, height: number);
  88088. /**
  88089. * Returns a string with the Size width and height
  88090. * @returns a string with the Size width and height
  88091. */
  88092. toString(): string;
  88093. /**
  88094. * "Size"
  88095. * @returns the string "Size"
  88096. */
  88097. getClassName(): string;
  88098. /**
  88099. * Returns the Size hash code.
  88100. * @returns a hash code for a unique width and height
  88101. */
  88102. getHashCode(): number;
  88103. /**
  88104. * Updates the current size from the given one.
  88105. * @param src the given size
  88106. */
  88107. copyFrom(src: Size): void;
  88108. /**
  88109. * Updates in place the current Size from the given floats.
  88110. * @param width width of the new size
  88111. * @param height height of the new size
  88112. * @returns the updated Size.
  88113. */
  88114. copyFromFloats(width: number, height: number): Size;
  88115. /**
  88116. * Updates in place the current Size from the given floats.
  88117. * @param width width to set
  88118. * @param height height to set
  88119. * @returns the updated Size.
  88120. */
  88121. set(width: number, height: number): Size;
  88122. /**
  88123. * Multiplies the width and height by numbers
  88124. * @param w factor to multiple the width by
  88125. * @param h factor to multiple the height by
  88126. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88127. */
  88128. multiplyByFloats(w: number, h: number): Size;
  88129. /**
  88130. * Clones the size
  88131. * @returns a new Size copied from the given one.
  88132. */
  88133. clone(): Size;
  88134. /**
  88135. * True if the current Size and the given one width and height are strictly equal.
  88136. * @param other the other size to compare against
  88137. * @returns True if the current Size and the given one width and height are strictly equal.
  88138. */
  88139. equals(other: Size): boolean;
  88140. /**
  88141. * The surface of the Size : width * height (float).
  88142. */
  88143. get surface(): number;
  88144. /**
  88145. * Create a new size of zero
  88146. * @returns a new Size set to (0.0, 0.0)
  88147. */
  88148. static Zero(): Size;
  88149. /**
  88150. * Sums the width and height of two sizes
  88151. * @param otherSize size to add to this size
  88152. * @returns a new Size set as the addition result of the current Size and the given one.
  88153. */
  88154. add(otherSize: Size): Size;
  88155. /**
  88156. * Subtracts the width and height of two
  88157. * @param otherSize size to subtract to this size
  88158. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88159. */
  88160. subtract(otherSize: Size): Size;
  88161. /**
  88162. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88163. * @param start starting size to lerp between
  88164. * @param end end size to lerp between
  88165. * @param amount amount to lerp between the start and end values
  88166. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88167. */
  88168. static Lerp(start: Size, end: Size, amount: number): Size;
  88169. }
  88170. }
  88171. declare module BABYLON {
  88172. /**
  88173. * Contains position and normal vectors for a vertex
  88174. */
  88175. export class PositionNormalVertex {
  88176. /** the position of the vertex (defaut: 0,0,0) */
  88177. position: Vector3;
  88178. /** the normal of the vertex (defaut: 0,1,0) */
  88179. normal: Vector3;
  88180. /**
  88181. * Creates a PositionNormalVertex
  88182. * @param position the position of the vertex (defaut: 0,0,0)
  88183. * @param normal the normal of the vertex (defaut: 0,1,0)
  88184. */
  88185. constructor(
  88186. /** the position of the vertex (defaut: 0,0,0) */
  88187. position?: Vector3,
  88188. /** the normal of the vertex (defaut: 0,1,0) */
  88189. normal?: Vector3);
  88190. /**
  88191. * Clones the PositionNormalVertex
  88192. * @returns the cloned PositionNormalVertex
  88193. */
  88194. clone(): PositionNormalVertex;
  88195. }
  88196. /**
  88197. * Contains position, normal and uv vectors for a vertex
  88198. */
  88199. export class PositionNormalTextureVertex {
  88200. /** the position of the vertex (defaut: 0,0,0) */
  88201. position: Vector3;
  88202. /** the normal of the vertex (defaut: 0,1,0) */
  88203. normal: Vector3;
  88204. /** the uv of the vertex (default: 0,0) */
  88205. uv: Vector2;
  88206. /**
  88207. * Creates a PositionNormalTextureVertex
  88208. * @param position the position of the vertex (defaut: 0,0,0)
  88209. * @param normal the normal of the vertex (defaut: 0,1,0)
  88210. * @param uv the uv of the vertex (default: 0,0)
  88211. */
  88212. constructor(
  88213. /** the position of the vertex (defaut: 0,0,0) */
  88214. position?: Vector3,
  88215. /** the normal of the vertex (defaut: 0,1,0) */
  88216. normal?: Vector3,
  88217. /** the uv of the vertex (default: 0,0) */
  88218. uv?: Vector2);
  88219. /**
  88220. * Clones the PositionNormalTextureVertex
  88221. * @returns the cloned PositionNormalTextureVertex
  88222. */
  88223. clone(): PositionNormalTextureVertex;
  88224. }
  88225. }
  88226. declare module BABYLON {
  88227. /**
  88228. * Enum defining the type of animations supported by InputBlock
  88229. */
  88230. export enum AnimatedInputBlockTypes {
  88231. /** No animation */
  88232. None = 0,
  88233. /** Time based animation. Will only work for floats */
  88234. Time = 1
  88235. }
  88236. }
  88237. declare module BABYLON {
  88238. /**
  88239. * Interface describing all the common properties and methods a shadow light needs to implement.
  88240. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88241. * as well as binding the different shadow properties to the effects.
  88242. */
  88243. export interface IShadowLight extends Light {
  88244. /**
  88245. * The light id in the scene (used in scene.findLighById for instance)
  88246. */
  88247. id: string;
  88248. /**
  88249. * The position the shdow will be casted from.
  88250. */
  88251. position: Vector3;
  88252. /**
  88253. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88254. */
  88255. direction: Vector3;
  88256. /**
  88257. * The transformed position. Position of the light in world space taking parenting in account.
  88258. */
  88259. transformedPosition: Vector3;
  88260. /**
  88261. * The transformed direction. Direction of the light in world space taking parenting in account.
  88262. */
  88263. transformedDirection: Vector3;
  88264. /**
  88265. * The friendly name of the light in the scene.
  88266. */
  88267. name: string;
  88268. /**
  88269. * Defines the shadow projection clipping minimum z value.
  88270. */
  88271. shadowMinZ: number;
  88272. /**
  88273. * Defines the shadow projection clipping maximum z value.
  88274. */
  88275. shadowMaxZ: number;
  88276. /**
  88277. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88278. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88279. */
  88280. computeTransformedInformation(): boolean;
  88281. /**
  88282. * Gets the scene the light belongs to.
  88283. * @returns The scene
  88284. */
  88285. getScene(): Scene;
  88286. /**
  88287. * Callback defining a custom Projection Matrix Builder.
  88288. * This can be used to override the default projection matrix computation.
  88289. */
  88290. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88291. /**
  88292. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88293. * @param matrix The materix to updated with the projection information
  88294. * @param viewMatrix The transform matrix of the light
  88295. * @param renderList The list of mesh to render in the map
  88296. * @returns The current light
  88297. */
  88298. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88299. /**
  88300. * Gets the current depth scale used in ESM.
  88301. * @returns The scale
  88302. */
  88303. getDepthScale(): number;
  88304. /**
  88305. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88306. * @returns true if a cube texture needs to be use
  88307. */
  88308. needCube(): boolean;
  88309. /**
  88310. * Detects if the projection matrix requires to be recomputed this frame.
  88311. * @returns true if it requires to be recomputed otherwise, false.
  88312. */
  88313. needProjectionMatrixCompute(): boolean;
  88314. /**
  88315. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88316. */
  88317. forceProjectionMatrixCompute(): void;
  88318. /**
  88319. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88320. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88321. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88322. */
  88323. getShadowDirection(faceIndex?: number): Vector3;
  88324. /**
  88325. * Gets the minZ used for shadow according to both the scene and the light.
  88326. * @param activeCamera The camera we are returning the min for
  88327. * @returns the depth min z
  88328. */
  88329. getDepthMinZ(activeCamera: Camera): number;
  88330. /**
  88331. * Gets the maxZ used for shadow according to both the scene and the light.
  88332. * @param activeCamera The camera we are returning the max for
  88333. * @returns the depth max z
  88334. */
  88335. getDepthMaxZ(activeCamera: Camera): number;
  88336. }
  88337. /**
  88338. * Base implementation IShadowLight
  88339. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88340. */
  88341. export abstract class ShadowLight extends Light implements IShadowLight {
  88342. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88343. protected _position: Vector3;
  88344. protected _setPosition(value: Vector3): void;
  88345. /**
  88346. * Sets the position the shadow will be casted from. Also use as the light position for both
  88347. * point and spot lights.
  88348. */
  88349. get position(): Vector3;
  88350. /**
  88351. * Sets the position the shadow will be casted from. Also use as the light position for both
  88352. * point and spot lights.
  88353. */
  88354. set position(value: Vector3);
  88355. protected _direction: Vector3;
  88356. protected _setDirection(value: Vector3): void;
  88357. /**
  88358. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88359. * Also use as the light direction on spot and directional lights.
  88360. */
  88361. get direction(): Vector3;
  88362. /**
  88363. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88364. * Also use as the light direction on spot and directional lights.
  88365. */
  88366. set direction(value: Vector3);
  88367. protected _shadowMinZ: number;
  88368. /**
  88369. * Gets the shadow projection clipping minimum z value.
  88370. */
  88371. get shadowMinZ(): number;
  88372. /**
  88373. * Sets the shadow projection clipping minimum z value.
  88374. */
  88375. set shadowMinZ(value: number);
  88376. protected _shadowMaxZ: number;
  88377. /**
  88378. * Sets the shadow projection clipping maximum z value.
  88379. */
  88380. get shadowMaxZ(): number;
  88381. /**
  88382. * Gets the shadow projection clipping maximum z value.
  88383. */
  88384. set shadowMaxZ(value: number);
  88385. /**
  88386. * Callback defining a custom Projection Matrix Builder.
  88387. * This can be used to override the default projection matrix computation.
  88388. */
  88389. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88390. /**
  88391. * The transformed position. Position of the light in world space taking parenting in account.
  88392. */
  88393. transformedPosition: Vector3;
  88394. /**
  88395. * The transformed direction. Direction of the light in world space taking parenting in account.
  88396. */
  88397. transformedDirection: Vector3;
  88398. private _needProjectionMatrixCompute;
  88399. /**
  88400. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88401. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88402. */
  88403. computeTransformedInformation(): boolean;
  88404. /**
  88405. * Return the depth scale used for the shadow map.
  88406. * @returns the depth scale.
  88407. */
  88408. getDepthScale(): number;
  88409. /**
  88410. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88411. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88412. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88413. */
  88414. getShadowDirection(faceIndex?: number): Vector3;
  88415. /**
  88416. * Returns the ShadowLight absolute position in the World.
  88417. * @returns the position vector in world space
  88418. */
  88419. getAbsolutePosition(): Vector3;
  88420. /**
  88421. * Sets the ShadowLight direction toward the passed target.
  88422. * @param target The point to target in local space
  88423. * @returns the updated ShadowLight direction
  88424. */
  88425. setDirectionToTarget(target: Vector3): Vector3;
  88426. /**
  88427. * Returns the light rotation in euler definition.
  88428. * @returns the x y z rotation in local space.
  88429. */
  88430. getRotation(): Vector3;
  88431. /**
  88432. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88433. * @returns true if a cube texture needs to be use
  88434. */
  88435. needCube(): boolean;
  88436. /**
  88437. * Detects if the projection matrix requires to be recomputed this frame.
  88438. * @returns true if it requires to be recomputed otherwise, false.
  88439. */
  88440. needProjectionMatrixCompute(): boolean;
  88441. /**
  88442. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88443. */
  88444. forceProjectionMatrixCompute(): void;
  88445. /** @hidden */
  88446. _initCache(): void;
  88447. /** @hidden */
  88448. _isSynchronized(): boolean;
  88449. /**
  88450. * Computes the world matrix of the node
  88451. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88452. * @returns the world matrix
  88453. */
  88454. computeWorldMatrix(force?: boolean): Matrix;
  88455. /**
  88456. * Gets the minZ used for shadow according to both the scene and the light.
  88457. * @param activeCamera The camera we are returning the min for
  88458. * @returns the depth min z
  88459. */
  88460. getDepthMinZ(activeCamera: Camera): number;
  88461. /**
  88462. * Gets the maxZ used for shadow according to both the scene and the light.
  88463. * @param activeCamera The camera we are returning the max for
  88464. * @returns the depth max z
  88465. */
  88466. getDepthMaxZ(activeCamera: Camera): number;
  88467. /**
  88468. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88469. * @param matrix The materix to updated with the projection information
  88470. * @param viewMatrix The transform matrix of the light
  88471. * @param renderList The list of mesh to render in the map
  88472. * @returns The current light
  88473. */
  88474. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88475. }
  88476. }
  88477. declare module BABYLON {
  88478. /** @hidden */
  88479. export var packingFunctions: {
  88480. name: string;
  88481. shader: string;
  88482. };
  88483. }
  88484. declare module BABYLON {
  88485. /** @hidden */
  88486. export var bayerDitherFunctions: {
  88487. name: string;
  88488. shader: string;
  88489. };
  88490. }
  88491. declare module BABYLON {
  88492. /** @hidden */
  88493. export var shadowMapFragmentDeclaration: {
  88494. name: string;
  88495. shader: string;
  88496. };
  88497. }
  88498. declare module BABYLON {
  88499. /** @hidden */
  88500. export var clipPlaneFragmentDeclaration: {
  88501. name: string;
  88502. shader: string;
  88503. };
  88504. }
  88505. declare module BABYLON {
  88506. /** @hidden */
  88507. export var clipPlaneFragment: {
  88508. name: string;
  88509. shader: string;
  88510. };
  88511. }
  88512. declare module BABYLON {
  88513. /** @hidden */
  88514. export var shadowMapFragment: {
  88515. name: string;
  88516. shader: string;
  88517. };
  88518. }
  88519. declare module BABYLON {
  88520. /** @hidden */
  88521. export var shadowMapPixelShader: {
  88522. name: string;
  88523. shader: string;
  88524. };
  88525. }
  88526. declare module BABYLON {
  88527. /** @hidden */
  88528. export var bonesDeclaration: {
  88529. name: string;
  88530. shader: string;
  88531. };
  88532. }
  88533. declare module BABYLON {
  88534. /** @hidden */
  88535. export var morphTargetsVertexGlobalDeclaration: {
  88536. name: string;
  88537. shader: string;
  88538. };
  88539. }
  88540. declare module BABYLON {
  88541. /** @hidden */
  88542. export var morphTargetsVertexDeclaration: {
  88543. name: string;
  88544. shader: string;
  88545. };
  88546. }
  88547. declare module BABYLON {
  88548. /** @hidden */
  88549. export var instancesDeclaration: {
  88550. name: string;
  88551. shader: string;
  88552. };
  88553. }
  88554. declare module BABYLON {
  88555. /** @hidden */
  88556. export var helperFunctions: {
  88557. name: string;
  88558. shader: string;
  88559. };
  88560. }
  88561. declare module BABYLON {
  88562. /** @hidden */
  88563. export var shadowMapVertexDeclaration: {
  88564. name: string;
  88565. shader: string;
  88566. };
  88567. }
  88568. declare module BABYLON {
  88569. /** @hidden */
  88570. export var clipPlaneVertexDeclaration: {
  88571. name: string;
  88572. shader: string;
  88573. };
  88574. }
  88575. declare module BABYLON {
  88576. /** @hidden */
  88577. export var morphTargetsVertex: {
  88578. name: string;
  88579. shader: string;
  88580. };
  88581. }
  88582. declare module BABYLON {
  88583. /** @hidden */
  88584. export var instancesVertex: {
  88585. name: string;
  88586. shader: string;
  88587. };
  88588. }
  88589. declare module BABYLON {
  88590. /** @hidden */
  88591. export var bonesVertex: {
  88592. name: string;
  88593. shader: string;
  88594. };
  88595. }
  88596. declare module BABYLON {
  88597. /** @hidden */
  88598. export var shadowMapVertexNormalBias: {
  88599. name: string;
  88600. shader: string;
  88601. };
  88602. }
  88603. declare module BABYLON {
  88604. /** @hidden */
  88605. export var shadowMapVertexMetric: {
  88606. name: string;
  88607. shader: string;
  88608. };
  88609. }
  88610. declare module BABYLON {
  88611. /** @hidden */
  88612. export var clipPlaneVertex: {
  88613. name: string;
  88614. shader: string;
  88615. };
  88616. }
  88617. declare module BABYLON {
  88618. /** @hidden */
  88619. export var shadowMapVertexShader: {
  88620. name: string;
  88621. shader: string;
  88622. };
  88623. }
  88624. declare module BABYLON {
  88625. /** @hidden */
  88626. export var depthBoxBlurPixelShader: {
  88627. name: string;
  88628. shader: string;
  88629. };
  88630. }
  88631. declare module BABYLON {
  88632. /** @hidden */
  88633. export var shadowMapFragmentSoftTransparentShadow: {
  88634. name: string;
  88635. shader: string;
  88636. };
  88637. }
  88638. declare module BABYLON {
  88639. /**
  88640. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  88641. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  88642. */
  88643. export class EffectFallbacks implements IEffectFallbacks {
  88644. private _defines;
  88645. private _currentRank;
  88646. private _maxRank;
  88647. private _mesh;
  88648. /**
  88649. * Removes the fallback from the bound mesh.
  88650. */
  88651. unBindMesh(): void;
  88652. /**
  88653. * Adds a fallback on the specified property.
  88654. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88655. * @param define The name of the define in the shader
  88656. */
  88657. addFallback(rank: number, define: string): void;
  88658. /**
  88659. * Sets the mesh to use CPU skinning when needing to fallback.
  88660. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88661. * @param mesh The mesh to use the fallbacks.
  88662. */
  88663. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  88664. /**
  88665. * Checks to see if more fallbacks are still availible.
  88666. */
  88667. get hasMoreFallbacks(): boolean;
  88668. /**
  88669. * Removes the defines that should be removed when falling back.
  88670. * @param currentDefines defines the current define statements for the shader.
  88671. * @param effect defines the current effect we try to compile
  88672. * @returns The resulting defines with defines of the current rank removed.
  88673. */
  88674. reduce(currentDefines: string, effect: Effect): string;
  88675. }
  88676. }
  88677. declare module BABYLON {
  88678. /**
  88679. * Interface used to define Action
  88680. */
  88681. export interface IAction {
  88682. /**
  88683. * Trigger for the action
  88684. */
  88685. trigger: number;
  88686. /** Options of the trigger */
  88687. triggerOptions: any;
  88688. /**
  88689. * Gets the trigger parameters
  88690. * @returns the trigger parameters
  88691. */
  88692. getTriggerParameter(): any;
  88693. /**
  88694. * Internal only - executes current action event
  88695. * @hidden
  88696. */
  88697. _executeCurrent(evt?: ActionEvent): void;
  88698. /**
  88699. * Serialize placeholder for child classes
  88700. * @param parent of child
  88701. * @returns the serialized object
  88702. */
  88703. serialize(parent: any): any;
  88704. /**
  88705. * Internal only
  88706. * @hidden
  88707. */
  88708. _prepare(): void;
  88709. /**
  88710. * Internal only - manager for action
  88711. * @hidden
  88712. */
  88713. _actionManager: AbstractActionManager;
  88714. /**
  88715. * Adds action to chain of actions, may be a DoNothingAction
  88716. * @param action defines the next action to execute
  88717. * @returns The action passed in
  88718. * @see https://www.babylonjs-playground.com/#1T30HR#0
  88719. */
  88720. then(action: IAction): IAction;
  88721. }
  88722. /**
  88723. * The action to be carried out following a trigger
  88724. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  88725. */
  88726. export class Action implements IAction {
  88727. /** the trigger, with or without parameters, for the action */
  88728. triggerOptions: any;
  88729. /**
  88730. * Trigger for the action
  88731. */
  88732. trigger: number;
  88733. /**
  88734. * Internal only - manager for action
  88735. * @hidden
  88736. */
  88737. _actionManager: ActionManager;
  88738. private _nextActiveAction;
  88739. private _child;
  88740. private _condition?;
  88741. private _triggerParameter;
  88742. /**
  88743. * An event triggered prior to action being executed.
  88744. */
  88745. onBeforeExecuteObservable: Observable<Action>;
  88746. /**
  88747. * Creates a new Action
  88748. * @param triggerOptions the trigger, with or without parameters, for the action
  88749. * @param condition an optional determinant of action
  88750. */
  88751. constructor(
  88752. /** the trigger, with or without parameters, for the action */
  88753. triggerOptions: any, condition?: Condition);
  88754. /**
  88755. * Internal only
  88756. * @hidden
  88757. */
  88758. _prepare(): void;
  88759. /**
  88760. * Gets the trigger parameters
  88761. * @returns the trigger parameters
  88762. */
  88763. getTriggerParameter(): any;
  88764. /**
  88765. * Internal only - executes current action event
  88766. * @hidden
  88767. */
  88768. _executeCurrent(evt?: ActionEvent): void;
  88769. /**
  88770. * Execute placeholder for child classes
  88771. * @param evt optional action event
  88772. */
  88773. execute(evt?: ActionEvent): void;
  88774. /**
  88775. * Skips to next active action
  88776. */
  88777. skipToNextActiveAction(): void;
  88778. /**
  88779. * Adds action to chain of actions, may be a DoNothingAction
  88780. * @param action defines the next action to execute
  88781. * @returns The action passed in
  88782. * @see https://www.babylonjs-playground.com/#1T30HR#0
  88783. */
  88784. then(action: Action): Action;
  88785. /**
  88786. * Internal only
  88787. * @hidden
  88788. */
  88789. _getProperty(propertyPath: string): string;
  88790. /**
  88791. * Internal only
  88792. * @hidden
  88793. */
  88794. _getEffectiveTarget(target: any, propertyPath: string): any;
  88795. /**
  88796. * Serialize placeholder for child classes
  88797. * @param parent of child
  88798. * @returns the serialized object
  88799. */
  88800. serialize(parent: any): any;
  88801. /**
  88802. * Internal only called by serialize
  88803. * @hidden
  88804. */
  88805. protected _serialize(serializedAction: any, parent?: any): any;
  88806. /**
  88807. * Internal only
  88808. * @hidden
  88809. */
  88810. static _SerializeValueAsString: (value: any) => string;
  88811. /**
  88812. * Internal only
  88813. * @hidden
  88814. */
  88815. static _GetTargetProperty: (target: Scene | Node) => {
  88816. name: string;
  88817. targetType: string;
  88818. value: string;
  88819. };
  88820. }
  88821. }
  88822. declare module BABYLON {
  88823. /**
  88824. * A Condition applied to an Action
  88825. */
  88826. export class Condition {
  88827. /**
  88828. * Internal only - manager for action
  88829. * @hidden
  88830. */
  88831. _actionManager: ActionManager;
  88832. /**
  88833. * Internal only
  88834. * @hidden
  88835. */
  88836. _evaluationId: number;
  88837. /**
  88838. * Internal only
  88839. * @hidden
  88840. */
  88841. _currentResult: boolean;
  88842. /**
  88843. * Creates a new Condition
  88844. * @param actionManager the manager of the action the condition is applied to
  88845. */
  88846. constructor(actionManager: ActionManager);
  88847. /**
  88848. * Check if the current condition is valid
  88849. * @returns a boolean
  88850. */
  88851. isValid(): boolean;
  88852. /**
  88853. * Internal only
  88854. * @hidden
  88855. */
  88856. _getProperty(propertyPath: string): string;
  88857. /**
  88858. * Internal only
  88859. * @hidden
  88860. */
  88861. _getEffectiveTarget(target: any, propertyPath: string): any;
  88862. /**
  88863. * Serialize placeholder for child classes
  88864. * @returns the serialized object
  88865. */
  88866. serialize(): any;
  88867. /**
  88868. * Internal only
  88869. * @hidden
  88870. */
  88871. protected _serialize(serializedCondition: any): any;
  88872. }
  88873. /**
  88874. * Defines specific conditional operators as extensions of Condition
  88875. */
  88876. export class ValueCondition extends Condition {
  88877. /** path to specify the property of the target the conditional operator uses */
  88878. propertyPath: string;
  88879. /** the value compared by the conditional operator against the current value of the property */
  88880. value: any;
  88881. /** the conditional operator, default ValueCondition.IsEqual */
  88882. operator: number;
  88883. /**
  88884. * Internal only
  88885. * @hidden
  88886. */
  88887. private static _IsEqual;
  88888. /**
  88889. * Internal only
  88890. * @hidden
  88891. */
  88892. private static _IsDifferent;
  88893. /**
  88894. * Internal only
  88895. * @hidden
  88896. */
  88897. private static _IsGreater;
  88898. /**
  88899. * Internal only
  88900. * @hidden
  88901. */
  88902. private static _IsLesser;
  88903. /**
  88904. * returns the number for IsEqual
  88905. */
  88906. static get IsEqual(): number;
  88907. /**
  88908. * Returns the number for IsDifferent
  88909. */
  88910. static get IsDifferent(): number;
  88911. /**
  88912. * Returns the number for IsGreater
  88913. */
  88914. static get IsGreater(): number;
  88915. /**
  88916. * Returns the number for IsLesser
  88917. */
  88918. static get IsLesser(): number;
  88919. /**
  88920. * Internal only The action manager for the condition
  88921. * @hidden
  88922. */
  88923. _actionManager: ActionManager;
  88924. /**
  88925. * Internal only
  88926. * @hidden
  88927. */
  88928. private _target;
  88929. /**
  88930. * Internal only
  88931. * @hidden
  88932. */
  88933. private _effectiveTarget;
  88934. /**
  88935. * Internal only
  88936. * @hidden
  88937. */
  88938. private _property;
  88939. /**
  88940. * Creates a new ValueCondition
  88941. * @param actionManager manager for the action the condition applies to
  88942. * @param target for the action
  88943. * @param propertyPath path to specify the property of the target the conditional operator uses
  88944. * @param value the value compared by the conditional operator against the current value of the property
  88945. * @param operator the conditional operator, default ValueCondition.IsEqual
  88946. */
  88947. constructor(actionManager: ActionManager, target: any,
  88948. /** path to specify the property of the target the conditional operator uses */
  88949. propertyPath: string,
  88950. /** the value compared by the conditional operator against the current value of the property */
  88951. value: any,
  88952. /** the conditional operator, default ValueCondition.IsEqual */
  88953. operator?: number);
  88954. /**
  88955. * Compares the given value with the property value for the specified conditional operator
  88956. * @returns the result of the comparison
  88957. */
  88958. isValid(): boolean;
  88959. /**
  88960. * Serialize the ValueCondition into a JSON compatible object
  88961. * @returns serialization object
  88962. */
  88963. serialize(): any;
  88964. /**
  88965. * Gets the name of the conditional operator for the ValueCondition
  88966. * @param operator the conditional operator
  88967. * @returns the name
  88968. */
  88969. static GetOperatorName(operator: number): string;
  88970. }
  88971. /**
  88972. * Defines a predicate condition as an extension of Condition
  88973. */
  88974. export class PredicateCondition extends Condition {
  88975. /** defines the predicate function used to validate the condition */
  88976. predicate: () => boolean;
  88977. /**
  88978. * Internal only - manager for action
  88979. * @hidden
  88980. */
  88981. _actionManager: ActionManager;
  88982. /**
  88983. * Creates a new PredicateCondition
  88984. * @param actionManager manager for the action the condition applies to
  88985. * @param predicate defines the predicate function used to validate the condition
  88986. */
  88987. constructor(actionManager: ActionManager,
  88988. /** defines the predicate function used to validate the condition */
  88989. predicate: () => boolean);
  88990. /**
  88991. * @returns the validity of the predicate condition
  88992. */
  88993. isValid(): boolean;
  88994. }
  88995. /**
  88996. * Defines a state condition as an extension of Condition
  88997. */
  88998. export class StateCondition extends Condition {
  88999. /** Value to compare with target state */
  89000. value: string;
  89001. /**
  89002. * Internal only - manager for action
  89003. * @hidden
  89004. */
  89005. _actionManager: ActionManager;
  89006. /**
  89007. * Internal only
  89008. * @hidden
  89009. */
  89010. private _target;
  89011. /**
  89012. * Creates a new StateCondition
  89013. * @param actionManager manager for the action the condition applies to
  89014. * @param target of the condition
  89015. * @param value to compare with target state
  89016. */
  89017. constructor(actionManager: ActionManager, target: any,
  89018. /** Value to compare with target state */
  89019. value: string);
  89020. /**
  89021. * Gets a boolean indicating if the current condition is met
  89022. * @returns the validity of the state
  89023. */
  89024. isValid(): boolean;
  89025. /**
  89026. * Serialize the StateCondition into a JSON compatible object
  89027. * @returns serialization object
  89028. */
  89029. serialize(): any;
  89030. }
  89031. }
  89032. declare module BABYLON {
  89033. /**
  89034. * This defines an action responsible to toggle a boolean once triggered.
  89035. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89036. */
  89037. export class SwitchBooleanAction extends Action {
  89038. /**
  89039. * The path to the boolean property in the target object
  89040. */
  89041. propertyPath: string;
  89042. private _target;
  89043. private _effectiveTarget;
  89044. private _property;
  89045. /**
  89046. * Instantiate the action
  89047. * @param triggerOptions defines the trigger options
  89048. * @param target defines the object containing the boolean
  89049. * @param propertyPath defines the path to the boolean property in the target object
  89050. * @param condition defines the trigger related conditions
  89051. */
  89052. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89053. /** @hidden */
  89054. _prepare(): void;
  89055. /**
  89056. * Execute the action toggle the boolean value.
  89057. */
  89058. execute(): void;
  89059. /**
  89060. * Serializes the actions and its related information.
  89061. * @param parent defines the object to serialize in
  89062. * @returns the serialized object
  89063. */
  89064. serialize(parent: any): any;
  89065. }
  89066. /**
  89067. * This defines an action responsible to set a the state field of the target
  89068. * to a desired value once triggered.
  89069. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89070. */
  89071. export class SetStateAction extends Action {
  89072. /**
  89073. * The value to store in the state field.
  89074. */
  89075. value: string;
  89076. private _target;
  89077. /**
  89078. * Instantiate the action
  89079. * @param triggerOptions defines the trigger options
  89080. * @param target defines the object containing the state property
  89081. * @param value defines the value to store in the state field
  89082. * @param condition defines the trigger related conditions
  89083. */
  89084. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89085. /**
  89086. * Execute the action and store the value on the target state property.
  89087. */
  89088. execute(): void;
  89089. /**
  89090. * Serializes the actions and its related information.
  89091. * @param parent defines the object to serialize in
  89092. * @returns the serialized object
  89093. */
  89094. serialize(parent: any): any;
  89095. }
  89096. /**
  89097. * This defines an action responsible to set a property of the target
  89098. * to a desired value once triggered.
  89099. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89100. */
  89101. export class SetValueAction extends Action {
  89102. /**
  89103. * The path of the property to set in the target.
  89104. */
  89105. propertyPath: string;
  89106. /**
  89107. * The value to set in the property
  89108. */
  89109. value: any;
  89110. private _target;
  89111. private _effectiveTarget;
  89112. private _property;
  89113. /**
  89114. * Instantiate the action
  89115. * @param triggerOptions defines the trigger options
  89116. * @param target defines the object containing the property
  89117. * @param propertyPath defines the path of the property to set in the target
  89118. * @param value defines the value to set in the property
  89119. * @param condition defines the trigger related conditions
  89120. */
  89121. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89122. /** @hidden */
  89123. _prepare(): void;
  89124. /**
  89125. * Execute the action and set the targetted property to the desired value.
  89126. */
  89127. execute(): void;
  89128. /**
  89129. * Serializes the actions and its related information.
  89130. * @param parent defines the object to serialize in
  89131. * @returns the serialized object
  89132. */
  89133. serialize(parent: any): any;
  89134. }
  89135. /**
  89136. * This defines an action responsible to increment the target value
  89137. * to a desired value once triggered.
  89138. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89139. */
  89140. export class IncrementValueAction extends Action {
  89141. /**
  89142. * The path of the property to increment in the target.
  89143. */
  89144. propertyPath: string;
  89145. /**
  89146. * The value we should increment the property by.
  89147. */
  89148. value: any;
  89149. private _target;
  89150. private _effectiveTarget;
  89151. private _property;
  89152. /**
  89153. * Instantiate the action
  89154. * @param triggerOptions defines the trigger options
  89155. * @param target defines the object containing the property
  89156. * @param propertyPath defines the path of the property to increment in the target
  89157. * @param value defines the value value we should increment the property by
  89158. * @param condition defines the trigger related conditions
  89159. */
  89160. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89161. /** @hidden */
  89162. _prepare(): void;
  89163. /**
  89164. * Execute the action and increment the target of the value amount.
  89165. */
  89166. execute(): void;
  89167. /**
  89168. * Serializes the actions and its related information.
  89169. * @param parent defines the object to serialize in
  89170. * @returns the serialized object
  89171. */
  89172. serialize(parent: any): any;
  89173. }
  89174. /**
  89175. * This defines an action responsible to start an animation once triggered.
  89176. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89177. */
  89178. export class PlayAnimationAction extends Action {
  89179. /**
  89180. * Where the animation should start (animation frame)
  89181. */
  89182. from: number;
  89183. /**
  89184. * Where the animation should stop (animation frame)
  89185. */
  89186. to: number;
  89187. /**
  89188. * Define if the animation should loop or stop after the first play.
  89189. */
  89190. loop?: boolean;
  89191. private _target;
  89192. /**
  89193. * Instantiate the action
  89194. * @param triggerOptions defines the trigger options
  89195. * @param target defines the target animation or animation name
  89196. * @param from defines from where the animation should start (animation frame)
  89197. * @param end defines where the animation should stop (animation frame)
  89198. * @param loop defines if the animation should loop or stop after the first play
  89199. * @param condition defines the trigger related conditions
  89200. */
  89201. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89202. /** @hidden */
  89203. _prepare(): void;
  89204. /**
  89205. * Execute the action and play the animation.
  89206. */
  89207. execute(): void;
  89208. /**
  89209. * Serializes the actions and its related information.
  89210. * @param parent defines the object to serialize in
  89211. * @returns the serialized object
  89212. */
  89213. serialize(parent: any): any;
  89214. }
  89215. /**
  89216. * This defines an action responsible to stop an animation once triggered.
  89217. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89218. */
  89219. export class StopAnimationAction extends Action {
  89220. private _target;
  89221. /**
  89222. * Instantiate the action
  89223. * @param triggerOptions defines the trigger options
  89224. * @param target defines the target animation or animation name
  89225. * @param condition defines the trigger related conditions
  89226. */
  89227. constructor(triggerOptions: any, target: any, condition?: Condition);
  89228. /** @hidden */
  89229. _prepare(): void;
  89230. /**
  89231. * Execute the action and stop the animation.
  89232. */
  89233. execute(): void;
  89234. /**
  89235. * Serializes the actions and its related information.
  89236. * @param parent defines the object to serialize in
  89237. * @returns the serialized object
  89238. */
  89239. serialize(parent: any): any;
  89240. }
  89241. /**
  89242. * This defines an action responsible that does nothing once triggered.
  89243. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89244. */
  89245. export class DoNothingAction extends Action {
  89246. /**
  89247. * Instantiate the action
  89248. * @param triggerOptions defines the trigger options
  89249. * @param condition defines the trigger related conditions
  89250. */
  89251. constructor(triggerOptions?: any, condition?: Condition);
  89252. /**
  89253. * Execute the action and do nothing.
  89254. */
  89255. execute(): void;
  89256. /**
  89257. * Serializes the actions and its related information.
  89258. * @param parent defines the object to serialize in
  89259. * @returns the serialized object
  89260. */
  89261. serialize(parent: any): any;
  89262. }
  89263. /**
  89264. * This defines an action responsible to trigger several actions once triggered.
  89265. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89266. */
  89267. export class CombineAction extends Action {
  89268. /**
  89269. * The list of aggregated animations to run.
  89270. */
  89271. children: Action[];
  89272. /**
  89273. * Instantiate the action
  89274. * @param triggerOptions defines the trigger options
  89275. * @param children defines the list of aggregated animations to run
  89276. * @param condition defines the trigger related conditions
  89277. */
  89278. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89279. /** @hidden */
  89280. _prepare(): void;
  89281. /**
  89282. * Execute the action and executes all the aggregated actions.
  89283. */
  89284. execute(evt: ActionEvent): void;
  89285. /**
  89286. * Serializes the actions and its related information.
  89287. * @param parent defines the object to serialize in
  89288. * @returns the serialized object
  89289. */
  89290. serialize(parent: any): any;
  89291. }
  89292. /**
  89293. * This defines an action responsible to run code (external event) once triggered.
  89294. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89295. */
  89296. export class ExecuteCodeAction extends Action {
  89297. /**
  89298. * The callback function to run.
  89299. */
  89300. func: (evt: ActionEvent) => void;
  89301. /**
  89302. * Instantiate the action
  89303. * @param triggerOptions defines the trigger options
  89304. * @param func defines the callback function to run
  89305. * @param condition defines the trigger related conditions
  89306. */
  89307. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89308. /**
  89309. * Execute the action and run the attached code.
  89310. */
  89311. execute(evt: ActionEvent): void;
  89312. }
  89313. /**
  89314. * This defines an action responsible to set the parent property of the target once triggered.
  89315. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89316. */
  89317. export class SetParentAction extends Action {
  89318. private _parent;
  89319. private _target;
  89320. /**
  89321. * Instantiate the action
  89322. * @param triggerOptions defines the trigger options
  89323. * @param target defines the target containing the parent property
  89324. * @param parent defines from where the animation should start (animation frame)
  89325. * @param condition defines the trigger related conditions
  89326. */
  89327. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89328. /** @hidden */
  89329. _prepare(): void;
  89330. /**
  89331. * Execute the action and set the parent property.
  89332. */
  89333. execute(): void;
  89334. /**
  89335. * Serializes the actions and its related information.
  89336. * @param parent defines the object to serialize in
  89337. * @returns the serialized object
  89338. */
  89339. serialize(parent: any): any;
  89340. }
  89341. }
  89342. declare module BABYLON {
  89343. /**
  89344. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89345. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89346. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89347. */
  89348. export class ActionManager extends AbstractActionManager {
  89349. /**
  89350. * Nothing
  89351. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89352. */
  89353. static readonly NothingTrigger: number;
  89354. /**
  89355. * On pick
  89356. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89357. */
  89358. static readonly OnPickTrigger: number;
  89359. /**
  89360. * On left pick
  89361. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89362. */
  89363. static readonly OnLeftPickTrigger: number;
  89364. /**
  89365. * On right pick
  89366. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89367. */
  89368. static readonly OnRightPickTrigger: number;
  89369. /**
  89370. * On center pick
  89371. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89372. */
  89373. static readonly OnCenterPickTrigger: number;
  89374. /**
  89375. * On pick down
  89376. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89377. */
  89378. static readonly OnPickDownTrigger: number;
  89379. /**
  89380. * On double pick
  89381. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89382. */
  89383. static readonly OnDoublePickTrigger: number;
  89384. /**
  89385. * On pick up
  89386. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89387. */
  89388. static readonly OnPickUpTrigger: number;
  89389. /**
  89390. * On pick out.
  89391. * This trigger will only be raised if you also declared a OnPickDown
  89392. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89393. */
  89394. static readonly OnPickOutTrigger: number;
  89395. /**
  89396. * On long press
  89397. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89398. */
  89399. static readonly OnLongPressTrigger: number;
  89400. /**
  89401. * On pointer over
  89402. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89403. */
  89404. static readonly OnPointerOverTrigger: number;
  89405. /**
  89406. * On pointer out
  89407. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89408. */
  89409. static readonly OnPointerOutTrigger: number;
  89410. /**
  89411. * On every frame
  89412. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89413. */
  89414. static readonly OnEveryFrameTrigger: number;
  89415. /**
  89416. * On intersection enter
  89417. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89418. */
  89419. static readonly OnIntersectionEnterTrigger: number;
  89420. /**
  89421. * On intersection exit
  89422. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89423. */
  89424. static readonly OnIntersectionExitTrigger: number;
  89425. /**
  89426. * On key down
  89427. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89428. */
  89429. static readonly OnKeyDownTrigger: number;
  89430. /**
  89431. * On key up
  89432. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89433. */
  89434. static readonly OnKeyUpTrigger: number;
  89435. private _scene;
  89436. /**
  89437. * Creates a new action manager
  89438. * @param scene defines the hosting scene
  89439. */
  89440. constructor(scene: Scene);
  89441. /**
  89442. * Releases all associated resources
  89443. */
  89444. dispose(): void;
  89445. /**
  89446. * Gets hosting scene
  89447. * @returns the hosting scene
  89448. */
  89449. getScene(): Scene;
  89450. /**
  89451. * Does this action manager handles actions of any of the given triggers
  89452. * @param triggers defines the triggers to be tested
  89453. * @return a boolean indicating whether one (or more) of the triggers is handled
  89454. */
  89455. hasSpecificTriggers(triggers: number[]): boolean;
  89456. /**
  89457. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89458. * speed.
  89459. * @param triggerA defines the trigger to be tested
  89460. * @param triggerB defines the trigger to be tested
  89461. * @return a boolean indicating whether one (or more) of the triggers is handled
  89462. */
  89463. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89464. /**
  89465. * Does this action manager handles actions of a given trigger
  89466. * @param trigger defines the trigger to be tested
  89467. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89468. * @return whether the trigger is handled
  89469. */
  89470. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89471. /**
  89472. * Does this action manager has pointer triggers
  89473. */
  89474. get hasPointerTriggers(): boolean;
  89475. /**
  89476. * Does this action manager has pick triggers
  89477. */
  89478. get hasPickTriggers(): boolean;
  89479. /**
  89480. * Registers an action to this action manager
  89481. * @param action defines the action to be registered
  89482. * @return the action amended (prepared) after registration
  89483. */
  89484. registerAction(action: IAction): Nullable<IAction>;
  89485. /**
  89486. * Unregisters an action to this action manager
  89487. * @param action defines the action to be unregistered
  89488. * @return a boolean indicating whether the action has been unregistered
  89489. */
  89490. unregisterAction(action: IAction): Boolean;
  89491. /**
  89492. * Process a specific trigger
  89493. * @param trigger defines the trigger to process
  89494. * @param evt defines the event details to be processed
  89495. */
  89496. processTrigger(trigger: number, evt?: IActionEvent): void;
  89497. /** @hidden */
  89498. _getEffectiveTarget(target: any, propertyPath: string): any;
  89499. /** @hidden */
  89500. _getProperty(propertyPath: string): string;
  89501. /**
  89502. * Serialize this manager to a JSON object
  89503. * @param name defines the property name to store this manager
  89504. * @returns a JSON representation of this manager
  89505. */
  89506. serialize(name: string): any;
  89507. /**
  89508. * Creates a new ActionManager from a JSON data
  89509. * @param parsedActions defines the JSON data to read from
  89510. * @param object defines the hosting mesh
  89511. * @param scene defines the hosting scene
  89512. */
  89513. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89514. /**
  89515. * Get a trigger name by index
  89516. * @param trigger defines the trigger index
  89517. * @returns a trigger name
  89518. */
  89519. static GetTriggerName(trigger: number): string;
  89520. }
  89521. }
  89522. declare module BABYLON {
  89523. /**
  89524. * Class used to represent a sprite
  89525. * @see https://doc.babylonjs.com/babylon101/sprites
  89526. */
  89527. export class Sprite implements IAnimatable {
  89528. /** defines the name */
  89529. name: string;
  89530. /** Gets or sets the current world position */
  89531. position: Vector3;
  89532. /** Gets or sets the main color */
  89533. color: Color4;
  89534. /** Gets or sets the width */
  89535. width: number;
  89536. /** Gets or sets the height */
  89537. height: number;
  89538. /** Gets or sets rotation angle */
  89539. angle: number;
  89540. /** Gets or sets the cell index in the sprite sheet */
  89541. cellIndex: number;
  89542. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89543. cellRef: string;
  89544. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89545. invertU: boolean;
  89546. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89547. invertV: boolean;
  89548. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89549. disposeWhenFinishedAnimating: boolean;
  89550. /** Gets the list of attached animations */
  89551. animations: Nullable<Array<Animation>>;
  89552. /** Gets or sets a boolean indicating if the sprite can be picked */
  89553. isPickable: boolean;
  89554. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  89555. useAlphaForPicking: boolean;
  89556. /** @hidden */
  89557. _xOffset: number;
  89558. /** @hidden */
  89559. _yOffset: number;
  89560. /** @hidden */
  89561. _xSize: number;
  89562. /** @hidden */
  89563. _ySize: number;
  89564. /**
  89565. * Gets or sets the associated action manager
  89566. */
  89567. actionManager: Nullable<ActionManager>;
  89568. /**
  89569. * An event triggered when the control has been disposed
  89570. */
  89571. onDisposeObservable: Observable<Sprite>;
  89572. private _animationStarted;
  89573. private _loopAnimation;
  89574. private _fromIndex;
  89575. private _toIndex;
  89576. private _delay;
  89577. private _direction;
  89578. private _manager;
  89579. private _time;
  89580. private _onAnimationEnd;
  89581. /**
  89582. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  89583. */
  89584. isVisible: boolean;
  89585. /**
  89586. * Gets or sets the sprite size
  89587. */
  89588. get size(): number;
  89589. set size(value: number);
  89590. /**
  89591. * Returns a boolean indicating if the animation is started
  89592. */
  89593. get animationStarted(): boolean;
  89594. /**
  89595. * Gets or sets the unique id of the sprite
  89596. */
  89597. uniqueId: number;
  89598. /**
  89599. * Gets the manager of this sprite
  89600. */
  89601. get manager(): ISpriteManager;
  89602. /**
  89603. * Creates a new Sprite
  89604. * @param name defines the name
  89605. * @param manager defines the manager
  89606. */
  89607. constructor(
  89608. /** defines the name */
  89609. name: string, manager: ISpriteManager);
  89610. /**
  89611. * Returns the string "Sprite"
  89612. * @returns "Sprite"
  89613. */
  89614. getClassName(): string;
  89615. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  89616. get fromIndex(): number;
  89617. set fromIndex(value: number);
  89618. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  89619. get toIndex(): number;
  89620. set toIndex(value: number);
  89621. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  89622. get loopAnimation(): boolean;
  89623. set loopAnimation(value: boolean);
  89624. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89625. get delay(): number;
  89626. set delay(value: number);
  89627. /**
  89628. * Starts an animation
  89629. * @param from defines the initial key
  89630. * @param to defines the end key
  89631. * @param loop defines if the animation must loop
  89632. * @param delay defines the start delay (in ms)
  89633. * @param onAnimationEnd defines a callback to call when animation ends
  89634. */
  89635. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  89636. /** Stops current animation (if any) */
  89637. stopAnimation(): void;
  89638. /** @hidden */
  89639. _animate(deltaTime: number): void;
  89640. /** Release associated resources */
  89641. dispose(): void;
  89642. /**
  89643. * Serializes the sprite to a JSON object
  89644. * @returns the JSON object
  89645. */
  89646. serialize(): any;
  89647. /**
  89648. * Parses a JSON object to create a new sprite
  89649. * @param parsedSprite The JSON object to parse
  89650. * @param manager defines the hosting manager
  89651. * @returns the new sprite
  89652. */
  89653. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  89654. }
  89655. }
  89656. declare module BABYLON {
  89657. /**
  89658. * Information about the result of picking within a scene
  89659. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  89660. */
  89661. export class PickingInfo {
  89662. /** @hidden */
  89663. _pickingUnavailable: boolean;
  89664. /**
  89665. * If the pick collided with an object
  89666. */
  89667. hit: boolean;
  89668. /**
  89669. * Distance away where the pick collided
  89670. */
  89671. distance: number;
  89672. /**
  89673. * The location of pick collision
  89674. */
  89675. pickedPoint: Nullable<Vector3>;
  89676. /**
  89677. * The mesh corresponding the the pick collision
  89678. */
  89679. pickedMesh: Nullable<AbstractMesh>;
  89680. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  89681. bu: number;
  89682. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  89683. bv: number;
  89684. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  89685. faceId: number;
  89686. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  89687. subMeshFaceId: number;
  89688. /** Id of the the submesh that was picked */
  89689. subMeshId: number;
  89690. /** If a sprite was picked, this will be the sprite the pick collided with */
  89691. pickedSprite: Nullable<Sprite>;
  89692. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  89693. thinInstanceIndex: number;
  89694. /**
  89695. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  89696. */
  89697. originMesh: Nullable<AbstractMesh>;
  89698. /**
  89699. * The ray that was used to perform the picking.
  89700. */
  89701. ray: Nullable<Ray>;
  89702. /**
  89703. * Gets the normal correspodning to the face the pick collided with
  89704. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  89705. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  89706. * @returns The normal correspodning to the face the pick collided with
  89707. */
  89708. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  89709. /**
  89710. * Gets the texture coordinates of where the pick occured
  89711. * @returns the vector containing the coordnates of the texture
  89712. */
  89713. getTextureCoordinates(): Nullable<Vector2>;
  89714. }
  89715. }
  89716. declare module BABYLON {
  89717. /**
  89718. * Class representing a ray with position and direction
  89719. */
  89720. export class Ray {
  89721. /** origin point */
  89722. origin: Vector3;
  89723. /** direction */
  89724. direction: Vector3;
  89725. /** length of the ray */
  89726. length: number;
  89727. private static readonly _TmpVector3;
  89728. private _tmpRay;
  89729. /**
  89730. * Creates a new ray
  89731. * @param origin origin point
  89732. * @param direction direction
  89733. * @param length length of the ray
  89734. */
  89735. constructor(
  89736. /** origin point */
  89737. origin: Vector3,
  89738. /** direction */
  89739. direction: Vector3,
  89740. /** length of the ray */
  89741. length?: number);
  89742. /**
  89743. * Checks if the ray intersects a box
  89744. * This does not account for the ray lenght by design to improve perfs.
  89745. * @param minimum bound of the box
  89746. * @param maximum bound of the box
  89747. * @param intersectionTreshold extra extend to be added to the box in all direction
  89748. * @returns if the box was hit
  89749. */
  89750. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  89751. /**
  89752. * Checks if the ray intersects a box
  89753. * This does not account for the ray lenght by design to improve perfs.
  89754. * @param box the bounding box to check
  89755. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  89756. * @returns if the box was hit
  89757. */
  89758. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  89759. /**
  89760. * If the ray hits a sphere
  89761. * @param sphere the bounding sphere to check
  89762. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  89763. * @returns true if it hits the sphere
  89764. */
  89765. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  89766. /**
  89767. * If the ray hits a triange
  89768. * @param vertex0 triangle vertex
  89769. * @param vertex1 triangle vertex
  89770. * @param vertex2 triangle vertex
  89771. * @returns intersection information if hit
  89772. */
  89773. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  89774. /**
  89775. * Checks if ray intersects a plane
  89776. * @param plane the plane to check
  89777. * @returns the distance away it was hit
  89778. */
  89779. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  89780. /**
  89781. * Calculate the intercept of a ray on a given axis
  89782. * @param axis to check 'x' | 'y' | 'z'
  89783. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  89784. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  89785. */
  89786. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  89787. /**
  89788. * Checks if ray intersects a mesh
  89789. * @param mesh the mesh to check
  89790. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89791. * @returns picking info of the intersecton
  89792. */
  89793. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  89794. /**
  89795. * Checks if ray intersects a mesh
  89796. * @param meshes the meshes to check
  89797. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89798. * @param results array to store result in
  89799. * @returns Array of picking infos
  89800. */
  89801. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  89802. private _comparePickingInfo;
  89803. private static smallnum;
  89804. private static rayl;
  89805. /**
  89806. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  89807. * @param sega the first point of the segment to test the intersection against
  89808. * @param segb the second point of the segment to test the intersection against
  89809. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  89810. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  89811. */
  89812. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  89813. /**
  89814. * Update the ray from viewport position
  89815. * @param x position
  89816. * @param y y position
  89817. * @param viewportWidth viewport width
  89818. * @param viewportHeight viewport height
  89819. * @param world world matrix
  89820. * @param view view matrix
  89821. * @param projection projection matrix
  89822. * @returns this ray updated
  89823. */
  89824. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  89825. /**
  89826. * Creates a ray with origin and direction of 0,0,0
  89827. * @returns the new ray
  89828. */
  89829. static Zero(): Ray;
  89830. /**
  89831. * Creates a new ray from screen space and viewport
  89832. * @param x position
  89833. * @param y y position
  89834. * @param viewportWidth viewport width
  89835. * @param viewportHeight viewport height
  89836. * @param world world matrix
  89837. * @param view view matrix
  89838. * @param projection projection matrix
  89839. * @returns new ray
  89840. */
  89841. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  89842. /**
  89843. * 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
  89844. * transformed to the given world matrix.
  89845. * @param origin The origin point
  89846. * @param end The end point
  89847. * @param world a matrix to transform the ray to. Default is the identity matrix.
  89848. * @returns the new ray
  89849. */
  89850. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  89851. /**
  89852. * Transforms a ray by a matrix
  89853. * @param ray ray to transform
  89854. * @param matrix matrix to apply
  89855. * @returns the resulting new ray
  89856. */
  89857. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  89858. /**
  89859. * Transforms a ray by a matrix
  89860. * @param ray ray to transform
  89861. * @param matrix matrix to apply
  89862. * @param result ray to store result in
  89863. */
  89864. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  89865. /**
  89866. * Unproject a ray from screen space to object space
  89867. * @param sourceX defines the screen space x coordinate to use
  89868. * @param sourceY defines the screen space y coordinate to use
  89869. * @param viewportWidth defines the current width of the viewport
  89870. * @param viewportHeight defines the current height of the viewport
  89871. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  89872. * @param view defines the view matrix to use
  89873. * @param projection defines the projection matrix to use
  89874. */
  89875. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  89876. }
  89877. /**
  89878. * Type used to define predicate used to select faces when a mesh intersection is detected
  89879. */
  89880. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  89881. interface Scene {
  89882. /** @hidden */
  89883. _tempPickingRay: Nullable<Ray>;
  89884. /** @hidden */
  89885. _cachedRayForTransform: Ray;
  89886. /** @hidden */
  89887. _pickWithRayInverseMatrix: Matrix;
  89888. /** @hidden */
  89889. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  89890. /** @hidden */
  89891. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  89892. /** @hidden */
  89893. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  89894. }
  89895. }
  89896. declare module BABYLON {
  89897. /**
  89898. * Groups all the scene component constants in one place to ease maintenance.
  89899. * @hidden
  89900. */
  89901. export class SceneComponentConstants {
  89902. static readonly NAME_EFFECTLAYER: string;
  89903. static readonly NAME_LAYER: string;
  89904. static readonly NAME_LENSFLARESYSTEM: string;
  89905. static readonly NAME_BOUNDINGBOXRENDERER: string;
  89906. static readonly NAME_PARTICLESYSTEM: string;
  89907. static readonly NAME_GAMEPAD: string;
  89908. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  89909. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  89910. static readonly NAME_PREPASSRENDERER: string;
  89911. static readonly NAME_DEPTHRENDERER: string;
  89912. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  89913. static readonly NAME_SPRITE: string;
  89914. static readonly NAME_OUTLINERENDERER: string;
  89915. static readonly NAME_PROCEDURALTEXTURE: string;
  89916. static readonly NAME_SHADOWGENERATOR: string;
  89917. static readonly NAME_OCTREE: string;
  89918. static readonly NAME_PHYSICSENGINE: string;
  89919. static readonly NAME_AUDIO: string;
  89920. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  89921. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  89922. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  89923. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  89924. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  89925. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  89926. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  89927. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  89928. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  89929. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  89930. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  89931. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  89932. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  89933. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  89934. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  89935. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  89936. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  89937. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  89938. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  89939. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  89940. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  89941. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  89942. static readonly STEP_AFTERRENDER_AUDIO: number;
  89943. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  89944. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  89945. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  89946. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  89947. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  89948. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  89949. static readonly STEP_POINTERMOVE_SPRITE: number;
  89950. static readonly STEP_POINTERDOWN_SPRITE: number;
  89951. static readonly STEP_POINTERUP_SPRITE: number;
  89952. }
  89953. /**
  89954. * This represents a scene component.
  89955. *
  89956. * This is used to decouple the dependency the scene is having on the different workloads like
  89957. * layers, post processes...
  89958. */
  89959. export interface ISceneComponent {
  89960. /**
  89961. * The name of the component. Each component must have a unique name.
  89962. */
  89963. name: string;
  89964. /**
  89965. * The scene the component belongs to.
  89966. */
  89967. scene: Scene;
  89968. /**
  89969. * Register the component to one instance of a scene.
  89970. */
  89971. register(): void;
  89972. /**
  89973. * Rebuilds the elements related to this component in case of
  89974. * context lost for instance.
  89975. */
  89976. rebuild(): void;
  89977. /**
  89978. * Disposes the component and the associated ressources.
  89979. */
  89980. dispose(): void;
  89981. }
  89982. /**
  89983. * This represents a SERIALIZABLE scene component.
  89984. *
  89985. * This extends Scene Component to add Serialization methods on top.
  89986. */
  89987. export interface ISceneSerializableComponent extends ISceneComponent {
  89988. /**
  89989. * Adds all the elements from the container to the scene
  89990. * @param container the container holding the elements
  89991. */
  89992. addFromContainer(container: AbstractScene): void;
  89993. /**
  89994. * Removes all the elements in the container from the scene
  89995. * @param container contains the elements to remove
  89996. * @param dispose if the removed element should be disposed (default: false)
  89997. */
  89998. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  89999. /**
  90000. * Serializes the component data to the specified json object
  90001. * @param serializationObject The object to serialize to
  90002. */
  90003. serialize(serializationObject: any): void;
  90004. }
  90005. /**
  90006. * Strong typing of a Mesh related stage step action
  90007. */
  90008. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90009. /**
  90010. * Strong typing of a Evaluate Sub Mesh related stage step action
  90011. */
  90012. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90013. /**
  90014. * Strong typing of a Active Mesh related stage step action
  90015. */
  90016. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90017. /**
  90018. * Strong typing of a Camera related stage step action
  90019. */
  90020. export type CameraStageAction = (camera: Camera) => void;
  90021. /**
  90022. * Strong typing of a Camera Frame buffer related stage step action
  90023. */
  90024. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90025. /**
  90026. * Strong typing of a Render Target related stage step action
  90027. */
  90028. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90029. /**
  90030. * Strong typing of a RenderingGroup related stage step action
  90031. */
  90032. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90033. /**
  90034. * Strong typing of a Mesh Render related stage step action
  90035. */
  90036. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90037. /**
  90038. * Strong typing of a simple stage step action
  90039. */
  90040. export type SimpleStageAction = () => void;
  90041. /**
  90042. * Strong typing of a render target action.
  90043. */
  90044. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90045. /**
  90046. * Strong typing of a pointer move action.
  90047. */
  90048. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90049. /**
  90050. * Strong typing of a pointer up/down action.
  90051. */
  90052. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90053. /**
  90054. * Representation of a stage in the scene (Basically a list of ordered steps)
  90055. * @hidden
  90056. */
  90057. export class Stage<T extends Function> extends Array<{
  90058. index: number;
  90059. component: ISceneComponent;
  90060. action: T;
  90061. }> {
  90062. /**
  90063. * Hide ctor from the rest of the world.
  90064. * @param items The items to add.
  90065. */
  90066. private constructor();
  90067. /**
  90068. * Creates a new Stage.
  90069. * @returns A new instance of a Stage
  90070. */
  90071. static Create<T extends Function>(): Stage<T>;
  90072. /**
  90073. * Registers a step in an ordered way in the targeted stage.
  90074. * @param index Defines the position to register the step in
  90075. * @param component Defines the component attached to the step
  90076. * @param action Defines the action to launch during the step
  90077. */
  90078. registerStep(index: number, component: ISceneComponent, action: T): void;
  90079. /**
  90080. * Clears all the steps from the stage.
  90081. */
  90082. clear(): void;
  90083. }
  90084. }
  90085. declare module BABYLON {
  90086. interface Scene {
  90087. /** @hidden */
  90088. _pointerOverSprite: Nullable<Sprite>;
  90089. /** @hidden */
  90090. _pickedDownSprite: Nullable<Sprite>;
  90091. /** @hidden */
  90092. _tempSpritePickingRay: Nullable<Ray>;
  90093. /**
  90094. * All of the sprite managers added to this scene
  90095. * @see https://doc.babylonjs.com/babylon101/sprites
  90096. */
  90097. spriteManagers: Array<ISpriteManager>;
  90098. /**
  90099. * An event triggered when sprites rendering is about to start
  90100. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90101. */
  90102. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90103. /**
  90104. * An event triggered when sprites rendering is done
  90105. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90106. */
  90107. onAfterSpritesRenderingObservable: Observable<Scene>;
  90108. /** @hidden */
  90109. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90110. /** Launch a ray to try to pick a sprite in the scene
  90111. * @param x position on screen
  90112. * @param y position on screen
  90113. * @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
  90114. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90115. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90116. * @returns a PickingInfo
  90117. */
  90118. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90119. /** Use the given ray to pick a sprite in the scene
  90120. * @param ray The ray (in world space) to use to pick meshes
  90121. * @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
  90122. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90123. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90124. * @returns a PickingInfo
  90125. */
  90126. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90127. /** @hidden */
  90128. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90129. /** Launch a ray to try to pick sprites in the scene
  90130. * @param x position on screen
  90131. * @param y position on screen
  90132. * @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
  90133. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90134. * @returns a PickingInfo array
  90135. */
  90136. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90137. /** Use the given ray to pick sprites in the scene
  90138. * @param ray The ray (in world space) to use to pick meshes
  90139. * @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
  90140. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90141. * @returns a PickingInfo array
  90142. */
  90143. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90144. /**
  90145. * Force the sprite under the pointer
  90146. * @param sprite defines the sprite to use
  90147. */
  90148. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90149. /**
  90150. * Gets the sprite under the pointer
  90151. * @returns a Sprite or null if no sprite is under the pointer
  90152. */
  90153. getPointerOverSprite(): Nullable<Sprite>;
  90154. }
  90155. /**
  90156. * Defines the sprite scene component responsible to manage sprites
  90157. * in a given scene.
  90158. */
  90159. export class SpriteSceneComponent implements ISceneComponent {
  90160. /**
  90161. * The component name helpfull to identify the component in the list of scene components.
  90162. */
  90163. readonly name: string;
  90164. /**
  90165. * The scene the component belongs to.
  90166. */
  90167. scene: Scene;
  90168. /** @hidden */
  90169. private _spritePredicate;
  90170. /**
  90171. * Creates a new instance of the component for the given scene
  90172. * @param scene Defines the scene to register the component in
  90173. */
  90174. constructor(scene: Scene);
  90175. /**
  90176. * Registers the component in a given scene
  90177. */
  90178. register(): void;
  90179. /**
  90180. * Rebuilds the elements related to this component in case of
  90181. * context lost for instance.
  90182. */
  90183. rebuild(): void;
  90184. /**
  90185. * Disposes the component and the associated ressources.
  90186. */
  90187. dispose(): void;
  90188. private _pickSpriteButKeepRay;
  90189. private _pointerMove;
  90190. private _pointerDown;
  90191. private _pointerUp;
  90192. }
  90193. }
  90194. declare module BABYLON {
  90195. /** @hidden */
  90196. export var fogFragmentDeclaration: {
  90197. name: string;
  90198. shader: string;
  90199. };
  90200. }
  90201. declare module BABYLON {
  90202. /** @hidden */
  90203. export var fogFragment: {
  90204. name: string;
  90205. shader: string;
  90206. };
  90207. }
  90208. declare module BABYLON {
  90209. /** @hidden */
  90210. export var spritesPixelShader: {
  90211. name: string;
  90212. shader: string;
  90213. };
  90214. }
  90215. declare module BABYLON {
  90216. /** @hidden */
  90217. export var fogVertexDeclaration: {
  90218. name: string;
  90219. shader: string;
  90220. };
  90221. }
  90222. declare module BABYLON {
  90223. /** @hidden */
  90224. export var spritesVertexShader: {
  90225. name: string;
  90226. shader: string;
  90227. };
  90228. }
  90229. declare module BABYLON {
  90230. /**
  90231. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90232. */
  90233. export interface ISpriteManager extends IDisposable {
  90234. /**
  90235. * Gets manager's name
  90236. */
  90237. name: string;
  90238. /**
  90239. * Restricts the camera to viewing objects with the same layerMask.
  90240. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90241. */
  90242. layerMask: number;
  90243. /**
  90244. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90245. */
  90246. isPickable: boolean;
  90247. /**
  90248. * Gets the hosting scene
  90249. */
  90250. scene: Scene;
  90251. /**
  90252. * Specifies the rendering group id for this mesh (0 by default)
  90253. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90254. */
  90255. renderingGroupId: number;
  90256. /**
  90257. * Defines the list of sprites managed by the manager.
  90258. */
  90259. sprites: Array<Sprite>;
  90260. /**
  90261. * Gets or sets the spritesheet texture
  90262. */
  90263. texture: Texture;
  90264. /** Defines the default width of a cell in the spritesheet */
  90265. cellWidth: number;
  90266. /** Defines the default height of a cell in the spritesheet */
  90267. cellHeight: number;
  90268. /**
  90269. * Tests the intersection of a sprite with a specific ray.
  90270. * @param ray The ray we are sending to test the collision
  90271. * @param camera The camera space we are sending rays in
  90272. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90273. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90274. * @returns picking info or null.
  90275. */
  90276. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90277. /**
  90278. * Intersects the sprites with a ray
  90279. * @param ray defines the ray to intersect with
  90280. * @param camera defines the current active camera
  90281. * @param predicate defines a predicate used to select candidate sprites
  90282. * @returns null if no hit or a PickingInfo array
  90283. */
  90284. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90285. /**
  90286. * Renders the list of sprites on screen.
  90287. */
  90288. render(): void;
  90289. }
  90290. /**
  90291. * Class used to manage multiple sprites on the same spritesheet
  90292. * @see https://doc.babylonjs.com/babylon101/sprites
  90293. */
  90294. export class SpriteManager implements ISpriteManager {
  90295. /** defines the manager's name */
  90296. name: string;
  90297. /** Define the Url to load snippets */
  90298. static SnippetUrl: string;
  90299. /** Snippet ID if the manager was created from the snippet server */
  90300. snippetId: string;
  90301. /** Gets the list of sprites */
  90302. sprites: Sprite[];
  90303. /** Gets or sets the rendering group id (0 by default) */
  90304. renderingGroupId: number;
  90305. /** Gets or sets camera layer mask */
  90306. layerMask: number;
  90307. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90308. fogEnabled: boolean;
  90309. /** Gets or sets a boolean indicating if the sprites are pickable */
  90310. isPickable: boolean;
  90311. /** Defines the default width of a cell in the spritesheet */
  90312. cellWidth: number;
  90313. /** Defines the default height of a cell in the spritesheet */
  90314. cellHeight: number;
  90315. /** Associative array from JSON sprite data file */
  90316. private _cellData;
  90317. /** Array of sprite names from JSON sprite data file */
  90318. private _spriteMap;
  90319. /** True when packed cell data from JSON file is ready*/
  90320. private _packedAndReady;
  90321. private _textureContent;
  90322. private _useInstancing;
  90323. /**
  90324. * An event triggered when the manager is disposed.
  90325. */
  90326. onDisposeObservable: Observable<SpriteManager>;
  90327. private _onDisposeObserver;
  90328. /**
  90329. * Callback called when the manager is disposed
  90330. */
  90331. set onDispose(callback: () => void);
  90332. private _capacity;
  90333. private _fromPacked;
  90334. private _spriteTexture;
  90335. private _epsilon;
  90336. private _scene;
  90337. private _vertexData;
  90338. private _buffer;
  90339. private _vertexBuffers;
  90340. private _spriteBuffer;
  90341. private _indexBuffer;
  90342. private _effectBase;
  90343. private _effectFog;
  90344. private _vertexBufferSize;
  90345. /**
  90346. * Gets or sets the unique id of the sprite
  90347. */
  90348. uniqueId: number;
  90349. /**
  90350. * Gets the array of sprites
  90351. */
  90352. get children(): Sprite[];
  90353. /**
  90354. * Gets the hosting scene
  90355. */
  90356. get scene(): Scene;
  90357. /**
  90358. * Gets the capacity of the manager
  90359. */
  90360. get capacity(): number;
  90361. /**
  90362. * Gets or sets the spritesheet texture
  90363. */
  90364. get texture(): Texture;
  90365. set texture(value: Texture);
  90366. private _blendMode;
  90367. /**
  90368. * Blend mode use to render the particle, it can be any of
  90369. * the static Constants.ALPHA_x properties provided in this class.
  90370. * Default value is Constants.ALPHA_COMBINE
  90371. */
  90372. get blendMode(): number;
  90373. set blendMode(blendMode: number);
  90374. /** Disables writing to the depth buffer when rendering the sprites.
  90375. * It can be handy to disable depth writing when using textures without alpha channel
  90376. * and setting some specific blend modes.
  90377. */
  90378. disableDepthWrite: boolean;
  90379. /**
  90380. * Creates a new sprite manager
  90381. * @param name defines the manager's name
  90382. * @param imgUrl defines the sprite sheet url
  90383. * @param capacity defines the maximum allowed number of sprites
  90384. * @param cellSize defines the size of a sprite cell
  90385. * @param scene defines the hosting scene
  90386. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90387. * @param samplingMode defines the smapling mode to use with spritesheet
  90388. * @param fromPacked set to false; do not alter
  90389. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90390. */
  90391. constructor(
  90392. /** defines the manager's name */
  90393. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90394. /**
  90395. * Returns the string "SpriteManager"
  90396. * @returns "SpriteManager"
  90397. */
  90398. getClassName(): string;
  90399. private _makePacked;
  90400. private _appendSpriteVertex;
  90401. private _checkTextureAlpha;
  90402. /**
  90403. * Intersects the sprites with a ray
  90404. * @param ray defines the ray to intersect with
  90405. * @param camera defines the current active camera
  90406. * @param predicate defines a predicate used to select candidate sprites
  90407. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90408. * @returns null if no hit or a PickingInfo
  90409. */
  90410. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90411. /**
  90412. * Intersects the sprites with a ray
  90413. * @param ray defines the ray to intersect with
  90414. * @param camera defines the current active camera
  90415. * @param predicate defines a predicate used to select candidate sprites
  90416. * @returns null if no hit or a PickingInfo array
  90417. */
  90418. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90419. /**
  90420. * Render all child sprites
  90421. */
  90422. render(): void;
  90423. /**
  90424. * Release associated resources
  90425. */
  90426. dispose(): void;
  90427. /**
  90428. * Serializes the sprite manager to a JSON object
  90429. * @param serializeTexture defines if the texture must be serialized as well
  90430. * @returns the JSON object
  90431. */
  90432. serialize(serializeTexture?: boolean): any;
  90433. /**
  90434. * Parses a JSON object to create a new sprite manager.
  90435. * @param parsedManager The JSON object to parse
  90436. * @param scene The scene to create the sprite managerin
  90437. * @param rootUrl The root url to use to load external dependencies like texture
  90438. * @returns the new sprite manager
  90439. */
  90440. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90441. /**
  90442. * Creates a sprite manager from a snippet saved in a remote file
  90443. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90444. * @param url defines the url to load from
  90445. * @param scene defines the hosting scene
  90446. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90447. * @returns a promise that will resolve to the new sprite manager
  90448. */
  90449. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90450. /**
  90451. * Creates a sprite manager from a snippet saved by the sprite editor
  90452. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90453. * @param scene defines the hosting scene
  90454. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90455. * @returns a promise that will resolve to the new sprite manager
  90456. */
  90457. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90458. }
  90459. }
  90460. declare module BABYLON {
  90461. /** Interface used by value gradients (color, factor, ...) */
  90462. export interface IValueGradient {
  90463. /**
  90464. * Gets or sets the gradient value (between 0 and 1)
  90465. */
  90466. gradient: number;
  90467. }
  90468. /** Class used to store color4 gradient */
  90469. export class ColorGradient implements IValueGradient {
  90470. /**
  90471. * Gets or sets the gradient value (between 0 and 1)
  90472. */
  90473. gradient: number;
  90474. /**
  90475. * Gets or sets first associated color
  90476. */
  90477. color1: Color4;
  90478. /**
  90479. * Gets or sets second associated color
  90480. */
  90481. color2?: Color4 | undefined;
  90482. /**
  90483. * Creates a new color4 gradient
  90484. * @param gradient gets or sets the gradient value (between 0 and 1)
  90485. * @param color1 gets or sets first associated color
  90486. * @param color2 gets or sets first second color
  90487. */
  90488. constructor(
  90489. /**
  90490. * Gets or sets the gradient value (between 0 and 1)
  90491. */
  90492. gradient: number,
  90493. /**
  90494. * Gets or sets first associated color
  90495. */
  90496. color1: Color4,
  90497. /**
  90498. * Gets or sets second associated color
  90499. */
  90500. color2?: Color4 | undefined);
  90501. /**
  90502. * Will get a color picked randomly between color1 and color2.
  90503. * If color2 is undefined then color1 will be used
  90504. * @param result defines the target Color4 to store the result in
  90505. */
  90506. getColorToRef(result: Color4): void;
  90507. }
  90508. /** Class used to store color 3 gradient */
  90509. export class Color3Gradient implements IValueGradient {
  90510. /**
  90511. * Gets or sets the gradient value (between 0 and 1)
  90512. */
  90513. gradient: number;
  90514. /**
  90515. * Gets or sets the associated color
  90516. */
  90517. color: Color3;
  90518. /**
  90519. * Creates a new color3 gradient
  90520. * @param gradient gets or sets the gradient value (between 0 and 1)
  90521. * @param color gets or sets associated color
  90522. */
  90523. constructor(
  90524. /**
  90525. * Gets or sets the gradient value (between 0 and 1)
  90526. */
  90527. gradient: number,
  90528. /**
  90529. * Gets or sets the associated color
  90530. */
  90531. color: Color3);
  90532. }
  90533. /** Class used to store factor gradient */
  90534. export class FactorGradient implements IValueGradient {
  90535. /**
  90536. * Gets or sets the gradient value (between 0 and 1)
  90537. */
  90538. gradient: number;
  90539. /**
  90540. * Gets or sets first associated factor
  90541. */
  90542. factor1: number;
  90543. /**
  90544. * Gets or sets second associated factor
  90545. */
  90546. factor2?: number | undefined;
  90547. /**
  90548. * Creates a new factor gradient
  90549. * @param gradient gets or sets the gradient value (between 0 and 1)
  90550. * @param factor1 gets or sets first associated factor
  90551. * @param factor2 gets or sets second associated factor
  90552. */
  90553. constructor(
  90554. /**
  90555. * Gets or sets the gradient value (between 0 and 1)
  90556. */
  90557. gradient: number,
  90558. /**
  90559. * Gets or sets first associated factor
  90560. */
  90561. factor1: number,
  90562. /**
  90563. * Gets or sets second associated factor
  90564. */
  90565. factor2?: number | undefined);
  90566. /**
  90567. * Will get a number picked randomly between factor1 and factor2.
  90568. * If factor2 is undefined then factor1 will be used
  90569. * @returns the picked number
  90570. */
  90571. getFactor(): number;
  90572. }
  90573. /**
  90574. * Helper used to simplify some generic gradient tasks
  90575. */
  90576. export class GradientHelper {
  90577. /**
  90578. * Gets the current gradient from an array of IValueGradient
  90579. * @param ratio defines the current ratio to get
  90580. * @param gradients defines the array of IValueGradient
  90581. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  90582. */
  90583. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  90584. }
  90585. }
  90586. declare module BABYLON {
  90587. interface ThinEngine {
  90588. /**
  90589. * Creates a raw texture
  90590. * @param data defines the data to store in the texture
  90591. * @param width defines the width of the texture
  90592. * @param height defines the height of the texture
  90593. * @param format defines the format of the data
  90594. * @param generateMipMaps defines if the engine should generate the mip levels
  90595. * @param invertY defines if data must be stored with Y axis inverted
  90596. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  90597. * @param compression defines the compression used (null by default)
  90598. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90599. * @returns the raw texture inside an InternalTexture
  90600. */
  90601. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  90602. /**
  90603. * Update a raw texture
  90604. * @param texture defines the texture to update
  90605. * @param data defines the data to store in the texture
  90606. * @param format defines the format of the data
  90607. * @param invertY defines if data must be stored with Y axis inverted
  90608. */
  90609. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90610. /**
  90611. * Update a raw texture
  90612. * @param texture defines the texture to update
  90613. * @param data defines the data to store in the texture
  90614. * @param format defines the format of the data
  90615. * @param invertY defines if data must be stored with Y axis inverted
  90616. * @param compression defines the compression used (null by default)
  90617. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90618. */
  90619. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  90620. /**
  90621. * Creates a new raw cube texture
  90622. * @param data defines the array of data to use to create each face
  90623. * @param size defines the size of the textures
  90624. * @param format defines the format of the data
  90625. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90626. * @param generateMipMaps defines if the engine should generate the mip levels
  90627. * @param invertY defines if data must be stored with Y axis inverted
  90628. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90629. * @param compression defines the compression used (null by default)
  90630. * @returns the cube texture as an InternalTexture
  90631. */
  90632. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90633. /**
  90634. * Update a raw cube texture
  90635. * @param texture defines the texture to udpdate
  90636. * @param data defines the data to store
  90637. * @param format defines the data format
  90638. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90639. * @param invertY defines if data must be stored with Y axis inverted
  90640. */
  90641. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  90642. /**
  90643. * Update a raw cube texture
  90644. * @param texture defines the texture to udpdate
  90645. * @param data defines the data to store
  90646. * @param format defines the data format
  90647. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90648. * @param invertY defines if data must be stored with Y axis inverted
  90649. * @param compression defines the compression used (null by default)
  90650. */
  90651. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  90652. /**
  90653. * Update a raw cube texture
  90654. * @param texture defines the texture to udpdate
  90655. * @param data defines the data to store
  90656. * @param format defines the data format
  90657. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90658. * @param invertY defines if data must be stored with Y axis inverted
  90659. * @param compression defines the compression used (null by default)
  90660. * @param level defines which level of the texture to update
  90661. */
  90662. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  90663. /**
  90664. * Creates a new raw cube texture from a specified url
  90665. * @param url defines the url where the data is located
  90666. * @param scene defines the current scene
  90667. * @param size defines the size of the textures
  90668. * @param format defines the format of the data
  90669. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90670. * @param noMipmap defines if the engine should avoid generating the mip levels
  90671. * @param callback defines a callback used to extract texture data from loaded data
  90672. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  90673. * @param onLoad defines a callback called when texture is loaded
  90674. * @param onError defines a callback called if there is an error
  90675. * @returns the cube texture as an InternalTexture
  90676. */
  90677. 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;
  90678. /**
  90679. * Creates a new raw cube texture from a specified url
  90680. * @param url defines the url where the data is located
  90681. * @param scene defines the current scene
  90682. * @param size defines the size of the textures
  90683. * @param format defines the format of the data
  90684. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90685. * @param noMipmap defines if the engine should avoid generating the mip levels
  90686. * @param callback defines a callback used to extract texture data from loaded data
  90687. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  90688. * @param onLoad defines a callback called when texture is loaded
  90689. * @param onError defines a callback called if there is an error
  90690. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90691. * @param invertY defines if data must be stored with Y axis inverted
  90692. * @returns the cube texture as an InternalTexture
  90693. */
  90694. 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;
  90695. /**
  90696. * Creates a new raw 3D texture
  90697. * @param data defines the data used to create the texture
  90698. * @param width defines the width of the texture
  90699. * @param height defines the height of the texture
  90700. * @param depth defines the depth of the texture
  90701. * @param format defines the format of the texture
  90702. * @param generateMipMaps defines if the engine must generate mip levels
  90703. * @param invertY defines if data must be stored with Y axis inverted
  90704. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90705. * @param compression defines the compressed used (can be null)
  90706. * @param textureType defines the compressed used (can be null)
  90707. * @returns a new raw 3D texture (stored in an InternalTexture)
  90708. */
  90709. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  90710. /**
  90711. * Update a raw 3D texture
  90712. * @param texture defines the texture to update
  90713. * @param data defines the data to store
  90714. * @param format defines the data format
  90715. * @param invertY defines if data must be stored with Y axis inverted
  90716. */
  90717. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90718. /**
  90719. * Update a raw 3D texture
  90720. * @param texture defines the texture to update
  90721. * @param data defines the data to store
  90722. * @param format defines the data format
  90723. * @param invertY defines if data must be stored with Y axis inverted
  90724. * @param compression defines the used compression (can be null)
  90725. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  90726. */
  90727. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  90728. /**
  90729. * Creates a new raw 2D array texture
  90730. * @param data defines the data used to create the texture
  90731. * @param width defines the width of the texture
  90732. * @param height defines the height of the texture
  90733. * @param depth defines the number of layers of the texture
  90734. * @param format defines the format of the texture
  90735. * @param generateMipMaps defines if the engine must generate mip levels
  90736. * @param invertY defines if data must be stored with Y axis inverted
  90737. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90738. * @param compression defines the compressed used (can be null)
  90739. * @param textureType defines the compressed used (can be null)
  90740. * @returns a new raw 2D array texture (stored in an InternalTexture)
  90741. */
  90742. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  90743. /**
  90744. * Update a raw 2D array texture
  90745. * @param texture defines the texture to update
  90746. * @param data defines the data to store
  90747. * @param format defines the data format
  90748. * @param invertY defines if data must be stored with Y axis inverted
  90749. */
  90750. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90751. /**
  90752. * Update a raw 2D array texture
  90753. * @param texture defines the texture to update
  90754. * @param data defines the data to store
  90755. * @param format defines the data format
  90756. * @param invertY defines if data must be stored with Y axis inverted
  90757. * @param compression defines the used compression (can be null)
  90758. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  90759. */
  90760. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  90761. }
  90762. }
  90763. declare module BABYLON {
  90764. /**
  90765. * Raw texture can help creating a texture directly from an array of data.
  90766. * This can be super useful if you either get the data from an uncompressed source or
  90767. * if you wish to create your texture pixel by pixel.
  90768. */
  90769. export class RawTexture extends Texture {
  90770. /**
  90771. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90772. */
  90773. format: number;
  90774. /**
  90775. * Instantiates a new RawTexture.
  90776. * Raw texture can help creating a texture directly from an array of data.
  90777. * This can be super useful if you either get the data from an uncompressed source or
  90778. * if you wish to create your texture pixel by pixel.
  90779. * @param data define the array of data to use to create the texture
  90780. * @param width define the width of the texture
  90781. * @param height define the height of the texture
  90782. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90783. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90784. * @param generateMipMaps define whether mip maps should be generated or not
  90785. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90786. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90787. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90788. */
  90789. constructor(data: ArrayBufferView, width: number, height: number,
  90790. /**
  90791. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90792. */
  90793. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  90794. /**
  90795. * Updates the texture underlying data.
  90796. * @param data Define the new data of the texture
  90797. */
  90798. update(data: ArrayBufferView): void;
  90799. /**
  90800. * Creates a luminance texture from some data.
  90801. * @param data Define the texture data
  90802. * @param width Define the width of the texture
  90803. * @param height Define the height of the texture
  90804. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90805. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90806. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90807. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90808. * @returns the luminance texture
  90809. */
  90810. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90811. /**
  90812. * Creates a luminance alpha texture from some data.
  90813. * @param data Define the texture data
  90814. * @param width Define the width of the texture
  90815. * @param height Define the height of the texture
  90816. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90817. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90818. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90819. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90820. * @returns the luminance alpha texture
  90821. */
  90822. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90823. /**
  90824. * Creates an alpha texture from some data.
  90825. * @param data Define the texture data
  90826. * @param width Define the width of the texture
  90827. * @param height Define the height of the texture
  90828. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90829. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90830. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90831. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90832. * @returns the alpha texture
  90833. */
  90834. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90835. /**
  90836. * Creates a RGB texture from some data.
  90837. * @param data Define the texture data
  90838. * @param width Define the width of the texture
  90839. * @param height Define the height of the texture
  90840. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90841. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90842. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90843. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90844. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90845. * @returns the RGB alpha texture
  90846. */
  90847. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90848. /**
  90849. * Creates a RGBA texture from some data.
  90850. * @param data Define the texture data
  90851. * @param width Define the width of the texture
  90852. * @param height Define the height of the texture
  90853. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90854. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90855. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90856. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90857. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90858. * @returns the RGBA texture
  90859. */
  90860. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90861. /**
  90862. * Creates a R texture from some data.
  90863. * @param data Define the texture data
  90864. * @param width Define the width of the texture
  90865. * @param height Define the height of the texture
  90866. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90867. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90868. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90869. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90870. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90871. * @returns the R texture
  90872. */
  90873. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90874. }
  90875. }
  90876. declare module BABYLON {
  90877. interface ThinEngine {
  90878. /**
  90879. * Update a dynamic index buffer
  90880. * @param indexBuffer defines the target index buffer
  90881. * @param indices defines the data to update
  90882. * @param offset defines the offset in the target index buffer where update should start
  90883. */
  90884. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  90885. /**
  90886. * Updates a dynamic vertex buffer.
  90887. * @param vertexBuffer the vertex buffer to update
  90888. * @param data the data used to update the vertex buffer
  90889. * @param byteOffset the byte offset of the data
  90890. * @param byteLength the byte length of the data
  90891. */
  90892. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  90893. }
  90894. }
  90895. declare module BABYLON {
  90896. interface AbstractScene {
  90897. /**
  90898. * The list of procedural textures added to the scene
  90899. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90900. */
  90901. proceduralTextures: Array<ProceduralTexture>;
  90902. }
  90903. /**
  90904. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  90905. * in a given scene.
  90906. */
  90907. export class ProceduralTextureSceneComponent implements ISceneComponent {
  90908. /**
  90909. * The component name helpfull to identify the component in the list of scene components.
  90910. */
  90911. readonly name: string;
  90912. /**
  90913. * The scene the component belongs to.
  90914. */
  90915. scene: Scene;
  90916. /**
  90917. * Creates a new instance of the component for the given scene
  90918. * @param scene Defines the scene to register the component in
  90919. */
  90920. constructor(scene: Scene);
  90921. /**
  90922. * Registers the component in a given scene
  90923. */
  90924. register(): void;
  90925. /**
  90926. * Rebuilds the elements related to this component in case of
  90927. * context lost for instance.
  90928. */
  90929. rebuild(): void;
  90930. /**
  90931. * Disposes the component and the associated ressources.
  90932. */
  90933. dispose(): void;
  90934. private _beforeClear;
  90935. }
  90936. }
  90937. declare module BABYLON {
  90938. interface ThinEngine {
  90939. /**
  90940. * Creates a new render target cube texture
  90941. * @param size defines the size of the texture
  90942. * @param options defines the options used to create the texture
  90943. * @returns a new render target cube texture stored in an InternalTexture
  90944. */
  90945. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  90946. }
  90947. }
  90948. declare module BABYLON {
  90949. /** @hidden */
  90950. export var proceduralVertexShader: {
  90951. name: string;
  90952. shader: string;
  90953. };
  90954. }
  90955. declare module BABYLON {
  90956. /**
  90957. * 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.
  90958. * This is the base class of any Procedural texture and contains most of the shareable code.
  90959. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90960. */
  90961. export class ProceduralTexture extends Texture {
  90962. isCube: boolean;
  90963. /**
  90964. * Define if the texture is enabled or not (disabled texture will not render)
  90965. */
  90966. isEnabled: boolean;
  90967. /**
  90968. * Define if the texture must be cleared before rendering (default is true)
  90969. */
  90970. autoClear: boolean;
  90971. /**
  90972. * Callback called when the texture is generated
  90973. */
  90974. onGenerated: () => void;
  90975. /**
  90976. * Event raised when the texture is generated
  90977. */
  90978. onGeneratedObservable: Observable<ProceduralTexture>;
  90979. /** @hidden */
  90980. _generateMipMaps: boolean;
  90981. /** @hidden **/
  90982. _effect: Effect;
  90983. /** @hidden */
  90984. _textures: {
  90985. [key: string]: Texture;
  90986. };
  90987. /** @hidden */
  90988. protected _fallbackTexture: Nullable<Texture>;
  90989. private _size;
  90990. private _currentRefreshId;
  90991. private _frameId;
  90992. private _refreshRate;
  90993. private _vertexBuffers;
  90994. private _indexBuffer;
  90995. private _uniforms;
  90996. private _samplers;
  90997. private _fragment;
  90998. private _floats;
  90999. private _ints;
  91000. private _floatsArrays;
  91001. private _colors3;
  91002. private _colors4;
  91003. private _vectors2;
  91004. private _vectors3;
  91005. private _matrices;
  91006. private _fallbackTextureUsed;
  91007. private _fullEngine;
  91008. private _cachedDefines;
  91009. private _contentUpdateId;
  91010. private _contentData;
  91011. /**
  91012. * Instantiates a new procedural texture.
  91013. * 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.
  91014. * This is the base class of any Procedural texture and contains most of the shareable code.
  91015. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91016. * @param name Define the name of the texture
  91017. * @param size Define the size of the texture to create
  91018. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91019. * @param scene Define the scene the texture belongs to
  91020. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91021. * @param generateMipMaps Define if the texture should creates mip maps or not
  91022. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91023. */
  91024. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91025. /**
  91026. * The effect that is created when initializing the post process.
  91027. * @returns The created effect corresponding the the postprocess.
  91028. */
  91029. getEffect(): Effect;
  91030. /**
  91031. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91032. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91033. */
  91034. getContent(): Nullable<ArrayBufferView>;
  91035. private _createIndexBuffer;
  91036. /** @hidden */
  91037. _rebuild(): void;
  91038. /**
  91039. * Resets the texture in order to recreate its associated resources.
  91040. * This can be called in case of context loss
  91041. */
  91042. reset(): void;
  91043. protected _getDefines(): string;
  91044. /**
  91045. * Is the texture ready to be used ? (rendered at least once)
  91046. * @returns true if ready, otherwise, false.
  91047. */
  91048. isReady(): boolean;
  91049. /**
  91050. * Resets the refresh counter of the texture and start bak from scratch.
  91051. * Could be useful to regenerate the texture if it is setup to render only once.
  91052. */
  91053. resetRefreshCounter(): void;
  91054. /**
  91055. * Set the fragment shader to use in order to render the texture.
  91056. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91057. */
  91058. setFragment(fragment: any): void;
  91059. /**
  91060. * Define the refresh rate of the texture or the rendering frequency.
  91061. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91062. */
  91063. get refreshRate(): number;
  91064. set refreshRate(value: number);
  91065. /** @hidden */
  91066. _shouldRender(): boolean;
  91067. /**
  91068. * Get the size the texture is rendering at.
  91069. * @returns the size (texture is always squared)
  91070. */
  91071. getRenderSize(): number;
  91072. /**
  91073. * Resize the texture to new value.
  91074. * @param size Define the new size the texture should have
  91075. * @param generateMipMaps Define whether the new texture should create mip maps
  91076. */
  91077. resize(size: number, generateMipMaps: boolean): void;
  91078. private _checkUniform;
  91079. /**
  91080. * Set a texture in the shader program used to render.
  91081. * @param name Define the name of the uniform samplers as defined in the shader
  91082. * @param texture Define the texture to bind to this sampler
  91083. * @return the texture itself allowing "fluent" like uniform updates
  91084. */
  91085. setTexture(name: string, texture: Texture): ProceduralTexture;
  91086. /**
  91087. * Set a float in the shader.
  91088. * @param name Define the name of the uniform as defined in the shader
  91089. * @param value Define the value to give to the uniform
  91090. * @return the texture itself allowing "fluent" like uniform updates
  91091. */
  91092. setFloat(name: string, value: number): ProceduralTexture;
  91093. /**
  91094. * Set a int in the shader.
  91095. * @param name Define the name of the uniform as defined in the shader
  91096. * @param value Define the value to give to the uniform
  91097. * @return the texture itself allowing "fluent" like uniform updates
  91098. */
  91099. setInt(name: string, value: number): ProceduralTexture;
  91100. /**
  91101. * Set an array of floats in the shader.
  91102. * @param name Define the name of the uniform as defined in the shader
  91103. * @param value Define the value to give to the uniform
  91104. * @return the texture itself allowing "fluent" like uniform updates
  91105. */
  91106. setFloats(name: string, value: number[]): ProceduralTexture;
  91107. /**
  91108. * Set a vec3 in the shader from a Color3.
  91109. * @param name Define the name of the uniform as defined in the shader
  91110. * @param value Define the value to give to the uniform
  91111. * @return the texture itself allowing "fluent" like uniform updates
  91112. */
  91113. setColor3(name: string, value: Color3): ProceduralTexture;
  91114. /**
  91115. * Set a vec4 in the shader from a Color4.
  91116. * @param name Define the name of the uniform as defined in the shader
  91117. * @param value Define the value to give to the uniform
  91118. * @return the texture itself allowing "fluent" like uniform updates
  91119. */
  91120. setColor4(name: string, value: Color4): ProceduralTexture;
  91121. /**
  91122. * Set a vec2 in the shader from a Vector2.
  91123. * @param name Define the name of the uniform as defined in the shader
  91124. * @param value Define the value to give to the uniform
  91125. * @return the texture itself allowing "fluent" like uniform updates
  91126. */
  91127. setVector2(name: string, value: Vector2): ProceduralTexture;
  91128. /**
  91129. * Set a vec3 in the shader from a Vector3.
  91130. * @param name Define the name of the uniform as defined in the shader
  91131. * @param value Define the value to give to the uniform
  91132. * @return the texture itself allowing "fluent" like uniform updates
  91133. */
  91134. setVector3(name: string, value: Vector3): ProceduralTexture;
  91135. /**
  91136. * Set a mat4 in the shader from a MAtrix.
  91137. * @param name Define the name of the uniform as defined in the shader
  91138. * @param value Define the value to give to the uniform
  91139. * @return the texture itself allowing "fluent" like uniform updates
  91140. */
  91141. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91142. /**
  91143. * Render the texture to its associated render target.
  91144. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91145. */
  91146. render(useCameraPostProcess?: boolean): void;
  91147. /**
  91148. * Clone the texture.
  91149. * @returns the cloned texture
  91150. */
  91151. clone(): ProceduralTexture;
  91152. /**
  91153. * Dispose the texture and release its asoociated resources.
  91154. */
  91155. dispose(): void;
  91156. }
  91157. }
  91158. declare module BABYLON {
  91159. /**
  91160. * This represents the base class for particle system in Babylon.
  91161. * 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.
  91162. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91163. * @example https://doc.babylonjs.com/babylon101/particles
  91164. */
  91165. export class BaseParticleSystem {
  91166. /**
  91167. * Source color is added to the destination color without alpha affecting the result
  91168. */
  91169. static BLENDMODE_ONEONE: number;
  91170. /**
  91171. * Blend current color and particle color using particle’s alpha
  91172. */
  91173. static BLENDMODE_STANDARD: number;
  91174. /**
  91175. * Add current color and particle color multiplied by particle’s alpha
  91176. */
  91177. static BLENDMODE_ADD: number;
  91178. /**
  91179. * Multiply current color with particle color
  91180. */
  91181. static BLENDMODE_MULTIPLY: number;
  91182. /**
  91183. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91184. */
  91185. static BLENDMODE_MULTIPLYADD: number;
  91186. /**
  91187. * List of animations used by the particle system.
  91188. */
  91189. animations: Animation[];
  91190. /**
  91191. * Gets or sets the unique id of the particle system
  91192. */
  91193. uniqueId: number;
  91194. /**
  91195. * The id of the Particle system.
  91196. */
  91197. id: string;
  91198. /**
  91199. * The friendly name of the Particle system.
  91200. */
  91201. name: string;
  91202. /**
  91203. * Snippet ID if the particle system was created from the snippet server
  91204. */
  91205. snippetId: string;
  91206. /**
  91207. * The rendering group used by the Particle system to chose when to render.
  91208. */
  91209. renderingGroupId: number;
  91210. /**
  91211. * The emitter represents the Mesh or position we are attaching the particle system to.
  91212. */
  91213. emitter: Nullable<AbstractMesh | Vector3>;
  91214. /**
  91215. * The maximum number of particles to emit per frame
  91216. */
  91217. emitRate: number;
  91218. /**
  91219. * If you want to launch only a few particles at once, that can be done, as well.
  91220. */
  91221. manualEmitCount: number;
  91222. /**
  91223. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91224. */
  91225. updateSpeed: number;
  91226. /**
  91227. * The amount of time the particle system is running (depends of the overall update speed).
  91228. */
  91229. targetStopDuration: number;
  91230. /**
  91231. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91232. */
  91233. disposeOnStop: boolean;
  91234. /**
  91235. * Minimum power of emitting particles.
  91236. */
  91237. minEmitPower: number;
  91238. /**
  91239. * Maximum power of emitting particles.
  91240. */
  91241. maxEmitPower: number;
  91242. /**
  91243. * Minimum life time of emitting particles.
  91244. */
  91245. minLifeTime: number;
  91246. /**
  91247. * Maximum life time of emitting particles.
  91248. */
  91249. maxLifeTime: number;
  91250. /**
  91251. * Minimum Size of emitting particles.
  91252. */
  91253. minSize: number;
  91254. /**
  91255. * Maximum Size of emitting particles.
  91256. */
  91257. maxSize: number;
  91258. /**
  91259. * Minimum scale of emitting particles on X axis.
  91260. */
  91261. minScaleX: number;
  91262. /**
  91263. * Maximum scale of emitting particles on X axis.
  91264. */
  91265. maxScaleX: number;
  91266. /**
  91267. * Minimum scale of emitting particles on Y axis.
  91268. */
  91269. minScaleY: number;
  91270. /**
  91271. * Maximum scale of emitting particles on Y axis.
  91272. */
  91273. maxScaleY: number;
  91274. /**
  91275. * Gets or sets the minimal initial rotation in radians.
  91276. */
  91277. minInitialRotation: number;
  91278. /**
  91279. * Gets or sets the maximal initial rotation in radians.
  91280. */
  91281. maxInitialRotation: number;
  91282. /**
  91283. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91284. */
  91285. minAngularSpeed: number;
  91286. /**
  91287. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91288. */
  91289. maxAngularSpeed: number;
  91290. /**
  91291. * The texture used to render each particle. (this can be a spritesheet)
  91292. */
  91293. particleTexture: Nullable<BaseTexture>;
  91294. /**
  91295. * The layer mask we are rendering the particles through.
  91296. */
  91297. layerMask: number;
  91298. /**
  91299. * This can help using your own shader to render the particle system.
  91300. * The according effect will be created
  91301. */
  91302. customShader: any;
  91303. /**
  91304. * By default particle system starts as soon as they are created. This prevents the
  91305. * automatic start to happen and let you decide when to start emitting particles.
  91306. */
  91307. preventAutoStart: boolean;
  91308. private _noiseTexture;
  91309. /**
  91310. * Gets or sets a texture used to add random noise to particle positions
  91311. */
  91312. get noiseTexture(): Nullable<ProceduralTexture>;
  91313. set noiseTexture(value: Nullable<ProceduralTexture>);
  91314. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91315. noiseStrength: Vector3;
  91316. /**
  91317. * Callback triggered when the particle animation is ending.
  91318. */
  91319. onAnimationEnd: Nullable<() => void>;
  91320. /**
  91321. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91322. */
  91323. blendMode: number;
  91324. /**
  91325. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91326. * to override the particles.
  91327. */
  91328. forceDepthWrite: boolean;
  91329. /** 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 */
  91330. preWarmCycles: number;
  91331. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91332. preWarmStepOffset: number;
  91333. /**
  91334. * 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)
  91335. */
  91336. spriteCellChangeSpeed: number;
  91337. /**
  91338. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91339. */
  91340. startSpriteCellID: number;
  91341. /**
  91342. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91343. */
  91344. endSpriteCellID: number;
  91345. /**
  91346. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91347. */
  91348. spriteCellWidth: number;
  91349. /**
  91350. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91351. */
  91352. spriteCellHeight: number;
  91353. /**
  91354. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91355. */
  91356. spriteRandomStartCell: boolean;
  91357. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91358. translationPivot: Vector2;
  91359. /** @hidden */
  91360. protected _isAnimationSheetEnabled: boolean;
  91361. /**
  91362. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91363. */
  91364. beginAnimationOnStart: boolean;
  91365. /**
  91366. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91367. */
  91368. beginAnimationFrom: number;
  91369. /**
  91370. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91371. */
  91372. beginAnimationTo: number;
  91373. /**
  91374. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91375. */
  91376. beginAnimationLoop: boolean;
  91377. /**
  91378. * Gets or sets a world offset applied to all particles
  91379. */
  91380. worldOffset: Vector3;
  91381. /**
  91382. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91383. */
  91384. get isAnimationSheetEnabled(): boolean;
  91385. set isAnimationSheetEnabled(value: boolean);
  91386. /**
  91387. * Get hosting scene
  91388. * @returns the scene
  91389. */
  91390. getScene(): Nullable<Scene>;
  91391. /**
  91392. * You can use gravity if you want to give an orientation to your particles.
  91393. */
  91394. gravity: Vector3;
  91395. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91396. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91397. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91398. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91399. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91400. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91401. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91402. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91403. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91404. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91405. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91406. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91407. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91408. /**
  91409. * Defines the delay in milliseconds before starting the system (0 by default)
  91410. */
  91411. startDelay: number;
  91412. /**
  91413. * Gets the current list of drag gradients.
  91414. * You must use addDragGradient and removeDragGradient to udpate this list
  91415. * @returns the list of drag gradients
  91416. */
  91417. getDragGradients(): Nullable<Array<FactorGradient>>;
  91418. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91419. limitVelocityDamping: number;
  91420. /**
  91421. * Gets the current list of limit velocity gradients.
  91422. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91423. * @returns the list of limit velocity gradients
  91424. */
  91425. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91426. /**
  91427. * Gets the current list of color gradients.
  91428. * You must use addColorGradient and removeColorGradient to udpate this list
  91429. * @returns the list of color gradients
  91430. */
  91431. getColorGradients(): Nullable<Array<ColorGradient>>;
  91432. /**
  91433. * Gets the current list of size gradients.
  91434. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91435. * @returns the list of size gradients
  91436. */
  91437. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91438. /**
  91439. * Gets the current list of color remap gradients.
  91440. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91441. * @returns the list of color remap gradients
  91442. */
  91443. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91444. /**
  91445. * Gets the current list of alpha remap gradients.
  91446. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91447. * @returns the list of alpha remap gradients
  91448. */
  91449. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91450. /**
  91451. * Gets the current list of life time gradients.
  91452. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91453. * @returns the list of life time gradients
  91454. */
  91455. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91456. /**
  91457. * Gets the current list of angular speed gradients.
  91458. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91459. * @returns the list of angular speed gradients
  91460. */
  91461. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91462. /**
  91463. * Gets the current list of velocity gradients.
  91464. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91465. * @returns the list of velocity gradients
  91466. */
  91467. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91468. /**
  91469. * Gets the current list of start size gradients.
  91470. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91471. * @returns the list of start size gradients
  91472. */
  91473. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91474. /**
  91475. * Gets the current list of emit rate gradients.
  91476. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91477. * @returns the list of emit rate gradients
  91478. */
  91479. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91480. /**
  91481. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91482. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91483. */
  91484. get direction1(): Vector3;
  91485. set direction1(value: Vector3);
  91486. /**
  91487. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91488. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91489. */
  91490. get direction2(): Vector3;
  91491. set direction2(value: Vector3);
  91492. /**
  91493. * 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.
  91494. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91495. */
  91496. get minEmitBox(): Vector3;
  91497. set minEmitBox(value: Vector3);
  91498. /**
  91499. * 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.
  91500. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91501. */
  91502. get maxEmitBox(): Vector3;
  91503. set maxEmitBox(value: Vector3);
  91504. /**
  91505. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91506. */
  91507. color1: Color4;
  91508. /**
  91509. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91510. */
  91511. color2: Color4;
  91512. /**
  91513. * Color the particle will have at the end of its lifetime
  91514. */
  91515. colorDead: Color4;
  91516. /**
  91517. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91518. */
  91519. textureMask: Color4;
  91520. /**
  91521. * The particle emitter type defines the emitter used by the particle system.
  91522. * It can be for example box, sphere, or cone...
  91523. */
  91524. particleEmitterType: IParticleEmitterType;
  91525. /** @hidden */
  91526. _isSubEmitter: boolean;
  91527. /**
  91528. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91529. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91530. */
  91531. billboardMode: number;
  91532. protected _isBillboardBased: boolean;
  91533. /**
  91534. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91535. */
  91536. get isBillboardBased(): boolean;
  91537. set isBillboardBased(value: boolean);
  91538. /**
  91539. * The scene the particle system belongs to.
  91540. */
  91541. protected _scene: Nullable<Scene>;
  91542. /**
  91543. * The engine the particle system belongs to.
  91544. */
  91545. protected _engine: ThinEngine;
  91546. /**
  91547. * Local cache of defines for image processing.
  91548. */
  91549. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91550. /**
  91551. * Default configuration related to image processing available in the standard Material.
  91552. */
  91553. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  91554. /**
  91555. * Gets the image processing configuration used either in this material.
  91556. */
  91557. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  91558. /**
  91559. * Sets the Default image processing configuration used either in the this material.
  91560. *
  91561. * If sets to null, the scene one is in use.
  91562. */
  91563. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  91564. /**
  91565. * Attaches a new image processing configuration to the Standard Material.
  91566. * @param configuration
  91567. */
  91568. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  91569. /** @hidden */
  91570. protected _reset(): void;
  91571. /** @hidden */
  91572. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  91573. /**
  91574. * Instantiates a particle system.
  91575. * 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.
  91576. * @param name The name of the particle system
  91577. */
  91578. constructor(name: string);
  91579. /**
  91580. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  91581. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91582. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91583. * @returns the emitter
  91584. */
  91585. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  91586. /**
  91587. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  91588. * @param radius The radius of the hemisphere to emit from
  91589. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91590. * @returns the emitter
  91591. */
  91592. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  91593. /**
  91594. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  91595. * @param radius The radius of the sphere to emit from
  91596. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91597. * @returns the emitter
  91598. */
  91599. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  91600. /**
  91601. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  91602. * @param radius The radius of the sphere to emit from
  91603. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  91604. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  91605. * @returns the emitter
  91606. */
  91607. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  91608. /**
  91609. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  91610. * @param radius The radius of the emission cylinder
  91611. * @param height The height of the emission cylinder
  91612. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  91613. * @param directionRandomizer How much to randomize the particle direction [0-1]
  91614. * @returns the emitter
  91615. */
  91616. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  91617. /**
  91618. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  91619. * @param radius The radius of the cylinder to emit from
  91620. * @param height The height of the emission cylinder
  91621. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91622. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  91623. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  91624. * @returns the emitter
  91625. */
  91626. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  91627. /**
  91628. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  91629. * @param radius The radius of the cone to emit from
  91630. * @param angle The base angle of the cone
  91631. * @returns the emitter
  91632. */
  91633. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  91634. /**
  91635. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  91636. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91637. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91638. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91639. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91640. * @returns the emitter
  91641. */
  91642. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  91643. }
  91644. }
  91645. declare module BABYLON {
  91646. /**
  91647. * Type of sub emitter
  91648. */
  91649. export enum SubEmitterType {
  91650. /**
  91651. * Attached to the particle over it's lifetime
  91652. */
  91653. ATTACHED = 0,
  91654. /**
  91655. * Created when the particle dies
  91656. */
  91657. END = 1
  91658. }
  91659. /**
  91660. * Sub emitter class used to emit particles from an existing particle
  91661. */
  91662. export class SubEmitter {
  91663. /**
  91664. * the particle system to be used by the sub emitter
  91665. */
  91666. particleSystem: ParticleSystem;
  91667. /**
  91668. * Type of the submitter (Default: END)
  91669. */
  91670. type: SubEmitterType;
  91671. /**
  91672. * 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)
  91673. * Note: This only is supported when using an emitter of type Mesh
  91674. */
  91675. inheritDirection: boolean;
  91676. /**
  91677. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  91678. */
  91679. inheritedVelocityAmount: number;
  91680. /**
  91681. * Creates a sub emitter
  91682. * @param particleSystem the particle system to be used by the sub emitter
  91683. */
  91684. constructor(
  91685. /**
  91686. * the particle system to be used by the sub emitter
  91687. */
  91688. particleSystem: ParticleSystem);
  91689. /**
  91690. * Clones the sub emitter
  91691. * @returns the cloned sub emitter
  91692. */
  91693. clone(): SubEmitter;
  91694. /**
  91695. * Serialize current object to a JSON object
  91696. * @returns the serialized object
  91697. */
  91698. serialize(): any;
  91699. /** @hidden */
  91700. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  91701. /**
  91702. * Creates a new SubEmitter from a serialized JSON version
  91703. * @param serializationObject defines the JSON object to read from
  91704. * @param sceneOrEngine defines the hosting scene or the hosting engine
  91705. * @param rootUrl defines the rootUrl for data loading
  91706. * @returns a new SubEmitter
  91707. */
  91708. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  91709. /** Release associated resources */
  91710. dispose(): void;
  91711. }
  91712. }
  91713. declare module BABYLON {
  91714. /** @hidden */
  91715. export var imageProcessingDeclaration: {
  91716. name: string;
  91717. shader: string;
  91718. };
  91719. }
  91720. declare module BABYLON {
  91721. /** @hidden */
  91722. export var imageProcessingFunctions: {
  91723. name: string;
  91724. shader: string;
  91725. };
  91726. }
  91727. declare module BABYLON {
  91728. /** @hidden */
  91729. export var particlesPixelShader: {
  91730. name: string;
  91731. shader: string;
  91732. };
  91733. }
  91734. declare module BABYLON {
  91735. /** @hidden */
  91736. export var particlesVertexShader: {
  91737. name: string;
  91738. shader: string;
  91739. };
  91740. }
  91741. declare module BABYLON {
  91742. /**
  91743. * Interface used to define entities containing multiple clip planes
  91744. */
  91745. export interface IClipPlanesHolder {
  91746. /**
  91747. * Gets or sets the active clipplane 1
  91748. */
  91749. clipPlane: Nullable<Plane>;
  91750. /**
  91751. * Gets or sets the active clipplane 2
  91752. */
  91753. clipPlane2: Nullable<Plane>;
  91754. /**
  91755. * Gets or sets the active clipplane 3
  91756. */
  91757. clipPlane3: Nullable<Plane>;
  91758. /**
  91759. * Gets or sets the active clipplane 4
  91760. */
  91761. clipPlane4: Nullable<Plane>;
  91762. /**
  91763. * Gets or sets the active clipplane 5
  91764. */
  91765. clipPlane5: Nullable<Plane>;
  91766. /**
  91767. * Gets or sets the active clipplane 6
  91768. */
  91769. clipPlane6: Nullable<Plane>;
  91770. }
  91771. }
  91772. declare module BABYLON {
  91773. /**
  91774. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  91775. *
  91776. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  91777. *
  91778. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  91779. */
  91780. export class ThinMaterialHelper {
  91781. /**
  91782. * Binds the clip plane information from the holder to the effect.
  91783. * @param effect The effect we are binding the data to
  91784. * @param holder The entity containing the clip plane information
  91785. */
  91786. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  91787. }
  91788. }
  91789. declare module BABYLON {
  91790. interface ThinEngine {
  91791. /**
  91792. * Sets alpha constants used by some alpha blending modes
  91793. * @param r defines the red component
  91794. * @param g defines the green component
  91795. * @param b defines the blue component
  91796. * @param a defines the alpha component
  91797. */
  91798. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  91799. /**
  91800. * Sets the current alpha mode
  91801. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  91802. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  91803. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  91804. */
  91805. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  91806. /**
  91807. * Gets the current alpha mode
  91808. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  91809. * @returns the current alpha mode
  91810. */
  91811. getAlphaMode(): number;
  91812. /**
  91813. * Sets the current alpha equation
  91814. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  91815. */
  91816. setAlphaEquation(equation: number): void;
  91817. /**
  91818. * Gets the current alpha equation.
  91819. * @returns the current alpha equation
  91820. */
  91821. getAlphaEquation(): number;
  91822. }
  91823. }
  91824. declare module BABYLON {
  91825. /**
  91826. * This represents a particle system in Babylon.
  91827. * 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.
  91828. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91829. * @example https://doc.babylonjs.com/babylon101/particles
  91830. */
  91831. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  91832. /**
  91833. * Billboard mode will only apply to Y axis
  91834. */
  91835. static readonly BILLBOARDMODE_Y: number;
  91836. /**
  91837. * Billboard mode will apply to all axes
  91838. */
  91839. static readonly BILLBOARDMODE_ALL: number;
  91840. /**
  91841. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  91842. */
  91843. static readonly BILLBOARDMODE_STRETCHED: number;
  91844. /**
  91845. * This function can be defined to provide custom update for active particles.
  91846. * This function will be called instead of regular update (age, position, color, etc.).
  91847. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  91848. */
  91849. updateFunction: (particles: Particle[]) => void;
  91850. private _emitterWorldMatrix;
  91851. /**
  91852. * This function can be defined to specify initial direction for every new particle.
  91853. * It by default use the emitterType defined function
  91854. */
  91855. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  91856. /**
  91857. * This function can be defined to specify initial position for every new particle.
  91858. * It by default use the emitterType defined function
  91859. */
  91860. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  91861. /**
  91862. * @hidden
  91863. */
  91864. _inheritedVelocityOffset: Vector3;
  91865. /**
  91866. * An event triggered when the system is disposed
  91867. */
  91868. onDisposeObservable: Observable<IParticleSystem>;
  91869. private _onDisposeObserver;
  91870. /**
  91871. * Sets a callback that will be triggered when the system is disposed
  91872. */
  91873. set onDispose(callback: () => void);
  91874. private _particles;
  91875. private _epsilon;
  91876. private _capacity;
  91877. private _stockParticles;
  91878. private _newPartsExcess;
  91879. private _vertexData;
  91880. private _vertexBuffer;
  91881. private _vertexBuffers;
  91882. private _spriteBuffer;
  91883. private _indexBuffer;
  91884. private _effect;
  91885. private _customEffect;
  91886. private _cachedDefines;
  91887. private _scaledColorStep;
  91888. private _colorDiff;
  91889. private _scaledDirection;
  91890. private _scaledGravity;
  91891. private _currentRenderId;
  91892. private _alive;
  91893. private _useInstancing;
  91894. private _started;
  91895. private _stopped;
  91896. private _actualFrame;
  91897. private _scaledUpdateSpeed;
  91898. private _vertexBufferSize;
  91899. /** @hidden */
  91900. _currentEmitRateGradient: Nullable<FactorGradient>;
  91901. /** @hidden */
  91902. _currentEmitRate1: number;
  91903. /** @hidden */
  91904. _currentEmitRate2: number;
  91905. /** @hidden */
  91906. _currentStartSizeGradient: Nullable<FactorGradient>;
  91907. /** @hidden */
  91908. _currentStartSize1: number;
  91909. /** @hidden */
  91910. _currentStartSize2: number;
  91911. private readonly _rawTextureWidth;
  91912. private _rampGradientsTexture;
  91913. private _useRampGradients;
  91914. /** Gets or sets a matrix to use to compute projection */
  91915. defaultProjectionMatrix: Matrix;
  91916. /** Gets or sets a matrix to use to compute view */
  91917. defaultViewMatrix: Matrix;
  91918. /** Gets or sets a boolean indicating that ramp gradients must be used
  91919. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  91920. */
  91921. get useRampGradients(): boolean;
  91922. set useRampGradients(value: boolean);
  91923. /**
  91924. * 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.
  91925. * 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: [])
  91926. */
  91927. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  91928. private _subEmitters;
  91929. /**
  91930. * @hidden
  91931. * If the particle systems emitter should be disposed when the particle system is disposed
  91932. */
  91933. _disposeEmitterOnDispose: boolean;
  91934. /**
  91935. * The current active Sub-systems, this property is used by the root particle system only.
  91936. */
  91937. activeSubSystems: Array<ParticleSystem>;
  91938. /**
  91939. * Specifies if the particles are updated in emitter local space or world space
  91940. */
  91941. isLocal: boolean;
  91942. private _rootParticleSystem;
  91943. /**
  91944. * Gets the current list of active particles
  91945. */
  91946. get particles(): Particle[];
  91947. /**
  91948. * Gets the number of particles active at the same time.
  91949. * @returns The number of active particles.
  91950. */
  91951. getActiveCount(): number;
  91952. /**
  91953. * Returns the string "ParticleSystem"
  91954. * @returns a string containing the class name
  91955. */
  91956. getClassName(): string;
  91957. /**
  91958. * Gets a boolean indicating that the system is stopping
  91959. * @returns true if the system is currently stopping
  91960. */
  91961. isStopping(): boolean;
  91962. /**
  91963. * Gets the custom effect used to render the particles
  91964. * @param blendMode Blend mode for which the effect should be retrieved
  91965. * @returns The effect
  91966. */
  91967. getCustomEffect(blendMode?: number): Nullable<Effect>;
  91968. /**
  91969. * Sets the custom effect used to render the particles
  91970. * @param effect The effect to set
  91971. * @param blendMode Blend mode for which the effect should be set
  91972. */
  91973. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  91974. /** @hidden */
  91975. private _onBeforeDrawParticlesObservable;
  91976. /**
  91977. * Observable that will be called just before the particles are drawn
  91978. */
  91979. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  91980. /**
  91981. * Gets the name of the particle vertex shader
  91982. */
  91983. get vertexShaderName(): string;
  91984. /**
  91985. * Instantiates a particle system.
  91986. * 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.
  91987. * @param name The name of the particle system
  91988. * @param capacity The max number of particles alive at the same time
  91989. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  91990. * @param customEffect a custom effect used to change the way particles are rendered by default
  91991. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  91992. * @param epsilon Offset used to render the particles
  91993. */
  91994. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  91995. private _addFactorGradient;
  91996. private _removeFactorGradient;
  91997. /**
  91998. * Adds a new life time gradient
  91999. * @param gradient defines the gradient to use (between 0 and 1)
  92000. * @param factor defines the life time factor to affect to the specified gradient
  92001. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92002. * @returns the current particle system
  92003. */
  92004. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92005. /**
  92006. * Remove a specific life time gradient
  92007. * @param gradient defines the gradient to remove
  92008. * @returns the current particle system
  92009. */
  92010. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92011. /**
  92012. * Adds a new size gradient
  92013. * @param gradient defines the gradient to use (between 0 and 1)
  92014. * @param factor defines the size factor to affect to the specified gradient
  92015. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92016. * @returns the current particle system
  92017. */
  92018. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92019. /**
  92020. * Remove a specific size gradient
  92021. * @param gradient defines the gradient to remove
  92022. * @returns the current particle system
  92023. */
  92024. removeSizeGradient(gradient: number): IParticleSystem;
  92025. /**
  92026. * Adds a new color remap gradient
  92027. * @param gradient defines the gradient to use (between 0 and 1)
  92028. * @param min defines the color remap minimal range
  92029. * @param max defines the color remap maximal range
  92030. * @returns the current particle system
  92031. */
  92032. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92033. /**
  92034. * Remove a specific color remap gradient
  92035. * @param gradient defines the gradient to remove
  92036. * @returns the current particle system
  92037. */
  92038. removeColorRemapGradient(gradient: number): IParticleSystem;
  92039. /**
  92040. * Adds a new alpha remap gradient
  92041. * @param gradient defines the gradient to use (between 0 and 1)
  92042. * @param min defines the alpha remap minimal range
  92043. * @param max defines the alpha remap maximal range
  92044. * @returns the current particle system
  92045. */
  92046. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92047. /**
  92048. * Remove a specific alpha remap gradient
  92049. * @param gradient defines the gradient to remove
  92050. * @returns the current particle system
  92051. */
  92052. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92053. /**
  92054. * Adds a new angular speed gradient
  92055. * @param gradient defines the gradient to use (between 0 and 1)
  92056. * @param factor defines the angular speed to affect to the specified gradient
  92057. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92058. * @returns the current particle system
  92059. */
  92060. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92061. /**
  92062. * Remove a specific angular speed gradient
  92063. * @param gradient defines the gradient to remove
  92064. * @returns the current particle system
  92065. */
  92066. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92067. /**
  92068. * Adds a new velocity gradient
  92069. * @param gradient defines the gradient to use (between 0 and 1)
  92070. * @param factor defines the velocity to affect to the specified gradient
  92071. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92072. * @returns the current particle system
  92073. */
  92074. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92075. /**
  92076. * Remove a specific velocity gradient
  92077. * @param gradient defines the gradient to remove
  92078. * @returns the current particle system
  92079. */
  92080. removeVelocityGradient(gradient: number): IParticleSystem;
  92081. /**
  92082. * Adds a new limit velocity gradient
  92083. * @param gradient defines the gradient to use (between 0 and 1)
  92084. * @param factor defines the limit velocity value to affect to the specified gradient
  92085. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92086. * @returns the current particle system
  92087. */
  92088. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92089. /**
  92090. * Remove a specific limit velocity gradient
  92091. * @param gradient defines the gradient to remove
  92092. * @returns the current particle system
  92093. */
  92094. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92095. /**
  92096. * Adds a new drag gradient
  92097. * @param gradient defines the gradient to use (between 0 and 1)
  92098. * @param factor defines the drag value to affect to the specified gradient
  92099. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92100. * @returns the current particle system
  92101. */
  92102. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92103. /**
  92104. * Remove a specific drag gradient
  92105. * @param gradient defines the gradient to remove
  92106. * @returns the current particle system
  92107. */
  92108. removeDragGradient(gradient: number): IParticleSystem;
  92109. /**
  92110. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92111. * @param gradient defines the gradient to use (between 0 and 1)
  92112. * @param factor defines the emit rate value to affect to the specified gradient
  92113. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92114. * @returns the current particle system
  92115. */
  92116. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92117. /**
  92118. * Remove a specific emit rate gradient
  92119. * @param gradient defines the gradient to remove
  92120. * @returns the current particle system
  92121. */
  92122. removeEmitRateGradient(gradient: number): IParticleSystem;
  92123. /**
  92124. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92125. * @param gradient defines the gradient to use (between 0 and 1)
  92126. * @param factor defines the start size value to affect to the specified gradient
  92127. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92128. * @returns the current particle system
  92129. */
  92130. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92131. /**
  92132. * Remove a specific start size gradient
  92133. * @param gradient defines the gradient to remove
  92134. * @returns the current particle system
  92135. */
  92136. removeStartSizeGradient(gradient: number): IParticleSystem;
  92137. private _createRampGradientTexture;
  92138. /**
  92139. * Gets the current list of ramp gradients.
  92140. * You must use addRampGradient and removeRampGradient to udpate this list
  92141. * @returns the list of ramp gradients
  92142. */
  92143. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92144. /** Force the system to rebuild all gradients that need to be resync */
  92145. forceRefreshGradients(): void;
  92146. private _syncRampGradientTexture;
  92147. /**
  92148. * Adds a new ramp gradient used to remap particle colors
  92149. * @param gradient defines the gradient to use (between 0 and 1)
  92150. * @param color defines the color to affect to the specified gradient
  92151. * @returns the current particle system
  92152. */
  92153. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92154. /**
  92155. * Remove a specific ramp gradient
  92156. * @param gradient defines the gradient to remove
  92157. * @returns the current particle system
  92158. */
  92159. removeRampGradient(gradient: number): ParticleSystem;
  92160. /**
  92161. * Adds a new color gradient
  92162. * @param gradient defines the gradient to use (between 0 and 1)
  92163. * @param color1 defines the color to affect to the specified gradient
  92164. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92165. * @returns this particle system
  92166. */
  92167. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92168. /**
  92169. * Remove a specific color gradient
  92170. * @param gradient defines the gradient to remove
  92171. * @returns this particle system
  92172. */
  92173. removeColorGradient(gradient: number): IParticleSystem;
  92174. private _fetchR;
  92175. protected _reset(): void;
  92176. private _resetEffect;
  92177. private _createVertexBuffers;
  92178. private _createIndexBuffer;
  92179. /**
  92180. * Gets the maximum number of particles active at the same time.
  92181. * @returns The max number of active particles.
  92182. */
  92183. getCapacity(): number;
  92184. /**
  92185. * Gets whether there are still active particles in the system.
  92186. * @returns True if it is alive, otherwise false.
  92187. */
  92188. isAlive(): boolean;
  92189. /**
  92190. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92191. * @returns True if it has been started, otherwise false.
  92192. */
  92193. isStarted(): boolean;
  92194. private _prepareSubEmitterInternalArray;
  92195. /**
  92196. * Starts the particle system and begins to emit
  92197. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92198. */
  92199. start(delay?: number): void;
  92200. /**
  92201. * Stops the particle system.
  92202. * @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.
  92203. */
  92204. stop(stopSubEmitters?: boolean): void;
  92205. /**
  92206. * Remove all active particles
  92207. */
  92208. reset(): void;
  92209. /**
  92210. * @hidden (for internal use only)
  92211. */
  92212. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92213. /**
  92214. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92215. * Its lifetime will start back at 0.
  92216. */
  92217. recycleParticle: (particle: Particle) => void;
  92218. private _stopSubEmitters;
  92219. private _createParticle;
  92220. private _removeFromRoot;
  92221. private _emitFromParticle;
  92222. private _update;
  92223. /** @hidden */
  92224. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92225. /** @hidden */
  92226. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92227. /**
  92228. * Fill the defines array according to the current settings of the particle system
  92229. * @param defines Array to be updated
  92230. * @param blendMode blend mode to take into account when updating the array
  92231. */
  92232. fillDefines(defines: Array<string>, blendMode: number): void;
  92233. /**
  92234. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92235. * @param uniforms Uniforms array to fill
  92236. * @param attributes Attributes array to fill
  92237. * @param samplers Samplers array to fill
  92238. */
  92239. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92240. /** @hidden */
  92241. private _getEffect;
  92242. /**
  92243. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92244. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92245. */
  92246. animate(preWarmOnly?: boolean): void;
  92247. private _appendParticleVertices;
  92248. /**
  92249. * Rebuilds the particle system.
  92250. */
  92251. rebuild(): void;
  92252. /**
  92253. * Is this system ready to be used/rendered
  92254. * @return true if the system is ready
  92255. */
  92256. isReady(): boolean;
  92257. private _render;
  92258. /**
  92259. * Renders the particle system in its current state.
  92260. * @returns the current number of particles
  92261. */
  92262. render(): number;
  92263. /**
  92264. * Disposes the particle system and free the associated resources
  92265. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92266. */
  92267. dispose(disposeTexture?: boolean): void;
  92268. /**
  92269. * Clones the particle system.
  92270. * @param name The name of the cloned object
  92271. * @param newEmitter The new emitter to use
  92272. * @returns the cloned particle system
  92273. */
  92274. clone(name: string, newEmitter: any): ParticleSystem;
  92275. /**
  92276. * Serializes the particle system to a JSON object
  92277. * @param serializeTexture defines if the texture must be serialized as well
  92278. * @returns the JSON object
  92279. */
  92280. serialize(serializeTexture?: boolean): any;
  92281. /** @hidden */
  92282. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92283. /** @hidden */
  92284. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92285. /**
  92286. * Parses a JSON object to create a particle system.
  92287. * @param parsedParticleSystem The JSON object to parse
  92288. * @param sceneOrEngine The scene or the engine to create the particle system in
  92289. * @param rootUrl The root url to use to load external dependencies like texture
  92290. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92291. * @returns the Parsed particle system
  92292. */
  92293. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92294. }
  92295. }
  92296. declare module BABYLON {
  92297. /**
  92298. * A particle represents one of the element emitted by a particle system.
  92299. * This is mainly define by its coordinates, direction, velocity and age.
  92300. */
  92301. export class Particle {
  92302. /**
  92303. * The particle system the particle belongs to.
  92304. */
  92305. particleSystem: ParticleSystem;
  92306. private static _Count;
  92307. /**
  92308. * Unique ID of the particle
  92309. */
  92310. id: number;
  92311. /**
  92312. * The world position of the particle in the scene.
  92313. */
  92314. position: Vector3;
  92315. /**
  92316. * The world direction of the particle in the scene.
  92317. */
  92318. direction: Vector3;
  92319. /**
  92320. * The color of the particle.
  92321. */
  92322. color: Color4;
  92323. /**
  92324. * The color change of the particle per step.
  92325. */
  92326. colorStep: Color4;
  92327. /**
  92328. * Defines how long will the life of the particle be.
  92329. */
  92330. lifeTime: number;
  92331. /**
  92332. * The current age of the particle.
  92333. */
  92334. age: number;
  92335. /**
  92336. * The current size of the particle.
  92337. */
  92338. size: number;
  92339. /**
  92340. * The current scale of the particle.
  92341. */
  92342. scale: Vector2;
  92343. /**
  92344. * The current angle of the particle.
  92345. */
  92346. angle: number;
  92347. /**
  92348. * Defines how fast is the angle changing.
  92349. */
  92350. angularSpeed: number;
  92351. /**
  92352. * Defines the cell index used by the particle to be rendered from a sprite.
  92353. */
  92354. cellIndex: number;
  92355. /**
  92356. * The information required to support color remapping
  92357. */
  92358. remapData: Vector4;
  92359. /** @hidden */
  92360. _randomCellOffset?: number;
  92361. /** @hidden */
  92362. _initialDirection: Nullable<Vector3>;
  92363. /** @hidden */
  92364. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92365. /** @hidden */
  92366. _initialStartSpriteCellID: number;
  92367. /** @hidden */
  92368. _initialEndSpriteCellID: number;
  92369. /** @hidden */
  92370. _currentColorGradient: Nullable<ColorGradient>;
  92371. /** @hidden */
  92372. _currentColor1: Color4;
  92373. /** @hidden */
  92374. _currentColor2: Color4;
  92375. /** @hidden */
  92376. _currentSizeGradient: Nullable<FactorGradient>;
  92377. /** @hidden */
  92378. _currentSize1: number;
  92379. /** @hidden */
  92380. _currentSize2: number;
  92381. /** @hidden */
  92382. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92383. /** @hidden */
  92384. _currentAngularSpeed1: number;
  92385. /** @hidden */
  92386. _currentAngularSpeed2: number;
  92387. /** @hidden */
  92388. _currentVelocityGradient: Nullable<FactorGradient>;
  92389. /** @hidden */
  92390. _currentVelocity1: number;
  92391. /** @hidden */
  92392. _currentVelocity2: number;
  92393. /** @hidden */
  92394. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92395. /** @hidden */
  92396. _currentLimitVelocity1: number;
  92397. /** @hidden */
  92398. _currentLimitVelocity2: number;
  92399. /** @hidden */
  92400. _currentDragGradient: Nullable<FactorGradient>;
  92401. /** @hidden */
  92402. _currentDrag1: number;
  92403. /** @hidden */
  92404. _currentDrag2: number;
  92405. /** @hidden */
  92406. _randomNoiseCoordinates1: Vector3;
  92407. /** @hidden */
  92408. _randomNoiseCoordinates2: Vector3;
  92409. /** @hidden */
  92410. _localPosition?: Vector3;
  92411. /**
  92412. * Creates a new instance Particle
  92413. * @param particleSystem the particle system the particle belongs to
  92414. */
  92415. constructor(
  92416. /**
  92417. * The particle system the particle belongs to.
  92418. */
  92419. particleSystem: ParticleSystem);
  92420. private updateCellInfoFromSystem;
  92421. /**
  92422. * Defines how the sprite cell index is updated for the particle
  92423. */
  92424. updateCellIndex(): void;
  92425. /** @hidden */
  92426. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92427. /** @hidden */
  92428. _inheritParticleInfoToSubEmitters(): void;
  92429. /** @hidden */
  92430. _reset(): void;
  92431. /**
  92432. * Copy the properties of particle to another one.
  92433. * @param other the particle to copy the information to.
  92434. */
  92435. copyTo(other: Particle): void;
  92436. }
  92437. }
  92438. declare module BABYLON {
  92439. /**
  92440. * Particle emitter represents a volume emitting particles.
  92441. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92442. */
  92443. export interface IParticleEmitterType {
  92444. /**
  92445. * Called by the particle System when the direction is computed for the created particle.
  92446. * @param worldMatrix is the world matrix of the particle system
  92447. * @param directionToUpdate is the direction vector to update with the result
  92448. * @param particle is the particle we are computed the direction for
  92449. * @param isLocal defines if the direction should be set in local space
  92450. */
  92451. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92452. /**
  92453. * Called by the particle System when the position is computed for the created particle.
  92454. * @param worldMatrix is the world matrix of the particle system
  92455. * @param positionToUpdate is the position vector to update with the result
  92456. * @param particle is the particle we are computed the position for
  92457. * @param isLocal defines if the position should be set in local space
  92458. */
  92459. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92460. /**
  92461. * Clones the current emitter and returns a copy of it
  92462. * @returns the new emitter
  92463. */
  92464. clone(): IParticleEmitterType;
  92465. /**
  92466. * Called by the GPUParticleSystem to setup the update shader
  92467. * @param effect defines the update shader
  92468. */
  92469. applyToShader(effect: Effect): void;
  92470. /**
  92471. * Returns a string to use to update the GPU particles update shader
  92472. * @returns the effect defines string
  92473. */
  92474. getEffectDefines(): string;
  92475. /**
  92476. * Returns a string representing the class name
  92477. * @returns a string containing the class name
  92478. */
  92479. getClassName(): string;
  92480. /**
  92481. * Serializes the particle system to a JSON object.
  92482. * @returns the JSON object
  92483. */
  92484. serialize(): any;
  92485. /**
  92486. * Parse properties from a JSON object
  92487. * @param serializationObject defines the JSON object
  92488. * @param scene defines the hosting scene
  92489. */
  92490. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92491. }
  92492. }
  92493. declare module BABYLON {
  92494. /**
  92495. * Particle emitter emitting particles from the inside of a box.
  92496. * It emits the particles randomly between 2 given directions.
  92497. */
  92498. export class BoxParticleEmitter implements IParticleEmitterType {
  92499. /**
  92500. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92501. */
  92502. direction1: Vector3;
  92503. /**
  92504. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92505. */
  92506. direction2: Vector3;
  92507. /**
  92508. * 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.
  92509. */
  92510. minEmitBox: Vector3;
  92511. /**
  92512. * 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.
  92513. */
  92514. maxEmitBox: Vector3;
  92515. /**
  92516. * Creates a new instance BoxParticleEmitter
  92517. */
  92518. constructor();
  92519. /**
  92520. * Called by the particle System when the direction is computed for the created particle.
  92521. * @param worldMatrix is the world matrix of the particle system
  92522. * @param directionToUpdate is the direction vector to update with the result
  92523. * @param particle is the particle we are computed the direction for
  92524. * @param isLocal defines if the direction should be set in local space
  92525. */
  92526. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92527. /**
  92528. * Called by the particle System when the position is computed for the created particle.
  92529. * @param worldMatrix is the world matrix of the particle system
  92530. * @param positionToUpdate is the position vector to update with the result
  92531. * @param particle is the particle we are computed the position for
  92532. * @param isLocal defines if the position should be set in local space
  92533. */
  92534. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92535. /**
  92536. * Clones the current emitter and returns a copy of it
  92537. * @returns the new emitter
  92538. */
  92539. clone(): BoxParticleEmitter;
  92540. /**
  92541. * Called by the GPUParticleSystem to setup the update shader
  92542. * @param effect defines the update shader
  92543. */
  92544. applyToShader(effect: Effect): void;
  92545. /**
  92546. * Returns a string to use to update the GPU particles update shader
  92547. * @returns a string containng the defines string
  92548. */
  92549. getEffectDefines(): string;
  92550. /**
  92551. * Returns the string "BoxParticleEmitter"
  92552. * @returns a string containing the class name
  92553. */
  92554. getClassName(): string;
  92555. /**
  92556. * Serializes the particle system to a JSON object.
  92557. * @returns the JSON object
  92558. */
  92559. serialize(): any;
  92560. /**
  92561. * Parse properties from a JSON object
  92562. * @param serializationObject defines the JSON object
  92563. */
  92564. parse(serializationObject: any): void;
  92565. }
  92566. }
  92567. declare module BABYLON {
  92568. /**
  92569. * Particle emitter emitting particles from the inside of a cone.
  92570. * It emits the particles alongside the cone volume from the base to the particle.
  92571. * The emission direction might be randomized.
  92572. */
  92573. export class ConeParticleEmitter implements IParticleEmitterType {
  92574. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92575. directionRandomizer: number;
  92576. private _radius;
  92577. private _angle;
  92578. private _height;
  92579. /**
  92580. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  92581. */
  92582. radiusRange: number;
  92583. /**
  92584. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  92585. */
  92586. heightRange: number;
  92587. /**
  92588. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  92589. */
  92590. emitFromSpawnPointOnly: boolean;
  92591. /**
  92592. * Gets or sets the radius of the emission cone
  92593. */
  92594. get radius(): number;
  92595. set radius(value: number);
  92596. /**
  92597. * Gets or sets the angle of the emission cone
  92598. */
  92599. get angle(): number;
  92600. set angle(value: number);
  92601. private _buildHeight;
  92602. /**
  92603. * Creates a new instance ConeParticleEmitter
  92604. * @param radius the radius of the emission cone (1 by default)
  92605. * @param angle the cone base angle (PI by default)
  92606. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  92607. */
  92608. constructor(radius?: number, angle?: number,
  92609. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92610. directionRandomizer?: number);
  92611. /**
  92612. * Called by the particle System when the direction is computed for the created particle.
  92613. * @param worldMatrix is the world matrix of the particle system
  92614. * @param directionToUpdate is the direction vector to update with the result
  92615. * @param particle is the particle we are computed the direction for
  92616. * @param isLocal defines if the direction should be set in local space
  92617. */
  92618. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92619. /**
  92620. * Called by the particle System when the position is computed for the created particle.
  92621. * @param worldMatrix is the world matrix of the particle system
  92622. * @param positionToUpdate is the position vector to update with the result
  92623. * @param particle is the particle we are computed the position for
  92624. * @param isLocal defines if the position should be set in local space
  92625. */
  92626. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92627. /**
  92628. * Clones the current emitter and returns a copy of it
  92629. * @returns the new emitter
  92630. */
  92631. clone(): ConeParticleEmitter;
  92632. /**
  92633. * Called by the GPUParticleSystem to setup the update shader
  92634. * @param effect defines the update shader
  92635. */
  92636. applyToShader(effect: Effect): void;
  92637. /**
  92638. * Returns a string to use to update the GPU particles update shader
  92639. * @returns a string containng the defines string
  92640. */
  92641. getEffectDefines(): string;
  92642. /**
  92643. * Returns the string "ConeParticleEmitter"
  92644. * @returns a string containing the class name
  92645. */
  92646. getClassName(): string;
  92647. /**
  92648. * Serializes the particle system to a JSON object.
  92649. * @returns the JSON object
  92650. */
  92651. serialize(): any;
  92652. /**
  92653. * Parse properties from a JSON object
  92654. * @param serializationObject defines the JSON object
  92655. */
  92656. parse(serializationObject: any): void;
  92657. }
  92658. }
  92659. declare module BABYLON {
  92660. /**
  92661. * Particle emitter emitting particles from the inside of a cylinder.
  92662. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  92663. */
  92664. export class CylinderParticleEmitter implements IParticleEmitterType {
  92665. /**
  92666. * The radius of the emission cylinder.
  92667. */
  92668. radius: number;
  92669. /**
  92670. * The height of the emission cylinder.
  92671. */
  92672. height: number;
  92673. /**
  92674. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92675. */
  92676. radiusRange: number;
  92677. /**
  92678. * How much to randomize the particle direction [0-1].
  92679. */
  92680. directionRandomizer: number;
  92681. /**
  92682. * Creates a new instance CylinderParticleEmitter
  92683. * @param radius the radius of the emission cylinder (1 by default)
  92684. * @param height the height of the emission cylinder (1 by default)
  92685. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92686. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  92687. */
  92688. constructor(
  92689. /**
  92690. * The radius of the emission cylinder.
  92691. */
  92692. radius?: number,
  92693. /**
  92694. * The height of the emission cylinder.
  92695. */
  92696. height?: number,
  92697. /**
  92698. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92699. */
  92700. radiusRange?: number,
  92701. /**
  92702. * How much to randomize the particle direction [0-1].
  92703. */
  92704. directionRandomizer?: number);
  92705. /**
  92706. * Called by the particle System when the direction is computed for the created particle.
  92707. * @param worldMatrix is the world matrix of the particle system
  92708. * @param directionToUpdate is the direction vector to update with the result
  92709. * @param particle is the particle we are computed the direction for
  92710. * @param isLocal defines if the direction should be set in local space
  92711. */
  92712. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92713. /**
  92714. * Called by the particle System when the position is computed for the created particle.
  92715. * @param worldMatrix is the world matrix of the particle system
  92716. * @param positionToUpdate is the position vector to update with the result
  92717. * @param particle is the particle we are computed the position for
  92718. * @param isLocal defines if the position should be set in local space
  92719. */
  92720. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92721. /**
  92722. * Clones the current emitter and returns a copy of it
  92723. * @returns the new emitter
  92724. */
  92725. clone(): CylinderParticleEmitter;
  92726. /**
  92727. * Called by the GPUParticleSystem to setup the update shader
  92728. * @param effect defines the update shader
  92729. */
  92730. applyToShader(effect: Effect): void;
  92731. /**
  92732. * Returns a string to use to update the GPU particles update shader
  92733. * @returns a string containng the defines string
  92734. */
  92735. getEffectDefines(): string;
  92736. /**
  92737. * Returns the string "CylinderParticleEmitter"
  92738. * @returns a string containing the class name
  92739. */
  92740. getClassName(): string;
  92741. /**
  92742. * Serializes the particle system to a JSON object.
  92743. * @returns the JSON object
  92744. */
  92745. serialize(): any;
  92746. /**
  92747. * Parse properties from a JSON object
  92748. * @param serializationObject defines the JSON object
  92749. */
  92750. parse(serializationObject: any): void;
  92751. }
  92752. /**
  92753. * Particle emitter emitting particles from the inside of a cylinder.
  92754. * It emits the particles randomly between two vectors.
  92755. */
  92756. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  92757. /**
  92758. * The min limit of the emission direction.
  92759. */
  92760. direction1: Vector3;
  92761. /**
  92762. * The max limit of the emission direction.
  92763. */
  92764. direction2: Vector3;
  92765. /**
  92766. * Creates a new instance CylinderDirectedParticleEmitter
  92767. * @param radius the radius of the emission cylinder (1 by default)
  92768. * @param height the height of the emission cylinder (1 by default)
  92769. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92770. * @param direction1 the min limit of the emission direction (up vector by default)
  92771. * @param direction2 the max limit of the emission direction (up vector by default)
  92772. */
  92773. constructor(radius?: number, height?: number, radiusRange?: number,
  92774. /**
  92775. * The min limit of the emission direction.
  92776. */
  92777. direction1?: Vector3,
  92778. /**
  92779. * The max limit of the emission direction.
  92780. */
  92781. direction2?: Vector3);
  92782. /**
  92783. * Called by the particle System when the direction is computed for the created particle.
  92784. * @param worldMatrix is the world matrix of the particle system
  92785. * @param directionToUpdate is the direction vector to update with the result
  92786. * @param particle is the particle we are computed the direction for
  92787. */
  92788. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  92789. /**
  92790. * Clones the current emitter and returns a copy of it
  92791. * @returns the new emitter
  92792. */
  92793. clone(): CylinderDirectedParticleEmitter;
  92794. /**
  92795. * Called by the GPUParticleSystem to setup the update shader
  92796. * @param effect defines the update shader
  92797. */
  92798. applyToShader(effect: Effect): void;
  92799. /**
  92800. * Returns a string to use to update the GPU particles update shader
  92801. * @returns a string containng the defines string
  92802. */
  92803. getEffectDefines(): string;
  92804. /**
  92805. * Returns the string "CylinderDirectedParticleEmitter"
  92806. * @returns a string containing the class name
  92807. */
  92808. getClassName(): string;
  92809. /**
  92810. * Serializes the particle system to a JSON object.
  92811. * @returns the JSON object
  92812. */
  92813. serialize(): any;
  92814. /**
  92815. * Parse properties from a JSON object
  92816. * @param serializationObject defines the JSON object
  92817. */
  92818. parse(serializationObject: any): void;
  92819. }
  92820. }
  92821. declare module BABYLON {
  92822. /**
  92823. * Particle emitter emitting particles from the inside of a hemisphere.
  92824. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  92825. */
  92826. export class HemisphericParticleEmitter implements IParticleEmitterType {
  92827. /**
  92828. * The radius of the emission hemisphere.
  92829. */
  92830. radius: number;
  92831. /**
  92832. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92833. */
  92834. radiusRange: number;
  92835. /**
  92836. * How much to randomize the particle direction [0-1].
  92837. */
  92838. directionRandomizer: number;
  92839. /**
  92840. * Creates a new instance HemisphericParticleEmitter
  92841. * @param radius the radius of the emission hemisphere (1 by default)
  92842. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92843. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  92844. */
  92845. constructor(
  92846. /**
  92847. * The radius of the emission hemisphere.
  92848. */
  92849. radius?: number,
  92850. /**
  92851. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92852. */
  92853. radiusRange?: number,
  92854. /**
  92855. * How much to randomize the particle direction [0-1].
  92856. */
  92857. directionRandomizer?: number);
  92858. /**
  92859. * Called by the particle System when the direction is computed for the created particle.
  92860. * @param worldMatrix is the world matrix of the particle system
  92861. * @param directionToUpdate is the direction vector to update with the result
  92862. * @param particle is the particle we are computed the direction for
  92863. * @param isLocal defines if the direction should be set in local space
  92864. */
  92865. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92866. /**
  92867. * Called by the particle System when the position is computed for the created particle.
  92868. * @param worldMatrix is the world matrix of the particle system
  92869. * @param positionToUpdate is the position vector to update with the result
  92870. * @param particle is the particle we are computed the position for
  92871. * @param isLocal defines if the position should be set in local space
  92872. */
  92873. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92874. /**
  92875. * Clones the current emitter and returns a copy of it
  92876. * @returns the new emitter
  92877. */
  92878. clone(): HemisphericParticleEmitter;
  92879. /**
  92880. * Called by the GPUParticleSystem to setup the update shader
  92881. * @param effect defines the update shader
  92882. */
  92883. applyToShader(effect: Effect): void;
  92884. /**
  92885. * Returns a string to use to update the GPU particles update shader
  92886. * @returns a string containng the defines string
  92887. */
  92888. getEffectDefines(): string;
  92889. /**
  92890. * Returns the string "HemisphericParticleEmitter"
  92891. * @returns a string containing the class name
  92892. */
  92893. getClassName(): string;
  92894. /**
  92895. * Serializes the particle system to a JSON object.
  92896. * @returns the JSON object
  92897. */
  92898. serialize(): any;
  92899. /**
  92900. * Parse properties from a JSON object
  92901. * @param serializationObject defines the JSON object
  92902. */
  92903. parse(serializationObject: any): void;
  92904. }
  92905. }
  92906. declare module BABYLON {
  92907. /**
  92908. * Particle emitter emitting particles from a point.
  92909. * It emits the particles randomly between 2 given directions.
  92910. */
  92911. export class PointParticleEmitter implements IParticleEmitterType {
  92912. /**
  92913. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92914. */
  92915. direction1: Vector3;
  92916. /**
  92917. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92918. */
  92919. direction2: Vector3;
  92920. /**
  92921. * Creates a new instance PointParticleEmitter
  92922. */
  92923. constructor();
  92924. /**
  92925. * Called by the particle System when the direction is computed for the created particle.
  92926. * @param worldMatrix is the world matrix of the particle system
  92927. * @param directionToUpdate is the direction vector to update with the result
  92928. * @param particle is the particle we are computed the direction for
  92929. * @param isLocal defines if the direction should be set in local space
  92930. */
  92931. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92932. /**
  92933. * Called by the particle System when the position is computed for the created particle.
  92934. * @param worldMatrix is the world matrix of the particle system
  92935. * @param positionToUpdate is the position vector to update with the result
  92936. * @param particle is the particle we are computed the position for
  92937. * @param isLocal defines if the position should be set in local space
  92938. */
  92939. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92940. /**
  92941. * Clones the current emitter and returns a copy of it
  92942. * @returns the new emitter
  92943. */
  92944. clone(): PointParticleEmitter;
  92945. /**
  92946. * Called by the GPUParticleSystem to setup the update shader
  92947. * @param effect defines the update shader
  92948. */
  92949. applyToShader(effect: Effect): void;
  92950. /**
  92951. * Returns a string to use to update the GPU particles update shader
  92952. * @returns a string containng the defines string
  92953. */
  92954. getEffectDefines(): string;
  92955. /**
  92956. * Returns the string "PointParticleEmitter"
  92957. * @returns a string containing the class name
  92958. */
  92959. getClassName(): string;
  92960. /**
  92961. * Serializes the particle system to a JSON object.
  92962. * @returns the JSON object
  92963. */
  92964. serialize(): any;
  92965. /**
  92966. * Parse properties from a JSON object
  92967. * @param serializationObject defines the JSON object
  92968. */
  92969. parse(serializationObject: any): void;
  92970. }
  92971. }
  92972. declare module BABYLON {
  92973. /**
  92974. * Particle emitter emitting particles from the inside of a sphere.
  92975. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  92976. */
  92977. export class SphereParticleEmitter implements IParticleEmitterType {
  92978. /**
  92979. * The radius of the emission sphere.
  92980. */
  92981. radius: number;
  92982. /**
  92983. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92984. */
  92985. radiusRange: number;
  92986. /**
  92987. * How much to randomize the particle direction [0-1].
  92988. */
  92989. directionRandomizer: number;
  92990. /**
  92991. * Creates a new instance SphereParticleEmitter
  92992. * @param radius the radius of the emission sphere (1 by default)
  92993. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92994. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  92995. */
  92996. constructor(
  92997. /**
  92998. * The radius of the emission sphere.
  92999. */
  93000. radius?: number,
  93001. /**
  93002. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93003. */
  93004. radiusRange?: number,
  93005. /**
  93006. * How much to randomize the particle direction [0-1].
  93007. */
  93008. directionRandomizer?: number);
  93009. /**
  93010. * Called by the particle System when the direction is computed for the created particle.
  93011. * @param worldMatrix is the world matrix of the particle system
  93012. * @param directionToUpdate is the direction vector to update with the result
  93013. * @param particle is the particle we are computed the direction for
  93014. * @param isLocal defines if the direction should be set in local space
  93015. */
  93016. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93017. /**
  93018. * Called by the particle System when the position is computed for the created particle.
  93019. * @param worldMatrix is the world matrix of the particle system
  93020. * @param positionToUpdate is the position vector to update with the result
  93021. * @param particle is the particle we are computed the position for
  93022. * @param isLocal defines if the position should be set in local space
  93023. */
  93024. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93025. /**
  93026. * Clones the current emitter and returns a copy of it
  93027. * @returns the new emitter
  93028. */
  93029. clone(): SphereParticleEmitter;
  93030. /**
  93031. * Called by the GPUParticleSystem to setup the update shader
  93032. * @param effect defines the update shader
  93033. */
  93034. applyToShader(effect: Effect): void;
  93035. /**
  93036. * Returns a string to use to update the GPU particles update shader
  93037. * @returns a string containng the defines string
  93038. */
  93039. getEffectDefines(): string;
  93040. /**
  93041. * Returns the string "SphereParticleEmitter"
  93042. * @returns a string containing the class name
  93043. */
  93044. getClassName(): string;
  93045. /**
  93046. * Serializes the particle system to a JSON object.
  93047. * @returns the JSON object
  93048. */
  93049. serialize(): any;
  93050. /**
  93051. * Parse properties from a JSON object
  93052. * @param serializationObject defines the JSON object
  93053. */
  93054. parse(serializationObject: any): void;
  93055. }
  93056. /**
  93057. * Particle emitter emitting particles from the inside of a sphere.
  93058. * It emits the particles randomly between two vectors.
  93059. */
  93060. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93061. /**
  93062. * The min limit of the emission direction.
  93063. */
  93064. direction1: Vector3;
  93065. /**
  93066. * The max limit of the emission direction.
  93067. */
  93068. direction2: Vector3;
  93069. /**
  93070. * Creates a new instance SphereDirectedParticleEmitter
  93071. * @param radius the radius of the emission sphere (1 by default)
  93072. * @param direction1 the min limit of the emission direction (up vector by default)
  93073. * @param direction2 the max limit of the emission direction (up vector by default)
  93074. */
  93075. constructor(radius?: number,
  93076. /**
  93077. * The min limit of the emission direction.
  93078. */
  93079. direction1?: Vector3,
  93080. /**
  93081. * The max limit of the emission direction.
  93082. */
  93083. direction2?: Vector3);
  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. */
  93090. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93091. /**
  93092. * Clones the current emitter and returns a copy of it
  93093. * @returns the new emitter
  93094. */
  93095. clone(): SphereDirectedParticleEmitter;
  93096. /**
  93097. * Called by the GPUParticleSystem to setup the update shader
  93098. * @param effect defines the update shader
  93099. */
  93100. applyToShader(effect: Effect): void;
  93101. /**
  93102. * Returns a string to use to update the GPU particles update shader
  93103. * @returns a string containng the defines string
  93104. */
  93105. getEffectDefines(): string;
  93106. /**
  93107. * Returns the string "SphereDirectedParticleEmitter"
  93108. * @returns a string containing the class name
  93109. */
  93110. getClassName(): string;
  93111. /**
  93112. * Serializes the particle system to a JSON object.
  93113. * @returns the JSON object
  93114. */
  93115. serialize(): any;
  93116. /**
  93117. * Parse properties from a JSON object
  93118. * @param serializationObject defines the JSON object
  93119. */
  93120. parse(serializationObject: any): void;
  93121. }
  93122. }
  93123. declare module BABYLON {
  93124. /**
  93125. * Particle emitter emitting particles from a custom list of positions.
  93126. */
  93127. export class CustomParticleEmitter implements IParticleEmitterType {
  93128. /**
  93129. * Gets or sets the position generator that will create the inital position of each particle.
  93130. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93131. */
  93132. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93133. /**
  93134. * Gets or sets the destination generator that will create the final destination of each particle.
  93135. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93136. */
  93137. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93138. /**
  93139. * Creates a new instance CustomParticleEmitter
  93140. */
  93141. constructor();
  93142. /**
  93143. * Called by the particle System when the direction is computed for the created particle.
  93144. * @param worldMatrix is the world matrix of the particle system
  93145. * @param directionToUpdate is the direction vector to update with the result
  93146. * @param particle is the particle we are computed the direction for
  93147. * @param isLocal defines if the direction should be set in local space
  93148. */
  93149. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93150. /**
  93151. * Called by the particle System when the position is computed for the created particle.
  93152. * @param worldMatrix is the world matrix of the particle system
  93153. * @param positionToUpdate is the position vector to update with the result
  93154. * @param particle is the particle we are computed the position for
  93155. * @param isLocal defines if the position should be set in local space
  93156. */
  93157. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93158. /**
  93159. * Clones the current emitter and returns a copy of it
  93160. * @returns the new emitter
  93161. */
  93162. clone(): CustomParticleEmitter;
  93163. /**
  93164. * Called by the GPUParticleSystem to setup the update shader
  93165. * @param effect defines the update shader
  93166. */
  93167. applyToShader(effect: Effect): void;
  93168. /**
  93169. * Returns a string to use to update the GPU particles update shader
  93170. * @returns a string containng the defines string
  93171. */
  93172. getEffectDefines(): string;
  93173. /**
  93174. * Returns the string "PointParticleEmitter"
  93175. * @returns a string containing the class name
  93176. */
  93177. getClassName(): string;
  93178. /**
  93179. * Serializes the particle system to a JSON object.
  93180. * @returns the JSON object
  93181. */
  93182. serialize(): any;
  93183. /**
  93184. * Parse properties from a JSON object
  93185. * @param serializationObject defines the JSON object
  93186. */
  93187. parse(serializationObject: any): void;
  93188. }
  93189. }
  93190. declare module BABYLON {
  93191. /**
  93192. * Particle emitter emitting particles from the inside of a box.
  93193. * It emits the particles randomly between 2 given directions.
  93194. */
  93195. export class MeshParticleEmitter implements IParticleEmitterType {
  93196. private _indices;
  93197. private _positions;
  93198. private _normals;
  93199. private _storedNormal;
  93200. private _mesh;
  93201. /**
  93202. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93203. */
  93204. direction1: Vector3;
  93205. /**
  93206. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93207. */
  93208. direction2: Vector3;
  93209. /**
  93210. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93211. */
  93212. useMeshNormalsForDirection: boolean;
  93213. /** Defines the mesh to use as source */
  93214. get mesh(): Nullable<AbstractMesh>;
  93215. set mesh(value: Nullable<AbstractMesh>);
  93216. /**
  93217. * Creates a new instance MeshParticleEmitter
  93218. * @param mesh defines the mesh to use as source
  93219. */
  93220. constructor(mesh?: Nullable<AbstractMesh>);
  93221. /**
  93222. * Called by the particle System when the direction is computed for the created particle.
  93223. * @param worldMatrix is the world matrix of the particle system
  93224. * @param directionToUpdate is the direction vector to update with the result
  93225. * @param particle is the particle we are computed the direction for
  93226. * @param isLocal defines if the direction should be set in local space
  93227. */
  93228. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93229. /**
  93230. * Called by the particle System when the position is computed for the created particle.
  93231. * @param worldMatrix is the world matrix of the particle system
  93232. * @param positionToUpdate is the position vector to update with the result
  93233. * @param particle is the particle we are computed the position for
  93234. * @param isLocal defines if the position should be set in local space
  93235. */
  93236. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93237. /**
  93238. * Clones the current emitter and returns a copy of it
  93239. * @returns the new emitter
  93240. */
  93241. clone(): MeshParticleEmitter;
  93242. /**
  93243. * Called by the GPUParticleSystem to setup the update shader
  93244. * @param effect defines the update shader
  93245. */
  93246. applyToShader(effect: Effect): void;
  93247. /**
  93248. * Returns a string to use to update the GPU particles update shader
  93249. * @returns a string containng the defines string
  93250. */
  93251. getEffectDefines(): string;
  93252. /**
  93253. * Returns the string "BoxParticleEmitter"
  93254. * @returns a string containing the class name
  93255. */
  93256. getClassName(): string;
  93257. /**
  93258. * Serializes the particle system to a JSON object.
  93259. * @returns the JSON object
  93260. */
  93261. serialize(): any;
  93262. /**
  93263. * Parse properties from a JSON object
  93264. * @param serializationObject defines the JSON object
  93265. * @param scene defines the hosting scene
  93266. */
  93267. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93268. }
  93269. }
  93270. declare module BABYLON {
  93271. /**
  93272. * Interface representing a particle system in Babylon.js.
  93273. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93274. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93275. */
  93276. export interface IParticleSystem {
  93277. /**
  93278. * List of animations used by the particle system.
  93279. */
  93280. animations: Animation[];
  93281. /**
  93282. * The id of the Particle system.
  93283. */
  93284. id: string;
  93285. /**
  93286. * The name of the Particle system.
  93287. */
  93288. name: string;
  93289. /**
  93290. * The emitter represents the Mesh or position we are attaching the particle system to.
  93291. */
  93292. emitter: Nullable<AbstractMesh | Vector3>;
  93293. /**
  93294. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93295. */
  93296. isBillboardBased: boolean;
  93297. /**
  93298. * The rendering group used by the Particle system to chose when to render.
  93299. */
  93300. renderingGroupId: number;
  93301. /**
  93302. * The layer mask we are rendering the particles through.
  93303. */
  93304. layerMask: number;
  93305. /**
  93306. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93307. */
  93308. updateSpeed: number;
  93309. /**
  93310. * The amount of time the particle system is running (depends of the overall update speed).
  93311. */
  93312. targetStopDuration: number;
  93313. /**
  93314. * The texture used to render each particle. (this can be a spritesheet)
  93315. */
  93316. particleTexture: Nullable<BaseTexture>;
  93317. /**
  93318. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93319. */
  93320. blendMode: number;
  93321. /**
  93322. * Minimum life time of emitting particles.
  93323. */
  93324. minLifeTime: number;
  93325. /**
  93326. * Maximum life time of emitting particles.
  93327. */
  93328. maxLifeTime: number;
  93329. /**
  93330. * Minimum Size of emitting particles.
  93331. */
  93332. minSize: number;
  93333. /**
  93334. * Maximum Size of emitting particles.
  93335. */
  93336. maxSize: number;
  93337. /**
  93338. * Minimum scale of emitting particles on X axis.
  93339. */
  93340. minScaleX: number;
  93341. /**
  93342. * Maximum scale of emitting particles on X axis.
  93343. */
  93344. maxScaleX: number;
  93345. /**
  93346. * Minimum scale of emitting particles on Y axis.
  93347. */
  93348. minScaleY: number;
  93349. /**
  93350. * Maximum scale of emitting particles on Y axis.
  93351. */
  93352. maxScaleY: number;
  93353. /**
  93354. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93355. */
  93356. color1: Color4;
  93357. /**
  93358. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93359. */
  93360. color2: Color4;
  93361. /**
  93362. * Color the particle will have at the end of its lifetime.
  93363. */
  93364. colorDead: Color4;
  93365. /**
  93366. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93367. */
  93368. emitRate: number;
  93369. /**
  93370. * You can use gravity if you want to give an orientation to your particles.
  93371. */
  93372. gravity: Vector3;
  93373. /**
  93374. * Minimum power of emitting particles.
  93375. */
  93376. minEmitPower: number;
  93377. /**
  93378. * Maximum power of emitting particles.
  93379. */
  93380. maxEmitPower: number;
  93381. /**
  93382. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93383. */
  93384. minAngularSpeed: number;
  93385. /**
  93386. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93387. */
  93388. maxAngularSpeed: number;
  93389. /**
  93390. * Gets or sets the minimal initial rotation in radians.
  93391. */
  93392. minInitialRotation: number;
  93393. /**
  93394. * Gets or sets the maximal initial rotation in radians.
  93395. */
  93396. maxInitialRotation: number;
  93397. /**
  93398. * The particle emitter type defines the emitter used by the particle system.
  93399. * It can be for example box, sphere, or cone...
  93400. */
  93401. particleEmitterType: Nullable<IParticleEmitterType>;
  93402. /**
  93403. * Defines the delay in milliseconds before starting the system (0 by default)
  93404. */
  93405. startDelay: number;
  93406. /**
  93407. * 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
  93408. */
  93409. preWarmCycles: number;
  93410. /**
  93411. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93412. */
  93413. preWarmStepOffset: number;
  93414. /**
  93415. * 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)
  93416. */
  93417. spriteCellChangeSpeed: number;
  93418. /**
  93419. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93420. */
  93421. startSpriteCellID: number;
  93422. /**
  93423. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93424. */
  93425. endSpriteCellID: number;
  93426. /**
  93427. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93428. */
  93429. spriteCellWidth: number;
  93430. /**
  93431. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93432. */
  93433. spriteCellHeight: number;
  93434. /**
  93435. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93436. */
  93437. spriteRandomStartCell: boolean;
  93438. /**
  93439. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93440. */
  93441. isAnimationSheetEnabled: boolean;
  93442. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93443. translationPivot: Vector2;
  93444. /**
  93445. * Gets or sets a texture used to add random noise to particle positions
  93446. */
  93447. noiseTexture: Nullable<BaseTexture>;
  93448. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93449. noiseStrength: Vector3;
  93450. /**
  93451. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93452. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93453. */
  93454. billboardMode: number;
  93455. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93456. limitVelocityDamping: number;
  93457. /**
  93458. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93459. */
  93460. beginAnimationOnStart: boolean;
  93461. /**
  93462. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93463. */
  93464. beginAnimationFrom: number;
  93465. /**
  93466. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93467. */
  93468. beginAnimationTo: number;
  93469. /**
  93470. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93471. */
  93472. beginAnimationLoop: boolean;
  93473. /**
  93474. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93475. */
  93476. disposeOnStop: boolean;
  93477. /**
  93478. * Specifies if the particles are updated in emitter local space or world space
  93479. */
  93480. isLocal: boolean;
  93481. /** Snippet ID if the particle system was created from the snippet server */
  93482. snippetId: string;
  93483. /** Gets or sets a matrix to use to compute projection */
  93484. defaultProjectionMatrix: Matrix;
  93485. /**
  93486. * Gets the maximum number of particles active at the same time.
  93487. * @returns The max number of active particles.
  93488. */
  93489. getCapacity(): number;
  93490. /**
  93491. * Gets the number of particles active at the same time.
  93492. * @returns The number of active particles.
  93493. */
  93494. getActiveCount(): number;
  93495. /**
  93496. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93497. * @returns True if it has been started, otherwise false.
  93498. */
  93499. isStarted(): boolean;
  93500. /**
  93501. * Animates the particle system for this frame.
  93502. */
  93503. animate(): void;
  93504. /**
  93505. * Renders the particle system in its current state.
  93506. * @returns the current number of particles
  93507. */
  93508. render(): number;
  93509. /**
  93510. * Dispose the particle system and frees its associated resources.
  93511. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93512. */
  93513. dispose(disposeTexture?: boolean): void;
  93514. /**
  93515. * An event triggered when the system is disposed
  93516. */
  93517. onDisposeObservable: Observable<IParticleSystem>;
  93518. /**
  93519. * Clones the particle system.
  93520. * @param name The name of the cloned object
  93521. * @param newEmitter The new emitter to use
  93522. * @returns the cloned particle system
  93523. */
  93524. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93525. /**
  93526. * Serializes the particle system to a JSON object
  93527. * @param serializeTexture defines if the texture must be serialized as well
  93528. * @returns the JSON object
  93529. */
  93530. serialize(serializeTexture: boolean): any;
  93531. /**
  93532. * Rebuild the particle system
  93533. */
  93534. rebuild(): void;
  93535. /** Force the system to rebuild all gradients that need to be resync */
  93536. forceRefreshGradients(): void;
  93537. /**
  93538. * Starts the particle system and begins to emit
  93539. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93540. */
  93541. start(delay?: number): void;
  93542. /**
  93543. * Stops the particle system.
  93544. */
  93545. stop(): void;
  93546. /**
  93547. * Remove all active particles
  93548. */
  93549. reset(): void;
  93550. /**
  93551. * Gets a boolean indicating that the system is stopping
  93552. * @returns true if the system is currently stopping
  93553. */
  93554. isStopping(): boolean;
  93555. /**
  93556. * Is this system ready to be used/rendered
  93557. * @return true if the system is ready
  93558. */
  93559. isReady(): boolean;
  93560. /**
  93561. * Returns the string "ParticleSystem"
  93562. * @returns a string containing the class name
  93563. */
  93564. getClassName(): string;
  93565. /**
  93566. * Gets the custom effect used to render the particles
  93567. * @param blendMode Blend mode for which the effect should be retrieved
  93568. * @returns The effect
  93569. */
  93570. getCustomEffect(blendMode: number): Nullable<Effect>;
  93571. /**
  93572. * Sets the custom effect used to render the particles
  93573. * @param effect The effect to set
  93574. * @param blendMode Blend mode for which the effect should be set
  93575. */
  93576. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  93577. /**
  93578. * Fill the defines array according to the current settings of the particle system
  93579. * @param defines Array to be updated
  93580. * @param blendMode blend mode to take into account when updating the array
  93581. */
  93582. fillDefines(defines: Array<string>, blendMode: number): void;
  93583. /**
  93584. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93585. * @param uniforms Uniforms array to fill
  93586. * @param attributes Attributes array to fill
  93587. * @param samplers Samplers array to fill
  93588. */
  93589. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93590. /**
  93591. * Observable that will be called just before the particles are drawn
  93592. */
  93593. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  93594. /**
  93595. * Gets the name of the particle vertex shader
  93596. */
  93597. vertexShaderName: string;
  93598. /**
  93599. * Adds a new color gradient
  93600. * @param gradient defines the gradient to use (between 0 and 1)
  93601. * @param color1 defines the color to affect to the specified gradient
  93602. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93603. * @returns the current particle system
  93604. */
  93605. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93606. /**
  93607. * Remove a specific color gradient
  93608. * @param gradient defines the gradient to remove
  93609. * @returns the current particle system
  93610. */
  93611. removeColorGradient(gradient: number): IParticleSystem;
  93612. /**
  93613. * Adds a new size gradient
  93614. * @param gradient defines the gradient to use (between 0 and 1)
  93615. * @param factor defines the size factor to affect to the specified gradient
  93616. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93617. * @returns the current particle system
  93618. */
  93619. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93620. /**
  93621. * Remove a specific size gradient
  93622. * @param gradient defines the gradient to remove
  93623. * @returns the current particle system
  93624. */
  93625. removeSizeGradient(gradient: number): IParticleSystem;
  93626. /**
  93627. * Gets the current list of color gradients.
  93628. * You must use addColorGradient and removeColorGradient to udpate this list
  93629. * @returns the list of color gradients
  93630. */
  93631. getColorGradients(): Nullable<Array<ColorGradient>>;
  93632. /**
  93633. * Gets the current list of size gradients.
  93634. * You must use addSizeGradient and removeSizeGradient to udpate this list
  93635. * @returns the list of size gradients
  93636. */
  93637. getSizeGradients(): Nullable<Array<FactorGradient>>;
  93638. /**
  93639. * Gets the current list of angular speed gradients.
  93640. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  93641. * @returns the list of angular speed gradients
  93642. */
  93643. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  93644. /**
  93645. * Adds a new angular speed gradient
  93646. * @param gradient defines the gradient to use (between 0 and 1)
  93647. * @param factor defines the angular speed to affect to the specified gradient
  93648. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93649. * @returns the current particle system
  93650. */
  93651. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93652. /**
  93653. * Remove a specific angular speed gradient
  93654. * @param gradient defines the gradient to remove
  93655. * @returns the current particle system
  93656. */
  93657. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  93658. /**
  93659. * Gets the current list of velocity gradients.
  93660. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  93661. * @returns the list of velocity gradients
  93662. */
  93663. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  93664. /**
  93665. * Adds a new velocity gradient
  93666. * @param gradient defines the gradient to use (between 0 and 1)
  93667. * @param factor defines the velocity to affect to the specified gradient
  93668. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93669. * @returns the current particle system
  93670. */
  93671. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93672. /**
  93673. * Remove a specific velocity gradient
  93674. * @param gradient defines the gradient to remove
  93675. * @returns the current particle system
  93676. */
  93677. removeVelocityGradient(gradient: number): IParticleSystem;
  93678. /**
  93679. * Gets the current list of limit velocity gradients.
  93680. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  93681. * @returns the list of limit velocity gradients
  93682. */
  93683. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  93684. /**
  93685. * Adds a new limit velocity gradient
  93686. * @param gradient defines the gradient to use (between 0 and 1)
  93687. * @param factor defines the limit velocity to affect to the specified gradient
  93688. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93689. * @returns the current particle system
  93690. */
  93691. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93692. /**
  93693. * Remove a specific limit velocity gradient
  93694. * @param gradient defines the gradient to remove
  93695. * @returns the current particle system
  93696. */
  93697. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  93698. /**
  93699. * Adds a new drag gradient
  93700. * @param gradient defines the gradient to use (between 0 and 1)
  93701. * @param factor defines the drag to affect to the specified gradient
  93702. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93703. * @returns the current particle system
  93704. */
  93705. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93706. /**
  93707. * Remove a specific drag gradient
  93708. * @param gradient defines the gradient to remove
  93709. * @returns the current particle system
  93710. */
  93711. removeDragGradient(gradient: number): IParticleSystem;
  93712. /**
  93713. * Gets the current list of drag gradients.
  93714. * You must use addDragGradient and removeDragGradient to udpate this list
  93715. * @returns the list of drag gradients
  93716. */
  93717. getDragGradients(): Nullable<Array<FactorGradient>>;
  93718. /**
  93719. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  93720. * @param gradient defines the gradient to use (between 0 and 1)
  93721. * @param factor defines the emit rate to affect to the specified gradient
  93722. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93723. * @returns the current particle system
  93724. */
  93725. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93726. /**
  93727. * Remove a specific emit rate gradient
  93728. * @param gradient defines the gradient to remove
  93729. * @returns the current particle system
  93730. */
  93731. removeEmitRateGradient(gradient: number): IParticleSystem;
  93732. /**
  93733. * Gets the current list of emit rate gradients.
  93734. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  93735. * @returns the list of emit rate gradients
  93736. */
  93737. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  93738. /**
  93739. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  93740. * @param gradient defines the gradient to use (between 0 and 1)
  93741. * @param factor defines the start size to affect to the specified gradient
  93742. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93743. * @returns the current particle system
  93744. */
  93745. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93746. /**
  93747. * Remove a specific start size gradient
  93748. * @param gradient defines the gradient to remove
  93749. * @returns the current particle system
  93750. */
  93751. removeStartSizeGradient(gradient: number): IParticleSystem;
  93752. /**
  93753. * Gets the current list of start size gradients.
  93754. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  93755. * @returns the list of start size gradients
  93756. */
  93757. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  93758. /**
  93759. * Adds a new life time gradient
  93760. * @param gradient defines the gradient to use (between 0 and 1)
  93761. * @param factor defines the life time factor to affect to the specified gradient
  93762. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93763. * @returns the current particle system
  93764. */
  93765. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93766. /**
  93767. * Remove a specific life time gradient
  93768. * @param gradient defines the gradient to remove
  93769. * @returns the current particle system
  93770. */
  93771. removeLifeTimeGradient(gradient: number): IParticleSystem;
  93772. /**
  93773. * Gets the current list of life time gradients.
  93774. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  93775. * @returns the list of life time gradients
  93776. */
  93777. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  93778. /**
  93779. * Gets the current list of color gradients.
  93780. * You must use addColorGradient and removeColorGradient to udpate this list
  93781. * @returns the list of color gradients
  93782. */
  93783. getColorGradients(): Nullable<Array<ColorGradient>>;
  93784. /**
  93785. * Adds a new ramp gradient used to remap particle colors
  93786. * @param gradient defines the gradient to use (between 0 and 1)
  93787. * @param color defines the color to affect to the specified gradient
  93788. * @returns the current particle system
  93789. */
  93790. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  93791. /**
  93792. * Gets the current list of ramp gradients.
  93793. * You must use addRampGradient and removeRampGradient to udpate this list
  93794. * @returns the list of ramp gradients
  93795. */
  93796. getRampGradients(): Nullable<Array<Color3Gradient>>;
  93797. /** Gets or sets a boolean indicating that ramp gradients must be used
  93798. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  93799. */
  93800. useRampGradients: boolean;
  93801. /**
  93802. * Adds a new color remap gradient
  93803. * @param gradient defines the gradient to use (between 0 and 1)
  93804. * @param min defines the color remap minimal range
  93805. * @param max defines the color remap maximal range
  93806. * @returns the current particle system
  93807. */
  93808. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93809. /**
  93810. * Gets the current list of color remap gradients.
  93811. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  93812. * @returns the list of color remap gradients
  93813. */
  93814. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  93815. /**
  93816. * Adds a new alpha remap gradient
  93817. * @param gradient defines the gradient to use (between 0 and 1)
  93818. * @param min defines the alpha remap minimal range
  93819. * @param max defines the alpha remap maximal range
  93820. * @returns the current particle system
  93821. */
  93822. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93823. /**
  93824. * Gets the current list of alpha remap gradients.
  93825. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  93826. * @returns the list of alpha remap gradients
  93827. */
  93828. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  93829. /**
  93830. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  93831. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  93832. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  93833. * @returns the emitter
  93834. */
  93835. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  93836. /**
  93837. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  93838. * @param radius The radius of the hemisphere to emit from
  93839. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  93840. * @returns the emitter
  93841. */
  93842. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  93843. /**
  93844. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  93845. * @param radius The radius of the sphere to emit from
  93846. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  93847. * @returns the emitter
  93848. */
  93849. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  93850. /**
  93851. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  93852. * @param radius The radius of the sphere to emit from
  93853. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  93854. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  93855. * @returns the emitter
  93856. */
  93857. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  93858. /**
  93859. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  93860. * @param radius The radius of the emission cylinder
  93861. * @param height The height of the emission cylinder
  93862. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  93863. * @param directionRandomizer How much to randomize the particle direction [0-1]
  93864. * @returns the emitter
  93865. */
  93866. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  93867. /**
  93868. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  93869. * @param radius The radius of the cylinder to emit from
  93870. * @param height The height of the emission cylinder
  93871. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93872. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  93873. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  93874. * @returns the emitter
  93875. */
  93876. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  93877. /**
  93878. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  93879. * @param radius The radius of the cone to emit from
  93880. * @param angle The base angle of the cone
  93881. * @returns the emitter
  93882. */
  93883. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  93884. /**
  93885. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  93886. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  93887. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  93888. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  93889. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  93890. * @returns the emitter
  93891. */
  93892. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  93893. /**
  93894. * Get hosting scene
  93895. * @returns the scene
  93896. */
  93897. getScene(): Nullable<Scene>;
  93898. }
  93899. }
  93900. declare module BABYLON {
  93901. /**
  93902. * 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.
  93903. * @see https://doc.babylonjs.com/how_to/transformnode
  93904. */
  93905. export class TransformNode extends Node {
  93906. /**
  93907. * Object will not rotate to face the camera
  93908. */
  93909. static BILLBOARDMODE_NONE: number;
  93910. /**
  93911. * Object will rotate to face the camera but only on the x axis
  93912. */
  93913. static BILLBOARDMODE_X: number;
  93914. /**
  93915. * Object will rotate to face the camera but only on the y axis
  93916. */
  93917. static BILLBOARDMODE_Y: number;
  93918. /**
  93919. * Object will rotate to face the camera but only on the z axis
  93920. */
  93921. static BILLBOARDMODE_Z: number;
  93922. /**
  93923. * Object will rotate to face the camera
  93924. */
  93925. static BILLBOARDMODE_ALL: number;
  93926. /**
  93927. * Object will rotate to face the camera's position instead of orientation
  93928. */
  93929. static BILLBOARDMODE_USE_POSITION: number;
  93930. private static _TmpRotation;
  93931. private static _TmpScaling;
  93932. private static _TmpTranslation;
  93933. private _forward;
  93934. private _forwardInverted;
  93935. private _up;
  93936. private _right;
  93937. private _rightInverted;
  93938. private _position;
  93939. private _rotation;
  93940. private _rotationQuaternion;
  93941. protected _scaling: Vector3;
  93942. protected _isDirty: boolean;
  93943. private _transformToBoneReferal;
  93944. private _isAbsoluteSynced;
  93945. private _billboardMode;
  93946. /**
  93947. * Gets or sets the billboard mode. Default is 0.
  93948. *
  93949. * | Value | Type | Description |
  93950. * | --- | --- | --- |
  93951. * | 0 | BILLBOARDMODE_NONE | |
  93952. * | 1 | BILLBOARDMODE_X | |
  93953. * | 2 | BILLBOARDMODE_Y | |
  93954. * | 4 | BILLBOARDMODE_Z | |
  93955. * | 7 | BILLBOARDMODE_ALL | |
  93956. *
  93957. */
  93958. get billboardMode(): number;
  93959. set billboardMode(value: number);
  93960. private _preserveParentRotationForBillboard;
  93961. /**
  93962. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  93963. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  93964. */
  93965. get preserveParentRotationForBillboard(): boolean;
  93966. set preserveParentRotationForBillboard(value: boolean);
  93967. /**
  93968. * 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
  93969. */
  93970. scalingDeterminant: number;
  93971. private _infiniteDistance;
  93972. /**
  93973. * Gets or sets the distance of the object to max, often used by skybox
  93974. */
  93975. get infiniteDistance(): boolean;
  93976. set infiniteDistance(value: boolean);
  93977. /**
  93978. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  93979. * By default the system will update normals to compensate
  93980. */
  93981. ignoreNonUniformScaling: boolean;
  93982. /**
  93983. * 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
  93984. */
  93985. reIntegrateRotationIntoRotationQuaternion: boolean;
  93986. /** @hidden */
  93987. _poseMatrix: Nullable<Matrix>;
  93988. /** @hidden */
  93989. _localMatrix: Matrix;
  93990. private _usePivotMatrix;
  93991. private _absolutePosition;
  93992. private _absoluteScaling;
  93993. private _absoluteRotationQuaternion;
  93994. private _pivotMatrix;
  93995. private _pivotMatrixInverse;
  93996. protected _postMultiplyPivotMatrix: boolean;
  93997. protected _isWorldMatrixFrozen: boolean;
  93998. /** @hidden */
  93999. _indexInSceneTransformNodesArray: number;
  94000. /**
  94001. * An event triggered after the world matrix is updated
  94002. */
  94003. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94004. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94005. /**
  94006. * Gets a string identifying the name of the class
  94007. * @returns "TransformNode" string
  94008. */
  94009. getClassName(): string;
  94010. /**
  94011. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94012. */
  94013. get position(): Vector3;
  94014. set position(newPosition: Vector3);
  94015. /**
  94016. * 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)).
  94017. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94018. */
  94019. get rotation(): Vector3;
  94020. set rotation(newRotation: Vector3);
  94021. /**
  94022. * 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)).
  94023. */
  94024. get scaling(): Vector3;
  94025. set scaling(newScaling: Vector3);
  94026. /**
  94027. * 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).
  94028. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94029. */
  94030. get rotationQuaternion(): Nullable<Quaternion>;
  94031. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94032. /**
  94033. * The forward direction of that transform in world space.
  94034. */
  94035. get forward(): Vector3;
  94036. /**
  94037. * The up direction of that transform in world space.
  94038. */
  94039. get up(): Vector3;
  94040. /**
  94041. * The right direction of that transform in world space.
  94042. */
  94043. get right(): Vector3;
  94044. /**
  94045. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94046. * @param matrix the matrix to copy the pose from
  94047. * @returns this TransformNode.
  94048. */
  94049. updatePoseMatrix(matrix: Matrix): TransformNode;
  94050. /**
  94051. * Returns the mesh Pose matrix.
  94052. * @returns the pose matrix
  94053. */
  94054. getPoseMatrix(): Matrix;
  94055. /** @hidden */
  94056. _isSynchronized(): boolean;
  94057. /** @hidden */
  94058. _initCache(): void;
  94059. /**
  94060. * Flag the transform node as dirty (Forcing it to update everything)
  94061. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94062. * @returns this transform node
  94063. */
  94064. markAsDirty(property: string): TransformNode;
  94065. /**
  94066. * Returns the current mesh absolute position.
  94067. * Returns a Vector3.
  94068. */
  94069. get absolutePosition(): Vector3;
  94070. /**
  94071. * Returns the current mesh absolute scaling.
  94072. * Returns a Vector3.
  94073. */
  94074. get absoluteScaling(): Vector3;
  94075. /**
  94076. * Returns the current mesh absolute rotation.
  94077. * Returns a Quaternion.
  94078. */
  94079. get absoluteRotationQuaternion(): Quaternion;
  94080. /**
  94081. * Sets a new matrix to apply before all other transformation
  94082. * @param matrix defines the transform matrix
  94083. * @returns the current TransformNode
  94084. */
  94085. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94086. /**
  94087. * Sets a new pivot matrix to the current node
  94088. * @param matrix defines the new pivot matrix to use
  94089. * @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
  94090. * @returns the current TransformNode
  94091. */
  94092. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94093. /**
  94094. * Returns the mesh pivot matrix.
  94095. * Default : Identity.
  94096. * @returns the matrix
  94097. */
  94098. getPivotMatrix(): Matrix;
  94099. /**
  94100. * Instantiate (when possible) or clone that node with its hierarchy
  94101. * @param newParent defines the new parent to use for the instance (or clone)
  94102. * @param options defines options to configure how copy is done
  94103. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94104. * @returns an instance (or a clone) of the current node with its hiearchy
  94105. */
  94106. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94107. doNotInstantiate: boolean;
  94108. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94109. /**
  94110. * Prevents the World matrix to be computed any longer
  94111. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94112. * @returns the TransformNode.
  94113. */
  94114. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94115. /**
  94116. * Allows back the World matrix computation.
  94117. * @returns the TransformNode.
  94118. */
  94119. unfreezeWorldMatrix(): this;
  94120. /**
  94121. * True if the World matrix has been frozen.
  94122. */
  94123. get isWorldMatrixFrozen(): boolean;
  94124. /**
  94125. * Retuns the mesh absolute position in the World.
  94126. * @returns a Vector3.
  94127. */
  94128. getAbsolutePosition(): Vector3;
  94129. /**
  94130. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94131. * @param absolutePosition the absolute position to set
  94132. * @returns the TransformNode.
  94133. */
  94134. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94135. /**
  94136. * Sets the mesh position in its local space.
  94137. * @param vector3 the position to set in localspace
  94138. * @returns the TransformNode.
  94139. */
  94140. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94141. /**
  94142. * Returns the mesh position in the local space from the current World matrix values.
  94143. * @returns a new Vector3.
  94144. */
  94145. getPositionExpressedInLocalSpace(): Vector3;
  94146. /**
  94147. * Translates the mesh along the passed Vector3 in its local space.
  94148. * @param vector3 the distance to translate in localspace
  94149. * @returns the TransformNode.
  94150. */
  94151. locallyTranslate(vector3: Vector3): TransformNode;
  94152. private static _lookAtVectorCache;
  94153. /**
  94154. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94155. * @param targetPoint the position (must be in same space as current mesh) to look at
  94156. * @param yawCor optional yaw (y-axis) correction in radians
  94157. * @param pitchCor optional pitch (x-axis) correction in radians
  94158. * @param rollCor optional roll (z-axis) correction in radians
  94159. * @param space the choosen space of the target
  94160. * @returns the TransformNode.
  94161. */
  94162. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94163. /**
  94164. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94165. * This Vector3 is expressed in the World space.
  94166. * @param localAxis axis to rotate
  94167. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94168. */
  94169. getDirection(localAxis: Vector3): Vector3;
  94170. /**
  94171. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94172. * localAxis is expressed in the mesh local space.
  94173. * result is computed in the Wordl space from the mesh World matrix.
  94174. * @param localAxis axis to rotate
  94175. * @param result the resulting transformnode
  94176. * @returns this TransformNode.
  94177. */
  94178. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94179. /**
  94180. * Sets this transform node rotation to the given local axis.
  94181. * @param localAxis the axis in local space
  94182. * @param yawCor optional yaw (y-axis) correction in radians
  94183. * @param pitchCor optional pitch (x-axis) correction in radians
  94184. * @param rollCor optional roll (z-axis) correction in radians
  94185. * @returns this TransformNode
  94186. */
  94187. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94188. /**
  94189. * Sets a new pivot point to the current node
  94190. * @param point defines the new pivot point to use
  94191. * @param space defines if the point is in world or local space (local by default)
  94192. * @returns the current TransformNode
  94193. */
  94194. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94195. /**
  94196. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94197. * @returns the pivot point
  94198. */
  94199. getPivotPoint(): Vector3;
  94200. /**
  94201. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94202. * @param result the vector3 to store the result
  94203. * @returns this TransformNode.
  94204. */
  94205. getPivotPointToRef(result: Vector3): TransformNode;
  94206. /**
  94207. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94208. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94209. */
  94210. getAbsolutePivotPoint(): Vector3;
  94211. /**
  94212. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94213. * @param result vector3 to store the result
  94214. * @returns this TransformNode.
  94215. */
  94216. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94217. /**
  94218. * Defines the passed node as the parent of the current node.
  94219. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94220. * @see https://doc.babylonjs.com/how_to/parenting
  94221. * @param node the node ot set as the parent
  94222. * @returns this TransformNode.
  94223. */
  94224. setParent(node: Nullable<Node>): TransformNode;
  94225. private _nonUniformScaling;
  94226. /**
  94227. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94228. */
  94229. get nonUniformScaling(): boolean;
  94230. /** @hidden */
  94231. _updateNonUniformScalingState(value: boolean): boolean;
  94232. /**
  94233. * Attach the current TransformNode to another TransformNode associated with a bone
  94234. * @param bone Bone affecting the TransformNode
  94235. * @param affectedTransformNode TransformNode associated with the bone
  94236. * @returns this object
  94237. */
  94238. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94239. /**
  94240. * Detach the transform node if its associated with a bone
  94241. * @returns this object
  94242. */
  94243. detachFromBone(): TransformNode;
  94244. private static _rotationAxisCache;
  94245. /**
  94246. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94247. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94248. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94249. * The passed axis is also normalized.
  94250. * @param axis the axis to rotate around
  94251. * @param amount the amount to rotate in radians
  94252. * @param space Space to rotate in (Default: local)
  94253. * @returns the TransformNode.
  94254. */
  94255. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94256. /**
  94257. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94258. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94259. * The passed axis is also normalized. .
  94260. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94261. * @param point the point to rotate around
  94262. * @param axis the axis to rotate around
  94263. * @param amount the amount to rotate in radians
  94264. * @returns the TransformNode
  94265. */
  94266. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94267. /**
  94268. * Translates the mesh along the axis vector for the passed distance in the given space.
  94269. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94270. * @param axis the axis to translate in
  94271. * @param distance the distance to translate
  94272. * @param space Space to rotate in (Default: local)
  94273. * @returns the TransformNode.
  94274. */
  94275. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94276. /**
  94277. * Adds a rotation step to the mesh current rotation.
  94278. * x, y, z are Euler angles expressed in radians.
  94279. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94280. * This means this rotation is made in the mesh local space only.
  94281. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94282. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94283. * ```javascript
  94284. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94285. * ```
  94286. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94287. * 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.
  94288. * @param x Rotation to add
  94289. * @param y Rotation to add
  94290. * @param z Rotation to add
  94291. * @returns the TransformNode.
  94292. */
  94293. addRotation(x: number, y: number, z: number): TransformNode;
  94294. /**
  94295. * @hidden
  94296. */
  94297. protected _getEffectiveParent(): Nullable<Node>;
  94298. /**
  94299. * Computes the world matrix of the node
  94300. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94301. * @returns the world matrix
  94302. */
  94303. computeWorldMatrix(force?: boolean): Matrix;
  94304. /**
  94305. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94306. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94307. */
  94308. resetLocalMatrix(independentOfChildren?: boolean): void;
  94309. protected _afterComputeWorldMatrix(): void;
  94310. /**
  94311. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94312. * @param func callback function to add
  94313. *
  94314. * @returns the TransformNode.
  94315. */
  94316. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94317. /**
  94318. * Removes a registered callback function.
  94319. * @param func callback function to remove
  94320. * @returns the TransformNode.
  94321. */
  94322. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94323. /**
  94324. * Gets the position of the current mesh in camera space
  94325. * @param camera defines the camera to use
  94326. * @returns a position
  94327. */
  94328. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94329. /**
  94330. * Returns the distance from the mesh to the active camera
  94331. * @param camera defines the camera to use
  94332. * @returns the distance
  94333. */
  94334. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94335. /**
  94336. * Clone the current transform node
  94337. * @param name Name of the new clone
  94338. * @param newParent New parent for the clone
  94339. * @param doNotCloneChildren Do not clone children hierarchy
  94340. * @returns the new transform node
  94341. */
  94342. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94343. /**
  94344. * Serializes the objects information.
  94345. * @param currentSerializationObject defines the object to serialize in
  94346. * @returns the serialized object
  94347. */
  94348. serialize(currentSerializationObject?: any): any;
  94349. /**
  94350. * Returns a new TransformNode object parsed from the source provided.
  94351. * @param parsedTransformNode is the source.
  94352. * @param scene the scne the object belongs to
  94353. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94354. * @returns a new TransformNode object parsed from the source provided.
  94355. */
  94356. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94357. /**
  94358. * Get all child-transformNodes of this node
  94359. * @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
  94360. * @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
  94361. * @returns an array of TransformNode
  94362. */
  94363. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94364. /**
  94365. * Releases resources associated with this transform node.
  94366. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94367. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94368. */
  94369. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94370. /**
  94371. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94372. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94373. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94374. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94375. * @returns the current mesh
  94376. */
  94377. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94378. private _syncAbsoluteScalingAndRotation;
  94379. }
  94380. }
  94381. declare module BABYLON {
  94382. /**
  94383. * Class used to override all child animations of a given target
  94384. */
  94385. export class AnimationPropertiesOverride {
  94386. /**
  94387. * Gets or sets a value indicating if animation blending must be used
  94388. */
  94389. enableBlending: boolean;
  94390. /**
  94391. * Gets or sets the blending speed to use when enableBlending is true
  94392. */
  94393. blendingSpeed: number;
  94394. /**
  94395. * Gets or sets the default loop mode to use
  94396. */
  94397. loopMode: number;
  94398. }
  94399. }
  94400. declare module BABYLON {
  94401. /**
  94402. * Class used to store bone information
  94403. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94404. */
  94405. export class Bone extends Node {
  94406. /**
  94407. * defines the bone name
  94408. */
  94409. name: string;
  94410. private static _tmpVecs;
  94411. private static _tmpQuat;
  94412. private static _tmpMats;
  94413. /**
  94414. * Gets the list of child bones
  94415. */
  94416. children: Bone[];
  94417. /** Gets the animations associated with this bone */
  94418. animations: Animation[];
  94419. /**
  94420. * Gets or sets bone length
  94421. */
  94422. length: number;
  94423. /**
  94424. * @hidden Internal only
  94425. * Set this value to map this bone to a different index in the transform matrices
  94426. * Set this value to -1 to exclude the bone from the transform matrices
  94427. */
  94428. _index: Nullable<number>;
  94429. private _skeleton;
  94430. private _localMatrix;
  94431. private _restPose;
  94432. private _bindPose;
  94433. private _baseMatrix;
  94434. private _absoluteTransform;
  94435. private _invertedAbsoluteTransform;
  94436. private _parent;
  94437. private _scalingDeterminant;
  94438. private _worldTransform;
  94439. private _localScaling;
  94440. private _localRotation;
  94441. private _localPosition;
  94442. private _needToDecompose;
  94443. private _needToCompose;
  94444. /** @hidden */
  94445. _linkedTransformNode: Nullable<TransformNode>;
  94446. /** @hidden */
  94447. _waitingTransformNodeId: Nullable<string>;
  94448. /** @hidden */
  94449. get _matrix(): Matrix;
  94450. /** @hidden */
  94451. set _matrix(value: Matrix);
  94452. /**
  94453. * Create a new bone
  94454. * @param name defines the bone name
  94455. * @param skeleton defines the parent skeleton
  94456. * @param parentBone defines the parent (can be null if the bone is the root)
  94457. * @param localMatrix defines the local matrix
  94458. * @param restPose defines the rest pose matrix
  94459. * @param baseMatrix defines the base matrix
  94460. * @param index defines index of the bone in the hiearchy
  94461. */
  94462. constructor(
  94463. /**
  94464. * defines the bone name
  94465. */
  94466. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94467. /**
  94468. * Gets the current object class name.
  94469. * @return the class name
  94470. */
  94471. getClassName(): string;
  94472. /**
  94473. * Gets the parent skeleton
  94474. * @returns a skeleton
  94475. */
  94476. getSkeleton(): Skeleton;
  94477. /**
  94478. * Gets parent bone
  94479. * @returns a bone or null if the bone is the root of the bone hierarchy
  94480. */
  94481. getParent(): Nullable<Bone>;
  94482. /**
  94483. * Returns an array containing the root bones
  94484. * @returns an array containing the root bones
  94485. */
  94486. getChildren(): Array<Bone>;
  94487. /**
  94488. * Gets the node index in matrix array generated for rendering
  94489. * @returns the node index
  94490. */
  94491. getIndex(): number;
  94492. /**
  94493. * Sets the parent bone
  94494. * @param parent defines the parent (can be null if the bone is the root)
  94495. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94496. */
  94497. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94498. /**
  94499. * Gets the local matrix
  94500. * @returns a matrix
  94501. */
  94502. getLocalMatrix(): Matrix;
  94503. /**
  94504. * Gets the base matrix (initial matrix which remains unchanged)
  94505. * @returns a matrix
  94506. */
  94507. getBaseMatrix(): Matrix;
  94508. /**
  94509. * Gets the rest pose matrix
  94510. * @returns a matrix
  94511. */
  94512. getRestPose(): Matrix;
  94513. /**
  94514. * Sets the rest pose matrix
  94515. * @param matrix the local-space rest pose to set for this bone
  94516. */
  94517. setRestPose(matrix: Matrix): void;
  94518. /**
  94519. * Gets the bind pose matrix
  94520. * @returns the bind pose matrix
  94521. */
  94522. getBindPose(): Matrix;
  94523. /**
  94524. * Sets the bind pose matrix
  94525. * @param matrix the local-space bind pose to set for this bone
  94526. */
  94527. setBindPose(matrix: Matrix): void;
  94528. /**
  94529. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94530. */
  94531. getWorldMatrix(): Matrix;
  94532. /**
  94533. * Sets the local matrix to rest pose matrix
  94534. */
  94535. returnToRest(): void;
  94536. /**
  94537. * Gets the inverse of the absolute transform matrix.
  94538. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94539. * @returns a matrix
  94540. */
  94541. getInvertedAbsoluteTransform(): Matrix;
  94542. /**
  94543. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94544. * @returns a matrix
  94545. */
  94546. getAbsoluteTransform(): Matrix;
  94547. /**
  94548. * Links with the given transform node.
  94549. * The local matrix of this bone is copied from the transform node every frame.
  94550. * @param transformNode defines the transform node to link to
  94551. */
  94552. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  94553. /**
  94554. * Gets the node used to drive the bone's transformation
  94555. * @returns a transform node or null
  94556. */
  94557. getTransformNode(): Nullable<TransformNode>;
  94558. /** Gets or sets current position (in local space) */
  94559. get position(): Vector3;
  94560. set position(newPosition: Vector3);
  94561. /** Gets or sets current rotation (in local space) */
  94562. get rotation(): Vector3;
  94563. set rotation(newRotation: Vector3);
  94564. /** Gets or sets current rotation quaternion (in local space) */
  94565. get rotationQuaternion(): Quaternion;
  94566. set rotationQuaternion(newRotation: Quaternion);
  94567. /** Gets or sets current scaling (in local space) */
  94568. get scaling(): Vector3;
  94569. set scaling(newScaling: Vector3);
  94570. /**
  94571. * Gets the animation properties override
  94572. */
  94573. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94574. private _decompose;
  94575. private _compose;
  94576. /**
  94577. * Update the base and local matrices
  94578. * @param matrix defines the new base or local matrix
  94579. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94580. * @param updateLocalMatrix defines if the local matrix should be updated
  94581. */
  94582. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  94583. /** @hidden */
  94584. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  94585. /**
  94586. * Flag the bone as dirty (Forcing it to update everything)
  94587. */
  94588. markAsDirty(): void;
  94589. /** @hidden */
  94590. _markAsDirtyAndCompose(): void;
  94591. private _markAsDirtyAndDecompose;
  94592. /**
  94593. * Translate the bone in local or world space
  94594. * @param vec The amount to translate the bone
  94595. * @param space The space that the translation is in
  94596. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94597. */
  94598. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94599. /**
  94600. * Set the postion of the bone in local or world space
  94601. * @param position The position to set the bone
  94602. * @param space The space that the position is in
  94603. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94604. */
  94605. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94606. /**
  94607. * Set the absolute position of the bone (world space)
  94608. * @param position The position to set the bone
  94609. * @param mesh The mesh that this bone is attached to
  94610. */
  94611. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  94612. /**
  94613. * Scale the bone on the x, y and z axes (in local space)
  94614. * @param x The amount to scale the bone on the x axis
  94615. * @param y The amount to scale the bone on the y axis
  94616. * @param z The amount to scale the bone on the z axis
  94617. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  94618. */
  94619. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  94620. /**
  94621. * Set the bone scaling in local space
  94622. * @param scale defines the scaling vector
  94623. */
  94624. setScale(scale: Vector3): void;
  94625. /**
  94626. * Gets the current scaling in local space
  94627. * @returns the current scaling vector
  94628. */
  94629. getScale(): Vector3;
  94630. /**
  94631. * Gets the current scaling in local space and stores it in a target vector
  94632. * @param result defines the target vector
  94633. */
  94634. getScaleToRef(result: Vector3): void;
  94635. /**
  94636. * Set the yaw, pitch, and roll of the bone in local or world space
  94637. * @param yaw The rotation of the bone on the y axis
  94638. * @param pitch The rotation of the bone on the x axis
  94639. * @param roll The rotation of the bone on the z axis
  94640. * @param space The space that the axes of rotation are in
  94641. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94642. */
  94643. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  94644. /**
  94645. * Add a rotation to the bone on an axis in local or world space
  94646. * @param axis The axis to rotate the bone on
  94647. * @param amount The amount to rotate the bone
  94648. * @param space The space that the axis is in
  94649. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94650. */
  94651. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  94652. /**
  94653. * Set the rotation of the bone to a particular axis angle in local or world space
  94654. * @param axis The axis to rotate the bone on
  94655. * @param angle The angle that the bone should be rotated to
  94656. * @param space The space that the axis is in
  94657. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94658. */
  94659. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  94660. /**
  94661. * Set the euler rotation of the bone in local of world space
  94662. * @param rotation The euler rotation that the bone should be set to
  94663. * @param space The space that the rotation is in
  94664. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94665. */
  94666. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94667. /**
  94668. * Set the quaternion rotation of the bone in local of world space
  94669. * @param quat The quaternion rotation that the bone should be set to
  94670. * @param space The space that the rotation is in
  94671. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94672. */
  94673. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  94674. /**
  94675. * Set the rotation matrix of the bone in local of world space
  94676. * @param rotMat The rotation matrix that the bone should be set to
  94677. * @param space The space that the rotation is in
  94678. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94679. */
  94680. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  94681. private _rotateWithMatrix;
  94682. private _getNegativeRotationToRef;
  94683. /**
  94684. * Get the position of the bone in local or world space
  94685. * @param space The space that the returned position is in
  94686. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94687. * @returns The position of the bone
  94688. */
  94689. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  94690. /**
  94691. * Copy the position of the bone to a vector3 in local or world space
  94692. * @param space The space that the returned position is in
  94693. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94694. * @param result The vector3 to copy the position to
  94695. */
  94696. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  94697. /**
  94698. * Get the absolute position of the bone (world space)
  94699. * @param mesh The mesh that this bone is attached to
  94700. * @returns The absolute position of the bone
  94701. */
  94702. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  94703. /**
  94704. * Copy the absolute position of the bone (world space) to the result param
  94705. * @param mesh The mesh that this bone is attached to
  94706. * @param result The vector3 to copy the absolute position to
  94707. */
  94708. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  94709. /**
  94710. * Compute the absolute transforms of this bone and its children
  94711. */
  94712. computeAbsoluteTransforms(): void;
  94713. /**
  94714. * Get the world direction from an axis that is in the local space of the bone
  94715. * @param localAxis The local direction that is used to compute the world direction
  94716. * @param mesh The mesh that this bone is attached to
  94717. * @returns The world direction
  94718. */
  94719. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  94720. /**
  94721. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  94722. * @param localAxis The local direction that is used to compute the world direction
  94723. * @param mesh The mesh that this bone is attached to
  94724. * @param result The vector3 that the world direction will be copied to
  94725. */
  94726. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94727. /**
  94728. * Get the euler rotation of the bone in local or world space
  94729. * @param space The space that the rotation should be in
  94730. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94731. * @returns The euler rotation
  94732. */
  94733. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  94734. /**
  94735. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  94736. * @param space The space that the rotation should be in
  94737. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94738. * @param result The vector3 that the rotation should be copied to
  94739. */
  94740. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94741. /**
  94742. * Get the quaternion rotation of the bone in either local or world space
  94743. * @param space The space that the rotation should be in
  94744. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94745. * @returns The quaternion rotation
  94746. */
  94747. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  94748. /**
  94749. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  94750. * @param space The space that the rotation should be in
  94751. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94752. * @param result The quaternion that the rotation should be copied to
  94753. */
  94754. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  94755. /**
  94756. * Get the rotation matrix of the bone in local or world space
  94757. * @param space The space that the rotation should be in
  94758. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94759. * @returns The rotation matrix
  94760. */
  94761. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  94762. /**
  94763. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  94764. * @param space The space that the rotation should be in
  94765. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94766. * @param result The quaternion that the rotation should be copied to
  94767. */
  94768. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  94769. /**
  94770. * Get the world position of a point that is in the local space of the bone
  94771. * @param position The local position
  94772. * @param mesh The mesh that this bone is attached to
  94773. * @returns The world position
  94774. */
  94775. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  94776. /**
  94777. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  94778. * @param position The local position
  94779. * @param mesh The mesh that this bone is attached to
  94780. * @param result The vector3 that the world position should be copied to
  94781. */
  94782. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94783. /**
  94784. * Get the local position of a point that is in world space
  94785. * @param position The world position
  94786. * @param mesh The mesh that this bone is attached to
  94787. * @returns The local position
  94788. */
  94789. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  94790. /**
  94791. * Get the local position of a point that is in world space and copy it to the result param
  94792. * @param position The world position
  94793. * @param mesh The mesh that this bone is attached to
  94794. * @param result The vector3 that the local position should be copied to
  94795. */
  94796. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94797. }
  94798. }
  94799. declare module BABYLON {
  94800. /**
  94801. * Defines a runtime animation
  94802. */
  94803. export class RuntimeAnimation {
  94804. private _events;
  94805. /**
  94806. * The current frame of the runtime animation
  94807. */
  94808. private _currentFrame;
  94809. /**
  94810. * The animation used by the runtime animation
  94811. */
  94812. private _animation;
  94813. /**
  94814. * The target of the runtime animation
  94815. */
  94816. private _target;
  94817. /**
  94818. * The initiating animatable
  94819. */
  94820. private _host;
  94821. /**
  94822. * The original value of the runtime animation
  94823. */
  94824. private _originalValue;
  94825. /**
  94826. * The original blend value of the runtime animation
  94827. */
  94828. private _originalBlendValue;
  94829. /**
  94830. * The offsets cache of the runtime animation
  94831. */
  94832. private _offsetsCache;
  94833. /**
  94834. * The high limits cache of the runtime animation
  94835. */
  94836. private _highLimitsCache;
  94837. /**
  94838. * Specifies if the runtime animation has been stopped
  94839. */
  94840. private _stopped;
  94841. /**
  94842. * The blending factor of the runtime animation
  94843. */
  94844. private _blendingFactor;
  94845. /**
  94846. * The BabylonJS scene
  94847. */
  94848. private _scene;
  94849. /**
  94850. * The current value of the runtime animation
  94851. */
  94852. private _currentValue;
  94853. /** @hidden */
  94854. _animationState: _IAnimationState;
  94855. /**
  94856. * The active target of the runtime animation
  94857. */
  94858. private _activeTargets;
  94859. private _currentActiveTarget;
  94860. private _directTarget;
  94861. /**
  94862. * The target path of the runtime animation
  94863. */
  94864. private _targetPath;
  94865. /**
  94866. * The weight of the runtime animation
  94867. */
  94868. private _weight;
  94869. /**
  94870. * The ratio offset of the runtime animation
  94871. */
  94872. private _ratioOffset;
  94873. /**
  94874. * The previous delay of the runtime animation
  94875. */
  94876. private _previousDelay;
  94877. /**
  94878. * The previous ratio of the runtime animation
  94879. */
  94880. private _previousRatio;
  94881. private _enableBlending;
  94882. private _keys;
  94883. private _minFrame;
  94884. private _maxFrame;
  94885. private _minValue;
  94886. private _maxValue;
  94887. private _targetIsArray;
  94888. /**
  94889. * Gets the current frame of the runtime animation
  94890. */
  94891. get currentFrame(): number;
  94892. /**
  94893. * Gets the weight of the runtime animation
  94894. */
  94895. get weight(): number;
  94896. /**
  94897. * Gets the current value of the runtime animation
  94898. */
  94899. get currentValue(): any;
  94900. /**
  94901. * Gets the target path of the runtime animation
  94902. */
  94903. get targetPath(): string;
  94904. /**
  94905. * Gets the actual target of the runtime animation
  94906. */
  94907. get target(): any;
  94908. /**
  94909. * Gets the additive state of the runtime animation
  94910. */
  94911. get isAdditive(): boolean;
  94912. /** @hidden */
  94913. _onLoop: () => void;
  94914. /**
  94915. * Create a new RuntimeAnimation object
  94916. * @param target defines the target of the animation
  94917. * @param animation defines the source animation object
  94918. * @param scene defines the hosting scene
  94919. * @param host defines the initiating Animatable
  94920. */
  94921. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  94922. private _preparePath;
  94923. /**
  94924. * Gets the animation from the runtime animation
  94925. */
  94926. get animation(): Animation;
  94927. /**
  94928. * Resets the runtime animation to the beginning
  94929. * @param restoreOriginal defines whether to restore the target property to the original value
  94930. */
  94931. reset(restoreOriginal?: boolean): void;
  94932. /**
  94933. * Specifies if the runtime animation is stopped
  94934. * @returns Boolean specifying if the runtime animation is stopped
  94935. */
  94936. isStopped(): boolean;
  94937. /**
  94938. * Disposes of the runtime animation
  94939. */
  94940. dispose(): void;
  94941. /**
  94942. * Apply the interpolated value to the target
  94943. * @param currentValue defines the value computed by the animation
  94944. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  94945. */
  94946. setValue(currentValue: any, weight: number): void;
  94947. private _getOriginalValues;
  94948. private _setValue;
  94949. /**
  94950. * Gets the loop pmode of the runtime animation
  94951. * @returns Loop Mode
  94952. */
  94953. private _getCorrectLoopMode;
  94954. /**
  94955. * Move the current animation to a given frame
  94956. * @param frame defines the frame to move to
  94957. */
  94958. goToFrame(frame: number): void;
  94959. /**
  94960. * @hidden Internal use only
  94961. */
  94962. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  94963. /**
  94964. * Execute the current animation
  94965. * @param delay defines the delay to add to the current frame
  94966. * @param from defines the lower bound of the animation range
  94967. * @param to defines the upper bound of the animation range
  94968. * @param loop defines if the current animation must loop
  94969. * @param speedRatio defines the current speed ratio
  94970. * @param weight defines the weight of the animation (default is -1 so no weight)
  94971. * @param onLoop optional callback called when animation loops
  94972. * @returns a boolean indicating if the animation is running
  94973. */
  94974. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  94975. }
  94976. }
  94977. declare module BABYLON {
  94978. /**
  94979. * Class used to store an actual running animation
  94980. */
  94981. export class Animatable {
  94982. /** defines the target object */
  94983. target: any;
  94984. /** defines the starting frame number (default is 0) */
  94985. fromFrame: number;
  94986. /** defines the ending frame number (default is 100) */
  94987. toFrame: number;
  94988. /** defines if the animation must loop (default is false) */
  94989. loopAnimation: boolean;
  94990. /** defines a callback to call when animation ends if it is not looping */
  94991. onAnimationEnd?: (() => void) | null | undefined;
  94992. /** defines a callback to call when animation loops */
  94993. onAnimationLoop?: (() => void) | null | undefined;
  94994. /** defines whether the animation should be evaluated additively */
  94995. isAdditive: boolean;
  94996. private _localDelayOffset;
  94997. private _pausedDelay;
  94998. private _runtimeAnimations;
  94999. private _paused;
  95000. private _scene;
  95001. private _speedRatio;
  95002. private _weight;
  95003. private _syncRoot;
  95004. /**
  95005. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95006. * This will only apply for non looping animation (default is true)
  95007. */
  95008. disposeOnEnd: boolean;
  95009. /**
  95010. * Gets a boolean indicating if the animation has started
  95011. */
  95012. animationStarted: boolean;
  95013. /**
  95014. * Observer raised when the animation ends
  95015. */
  95016. onAnimationEndObservable: Observable<Animatable>;
  95017. /**
  95018. * Observer raised when the animation loops
  95019. */
  95020. onAnimationLoopObservable: Observable<Animatable>;
  95021. /**
  95022. * Gets the root Animatable used to synchronize and normalize animations
  95023. */
  95024. get syncRoot(): Nullable<Animatable>;
  95025. /**
  95026. * Gets the current frame of the first RuntimeAnimation
  95027. * Used to synchronize Animatables
  95028. */
  95029. get masterFrame(): number;
  95030. /**
  95031. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95032. */
  95033. get weight(): number;
  95034. set weight(value: number);
  95035. /**
  95036. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95037. */
  95038. get speedRatio(): number;
  95039. set speedRatio(value: number);
  95040. /**
  95041. * Creates a new Animatable
  95042. * @param scene defines the hosting scene
  95043. * @param target defines the target object
  95044. * @param fromFrame defines the starting frame number (default is 0)
  95045. * @param toFrame defines the ending frame number (default is 100)
  95046. * @param loopAnimation defines if the animation must loop (default is false)
  95047. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95048. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95049. * @param animations defines a group of animation to add to the new Animatable
  95050. * @param onAnimationLoop defines a callback to call when animation loops
  95051. * @param isAdditive defines whether the animation should be evaluated additively
  95052. */
  95053. constructor(scene: Scene,
  95054. /** defines the target object */
  95055. target: any,
  95056. /** defines the starting frame number (default is 0) */
  95057. fromFrame?: number,
  95058. /** defines the ending frame number (default is 100) */
  95059. toFrame?: number,
  95060. /** defines if the animation must loop (default is false) */
  95061. loopAnimation?: boolean, speedRatio?: number,
  95062. /** defines a callback to call when animation ends if it is not looping */
  95063. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95064. /** defines a callback to call when animation loops */
  95065. onAnimationLoop?: (() => void) | null | undefined,
  95066. /** defines whether the animation should be evaluated additively */
  95067. isAdditive?: boolean);
  95068. /**
  95069. * Synchronize and normalize current Animatable with a source Animatable
  95070. * This is useful when using animation weights and when animations are not of the same length
  95071. * @param root defines the root Animatable to synchronize with
  95072. * @returns the current Animatable
  95073. */
  95074. syncWith(root: Animatable): Animatable;
  95075. /**
  95076. * Gets the list of runtime animations
  95077. * @returns an array of RuntimeAnimation
  95078. */
  95079. getAnimations(): RuntimeAnimation[];
  95080. /**
  95081. * Adds more animations to the current animatable
  95082. * @param target defines the target of the animations
  95083. * @param animations defines the new animations to add
  95084. */
  95085. appendAnimations(target: any, animations: Animation[]): void;
  95086. /**
  95087. * Gets the source animation for a specific property
  95088. * @param property defines the propertyu to look for
  95089. * @returns null or the source animation for the given property
  95090. */
  95091. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95092. /**
  95093. * Gets the runtime animation for a specific property
  95094. * @param property defines the propertyu to look for
  95095. * @returns null or the runtime animation for the given property
  95096. */
  95097. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95098. /**
  95099. * Resets the animatable to its original state
  95100. */
  95101. reset(): void;
  95102. /**
  95103. * Allows the animatable to blend with current running animations
  95104. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95105. * @param blendingSpeed defines the blending speed to use
  95106. */
  95107. enableBlending(blendingSpeed: number): void;
  95108. /**
  95109. * Disable animation blending
  95110. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95111. */
  95112. disableBlending(): void;
  95113. /**
  95114. * Jump directly to a given frame
  95115. * @param frame defines the frame to jump to
  95116. */
  95117. goToFrame(frame: number): void;
  95118. /**
  95119. * Pause the animation
  95120. */
  95121. pause(): void;
  95122. /**
  95123. * Restart the animation
  95124. */
  95125. restart(): void;
  95126. private _raiseOnAnimationEnd;
  95127. /**
  95128. * Stop and delete the current animation
  95129. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95130. * @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)
  95131. */
  95132. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95133. /**
  95134. * Wait asynchronously for the animation to end
  95135. * @returns a promise which will be fullfilled when the animation ends
  95136. */
  95137. waitAsync(): Promise<Animatable>;
  95138. /** @hidden */
  95139. _animate(delay: number): boolean;
  95140. }
  95141. interface Scene {
  95142. /** @hidden */
  95143. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95144. /** @hidden */
  95145. _processLateAnimationBindingsForMatrices(holder: {
  95146. totalWeight: number;
  95147. totalAdditiveWeight: number;
  95148. animations: RuntimeAnimation[];
  95149. additiveAnimations: RuntimeAnimation[];
  95150. originalValue: Matrix;
  95151. }): any;
  95152. /** @hidden */
  95153. _processLateAnimationBindingsForQuaternions(holder: {
  95154. totalWeight: number;
  95155. totalAdditiveWeight: number;
  95156. animations: RuntimeAnimation[];
  95157. additiveAnimations: RuntimeAnimation[];
  95158. originalValue: Quaternion;
  95159. }, refQuaternion: Quaternion): Quaternion;
  95160. /** @hidden */
  95161. _processLateAnimationBindings(): void;
  95162. /**
  95163. * Will start the animation sequence of a given target
  95164. * @param target defines the target
  95165. * @param from defines from which frame should animation start
  95166. * @param to defines until which frame should animation run.
  95167. * @param weight defines the weight to apply to the animation (1.0 by default)
  95168. * @param loop defines if the animation loops
  95169. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95170. * @param onAnimationEnd defines the function to be executed when the animation ends
  95171. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95172. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95173. * @param onAnimationLoop defines the callback to call when an animation loops
  95174. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95175. * @returns the animatable object created for this animation
  95176. */
  95177. 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;
  95178. /**
  95179. * Will start the animation sequence of a given target
  95180. * @param target defines the target
  95181. * @param from defines from which frame should animation start
  95182. * @param to defines until which frame should animation run.
  95183. * @param loop defines if the animation loops
  95184. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95185. * @param onAnimationEnd defines the function to be executed when the animation ends
  95186. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95187. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95188. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95189. * @param onAnimationLoop defines the callback to call when an animation loops
  95190. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95191. * @returns the animatable object created for this animation
  95192. */
  95193. 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;
  95194. /**
  95195. * Will start the animation sequence of a given target and its hierarchy
  95196. * @param target defines the target
  95197. * @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.
  95198. * @param from defines from which frame should animation start
  95199. * @param to defines until which frame should animation run.
  95200. * @param loop defines if the animation loops
  95201. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95202. * @param onAnimationEnd defines the function to be executed when the animation ends
  95203. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95204. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95205. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95206. * @param onAnimationLoop defines the callback to call when an animation loops
  95207. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95208. * @returns the list of created animatables
  95209. */
  95210. 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[];
  95211. /**
  95212. * Begin a new animation on a given node
  95213. * @param target defines the target where the animation will take place
  95214. * @param animations defines the list of animations to start
  95215. * @param from defines the initial value
  95216. * @param to defines the final value
  95217. * @param loop defines if you want animation to loop (off by default)
  95218. * @param speedRatio defines the speed ratio to apply to all animations
  95219. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95220. * @param onAnimationLoop defines the callback to call when an animation loops
  95221. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95222. * @returns the list of created animatables
  95223. */
  95224. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95225. /**
  95226. * Begin a new animation on a given node and its hierarchy
  95227. * @param target defines the root node where the animation will take place
  95228. * @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.
  95229. * @param animations defines the list of animations to start
  95230. * @param from defines the initial value
  95231. * @param to defines the final value
  95232. * @param loop defines if you want animation to loop (off by default)
  95233. * @param speedRatio defines the speed ratio to apply to all animations
  95234. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95235. * @param onAnimationLoop defines the callback to call when an animation loops
  95236. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95237. * @returns the list of animatables created for all nodes
  95238. */
  95239. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95240. /**
  95241. * Gets the animatable associated with a specific target
  95242. * @param target defines the target of the animatable
  95243. * @returns the required animatable if found
  95244. */
  95245. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95246. /**
  95247. * Gets all animatables associated with a given target
  95248. * @param target defines the target to look animatables for
  95249. * @returns an array of Animatables
  95250. */
  95251. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95252. /**
  95253. * Stops and removes all animations that have been applied to the scene
  95254. */
  95255. stopAllAnimations(): void;
  95256. /**
  95257. * Gets the current delta time used by animation engine
  95258. */
  95259. deltaTime: number;
  95260. }
  95261. interface Bone {
  95262. /**
  95263. * Copy an animation range from another bone
  95264. * @param source defines the source bone
  95265. * @param rangeName defines the range name to copy
  95266. * @param frameOffset defines the frame offset
  95267. * @param rescaleAsRequired defines if rescaling must be applied if required
  95268. * @param skelDimensionsRatio defines the scaling ratio
  95269. * @returns true if operation was successful
  95270. */
  95271. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95272. }
  95273. }
  95274. declare module BABYLON {
  95275. /**
  95276. * Class used to handle skinning animations
  95277. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95278. */
  95279. export class Skeleton implements IAnimatable {
  95280. /** defines the skeleton name */
  95281. name: string;
  95282. /** defines the skeleton Id */
  95283. id: string;
  95284. /**
  95285. * Defines the list of child bones
  95286. */
  95287. bones: Bone[];
  95288. /**
  95289. * Defines an estimate of the dimension of the skeleton at rest
  95290. */
  95291. dimensionsAtRest: Vector3;
  95292. /**
  95293. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95294. */
  95295. needInitialSkinMatrix: boolean;
  95296. /**
  95297. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95298. */
  95299. overrideMesh: Nullable<AbstractMesh>;
  95300. /**
  95301. * Gets the list of animations attached to this skeleton
  95302. */
  95303. animations: Array<Animation>;
  95304. private _scene;
  95305. private _isDirty;
  95306. private _transformMatrices;
  95307. private _transformMatrixTexture;
  95308. private _meshesWithPoseMatrix;
  95309. private _animatables;
  95310. private _identity;
  95311. private _synchronizedWithMesh;
  95312. private _ranges;
  95313. private _lastAbsoluteTransformsUpdateId;
  95314. private _canUseTextureForBones;
  95315. private _uniqueId;
  95316. /** @hidden */
  95317. _numBonesWithLinkedTransformNode: number;
  95318. /** @hidden */
  95319. _hasWaitingData: Nullable<boolean>;
  95320. /**
  95321. * Specifies if the skeleton should be serialized
  95322. */
  95323. doNotSerialize: boolean;
  95324. private _useTextureToStoreBoneMatrices;
  95325. /**
  95326. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95327. * Please note that this option is not available if the hardware does not support it
  95328. */
  95329. get useTextureToStoreBoneMatrices(): boolean;
  95330. set useTextureToStoreBoneMatrices(value: boolean);
  95331. private _animationPropertiesOverride;
  95332. /**
  95333. * Gets or sets the animation properties override
  95334. */
  95335. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95336. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95337. /**
  95338. * List of inspectable custom properties (used by the Inspector)
  95339. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95340. */
  95341. inspectableCustomProperties: IInspectable[];
  95342. /**
  95343. * An observable triggered before computing the skeleton's matrices
  95344. */
  95345. onBeforeComputeObservable: Observable<Skeleton>;
  95346. /**
  95347. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95348. */
  95349. get isUsingTextureForMatrices(): boolean;
  95350. /**
  95351. * Gets the unique ID of this skeleton
  95352. */
  95353. get uniqueId(): number;
  95354. /**
  95355. * Creates a new skeleton
  95356. * @param name defines the skeleton name
  95357. * @param id defines the skeleton Id
  95358. * @param scene defines the hosting scene
  95359. */
  95360. constructor(
  95361. /** defines the skeleton name */
  95362. name: string,
  95363. /** defines the skeleton Id */
  95364. id: string, scene: Scene);
  95365. /**
  95366. * Gets the current object class name.
  95367. * @return the class name
  95368. */
  95369. getClassName(): string;
  95370. /**
  95371. * Returns an array containing the root bones
  95372. * @returns an array containing the root bones
  95373. */
  95374. getChildren(): Array<Bone>;
  95375. /**
  95376. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95377. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95378. * @returns a Float32Array containing matrices data
  95379. */
  95380. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95381. /**
  95382. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95383. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95384. * @returns a raw texture containing the data
  95385. */
  95386. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95387. /**
  95388. * Gets the current hosting scene
  95389. * @returns a scene object
  95390. */
  95391. getScene(): Scene;
  95392. /**
  95393. * Gets a string representing the current skeleton data
  95394. * @param fullDetails defines a boolean indicating if we want a verbose version
  95395. * @returns a string representing the current skeleton data
  95396. */
  95397. toString(fullDetails?: boolean): string;
  95398. /**
  95399. * Get bone's index searching by name
  95400. * @param name defines bone's name to search for
  95401. * @return the indice of the bone. Returns -1 if not found
  95402. */
  95403. getBoneIndexByName(name: string): number;
  95404. /**
  95405. * Creater a new animation range
  95406. * @param name defines the name of the range
  95407. * @param from defines the start key
  95408. * @param to defines the end key
  95409. */
  95410. createAnimationRange(name: string, from: number, to: number): void;
  95411. /**
  95412. * Delete a specific animation range
  95413. * @param name defines the name of the range
  95414. * @param deleteFrames defines if frames must be removed as well
  95415. */
  95416. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95417. /**
  95418. * Gets a specific animation range
  95419. * @param name defines the name of the range to look for
  95420. * @returns the requested animation range or null if not found
  95421. */
  95422. getAnimationRange(name: string): Nullable<AnimationRange>;
  95423. /**
  95424. * Gets the list of all animation ranges defined on this skeleton
  95425. * @returns an array
  95426. */
  95427. getAnimationRanges(): Nullable<AnimationRange>[];
  95428. /**
  95429. * Copy animation range from a source skeleton.
  95430. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95431. * @param source defines the source skeleton
  95432. * @param name defines the name of the range to copy
  95433. * @param rescaleAsRequired defines if rescaling must be applied if required
  95434. * @returns true if operation was successful
  95435. */
  95436. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95437. /**
  95438. * Forces the skeleton to go to rest pose
  95439. */
  95440. returnToRest(): void;
  95441. private _getHighestAnimationFrame;
  95442. /**
  95443. * Begin a specific animation range
  95444. * @param name defines the name of the range to start
  95445. * @param loop defines if looping must be turned on (false by default)
  95446. * @param speedRatio defines the speed ratio to apply (1 by default)
  95447. * @param onAnimationEnd defines a callback which will be called when animation will end
  95448. * @returns a new animatable
  95449. */
  95450. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95451. /**
  95452. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95453. * @param skeleton defines the Skeleton containing the animation range to convert
  95454. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95455. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95456. * @returns the original skeleton
  95457. */
  95458. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95459. /** @hidden */
  95460. _markAsDirty(): void;
  95461. /** @hidden */
  95462. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95463. /** @hidden */
  95464. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95465. private _computeTransformMatrices;
  95466. /**
  95467. * Build all resources required to render a skeleton
  95468. */
  95469. prepare(): void;
  95470. /**
  95471. * Gets the list of animatables currently running for this skeleton
  95472. * @returns an array of animatables
  95473. */
  95474. getAnimatables(): IAnimatable[];
  95475. /**
  95476. * Clone the current skeleton
  95477. * @param name defines the name of the new skeleton
  95478. * @param id defines the id of the new skeleton
  95479. * @returns the new skeleton
  95480. */
  95481. clone(name: string, id?: string): Skeleton;
  95482. /**
  95483. * Enable animation blending for this skeleton
  95484. * @param blendingSpeed defines the blending speed to apply
  95485. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95486. */
  95487. enableBlending(blendingSpeed?: number): void;
  95488. /**
  95489. * Releases all resources associated with the current skeleton
  95490. */
  95491. dispose(): void;
  95492. /**
  95493. * Serialize the skeleton in a JSON object
  95494. * @returns a JSON object
  95495. */
  95496. serialize(): any;
  95497. /**
  95498. * Creates a new skeleton from serialized data
  95499. * @param parsedSkeleton defines the serialized data
  95500. * @param scene defines the hosting scene
  95501. * @returns a new skeleton
  95502. */
  95503. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95504. /**
  95505. * Compute all node absolute transforms
  95506. * @param forceUpdate defines if computation must be done even if cache is up to date
  95507. */
  95508. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95509. /**
  95510. * Gets the root pose matrix
  95511. * @returns a matrix
  95512. */
  95513. getPoseMatrix(): Nullable<Matrix>;
  95514. /**
  95515. * Sorts bones per internal index
  95516. */
  95517. sortBones(): void;
  95518. private _sortBones;
  95519. }
  95520. }
  95521. declare module BABYLON {
  95522. /**
  95523. * Creates an instance based on a source mesh.
  95524. */
  95525. export class InstancedMesh extends AbstractMesh {
  95526. private _sourceMesh;
  95527. private _currentLOD;
  95528. /** @hidden */
  95529. _indexInSourceMeshInstanceArray: number;
  95530. constructor(name: string, source: Mesh);
  95531. /**
  95532. * Returns the string "InstancedMesh".
  95533. */
  95534. getClassName(): string;
  95535. /** Gets the list of lights affecting that mesh */
  95536. get lightSources(): Light[];
  95537. _resyncLightSources(): void;
  95538. _resyncLightSource(light: Light): void;
  95539. _removeLightSource(light: Light, dispose: boolean): void;
  95540. /**
  95541. * If the source mesh receives shadows
  95542. */
  95543. get receiveShadows(): boolean;
  95544. /**
  95545. * The material of the source mesh
  95546. */
  95547. get material(): Nullable<Material>;
  95548. /**
  95549. * Visibility of the source mesh
  95550. */
  95551. get visibility(): number;
  95552. /**
  95553. * Skeleton of the source mesh
  95554. */
  95555. get skeleton(): Nullable<Skeleton>;
  95556. /**
  95557. * Rendering ground id of the source mesh
  95558. */
  95559. get renderingGroupId(): number;
  95560. set renderingGroupId(value: number);
  95561. /**
  95562. * Returns the total number of vertices (integer).
  95563. */
  95564. getTotalVertices(): number;
  95565. /**
  95566. * Returns a positive integer : the total number of indices in this mesh geometry.
  95567. * @returns the numner of indices or zero if the mesh has no geometry.
  95568. */
  95569. getTotalIndices(): number;
  95570. /**
  95571. * The source mesh of the instance
  95572. */
  95573. get sourceMesh(): Mesh;
  95574. /**
  95575. * Creates a new InstancedMesh object from the mesh model.
  95576. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95577. * @param name defines the name of the new instance
  95578. * @returns a new InstancedMesh
  95579. */
  95580. createInstance(name: string): InstancedMesh;
  95581. /**
  95582. * Is this node ready to be used/rendered
  95583. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95584. * @return {boolean} is it ready
  95585. */
  95586. isReady(completeCheck?: boolean): boolean;
  95587. /**
  95588. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  95589. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  95590. * @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.
  95591. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  95592. */
  95593. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  95594. /**
  95595. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95596. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95597. * The `data` are either a numeric array either a Float32Array.
  95598. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  95599. * 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).
  95600. * Note that a new underlying VertexBuffer object is created each call.
  95601. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95602. *
  95603. * Possible `kind` values :
  95604. * - VertexBuffer.PositionKind
  95605. * - VertexBuffer.UVKind
  95606. * - VertexBuffer.UV2Kind
  95607. * - VertexBuffer.UV3Kind
  95608. * - VertexBuffer.UV4Kind
  95609. * - VertexBuffer.UV5Kind
  95610. * - VertexBuffer.UV6Kind
  95611. * - VertexBuffer.ColorKind
  95612. * - VertexBuffer.MatricesIndicesKind
  95613. * - VertexBuffer.MatricesIndicesExtraKind
  95614. * - VertexBuffer.MatricesWeightsKind
  95615. * - VertexBuffer.MatricesWeightsExtraKind
  95616. *
  95617. * Returns the Mesh.
  95618. */
  95619. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95620. /**
  95621. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95622. * If the mesh has no geometry, it is simply returned as it is.
  95623. * The `data` are either a numeric array either a Float32Array.
  95624. * No new underlying VertexBuffer object is created.
  95625. * 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.
  95626. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  95627. *
  95628. * Possible `kind` values :
  95629. * - VertexBuffer.PositionKind
  95630. * - VertexBuffer.UVKind
  95631. * - VertexBuffer.UV2Kind
  95632. * - VertexBuffer.UV3Kind
  95633. * - VertexBuffer.UV4Kind
  95634. * - VertexBuffer.UV5Kind
  95635. * - VertexBuffer.UV6Kind
  95636. * - VertexBuffer.ColorKind
  95637. * - VertexBuffer.MatricesIndicesKind
  95638. * - VertexBuffer.MatricesIndicesExtraKind
  95639. * - VertexBuffer.MatricesWeightsKind
  95640. * - VertexBuffer.MatricesWeightsExtraKind
  95641. *
  95642. * Returns the Mesh.
  95643. */
  95644. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  95645. /**
  95646. * Sets the mesh indices.
  95647. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  95648. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  95649. * This method creates a new index buffer each call.
  95650. * Returns the Mesh.
  95651. */
  95652. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  95653. /**
  95654. * Boolean : True if the mesh owns the requested kind of data.
  95655. */
  95656. isVerticesDataPresent(kind: string): boolean;
  95657. /**
  95658. * Returns an array of indices (IndicesArray).
  95659. */
  95660. getIndices(): Nullable<IndicesArray>;
  95661. get _positions(): Nullable<Vector3[]>;
  95662. /**
  95663. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  95664. * This means the mesh underlying bounding box and sphere are recomputed.
  95665. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  95666. * @returns the current mesh
  95667. */
  95668. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  95669. /** @hidden */
  95670. _preActivate(): InstancedMesh;
  95671. /** @hidden */
  95672. _activate(renderId: number, intermediateRendering: boolean): boolean;
  95673. /** @hidden */
  95674. _postActivate(): void;
  95675. getWorldMatrix(): Matrix;
  95676. get isAnInstance(): boolean;
  95677. /**
  95678. * Returns the current associated LOD AbstractMesh.
  95679. */
  95680. getLOD(camera: Camera): AbstractMesh;
  95681. /** @hidden */
  95682. _preActivateForIntermediateRendering(renderId: number): Mesh;
  95683. /** @hidden */
  95684. _syncSubMeshes(): InstancedMesh;
  95685. /** @hidden */
  95686. _generatePointsArray(): boolean;
  95687. /** @hidden */
  95688. _updateBoundingInfo(): AbstractMesh;
  95689. /**
  95690. * Creates a new InstancedMesh from the current mesh.
  95691. * - name (string) : the cloned mesh name
  95692. * - newParent (optional Node) : the optional Node to parent the clone to.
  95693. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  95694. *
  95695. * Returns the clone.
  95696. */
  95697. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  95698. /**
  95699. * Disposes the InstancedMesh.
  95700. * Returns nothing.
  95701. */
  95702. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95703. }
  95704. interface Mesh {
  95705. /**
  95706. * Register a custom buffer that will be instanced
  95707. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  95708. * @param kind defines the buffer kind
  95709. * @param stride defines the stride in floats
  95710. */
  95711. registerInstancedBuffer(kind: string, stride: number): void;
  95712. /**
  95713. * true to use the edge renderer for all instances of this mesh
  95714. */
  95715. edgesShareWithInstances: boolean;
  95716. /** @hidden */
  95717. _userInstancedBuffersStorage: {
  95718. data: {
  95719. [key: string]: Float32Array;
  95720. };
  95721. sizes: {
  95722. [key: string]: number;
  95723. };
  95724. vertexBuffers: {
  95725. [key: string]: Nullable<VertexBuffer>;
  95726. };
  95727. strides: {
  95728. [key: string]: number;
  95729. };
  95730. };
  95731. }
  95732. interface AbstractMesh {
  95733. /**
  95734. * Object used to store instanced buffers defined by user
  95735. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  95736. */
  95737. instancedBuffers: {
  95738. [key: string]: any;
  95739. };
  95740. }
  95741. }
  95742. declare module BABYLON {
  95743. /**
  95744. * Defines the options associated with the creation of a shader material.
  95745. */
  95746. export interface IShaderMaterialOptions {
  95747. /**
  95748. * Does the material work in alpha blend mode
  95749. */
  95750. needAlphaBlending: boolean;
  95751. /**
  95752. * Does the material work in alpha test mode
  95753. */
  95754. needAlphaTesting: boolean;
  95755. /**
  95756. * The list of attribute names used in the shader
  95757. */
  95758. attributes: string[];
  95759. /**
  95760. * The list of unifrom names used in the shader
  95761. */
  95762. uniforms: string[];
  95763. /**
  95764. * The list of UBO names used in the shader
  95765. */
  95766. uniformBuffers: string[];
  95767. /**
  95768. * The list of sampler names used in the shader
  95769. */
  95770. samplers: string[];
  95771. /**
  95772. * The list of defines used in the shader
  95773. */
  95774. defines: string[];
  95775. }
  95776. /**
  95777. * 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.
  95778. *
  95779. * This returned material effects how the mesh will look based on the code in the shaders.
  95780. *
  95781. * @see https://doc.babylonjs.com/how_to/shader_material
  95782. */
  95783. export class ShaderMaterial extends Material {
  95784. private _shaderPath;
  95785. private _options;
  95786. private _textures;
  95787. private _textureArrays;
  95788. private _floats;
  95789. private _ints;
  95790. private _floatsArrays;
  95791. private _colors3;
  95792. private _colors3Arrays;
  95793. private _colors4;
  95794. private _colors4Arrays;
  95795. private _vectors2;
  95796. private _vectors3;
  95797. private _vectors4;
  95798. private _matrices;
  95799. private _matrixArrays;
  95800. private _matrices3x3;
  95801. private _matrices2x2;
  95802. private _vectors2Arrays;
  95803. private _vectors3Arrays;
  95804. private _vectors4Arrays;
  95805. private _cachedWorldViewMatrix;
  95806. private _cachedWorldViewProjectionMatrix;
  95807. private _renderId;
  95808. private _multiview;
  95809. private _cachedDefines;
  95810. /** Define the Url to load snippets */
  95811. static SnippetUrl: string;
  95812. /** Snippet ID if the material was created from the snippet server */
  95813. snippetId: string;
  95814. /**
  95815. * Instantiate a new shader material.
  95816. * 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.
  95817. * This returned material effects how the mesh will look based on the code in the shaders.
  95818. * @see https://doc.babylonjs.com/how_to/shader_material
  95819. * @param name Define the name of the material in the scene
  95820. * @param scene Define the scene the material belongs to
  95821. * @param shaderPath Defines the route to the shader code in one of three ways:
  95822. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  95823. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  95824. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  95825. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  95826. * @param options Define the options used to create the shader
  95827. */
  95828. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  95829. /**
  95830. * Gets the shader path used to define the shader code
  95831. * It can be modified to trigger a new compilation
  95832. */
  95833. get shaderPath(): any;
  95834. /**
  95835. * Sets the shader path used to define the shader code
  95836. * It can be modified to trigger a new compilation
  95837. */
  95838. set shaderPath(shaderPath: any);
  95839. /**
  95840. * Gets the options used to compile the shader.
  95841. * They can be modified to trigger a new compilation
  95842. */
  95843. get options(): IShaderMaterialOptions;
  95844. /**
  95845. * Gets the current class name of the material e.g. "ShaderMaterial"
  95846. * Mainly use in serialization.
  95847. * @returns the class name
  95848. */
  95849. getClassName(): string;
  95850. /**
  95851. * Specifies if the material will require alpha blending
  95852. * @returns a boolean specifying if alpha blending is needed
  95853. */
  95854. needAlphaBlending(): boolean;
  95855. /**
  95856. * Specifies if this material should be rendered in alpha test mode
  95857. * @returns a boolean specifying if an alpha test is needed.
  95858. */
  95859. needAlphaTesting(): boolean;
  95860. private _checkUniform;
  95861. /**
  95862. * Set a texture in the shader.
  95863. * @param name Define the name of the uniform samplers as defined in the shader
  95864. * @param texture Define the texture to bind to this sampler
  95865. * @return the material itself allowing "fluent" like uniform updates
  95866. */
  95867. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  95868. /**
  95869. * Set a texture array in the shader.
  95870. * @param name Define the name of the uniform sampler array as defined in the shader
  95871. * @param textures Define the list of textures to bind to this sampler
  95872. * @return the material itself allowing "fluent" like uniform updates
  95873. */
  95874. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  95875. /**
  95876. * Set a float in the shader.
  95877. * @param name Define the name of the uniform as defined in the shader
  95878. * @param value Define the value to give to the uniform
  95879. * @return the material itself allowing "fluent" like uniform updates
  95880. */
  95881. setFloat(name: string, value: number): ShaderMaterial;
  95882. /**
  95883. * Set a int in the shader.
  95884. * @param name Define the name of the uniform as defined in the shader
  95885. * @param value Define the value to give to the uniform
  95886. * @return the material itself allowing "fluent" like uniform updates
  95887. */
  95888. setInt(name: string, value: number): ShaderMaterial;
  95889. /**
  95890. * Set an array of floats in the shader.
  95891. * @param name Define the name of the uniform as defined in the shader
  95892. * @param value Define the value to give to the uniform
  95893. * @return the material itself allowing "fluent" like uniform updates
  95894. */
  95895. setFloats(name: string, value: number[]): ShaderMaterial;
  95896. /**
  95897. * Set a vec3 in the shader from a Color3.
  95898. * @param name Define the name of the uniform as defined in the shader
  95899. * @param value Define the value to give to the uniform
  95900. * @return the material itself allowing "fluent" like uniform updates
  95901. */
  95902. setColor3(name: string, value: Color3): ShaderMaterial;
  95903. /**
  95904. * Set a vec3 array in the shader from a Color3 array.
  95905. * @param name Define the name of the uniform as defined in the shader
  95906. * @param value Define the value to give to the uniform
  95907. * @return the material itself allowing "fluent" like uniform updates
  95908. */
  95909. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  95910. /**
  95911. * Set a vec4 in the shader from a Color4.
  95912. * @param name Define the name of the uniform as defined in the shader
  95913. * @param value Define the value to give to the uniform
  95914. * @return the material itself allowing "fluent" like uniform updates
  95915. */
  95916. setColor4(name: string, value: Color4): ShaderMaterial;
  95917. /**
  95918. * Set a vec4 array in the shader from a Color4 array.
  95919. * @param name Define the name of the uniform as defined in the shader
  95920. * @param value Define the value to give to the uniform
  95921. * @return the material itself allowing "fluent" like uniform updates
  95922. */
  95923. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  95924. /**
  95925. * Set a vec2 in the shader from a Vector2.
  95926. * @param name Define the name of the uniform as defined in the shader
  95927. * @param value Define the value to give to the uniform
  95928. * @return the material itself allowing "fluent" like uniform updates
  95929. */
  95930. setVector2(name: string, value: Vector2): ShaderMaterial;
  95931. /**
  95932. * Set a vec3 in the shader from a Vector3.
  95933. * @param name Define the name of the uniform as defined in the shader
  95934. * @param value Define the value to give to the uniform
  95935. * @return the material itself allowing "fluent" like uniform updates
  95936. */
  95937. setVector3(name: string, value: Vector3): ShaderMaterial;
  95938. /**
  95939. * Set a vec4 in the shader from a Vector4.
  95940. * @param name Define the name of the uniform as defined in the shader
  95941. * @param value Define the value to give to the uniform
  95942. * @return the material itself allowing "fluent" like uniform updates
  95943. */
  95944. setVector4(name: string, value: Vector4): ShaderMaterial;
  95945. /**
  95946. * Set a mat4 in the shader from a Matrix.
  95947. * @param name Define the name of the uniform as defined in the shader
  95948. * @param value Define the value to give to the uniform
  95949. * @return the material itself allowing "fluent" like uniform updates
  95950. */
  95951. setMatrix(name: string, value: Matrix): ShaderMaterial;
  95952. /**
  95953. * Set a float32Array in the shader from a matrix array.
  95954. * @param name Define the name of the uniform as defined in the shader
  95955. * @param value Define the value to give to the uniform
  95956. * @return the material itself allowing "fluent" like uniform updates
  95957. */
  95958. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  95959. /**
  95960. * Set a mat3 in the shader from a Float32Array.
  95961. * @param name Define the name of the uniform as defined in the shader
  95962. * @param value Define the value to give to the uniform
  95963. * @return the material itself allowing "fluent" like uniform updates
  95964. */
  95965. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  95966. /**
  95967. * Set a mat2 in the shader from a Float32Array.
  95968. * @param name Define the name of the uniform as defined in the shader
  95969. * @param value Define the value to give to the uniform
  95970. * @return the material itself allowing "fluent" like uniform updates
  95971. */
  95972. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  95973. /**
  95974. * Set a vec2 array in the shader from a number array.
  95975. * @param name Define the name of the uniform as defined in the shader
  95976. * @param value Define the value to give to the uniform
  95977. * @return the material itself allowing "fluent" like uniform updates
  95978. */
  95979. setArray2(name: string, value: number[]): ShaderMaterial;
  95980. /**
  95981. * Set a vec3 array in the shader from a number array.
  95982. * @param name Define the name of the uniform as defined in the shader
  95983. * @param value Define the value to give to the uniform
  95984. * @return the material itself allowing "fluent" like uniform updates
  95985. */
  95986. setArray3(name: string, value: number[]): ShaderMaterial;
  95987. /**
  95988. * Set a vec4 array in the shader from a number array.
  95989. * @param name Define the name of the uniform as defined in the shader
  95990. * @param value Define the value to give to the uniform
  95991. * @return the material itself allowing "fluent" like uniform updates
  95992. */
  95993. setArray4(name: string, value: number[]): ShaderMaterial;
  95994. private _checkCache;
  95995. /**
  95996. * Specifies that the submesh is ready to be used
  95997. * @param mesh defines the mesh to check
  95998. * @param subMesh defines which submesh to check
  95999. * @param useInstances specifies that instances should be used
  96000. * @returns a boolean indicating that the submesh is ready or not
  96001. */
  96002. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96003. /**
  96004. * Checks if the material is ready to render the requested mesh
  96005. * @param mesh Define the mesh to render
  96006. * @param useInstances Define whether or not the material is used with instances
  96007. * @returns true if ready, otherwise false
  96008. */
  96009. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96010. /**
  96011. * Binds the world matrix to the material
  96012. * @param world defines the world transformation matrix
  96013. * @param effectOverride - If provided, use this effect instead of internal effect
  96014. */
  96015. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96016. /**
  96017. * Binds the submesh to this material by preparing the effect and shader to draw
  96018. * @param world defines the world transformation matrix
  96019. * @param mesh defines the mesh containing the submesh
  96020. * @param subMesh defines the submesh to bind the material to
  96021. */
  96022. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96023. /**
  96024. * Binds the material to the mesh
  96025. * @param world defines the world transformation matrix
  96026. * @param mesh defines the mesh to bind the material to
  96027. * @param effectOverride - If provided, use this effect instead of internal effect
  96028. */
  96029. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96030. protected _afterBind(mesh?: Mesh): void;
  96031. /**
  96032. * Gets the active textures from the material
  96033. * @returns an array of textures
  96034. */
  96035. getActiveTextures(): BaseTexture[];
  96036. /**
  96037. * Specifies if the material uses a texture
  96038. * @param texture defines the texture to check against the material
  96039. * @returns a boolean specifying if the material uses the texture
  96040. */
  96041. hasTexture(texture: BaseTexture): boolean;
  96042. /**
  96043. * Makes a duplicate of the material, and gives it a new name
  96044. * @param name defines the new name for the duplicated material
  96045. * @returns the cloned material
  96046. */
  96047. clone(name: string): ShaderMaterial;
  96048. /**
  96049. * Disposes the material
  96050. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96051. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96052. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96053. */
  96054. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96055. /**
  96056. * Serializes this material in a JSON representation
  96057. * @returns the serialized material object
  96058. */
  96059. serialize(): any;
  96060. /**
  96061. * Creates a shader material from parsed shader material data
  96062. * @param source defines the JSON represnetation of the material
  96063. * @param scene defines the hosting scene
  96064. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96065. * @returns a new material
  96066. */
  96067. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96068. /**
  96069. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96070. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96071. * @param url defines the url to load from
  96072. * @param scene defines the hosting scene
  96073. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96074. * @returns a promise that will resolve to the new ShaderMaterial
  96075. */
  96076. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96077. /**
  96078. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96079. * @param snippetId defines the snippet to load
  96080. * @param scene defines the hosting scene
  96081. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96082. * @returns a promise that will resolve to the new ShaderMaterial
  96083. */
  96084. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96085. }
  96086. }
  96087. declare module BABYLON {
  96088. /** @hidden */
  96089. export var colorPixelShader: {
  96090. name: string;
  96091. shader: string;
  96092. };
  96093. }
  96094. declare module BABYLON {
  96095. /** @hidden */
  96096. export var colorVertexShader: {
  96097. name: string;
  96098. shader: string;
  96099. };
  96100. }
  96101. declare module BABYLON {
  96102. /**
  96103. * Line mesh
  96104. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96105. */
  96106. export class LinesMesh extends Mesh {
  96107. /**
  96108. * If vertex color should be applied to the mesh
  96109. */
  96110. readonly useVertexColor?: boolean | undefined;
  96111. /**
  96112. * If vertex alpha should be applied to the mesh
  96113. */
  96114. readonly useVertexAlpha?: boolean | undefined;
  96115. /**
  96116. * Color of the line (Default: White)
  96117. */
  96118. color: Color3;
  96119. /**
  96120. * Alpha of the line (Default: 1)
  96121. */
  96122. alpha: number;
  96123. /**
  96124. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96125. * This margin is expressed in world space coordinates, so its value may vary.
  96126. * Default value is 0.1
  96127. */
  96128. intersectionThreshold: number;
  96129. private _colorShader;
  96130. private color4;
  96131. /**
  96132. * Creates a new LinesMesh
  96133. * @param name defines the name
  96134. * @param scene defines the hosting scene
  96135. * @param parent defines the parent mesh if any
  96136. * @param source defines the optional source LinesMesh used to clone data from
  96137. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96138. * When false, achieved by calling a clone(), also passing False.
  96139. * This will make creation of children, recursive.
  96140. * @param useVertexColor defines if this LinesMesh supports vertex color
  96141. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96142. */
  96143. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96144. /**
  96145. * If vertex color should be applied to the mesh
  96146. */
  96147. useVertexColor?: boolean | undefined,
  96148. /**
  96149. * If vertex alpha should be applied to the mesh
  96150. */
  96151. useVertexAlpha?: boolean | undefined);
  96152. private _addClipPlaneDefine;
  96153. private _removeClipPlaneDefine;
  96154. isReady(): boolean;
  96155. /**
  96156. * Returns the string "LineMesh"
  96157. */
  96158. getClassName(): string;
  96159. /**
  96160. * @hidden
  96161. */
  96162. get material(): Material;
  96163. /**
  96164. * @hidden
  96165. */
  96166. set material(value: Material);
  96167. /**
  96168. * @hidden
  96169. */
  96170. get checkCollisions(): boolean;
  96171. /** @hidden */
  96172. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96173. /** @hidden */
  96174. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96175. /**
  96176. * Disposes of the line mesh
  96177. * @param doNotRecurse If children should be disposed
  96178. */
  96179. dispose(doNotRecurse?: boolean): void;
  96180. /**
  96181. * Returns a new LineMesh object cloned from the current one.
  96182. */
  96183. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96184. /**
  96185. * Creates a new InstancedLinesMesh object from the mesh model.
  96186. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96187. * @param name defines the name of the new instance
  96188. * @returns a new InstancedLinesMesh
  96189. */
  96190. createInstance(name: string): InstancedLinesMesh;
  96191. }
  96192. /**
  96193. * Creates an instance based on a source LinesMesh
  96194. */
  96195. export class InstancedLinesMesh extends InstancedMesh {
  96196. /**
  96197. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96198. * This margin is expressed in world space coordinates, so its value may vary.
  96199. * Initilized with the intersectionThreshold value of the source LinesMesh
  96200. */
  96201. intersectionThreshold: number;
  96202. constructor(name: string, source: LinesMesh);
  96203. /**
  96204. * Returns the string "InstancedLinesMesh".
  96205. */
  96206. getClassName(): string;
  96207. }
  96208. }
  96209. declare module BABYLON {
  96210. /** @hidden */
  96211. export var linePixelShader: {
  96212. name: string;
  96213. shader: string;
  96214. };
  96215. }
  96216. declare module BABYLON {
  96217. /** @hidden */
  96218. export var lineVertexShader: {
  96219. name: string;
  96220. shader: string;
  96221. };
  96222. }
  96223. declare module BABYLON {
  96224. interface Scene {
  96225. /** @hidden */
  96226. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96227. }
  96228. interface AbstractMesh {
  96229. /**
  96230. * Gets the edgesRenderer associated with the mesh
  96231. */
  96232. edgesRenderer: Nullable<EdgesRenderer>;
  96233. }
  96234. interface LinesMesh {
  96235. /**
  96236. * Enables the edge rendering mode on the mesh.
  96237. * This mode makes the mesh edges visible
  96238. * @param epsilon defines the maximal distance between two angles to detect a face
  96239. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96240. * @returns the currentAbstractMesh
  96241. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96242. */
  96243. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96244. }
  96245. interface InstancedLinesMesh {
  96246. /**
  96247. * Enables the edge rendering mode on the mesh.
  96248. * This mode makes the mesh edges visible
  96249. * @param epsilon defines the maximal distance between two angles to detect a face
  96250. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96251. * @returns the current InstancedLinesMesh
  96252. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96253. */
  96254. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96255. }
  96256. /**
  96257. * Defines the minimum contract an Edges renderer should follow.
  96258. */
  96259. export interface IEdgesRenderer extends IDisposable {
  96260. /**
  96261. * Gets or sets a boolean indicating if the edgesRenderer is active
  96262. */
  96263. isEnabled: boolean;
  96264. /**
  96265. * Renders the edges of the attached mesh,
  96266. */
  96267. render(): void;
  96268. /**
  96269. * Checks wether or not the edges renderer is ready to render.
  96270. * @return true if ready, otherwise false.
  96271. */
  96272. isReady(): boolean;
  96273. /**
  96274. * List of instances to render in case the source mesh has instances
  96275. */
  96276. customInstances: SmartArray<Matrix>;
  96277. }
  96278. /**
  96279. * Defines the additional options of the edges renderer
  96280. */
  96281. export interface IEdgesRendererOptions {
  96282. /**
  96283. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96284. * If not defined, the default value is true
  96285. */
  96286. useAlternateEdgeFinder?: boolean;
  96287. /**
  96288. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96289. * If not defined, the default value is true.
  96290. * 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)
  96291. * This option is used only if useAlternateEdgeFinder = true
  96292. */
  96293. useFastVertexMerger?: boolean;
  96294. /**
  96295. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96296. * The default value is 1e-6
  96297. * This option is used only if useAlternateEdgeFinder = true
  96298. */
  96299. epsilonVertexMerge?: number;
  96300. /**
  96301. * 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
  96302. * 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.
  96303. * This option is used only if useAlternateEdgeFinder = true
  96304. */
  96305. applyTessellation?: boolean;
  96306. /**
  96307. * 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
  96308. * The default value is 1e-6
  96309. * This option is used only if useAlternateEdgeFinder = true
  96310. */
  96311. epsilonVertexAligned?: number;
  96312. }
  96313. /**
  96314. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96315. */
  96316. export class EdgesRenderer implements IEdgesRenderer {
  96317. /**
  96318. * Define the size of the edges with an orthographic camera
  96319. */
  96320. edgesWidthScalerForOrthographic: number;
  96321. /**
  96322. * Define the size of the edges with a perspective camera
  96323. */
  96324. edgesWidthScalerForPerspective: number;
  96325. protected _source: AbstractMesh;
  96326. protected _linesPositions: number[];
  96327. protected _linesNormals: number[];
  96328. protected _linesIndices: number[];
  96329. protected _epsilon: number;
  96330. protected _indicesCount: number;
  96331. protected _lineShader: ShaderMaterial;
  96332. protected _ib: DataBuffer;
  96333. protected _buffers: {
  96334. [key: string]: Nullable<VertexBuffer>;
  96335. };
  96336. protected _buffersForInstances: {
  96337. [key: string]: Nullable<VertexBuffer>;
  96338. };
  96339. protected _checkVerticesInsteadOfIndices: boolean;
  96340. protected _options: Nullable<IEdgesRendererOptions>;
  96341. private _meshRebuildObserver;
  96342. private _meshDisposeObserver;
  96343. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96344. isEnabled: boolean;
  96345. /**
  96346. * List of instances to render in case the source mesh has instances
  96347. */
  96348. customInstances: SmartArray<Matrix>;
  96349. private static GetShader;
  96350. /**
  96351. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96352. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96353. * @param source Mesh used to create edges
  96354. * @param epsilon sum of angles in adjacency to check for edge
  96355. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96356. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96357. * @param options The options to apply when generating the edges
  96358. */
  96359. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96360. protected _prepareRessources(): void;
  96361. /** @hidden */
  96362. _rebuild(): void;
  96363. /**
  96364. * Releases the required resources for the edges renderer
  96365. */
  96366. dispose(): void;
  96367. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96368. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96369. /**
  96370. * Checks if the pair of p0 and p1 is en edge
  96371. * @param faceIndex
  96372. * @param edge
  96373. * @param faceNormals
  96374. * @param p0
  96375. * @param p1
  96376. * @private
  96377. */
  96378. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96379. /**
  96380. * push line into the position, normal and index buffer
  96381. * @protected
  96382. */
  96383. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96384. /**
  96385. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96386. */
  96387. private _tessellateTriangle;
  96388. private _generateEdgesLinesAlternate;
  96389. /**
  96390. * Generates lines edges from adjacencjes
  96391. * @private
  96392. */
  96393. _generateEdgesLines(): void;
  96394. /**
  96395. * Checks wether or not the edges renderer is ready to render.
  96396. * @return true if ready, otherwise false.
  96397. */
  96398. isReady(): boolean;
  96399. /**
  96400. * Renders the edges of the attached mesh,
  96401. */
  96402. render(): void;
  96403. }
  96404. /**
  96405. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96406. */
  96407. export class LineEdgesRenderer extends EdgesRenderer {
  96408. /**
  96409. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96410. * @param source LineMesh used to generate edges
  96411. * @param epsilon not important (specified angle for edge detection)
  96412. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96413. */
  96414. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96415. /**
  96416. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96417. */
  96418. _generateEdgesLines(): void;
  96419. }
  96420. }
  96421. declare module BABYLON {
  96422. /**
  96423. * This represents the object necessary to create a rendering group.
  96424. * This is exclusively used and created by the rendering manager.
  96425. * To modify the behavior, you use the available helpers in your scene or meshes.
  96426. * @hidden
  96427. */
  96428. export class RenderingGroup {
  96429. index: number;
  96430. private static _zeroVector;
  96431. private _scene;
  96432. private _opaqueSubMeshes;
  96433. private _transparentSubMeshes;
  96434. private _alphaTestSubMeshes;
  96435. private _depthOnlySubMeshes;
  96436. private _particleSystems;
  96437. private _spriteManagers;
  96438. private _opaqueSortCompareFn;
  96439. private _alphaTestSortCompareFn;
  96440. private _transparentSortCompareFn;
  96441. private _renderOpaque;
  96442. private _renderAlphaTest;
  96443. private _renderTransparent;
  96444. /** @hidden */
  96445. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96446. onBeforeTransparentRendering: () => void;
  96447. /**
  96448. * Set the opaque sort comparison function.
  96449. * If null the sub meshes will be render in the order they were created
  96450. */
  96451. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96452. /**
  96453. * Set the alpha test sort comparison function.
  96454. * If null the sub meshes will be render in the order they were created
  96455. */
  96456. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96457. /**
  96458. * Set the transparent sort comparison function.
  96459. * If null the sub meshes will be render in the order they were created
  96460. */
  96461. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96462. /**
  96463. * Creates a new rendering group.
  96464. * @param index The rendering group index
  96465. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96466. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96467. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96468. */
  96469. 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>);
  96470. /**
  96471. * Render all the sub meshes contained in the group.
  96472. * @param customRenderFunction Used to override the default render behaviour of the group.
  96473. * @returns true if rendered some submeshes.
  96474. */
  96475. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96476. /**
  96477. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96478. * @param subMeshes The submeshes to render
  96479. */
  96480. private renderOpaqueSorted;
  96481. /**
  96482. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96483. * @param subMeshes The submeshes to render
  96484. */
  96485. private renderAlphaTestSorted;
  96486. /**
  96487. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96488. * @param subMeshes The submeshes to render
  96489. */
  96490. private renderTransparentSorted;
  96491. /**
  96492. * Renders the submeshes in a specified order.
  96493. * @param subMeshes The submeshes to sort before render
  96494. * @param sortCompareFn The comparison function use to sort
  96495. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96496. * @param transparent Specifies to activate blending if true
  96497. */
  96498. private static renderSorted;
  96499. /**
  96500. * Renders the submeshes in the order they were dispatched (no sort applied).
  96501. * @param subMeshes The submeshes to render
  96502. */
  96503. private static renderUnsorted;
  96504. /**
  96505. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96506. * are rendered back to front if in the same alpha index.
  96507. *
  96508. * @param a The first submesh
  96509. * @param b The second submesh
  96510. * @returns The result of the comparison
  96511. */
  96512. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96513. /**
  96514. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96515. * are rendered back to front.
  96516. *
  96517. * @param a The first submesh
  96518. * @param b The second submesh
  96519. * @returns The result of the comparison
  96520. */
  96521. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96522. /**
  96523. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96524. * are rendered front to back (prevent overdraw).
  96525. *
  96526. * @param a The first submesh
  96527. * @param b The second submesh
  96528. * @returns The result of the comparison
  96529. */
  96530. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96531. /**
  96532. * Resets the different lists of submeshes to prepare a new frame.
  96533. */
  96534. prepare(): void;
  96535. dispose(): void;
  96536. /**
  96537. * Inserts the submesh in its correct queue depending on its material.
  96538. * @param subMesh The submesh to dispatch
  96539. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96540. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96541. */
  96542. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96543. dispatchSprites(spriteManager: ISpriteManager): void;
  96544. dispatchParticles(particleSystem: IParticleSystem): void;
  96545. private _renderParticles;
  96546. private _renderSprites;
  96547. }
  96548. }
  96549. declare module BABYLON {
  96550. /**
  96551. * Interface describing the different options available in the rendering manager
  96552. * regarding Auto Clear between groups.
  96553. */
  96554. export interface IRenderingManagerAutoClearSetup {
  96555. /**
  96556. * Defines whether or not autoclear is enable.
  96557. */
  96558. autoClear: boolean;
  96559. /**
  96560. * Defines whether or not to autoclear the depth buffer.
  96561. */
  96562. depth: boolean;
  96563. /**
  96564. * Defines whether or not to autoclear the stencil buffer.
  96565. */
  96566. stencil: boolean;
  96567. }
  96568. /**
  96569. * This class is used by the onRenderingGroupObservable
  96570. */
  96571. export class RenderingGroupInfo {
  96572. /**
  96573. * The Scene that being rendered
  96574. */
  96575. scene: Scene;
  96576. /**
  96577. * The camera currently used for the rendering pass
  96578. */
  96579. camera: Nullable<Camera>;
  96580. /**
  96581. * The ID of the renderingGroup being processed
  96582. */
  96583. renderingGroupId: number;
  96584. }
  96585. /**
  96586. * This is the manager responsible of all the rendering for meshes sprites and particles.
  96587. * It is enable to manage the different groups as well as the different necessary sort functions.
  96588. * This should not be used directly aside of the few static configurations
  96589. */
  96590. export class RenderingManager {
  96591. /**
  96592. * The max id used for rendering groups (not included)
  96593. */
  96594. static MAX_RENDERINGGROUPS: number;
  96595. /**
  96596. * The min id used for rendering groups (included)
  96597. */
  96598. static MIN_RENDERINGGROUPS: number;
  96599. /**
  96600. * Used to globally prevent autoclearing scenes.
  96601. */
  96602. static AUTOCLEAR: boolean;
  96603. /**
  96604. * @hidden
  96605. */
  96606. _useSceneAutoClearSetup: boolean;
  96607. private _scene;
  96608. private _renderingGroups;
  96609. private _depthStencilBufferAlreadyCleaned;
  96610. private _autoClearDepthStencil;
  96611. private _customOpaqueSortCompareFn;
  96612. private _customAlphaTestSortCompareFn;
  96613. private _customTransparentSortCompareFn;
  96614. private _renderingGroupInfo;
  96615. /**
  96616. * Instantiates a new rendering group for a particular scene
  96617. * @param scene Defines the scene the groups belongs to
  96618. */
  96619. constructor(scene: Scene);
  96620. private _clearDepthStencilBuffer;
  96621. /**
  96622. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  96623. * @hidden
  96624. */
  96625. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  96626. /**
  96627. * Resets the different information of the group to prepare a new frame
  96628. * @hidden
  96629. */
  96630. reset(): void;
  96631. /**
  96632. * Dispose and release the group and its associated resources.
  96633. * @hidden
  96634. */
  96635. dispose(): void;
  96636. /**
  96637. * Clear the info related to rendering groups preventing retention points during dispose.
  96638. */
  96639. freeRenderingGroups(): void;
  96640. private _prepareRenderingGroup;
  96641. /**
  96642. * Add a sprite manager to the rendering manager in order to render it this frame.
  96643. * @param spriteManager Define the sprite manager to render
  96644. */
  96645. dispatchSprites(spriteManager: ISpriteManager): void;
  96646. /**
  96647. * Add a particle system to the rendering manager in order to render it this frame.
  96648. * @param particleSystem Define the particle system to render
  96649. */
  96650. dispatchParticles(particleSystem: IParticleSystem): void;
  96651. /**
  96652. * Add a submesh to the manager in order to render it this frame
  96653. * @param subMesh The submesh to dispatch
  96654. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96655. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96656. */
  96657. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96658. /**
  96659. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  96660. * This allowed control for front to back rendering or reversly depending of the special needs.
  96661. *
  96662. * @param renderingGroupId The rendering group id corresponding to its index
  96663. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  96664. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  96665. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  96666. */
  96667. 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;
  96668. /**
  96669. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  96670. *
  96671. * @param renderingGroupId The rendering group id corresponding to its index
  96672. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  96673. * @param depth Automatically clears depth between groups if true and autoClear is true.
  96674. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  96675. */
  96676. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  96677. /**
  96678. * Gets the current auto clear configuration for one rendering group of the rendering
  96679. * manager.
  96680. * @param index the rendering group index to get the information for
  96681. * @returns The auto clear setup for the requested rendering group
  96682. */
  96683. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  96684. }
  96685. }
  96686. declare module BABYLON {
  96687. /**
  96688. * Defines the options associated with the creation of a custom shader for a shadow generator.
  96689. */
  96690. export interface ICustomShaderOptions {
  96691. /**
  96692. * Gets or sets the custom shader name to use
  96693. */
  96694. shaderName: string;
  96695. /**
  96696. * The list of attribute names used in the shader
  96697. */
  96698. attributes?: string[];
  96699. /**
  96700. * The list of unifrom names used in the shader
  96701. */
  96702. uniforms?: string[];
  96703. /**
  96704. * The list of sampler names used in the shader
  96705. */
  96706. samplers?: string[];
  96707. /**
  96708. * The list of defines used in the shader
  96709. */
  96710. defines?: string[];
  96711. }
  96712. /**
  96713. * Interface to implement to create a shadow generator compatible with BJS.
  96714. */
  96715. export interface IShadowGenerator {
  96716. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  96717. id: string;
  96718. /**
  96719. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  96720. * @returns The render target texture if present otherwise, null
  96721. */
  96722. getShadowMap(): Nullable<RenderTargetTexture>;
  96723. /**
  96724. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  96725. * @param subMesh The submesh we want to render in the shadow map
  96726. * @param useInstances Defines wether will draw in the map using instances
  96727. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  96728. * @returns true if ready otherwise, false
  96729. */
  96730. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  96731. /**
  96732. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  96733. * @param defines Defines of the material we want to update
  96734. * @param lightIndex Index of the light in the enabled light list of the material
  96735. */
  96736. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  96737. /**
  96738. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  96739. * defined in the generator but impacting the effect).
  96740. * It implies the unifroms available on the materials are the standard BJS ones.
  96741. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  96742. * @param effect The effect we are binfing the information for
  96743. */
  96744. bindShadowLight(lightIndex: string, effect: Effect): void;
  96745. /**
  96746. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  96747. * (eq to shadow prjection matrix * light transform matrix)
  96748. * @returns The transform matrix used to create the shadow map
  96749. */
  96750. getTransformMatrix(): Matrix;
  96751. /**
  96752. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  96753. * Cube and 2D textures for instance.
  96754. */
  96755. recreateShadowMap(): void;
  96756. /**
  96757. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96758. * @param onCompiled Callback triggered at the and of the effects compilation
  96759. * @param options Sets of optional options forcing the compilation with different modes
  96760. */
  96761. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  96762. useInstances: boolean;
  96763. }>): void;
  96764. /**
  96765. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96766. * @param options Sets of optional options forcing the compilation with different modes
  96767. * @returns A promise that resolves when the compilation completes
  96768. */
  96769. forceCompilationAsync(options?: Partial<{
  96770. useInstances: boolean;
  96771. }>): Promise<void>;
  96772. /**
  96773. * Serializes the shadow generator setup to a json object.
  96774. * @returns The serialized JSON object
  96775. */
  96776. serialize(): any;
  96777. /**
  96778. * Disposes the Shadow map and related Textures and effects.
  96779. */
  96780. dispose(): void;
  96781. }
  96782. /**
  96783. * Default implementation IShadowGenerator.
  96784. * This is the main object responsible of generating shadows in the framework.
  96785. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  96786. */
  96787. export class ShadowGenerator implements IShadowGenerator {
  96788. /**
  96789. * Name of the shadow generator class
  96790. */
  96791. static CLASSNAME: string;
  96792. /**
  96793. * Shadow generator mode None: no filtering applied.
  96794. */
  96795. static readonly FILTER_NONE: number;
  96796. /**
  96797. * Shadow generator mode ESM: Exponential Shadow Mapping.
  96798. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96799. */
  96800. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  96801. /**
  96802. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  96803. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  96804. */
  96805. static readonly FILTER_POISSONSAMPLING: number;
  96806. /**
  96807. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  96808. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96809. */
  96810. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  96811. /**
  96812. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  96813. * edge artifacts on steep falloff.
  96814. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96815. */
  96816. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  96817. /**
  96818. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  96819. * edge artifacts on steep falloff.
  96820. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96821. */
  96822. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  96823. /**
  96824. * Shadow generator mode PCF: Percentage Closer Filtering
  96825. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  96826. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  96827. */
  96828. static readonly FILTER_PCF: number;
  96829. /**
  96830. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  96831. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  96832. * Contact Hardening
  96833. */
  96834. static readonly FILTER_PCSS: number;
  96835. /**
  96836. * Reserved for PCF and PCSS
  96837. * Highest Quality.
  96838. *
  96839. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  96840. *
  96841. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  96842. */
  96843. static readonly QUALITY_HIGH: number;
  96844. /**
  96845. * Reserved for PCF and PCSS
  96846. * Good tradeoff for quality/perf cross devices
  96847. *
  96848. * Execute PCF on a 3*3 kernel.
  96849. *
  96850. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  96851. */
  96852. static readonly QUALITY_MEDIUM: number;
  96853. /**
  96854. * Reserved for PCF and PCSS
  96855. * The lowest quality but the fastest.
  96856. *
  96857. * Execute PCF on a 1*1 kernel.
  96858. *
  96859. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  96860. */
  96861. static readonly QUALITY_LOW: number;
  96862. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  96863. id: string;
  96864. /** Gets or sets the custom shader name to use */
  96865. customShaderOptions: ICustomShaderOptions;
  96866. /**
  96867. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  96868. */
  96869. onBeforeShadowMapRenderObservable: Observable<Effect>;
  96870. /**
  96871. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  96872. */
  96873. onAfterShadowMapRenderObservable: Observable<Effect>;
  96874. /**
  96875. * Observable triggered before a mesh is rendered in the shadow map.
  96876. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  96877. */
  96878. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  96879. /**
  96880. * Observable triggered after a mesh is rendered in the shadow map.
  96881. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  96882. */
  96883. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  96884. protected _bias: number;
  96885. /**
  96886. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  96887. */
  96888. get bias(): number;
  96889. /**
  96890. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  96891. */
  96892. set bias(bias: number);
  96893. protected _normalBias: number;
  96894. /**
  96895. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  96896. */
  96897. get normalBias(): number;
  96898. /**
  96899. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  96900. */
  96901. set normalBias(normalBias: number);
  96902. protected _blurBoxOffset: number;
  96903. /**
  96904. * Gets the blur box offset: offset applied during the blur pass.
  96905. * Only useful if useKernelBlur = false
  96906. */
  96907. get blurBoxOffset(): number;
  96908. /**
  96909. * Sets the blur box offset: offset applied during the blur pass.
  96910. * Only useful if useKernelBlur = false
  96911. */
  96912. set blurBoxOffset(value: number);
  96913. protected _blurScale: number;
  96914. /**
  96915. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  96916. * 2 means half of the size.
  96917. */
  96918. get blurScale(): number;
  96919. /**
  96920. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  96921. * 2 means half of the size.
  96922. */
  96923. set blurScale(value: number);
  96924. protected _blurKernel: number;
  96925. /**
  96926. * Gets the blur kernel: kernel size of the blur pass.
  96927. * Only useful if useKernelBlur = true
  96928. */
  96929. get blurKernel(): number;
  96930. /**
  96931. * Sets the blur kernel: kernel size of the blur pass.
  96932. * Only useful if useKernelBlur = true
  96933. */
  96934. set blurKernel(value: number);
  96935. protected _useKernelBlur: boolean;
  96936. /**
  96937. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  96938. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  96939. */
  96940. get useKernelBlur(): boolean;
  96941. /**
  96942. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  96943. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  96944. */
  96945. set useKernelBlur(value: boolean);
  96946. protected _depthScale: number;
  96947. /**
  96948. * Gets the depth scale used in ESM mode.
  96949. */
  96950. get depthScale(): number;
  96951. /**
  96952. * Sets the depth scale used in ESM mode.
  96953. * This can override the scale stored on the light.
  96954. */
  96955. set depthScale(value: number);
  96956. protected _validateFilter(filter: number): number;
  96957. protected _filter: number;
  96958. /**
  96959. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  96960. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  96961. */
  96962. get filter(): number;
  96963. /**
  96964. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  96965. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  96966. */
  96967. set filter(value: number);
  96968. /**
  96969. * Gets if the current filter is set to Poisson Sampling.
  96970. */
  96971. get usePoissonSampling(): boolean;
  96972. /**
  96973. * Sets the current filter to Poisson Sampling.
  96974. */
  96975. set usePoissonSampling(value: boolean);
  96976. /**
  96977. * Gets if the current filter is set to ESM.
  96978. */
  96979. get useExponentialShadowMap(): boolean;
  96980. /**
  96981. * Sets the current filter is to ESM.
  96982. */
  96983. set useExponentialShadowMap(value: boolean);
  96984. /**
  96985. * Gets if the current filter is set to filtered ESM.
  96986. */
  96987. get useBlurExponentialShadowMap(): boolean;
  96988. /**
  96989. * Gets if the current filter is set to filtered ESM.
  96990. */
  96991. set useBlurExponentialShadowMap(value: boolean);
  96992. /**
  96993. * Gets if the current filter is set to "close ESM" (using the inverse of the
  96994. * exponential to prevent steep falloff artifacts).
  96995. */
  96996. get useCloseExponentialShadowMap(): boolean;
  96997. /**
  96998. * Sets the current filter to "close ESM" (using the inverse of the
  96999. * exponential to prevent steep falloff artifacts).
  97000. */
  97001. set useCloseExponentialShadowMap(value: boolean);
  97002. /**
  97003. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97004. * exponential to prevent steep falloff artifacts).
  97005. */
  97006. get useBlurCloseExponentialShadowMap(): boolean;
  97007. /**
  97008. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97009. * exponential to prevent steep falloff artifacts).
  97010. */
  97011. set useBlurCloseExponentialShadowMap(value: boolean);
  97012. /**
  97013. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97014. */
  97015. get usePercentageCloserFiltering(): boolean;
  97016. /**
  97017. * Sets the current filter to "PCF" (percentage closer filtering).
  97018. */
  97019. set usePercentageCloserFiltering(value: boolean);
  97020. protected _filteringQuality: number;
  97021. /**
  97022. * Gets the PCF or PCSS Quality.
  97023. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97024. */
  97025. get filteringQuality(): number;
  97026. /**
  97027. * Sets the PCF or PCSS Quality.
  97028. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97029. */
  97030. set filteringQuality(filteringQuality: number);
  97031. /**
  97032. * Gets if the current filter is set to "PCSS" (contact hardening).
  97033. */
  97034. get useContactHardeningShadow(): boolean;
  97035. /**
  97036. * Sets the current filter to "PCSS" (contact hardening).
  97037. */
  97038. set useContactHardeningShadow(value: boolean);
  97039. protected _contactHardeningLightSizeUVRatio: number;
  97040. /**
  97041. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97042. * Using a ratio helps keeping shape stability independently of the map size.
  97043. *
  97044. * It does not account for the light projection as it was having too much
  97045. * instability during the light setup or during light position changes.
  97046. *
  97047. * Only valid if useContactHardeningShadow is true.
  97048. */
  97049. get contactHardeningLightSizeUVRatio(): number;
  97050. /**
  97051. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97052. * Using a ratio helps keeping shape stability independently of the map size.
  97053. *
  97054. * It does not account for the light projection as it was having too much
  97055. * instability during the light setup or during light position changes.
  97056. *
  97057. * Only valid if useContactHardeningShadow is true.
  97058. */
  97059. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97060. protected _darkness: number;
  97061. /** Gets or sets the actual darkness of a shadow */
  97062. get darkness(): number;
  97063. set darkness(value: number);
  97064. /**
  97065. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97066. * 0 means strongest and 1 would means no shadow.
  97067. * @returns the darkness.
  97068. */
  97069. getDarkness(): number;
  97070. /**
  97071. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97072. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97073. * @returns the shadow generator allowing fluent coding.
  97074. */
  97075. setDarkness(darkness: number): ShadowGenerator;
  97076. protected _transparencyShadow: boolean;
  97077. /** Gets or sets the ability to have transparent shadow */
  97078. get transparencyShadow(): boolean;
  97079. set transparencyShadow(value: boolean);
  97080. /**
  97081. * Sets the ability to have transparent shadow (boolean).
  97082. * @param transparent True if transparent else False
  97083. * @returns the shadow generator allowing fluent coding
  97084. */
  97085. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97086. /**
  97087. * Enables or disables shadows with varying strength based on the transparency
  97088. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97089. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97090. * mesh.visibility * alphaTexture.a
  97091. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97092. */
  97093. enableSoftTransparentShadow: boolean;
  97094. protected _shadowMap: Nullable<RenderTargetTexture>;
  97095. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97096. /**
  97097. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97098. * @returns The render target texture if present otherwise, null
  97099. */
  97100. getShadowMap(): Nullable<RenderTargetTexture>;
  97101. /**
  97102. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97103. * @returns The render target texture if the shadow map is present otherwise, null
  97104. */
  97105. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97106. /**
  97107. * Gets the class name of that object
  97108. * @returns "ShadowGenerator"
  97109. */
  97110. getClassName(): string;
  97111. /**
  97112. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97113. * @param mesh Mesh to add
  97114. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97115. * @returns the Shadow Generator itself
  97116. */
  97117. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97118. /**
  97119. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97120. * @param mesh Mesh to remove
  97121. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97122. * @returns the Shadow Generator itself
  97123. */
  97124. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97125. /**
  97126. * Controls the extent to which the shadows fade out at the edge of the frustum
  97127. */
  97128. frustumEdgeFalloff: number;
  97129. protected _light: IShadowLight;
  97130. /**
  97131. * Returns the associated light object.
  97132. * @returns the light generating the shadow
  97133. */
  97134. getLight(): IShadowLight;
  97135. /**
  97136. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97137. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97138. * It might on the other hand introduce peter panning.
  97139. */
  97140. forceBackFacesOnly: boolean;
  97141. protected _scene: Scene;
  97142. protected _lightDirection: Vector3;
  97143. protected _effect: Effect;
  97144. protected _viewMatrix: Matrix;
  97145. protected _projectionMatrix: Matrix;
  97146. protected _transformMatrix: Matrix;
  97147. protected _cachedPosition: Vector3;
  97148. protected _cachedDirection: Vector3;
  97149. protected _cachedDefines: string;
  97150. protected _currentRenderID: number;
  97151. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97152. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97153. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97154. protected _blurPostProcesses: PostProcess[];
  97155. protected _mapSize: number;
  97156. protected _currentFaceIndex: number;
  97157. protected _currentFaceIndexCache: number;
  97158. protected _textureType: number;
  97159. protected _defaultTextureMatrix: Matrix;
  97160. protected _storedUniqueId: Nullable<number>;
  97161. /** @hidden */
  97162. static _SceneComponentInitialization: (scene: Scene) => void;
  97163. /**
  97164. * Creates a ShadowGenerator object.
  97165. * A ShadowGenerator is the required tool to use the shadows.
  97166. * Each light casting shadows needs to use its own ShadowGenerator.
  97167. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97168. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97169. * @param light The light object generating the shadows.
  97170. * @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.
  97171. */
  97172. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97173. protected _initializeGenerator(): void;
  97174. protected _createTargetRenderTexture(): void;
  97175. protected _initializeShadowMap(): void;
  97176. protected _initializeBlurRTTAndPostProcesses(): void;
  97177. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97178. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97179. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97180. protected _applyFilterValues(): void;
  97181. /**
  97182. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97183. * @param onCompiled Callback triggered at the and of the effects compilation
  97184. * @param options Sets of optional options forcing the compilation with different modes
  97185. */
  97186. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97187. useInstances: boolean;
  97188. }>): void;
  97189. /**
  97190. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97191. * @param options Sets of optional options forcing the compilation with different modes
  97192. * @returns A promise that resolves when the compilation completes
  97193. */
  97194. forceCompilationAsync(options?: Partial<{
  97195. useInstances: boolean;
  97196. }>): Promise<void>;
  97197. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97198. private _prepareShadowDefines;
  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: any, 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. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97217. * @param effect The effect we are binfing the information for
  97218. */
  97219. bindShadowLight(lightIndex: string, effect: Effect): void;
  97220. /**
  97221. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97222. * (eq to shadow prjection matrix * light transform matrix)
  97223. * @returns The transform matrix used to create the shadow map
  97224. */
  97225. getTransformMatrix(): Matrix;
  97226. /**
  97227. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97228. * Cube and 2D textures for instance.
  97229. */
  97230. recreateShadowMap(): void;
  97231. protected _disposeBlurPostProcesses(): void;
  97232. protected _disposeRTTandPostProcesses(): void;
  97233. /**
  97234. * Disposes the ShadowGenerator.
  97235. * Returns nothing.
  97236. */
  97237. dispose(): void;
  97238. /**
  97239. * Serializes the shadow generator setup to a json object.
  97240. * @returns The serialized JSON object
  97241. */
  97242. serialize(): any;
  97243. /**
  97244. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97245. * @param parsedShadowGenerator The JSON object to parse
  97246. * @param scene The scene to create the shadow map for
  97247. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97248. * @returns The parsed shadow generator
  97249. */
  97250. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97251. }
  97252. }
  97253. declare module BABYLON {
  97254. /**
  97255. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97256. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97257. * 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.
  97258. */
  97259. export abstract class Light extends Node {
  97260. /**
  97261. * Falloff Default: light is falling off following the material specification:
  97262. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97263. */
  97264. static readonly FALLOFF_DEFAULT: number;
  97265. /**
  97266. * Falloff Physical: light is falling off following the inverse squared distance law.
  97267. */
  97268. static readonly FALLOFF_PHYSICAL: number;
  97269. /**
  97270. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97271. * to enhance interoperability with other engines.
  97272. */
  97273. static readonly FALLOFF_GLTF: number;
  97274. /**
  97275. * Falloff Standard: light is falling off like in the standard material
  97276. * to enhance interoperability with other materials.
  97277. */
  97278. static readonly FALLOFF_STANDARD: number;
  97279. /**
  97280. * If every light affecting the material is in this lightmapMode,
  97281. * material.lightmapTexture adds or multiplies
  97282. * (depends on material.useLightmapAsShadowmap)
  97283. * after every other light calculations.
  97284. */
  97285. static readonly LIGHTMAP_DEFAULT: number;
  97286. /**
  97287. * material.lightmapTexture as only diffuse lighting from this light
  97288. * adds only specular lighting from this light
  97289. * adds dynamic shadows
  97290. */
  97291. static readonly LIGHTMAP_SPECULAR: number;
  97292. /**
  97293. * material.lightmapTexture as only lighting
  97294. * no light calculation from this light
  97295. * only adds dynamic shadows from this light
  97296. */
  97297. static readonly LIGHTMAP_SHADOWSONLY: number;
  97298. /**
  97299. * Each light type uses the default quantity according to its type:
  97300. * point/spot lights use luminous intensity
  97301. * directional lights use illuminance
  97302. */
  97303. static readonly INTENSITYMODE_AUTOMATIC: number;
  97304. /**
  97305. * lumen (lm)
  97306. */
  97307. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97308. /**
  97309. * candela (lm/sr)
  97310. */
  97311. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97312. /**
  97313. * lux (lm/m^2)
  97314. */
  97315. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97316. /**
  97317. * nit (cd/m^2)
  97318. */
  97319. static readonly INTENSITYMODE_LUMINANCE: number;
  97320. /**
  97321. * Light type const id of the point light.
  97322. */
  97323. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97324. /**
  97325. * Light type const id of the directional light.
  97326. */
  97327. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97328. /**
  97329. * Light type const id of the spot light.
  97330. */
  97331. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97332. /**
  97333. * Light type const id of the hemispheric light.
  97334. */
  97335. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97336. /**
  97337. * Diffuse gives the basic color to an object.
  97338. */
  97339. diffuse: Color3;
  97340. /**
  97341. * Specular produces a highlight color on an object.
  97342. * Note: This is note affecting PBR materials.
  97343. */
  97344. specular: Color3;
  97345. /**
  97346. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97347. * falling off base on range or angle.
  97348. * This can be set to any values in Light.FALLOFF_x.
  97349. *
  97350. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97351. * other types of materials.
  97352. */
  97353. falloffType: number;
  97354. /**
  97355. * Strength of the light.
  97356. * Note: By default it is define in the framework own unit.
  97357. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97358. */
  97359. intensity: number;
  97360. private _range;
  97361. protected _inverseSquaredRange: number;
  97362. /**
  97363. * Defines how far from the source the light is impacting in scene units.
  97364. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97365. */
  97366. get range(): number;
  97367. /**
  97368. * Defines how far from the source the light is impacting in scene units.
  97369. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97370. */
  97371. set range(value: number);
  97372. /**
  97373. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97374. * of light.
  97375. */
  97376. private _photometricScale;
  97377. private _intensityMode;
  97378. /**
  97379. * Gets the photometric scale used to interpret the intensity.
  97380. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97381. */
  97382. get intensityMode(): number;
  97383. /**
  97384. * Sets the photometric scale used to interpret the intensity.
  97385. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97386. */
  97387. set intensityMode(value: number);
  97388. private _radius;
  97389. /**
  97390. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97391. */
  97392. get radius(): number;
  97393. /**
  97394. * sets the light radius used by PBR Materials to simulate soft area lights.
  97395. */
  97396. set radius(value: number);
  97397. private _renderPriority;
  97398. /**
  97399. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97400. * exceeding the number allowed of the materials.
  97401. */
  97402. renderPriority: number;
  97403. private _shadowEnabled;
  97404. /**
  97405. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97406. * the current shadow generator.
  97407. */
  97408. get shadowEnabled(): boolean;
  97409. /**
  97410. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97411. * the current shadow generator.
  97412. */
  97413. set shadowEnabled(value: boolean);
  97414. private _includedOnlyMeshes;
  97415. /**
  97416. * Gets the only meshes impacted by this light.
  97417. */
  97418. get includedOnlyMeshes(): AbstractMesh[];
  97419. /**
  97420. * Sets the only meshes impacted by this light.
  97421. */
  97422. set includedOnlyMeshes(value: AbstractMesh[]);
  97423. private _excludedMeshes;
  97424. /**
  97425. * Gets the meshes not impacted by this light.
  97426. */
  97427. get excludedMeshes(): AbstractMesh[];
  97428. /**
  97429. * Sets the meshes not impacted by this light.
  97430. */
  97431. set excludedMeshes(value: AbstractMesh[]);
  97432. private _excludeWithLayerMask;
  97433. /**
  97434. * Gets the layer id use to find what meshes are not impacted by the light.
  97435. * Inactive if 0
  97436. */
  97437. get excludeWithLayerMask(): number;
  97438. /**
  97439. * Sets the layer id use to find what meshes are not impacted by the light.
  97440. * Inactive if 0
  97441. */
  97442. set excludeWithLayerMask(value: number);
  97443. private _includeOnlyWithLayerMask;
  97444. /**
  97445. * Gets the layer id use to find what meshes are impacted by the light.
  97446. * Inactive if 0
  97447. */
  97448. get includeOnlyWithLayerMask(): number;
  97449. /**
  97450. * Sets the layer id use to find what meshes are impacted by the light.
  97451. * Inactive if 0
  97452. */
  97453. set includeOnlyWithLayerMask(value: number);
  97454. private _lightmapMode;
  97455. /**
  97456. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97457. */
  97458. get lightmapMode(): number;
  97459. /**
  97460. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97461. */
  97462. set lightmapMode(value: number);
  97463. /**
  97464. * Shadow generator associted to the light.
  97465. * @hidden Internal use only.
  97466. */
  97467. _shadowGenerator: Nullable<IShadowGenerator>;
  97468. /**
  97469. * @hidden Internal use only.
  97470. */
  97471. _excludedMeshesIds: string[];
  97472. /**
  97473. * @hidden Internal use only.
  97474. */
  97475. _includedOnlyMeshesIds: string[];
  97476. /**
  97477. * The current light unifom buffer.
  97478. * @hidden Internal use only.
  97479. */
  97480. _uniformBuffer: UniformBuffer;
  97481. /** @hidden */
  97482. _renderId: number;
  97483. /**
  97484. * Creates a Light object in the scene.
  97485. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97486. * @param name The firendly name of the light
  97487. * @param scene The scene the light belongs too
  97488. */
  97489. constructor(name: string, scene: Scene);
  97490. protected abstract _buildUniformLayout(): void;
  97491. /**
  97492. * Sets the passed Effect "effect" with the Light information.
  97493. * @param effect The effect to update
  97494. * @param lightIndex The index of the light in the effect to update
  97495. * @returns The light
  97496. */
  97497. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97498. /**
  97499. * Sets the passed Effect "effect" with the Light textures.
  97500. * @param effect The effect to update
  97501. * @param lightIndex The index of the light in the effect to update
  97502. * @returns The light
  97503. */
  97504. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97505. /**
  97506. * Binds the lights information from the scene to the effect for the given mesh.
  97507. * @param lightIndex Light index
  97508. * @param scene The scene where the light belongs to
  97509. * @param effect The effect we are binding the data to
  97510. * @param useSpecular Defines if specular is supported
  97511. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97512. */
  97513. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97514. /**
  97515. * Sets the passed Effect "effect" with the Light information.
  97516. * @param effect The effect to update
  97517. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97518. * @returns The light
  97519. */
  97520. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97521. /**
  97522. * Returns the string "Light".
  97523. * @returns the class name
  97524. */
  97525. getClassName(): string;
  97526. /** @hidden */
  97527. readonly _isLight: boolean;
  97528. /**
  97529. * Converts the light information to a readable string for debug purpose.
  97530. * @param fullDetails Supports for multiple levels of logging within scene loading
  97531. * @returns the human readable light info
  97532. */
  97533. toString(fullDetails?: boolean): string;
  97534. /** @hidden */
  97535. protected _syncParentEnabledState(): void;
  97536. /**
  97537. * Set the enabled state of this node.
  97538. * @param value - the new enabled state
  97539. */
  97540. setEnabled(value: boolean): void;
  97541. /**
  97542. * Returns the Light associated shadow generator if any.
  97543. * @return the associated shadow generator.
  97544. */
  97545. getShadowGenerator(): Nullable<IShadowGenerator>;
  97546. /**
  97547. * Returns a Vector3, the absolute light position in the World.
  97548. * @returns the world space position of the light
  97549. */
  97550. getAbsolutePosition(): Vector3;
  97551. /**
  97552. * Specifies if the light will affect the passed mesh.
  97553. * @param mesh The mesh to test against the light
  97554. * @return true the mesh is affected otherwise, false.
  97555. */
  97556. canAffectMesh(mesh: AbstractMesh): boolean;
  97557. /**
  97558. * Sort function to order lights for rendering.
  97559. * @param a First Light object to compare to second.
  97560. * @param b Second Light object to compare first.
  97561. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  97562. */
  97563. static CompareLightsPriority(a: Light, b: Light): number;
  97564. /**
  97565. * Releases resources associated with this node.
  97566. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  97567. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  97568. */
  97569. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97570. /**
  97571. * Returns the light type ID (integer).
  97572. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97573. */
  97574. getTypeID(): number;
  97575. /**
  97576. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  97577. * @returns the scaled intensity in intensity mode unit
  97578. */
  97579. getScaledIntensity(): number;
  97580. /**
  97581. * Returns a new Light object, named "name", from the current one.
  97582. * @param name The name of the cloned light
  97583. * @param newParent The parent of this light, if it has one
  97584. * @returns the new created light
  97585. */
  97586. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  97587. /**
  97588. * Serializes the current light into a Serialization object.
  97589. * @returns the serialized object.
  97590. */
  97591. serialize(): any;
  97592. /**
  97593. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  97594. * This new light is named "name" and added to the passed scene.
  97595. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  97596. * @param name The friendly name of the light
  97597. * @param scene The scene the new light will belong to
  97598. * @returns the constructor function
  97599. */
  97600. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  97601. /**
  97602. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  97603. * @param parsedLight The JSON representation of the light
  97604. * @param scene The scene to create the parsed light in
  97605. * @returns the created light after parsing
  97606. */
  97607. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  97608. private _hookArrayForExcluded;
  97609. private _hookArrayForIncludedOnly;
  97610. private _resyncMeshes;
  97611. /**
  97612. * Forces the meshes to update their light related information in their rendering used effects
  97613. * @hidden Internal Use Only
  97614. */
  97615. _markMeshesAsLightDirty(): void;
  97616. /**
  97617. * Recomputes the cached photometric scale if needed.
  97618. */
  97619. private _computePhotometricScale;
  97620. /**
  97621. * Returns the Photometric Scale according to the light type and intensity mode.
  97622. */
  97623. private _getPhotometricScale;
  97624. /**
  97625. * Reorder the light in the scene according to their defined priority.
  97626. * @hidden Internal Use Only
  97627. */
  97628. _reorderLightsInScene(): void;
  97629. /**
  97630. * Prepares the list of defines specific to the light type.
  97631. * @param defines the list of defines
  97632. * @param lightIndex defines the index of the light for the effect
  97633. */
  97634. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97635. }
  97636. }
  97637. declare module BABYLON {
  97638. /**
  97639. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  97640. * This is the base of the follow, arc rotate cameras and Free camera
  97641. * @see https://doc.babylonjs.com/features/cameras
  97642. */
  97643. export class TargetCamera extends Camera {
  97644. private static _RigCamTransformMatrix;
  97645. private static _TargetTransformMatrix;
  97646. private static _TargetFocalPoint;
  97647. private _tmpUpVector;
  97648. private _tmpTargetVector;
  97649. /**
  97650. * Define the current direction the camera is moving to
  97651. */
  97652. cameraDirection: Vector3;
  97653. /**
  97654. * Define the current rotation the camera is rotating to
  97655. */
  97656. cameraRotation: Vector2;
  97657. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  97658. ignoreParentScaling: boolean;
  97659. /**
  97660. * When set, the up vector of the camera will be updated by the rotation of the camera
  97661. */
  97662. updateUpVectorFromRotation: boolean;
  97663. private _tmpQuaternion;
  97664. /**
  97665. * Define the current rotation of the camera
  97666. */
  97667. rotation: Vector3;
  97668. /**
  97669. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  97670. */
  97671. rotationQuaternion: Quaternion;
  97672. /**
  97673. * Define the current speed of the camera
  97674. */
  97675. speed: number;
  97676. /**
  97677. * Add constraint to the camera to prevent it to move freely in all directions and
  97678. * around all axis.
  97679. */
  97680. noRotationConstraint: boolean;
  97681. /**
  97682. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  97683. * panning
  97684. */
  97685. invertRotation: boolean;
  97686. /**
  97687. * Speed multiplier for inverse camera panning
  97688. */
  97689. inverseRotationSpeed: number;
  97690. /**
  97691. * Define the current target of the camera as an object or a position.
  97692. */
  97693. lockedTarget: any;
  97694. /** @hidden */
  97695. _currentTarget: Vector3;
  97696. /** @hidden */
  97697. _initialFocalDistance: number;
  97698. /** @hidden */
  97699. _viewMatrix: Matrix;
  97700. /** @hidden */
  97701. _camMatrix: Matrix;
  97702. /** @hidden */
  97703. _cameraTransformMatrix: Matrix;
  97704. /** @hidden */
  97705. _cameraRotationMatrix: Matrix;
  97706. /** @hidden */
  97707. _referencePoint: Vector3;
  97708. /** @hidden */
  97709. _transformedReferencePoint: Vector3;
  97710. /** @hidden */
  97711. _reset: () => void;
  97712. private _defaultUp;
  97713. /**
  97714. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  97715. * This is the base of the follow, arc rotate cameras and Free camera
  97716. * @see https://doc.babylonjs.com/features/cameras
  97717. * @param name Defines the name of the camera in the scene
  97718. * @param position Defines the start position of the camera in the scene
  97719. * @param scene Defines the scene the camera belongs to
  97720. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  97721. */
  97722. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  97723. /**
  97724. * Gets the position in front of the camera at a given distance.
  97725. * @param distance The distance from the camera we want the position to be
  97726. * @returns the position
  97727. */
  97728. getFrontPosition(distance: number): Vector3;
  97729. /** @hidden */
  97730. _getLockedTargetPosition(): Nullable<Vector3>;
  97731. private _storedPosition;
  97732. private _storedRotation;
  97733. private _storedRotationQuaternion;
  97734. /**
  97735. * Store current camera state of the camera (fov, position, rotation, etc..)
  97736. * @returns the camera
  97737. */
  97738. storeState(): Camera;
  97739. /**
  97740. * Restored camera state. You must call storeState() first
  97741. * @returns whether it was successful or not
  97742. * @hidden
  97743. */
  97744. _restoreStateValues(): boolean;
  97745. /** @hidden */
  97746. _initCache(): void;
  97747. /** @hidden */
  97748. _updateCache(ignoreParentClass?: boolean): void;
  97749. /** @hidden */
  97750. _isSynchronizedViewMatrix(): boolean;
  97751. /** @hidden */
  97752. _computeLocalCameraSpeed(): number;
  97753. /**
  97754. * Defines the target the camera should look at.
  97755. * @param target Defines the new target as a Vector or a mesh
  97756. */
  97757. setTarget(target: Vector3): void;
  97758. /**
  97759. * Defines the target point of the camera.
  97760. * The camera looks towards it form the radius distance.
  97761. */
  97762. get target(): Vector3;
  97763. set target(value: Vector3);
  97764. /**
  97765. * Return the current target position of the camera. This value is expressed in local space.
  97766. * @returns the target position
  97767. */
  97768. getTarget(): Vector3;
  97769. /** @hidden */
  97770. _decideIfNeedsToMove(): boolean;
  97771. /** @hidden */
  97772. _updatePosition(): void;
  97773. /** @hidden */
  97774. _checkInputs(): void;
  97775. protected _updateCameraRotationMatrix(): void;
  97776. /**
  97777. * 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)
  97778. * @returns the current camera
  97779. */
  97780. private _rotateUpVectorWithCameraRotationMatrix;
  97781. private _cachedRotationZ;
  97782. private _cachedQuaternionRotationZ;
  97783. /** @hidden */
  97784. _getViewMatrix(): Matrix;
  97785. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  97786. /**
  97787. * @hidden
  97788. */
  97789. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  97790. /**
  97791. * @hidden
  97792. */
  97793. _updateRigCameras(): void;
  97794. private _getRigCamPositionAndTarget;
  97795. /**
  97796. * Gets the current object class name.
  97797. * @return the class name
  97798. */
  97799. getClassName(): string;
  97800. }
  97801. }
  97802. declare module BABYLON {
  97803. /**
  97804. * Gather the list of keyboard event types as constants.
  97805. */
  97806. export class KeyboardEventTypes {
  97807. /**
  97808. * The keydown event is fired when a key becomes active (pressed).
  97809. */
  97810. static readonly KEYDOWN: number;
  97811. /**
  97812. * The keyup event is fired when a key has been released.
  97813. */
  97814. static readonly KEYUP: number;
  97815. }
  97816. /**
  97817. * This class is used to store keyboard related info for the onKeyboardObservable event.
  97818. */
  97819. export class KeyboardInfo {
  97820. /**
  97821. * Defines the type of event (KeyboardEventTypes)
  97822. */
  97823. type: number;
  97824. /**
  97825. * Defines the related dom event
  97826. */
  97827. event: KeyboardEvent;
  97828. /**
  97829. * Instantiates a new keyboard info.
  97830. * This class is used to store keyboard related info for the onKeyboardObservable event.
  97831. * @param type Defines the type of event (KeyboardEventTypes)
  97832. * @param event Defines the related dom event
  97833. */
  97834. constructor(
  97835. /**
  97836. * Defines the type of event (KeyboardEventTypes)
  97837. */
  97838. type: number,
  97839. /**
  97840. * Defines the related dom event
  97841. */
  97842. event: KeyboardEvent);
  97843. }
  97844. /**
  97845. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  97846. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  97847. */
  97848. export class KeyboardInfoPre extends KeyboardInfo {
  97849. /**
  97850. * Defines the type of event (KeyboardEventTypes)
  97851. */
  97852. type: number;
  97853. /**
  97854. * Defines the related dom event
  97855. */
  97856. event: KeyboardEvent;
  97857. /**
  97858. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  97859. */
  97860. skipOnPointerObservable: boolean;
  97861. /**
  97862. * Instantiates a new keyboard pre info.
  97863. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  97864. * @param type Defines the type of event (KeyboardEventTypes)
  97865. * @param event Defines the related dom event
  97866. */
  97867. constructor(
  97868. /**
  97869. * Defines the type of event (KeyboardEventTypes)
  97870. */
  97871. type: number,
  97872. /**
  97873. * Defines the related dom event
  97874. */
  97875. event: KeyboardEvent);
  97876. }
  97877. }
  97878. declare module BABYLON {
  97879. /**
  97880. * Manage the keyboard inputs to control the movement of a free camera.
  97881. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97882. */
  97883. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  97884. /**
  97885. * Defines the camera the input is attached to.
  97886. */
  97887. camera: FreeCamera;
  97888. /**
  97889. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  97890. */
  97891. keysUp: number[];
  97892. /**
  97893. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  97894. */
  97895. keysUpward: number[];
  97896. /**
  97897. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  97898. */
  97899. keysDown: number[];
  97900. /**
  97901. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  97902. */
  97903. keysDownward: number[];
  97904. /**
  97905. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  97906. */
  97907. keysLeft: number[];
  97908. /**
  97909. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  97910. */
  97911. keysRight: number[];
  97912. private _keys;
  97913. private _onCanvasBlurObserver;
  97914. private _onKeyboardObserver;
  97915. private _engine;
  97916. private _scene;
  97917. /**
  97918. * Attach the input controls to a specific dom element to get the input from.
  97919. * @param element Defines the element the controls should be listened from
  97920. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  97921. */
  97922. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97923. /**
  97924. * Detach the current controls from the specified dom element.
  97925. * @param element Defines the element to stop listening the inputs from
  97926. */
  97927. detachControl(element: Nullable<HTMLElement>): void;
  97928. /**
  97929. * Update the current camera state depending on the inputs that have been used this frame.
  97930. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  97931. */
  97932. checkInputs(): void;
  97933. /**
  97934. * Gets the class name of the current intput.
  97935. * @returns the class name
  97936. */
  97937. getClassName(): string;
  97938. /** @hidden */
  97939. _onLostFocus(): void;
  97940. /**
  97941. * Get the friendly name associated with the input class.
  97942. * @returns the input friendly name
  97943. */
  97944. getSimpleName(): string;
  97945. }
  97946. }
  97947. declare module BABYLON {
  97948. /**
  97949. * Gather the list of pointer event types as constants.
  97950. */
  97951. export class PointerEventTypes {
  97952. /**
  97953. * 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.
  97954. */
  97955. static readonly POINTERDOWN: number;
  97956. /**
  97957. * The pointerup event is fired when a pointer is no longer active.
  97958. */
  97959. static readonly POINTERUP: number;
  97960. /**
  97961. * The pointermove event is fired when a pointer changes coordinates.
  97962. */
  97963. static readonly POINTERMOVE: number;
  97964. /**
  97965. * The pointerwheel event is fired when a mouse wheel has been rotated.
  97966. */
  97967. static readonly POINTERWHEEL: number;
  97968. /**
  97969. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  97970. */
  97971. static readonly POINTERPICK: number;
  97972. /**
  97973. * The pointertap event is fired when a the object has been touched and released without drag.
  97974. */
  97975. static readonly POINTERTAP: number;
  97976. /**
  97977. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  97978. */
  97979. static readonly POINTERDOUBLETAP: number;
  97980. }
  97981. /**
  97982. * Base class of pointer info types.
  97983. */
  97984. export class PointerInfoBase {
  97985. /**
  97986. * Defines the type of event (PointerEventTypes)
  97987. */
  97988. type: number;
  97989. /**
  97990. * Defines the related dom event
  97991. */
  97992. event: PointerEvent | MouseWheelEvent;
  97993. /**
  97994. * Instantiates the base class of pointers info.
  97995. * @param type Defines the type of event (PointerEventTypes)
  97996. * @param event Defines the related dom event
  97997. */
  97998. constructor(
  97999. /**
  98000. * Defines the type of event (PointerEventTypes)
  98001. */
  98002. type: number,
  98003. /**
  98004. * Defines the related dom event
  98005. */
  98006. event: PointerEvent | MouseWheelEvent);
  98007. }
  98008. /**
  98009. * This class is used to store pointer related info for the onPrePointerObservable event.
  98010. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98011. */
  98012. export class PointerInfoPre extends PointerInfoBase {
  98013. /**
  98014. * Ray from a pointer if availible (eg. 6dof controller)
  98015. */
  98016. ray: Nullable<Ray>;
  98017. /**
  98018. * Defines the local position of the pointer on the canvas.
  98019. */
  98020. localPosition: Vector2;
  98021. /**
  98022. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98023. */
  98024. skipOnPointerObservable: boolean;
  98025. /**
  98026. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98027. * @param type Defines the type of event (PointerEventTypes)
  98028. * @param event Defines the related dom event
  98029. * @param localX Defines the local x coordinates of the pointer when the event occured
  98030. * @param localY Defines the local y coordinates of the pointer when the event occured
  98031. */
  98032. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98033. }
  98034. /**
  98035. * This type contains all the data related to a pointer event in Babylon.js.
  98036. * 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.
  98037. */
  98038. export class PointerInfo extends PointerInfoBase {
  98039. /**
  98040. * Defines the picking info associated to the info (if any)\
  98041. */
  98042. pickInfo: Nullable<PickingInfo>;
  98043. /**
  98044. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98045. * @param type Defines the type of event (PointerEventTypes)
  98046. * @param event Defines the related dom event
  98047. * @param pickInfo Defines the picking info associated to the info (if any)\
  98048. */
  98049. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98050. /**
  98051. * Defines the picking info associated to the info (if any)\
  98052. */
  98053. pickInfo: Nullable<PickingInfo>);
  98054. }
  98055. /**
  98056. * Data relating to a touch event on the screen.
  98057. */
  98058. export interface PointerTouch {
  98059. /**
  98060. * X coordinate of touch.
  98061. */
  98062. x: number;
  98063. /**
  98064. * Y coordinate of touch.
  98065. */
  98066. y: number;
  98067. /**
  98068. * Id of touch. Unique for each finger.
  98069. */
  98070. pointerId: number;
  98071. /**
  98072. * Event type passed from DOM.
  98073. */
  98074. type: any;
  98075. }
  98076. }
  98077. declare module BABYLON {
  98078. /**
  98079. * Manage the mouse inputs to control the movement of a free camera.
  98080. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98081. */
  98082. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98083. /**
  98084. * Define if touch is enabled in the mouse input
  98085. */
  98086. touchEnabled: boolean;
  98087. /**
  98088. * Defines the camera the input is attached to.
  98089. */
  98090. camera: FreeCamera;
  98091. /**
  98092. * Defines the buttons associated with the input to handle camera move.
  98093. */
  98094. buttons: number[];
  98095. /**
  98096. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98097. */
  98098. angularSensibility: number;
  98099. private _pointerInput;
  98100. private _onMouseMove;
  98101. private _observer;
  98102. private previousPosition;
  98103. /**
  98104. * Observable for when a pointer move event occurs containing the move offset
  98105. */
  98106. onPointerMovedObservable: Observable<{
  98107. offsetX: number;
  98108. offsetY: number;
  98109. }>;
  98110. /**
  98111. * @hidden
  98112. * If the camera should be rotated automatically based on pointer movement
  98113. */
  98114. _allowCameraRotation: boolean;
  98115. /**
  98116. * Manage the mouse inputs to control the movement of a free camera.
  98117. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98118. * @param touchEnabled Defines if touch is enabled or not
  98119. */
  98120. constructor(
  98121. /**
  98122. * Define if touch is enabled in the mouse input
  98123. */
  98124. touchEnabled?: boolean);
  98125. /**
  98126. * Attach the input controls to a specific dom element to get the input from.
  98127. * @param element Defines the element the controls should be listened from
  98128. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98129. */
  98130. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98131. /**
  98132. * Called on JS contextmenu event.
  98133. * Override this method to provide functionality.
  98134. */
  98135. protected onContextMenu(evt: PointerEvent): void;
  98136. /**
  98137. * Detach the current controls from the specified dom element.
  98138. * @param element Defines the element to stop listening the inputs from
  98139. */
  98140. detachControl(element: Nullable<HTMLElement>): void;
  98141. /**
  98142. * Gets the class name of the current intput.
  98143. * @returns the class name
  98144. */
  98145. getClassName(): string;
  98146. /**
  98147. * Get the friendly name associated with the input class.
  98148. * @returns the input friendly name
  98149. */
  98150. getSimpleName(): string;
  98151. }
  98152. }
  98153. declare module BABYLON {
  98154. /**
  98155. * Manage the touch inputs to control the movement of a free camera.
  98156. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98157. */
  98158. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98159. /**
  98160. * Define if mouse events can be treated as touch events
  98161. */
  98162. allowMouse: boolean;
  98163. /**
  98164. * Defines the camera the input is attached to.
  98165. */
  98166. camera: FreeCamera;
  98167. /**
  98168. * Defines the touch sensibility for rotation.
  98169. * The higher the faster.
  98170. */
  98171. touchAngularSensibility: number;
  98172. /**
  98173. * Defines the touch sensibility for move.
  98174. * The higher the faster.
  98175. */
  98176. touchMoveSensibility: number;
  98177. private _offsetX;
  98178. private _offsetY;
  98179. private _pointerPressed;
  98180. private _pointerInput;
  98181. private _observer;
  98182. private _onLostFocus;
  98183. /**
  98184. * Manage the touch inputs to control the movement of a free camera.
  98185. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98186. * @param allowMouse Defines if mouse events can be treated as touch events
  98187. */
  98188. constructor(
  98189. /**
  98190. * Define if mouse events can be treated as touch events
  98191. */
  98192. allowMouse?: boolean);
  98193. /**
  98194. * Attach the input controls to a specific dom element to get the input from.
  98195. * @param element Defines the element the controls should be listened from
  98196. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98197. */
  98198. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98199. /**
  98200. * Detach the current controls from the specified dom element.
  98201. * @param element Defines the element to stop listening the inputs from
  98202. */
  98203. detachControl(element: Nullable<HTMLElement>): void;
  98204. /**
  98205. * Update the current camera state depending on the inputs that have been used this frame.
  98206. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98207. */
  98208. checkInputs(): void;
  98209. /**
  98210. * Gets the class name of the current intput.
  98211. * @returns the class name
  98212. */
  98213. getClassName(): string;
  98214. /**
  98215. * Get the friendly name associated with the input class.
  98216. * @returns the input friendly name
  98217. */
  98218. getSimpleName(): string;
  98219. }
  98220. }
  98221. declare module BABYLON {
  98222. /**
  98223. * Default Inputs manager for the FreeCamera.
  98224. * It groups all the default supported inputs for ease of use.
  98225. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98226. */
  98227. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98228. /**
  98229. * @hidden
  98230. */
  98231. _mouseInput: Nullable<FreeCameraMouseInput>;
  98232. /**
  98233. * Instantiates a new FreeCameraInputsManager.
  98234. * @param camera Defines the camera the inputs belong to
  98235. */
  98236. constructor(camera: FreeCamera);
  98237. /**
  98238. * Add keyboard input support to the input manager.
  98239. * @returns the current input manager
  98240. */
  98241. addKeyboard(): FreeCameraInputsManager;
  98242. /**
  98243. * Add mouse input support to the input manager.
  98244. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98245. * @returns the current input manager
  98246. */
  98247. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98248. /**
  98249. * Removes the mouse input support from the manager
  98250. * @returns the current input manager
  98251. */
  98252. removeMouse(): FreeCameraInputsManager;
  98253. /**
  98254. * Add touch input support to the input manager.
  98255. * @returns the current input manager
  98256. */
  98257. addTouch(): FreeCameraInputsManager;
  98258. /**
  98259. * Remove all attached input methods from a camera
  98260. */
  98261. clear(): void;
  98262. }
  98263. }
  98264. declare module BABYLON {
  98265. /**
  98266. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98267. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98268. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98269. */
  98270. export class FreeCamera extends TargetCamera {
  98271. /**
  98272. * Define the collision ellipsoid of the camera.
  98273. * This is helpful to simulate a camera body like the player body around the camera
  98274. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98275. */
  98276. ellipsoid: Vector3;
  98277. /**
  98278. * Define an offset for the position of the ellipsoid around the camera.
  98279. * This can be helpful to determine the center of the body near the gravity center of the body
  98280. * instead of its head.
  98281. */
  98282. ellipsoidOffset: Vector3;
  98283. /**
  98284. * Enable or disable collisions of the camera with the rest of the scene objects.
  98285. */
  98286. checkCollisions: boolean;
  98287. /**
  98288. * Enable or disable gravity on the camera.
  98289. */
  98290. applyGravity: boolean;
  98291. /**
  98292. * Define the input manager associated to the camera.
  98293. */
  98294. inputs: FreeCameraInputsManager;
  98295. /**
  98296. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98297. * Higher values reduce sensitivity.
  98298. */
  98299. get angularSensibility(): number;
  98300. /**
  98301. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98302. * Higher values reduce sensitivity.
  98303. */
  98304. set angularSensibility(value: number);
  98305. /**
  98306. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98307. */
  98308. get keysUp(): number[];
  98309. set keysUp(value: number[]);
  98310. /**
  98311. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98312. */
  98313. get keysUpward(): number[];
  98314. set keysUpward(value: number[]);
  98315. /**
  98316. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98317. */
  98318. get keysDown(): number[];
  98319. set keysDown(value: number[]);
  98320. /**
  98321. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98322. */
  98323. get keysDownward(): number[];
  98324. set keysDownward(value: number[]);
  98325. /**
  98326. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98327. */
  98328. get keysLeft(): number[];
  98329. set keysLeft(value: number[]);
  98330. /**
  98331. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98332. */
  98333. get keysRight(): number[];
  98334. set keysRight(value: number[]);
  98335. /**
  98336. * Event raised when the camera collide with a mesh in the scene.
  98337. */
  98338. onCollide: (collidedMesh: AbstractMesh) => void;
  98339. private _collider;
  98340. private _needMoveForGravity;
  98341. private _oldPosition;
  98342. private _diffPosition;
  98343. private _newPosition;
  98344. /** @hidden */
  98345. _localDirection: Vector3;
  98346. /** @hidden */
  98347. _transformedDirection: Vector3;
  98348. /**
  98349. * Instantiates a Free Camera.
  98350. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98351. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98352. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98353. * @param name Define the name of the camera in the scene
  98354. * @param position Define the start position of the camera in the scene
  98355. * @param scene Define the scene the camera belongs to
  98356. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98357. */
  98358. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98359. /**
  98360. * Attached controls to the current camera.
  98361. * @param element Defines the element the controls should be listened from
  98362. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98363. */
  98364. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98365. /**
  98366. * Detach the current controls from the camera.
  98367. * The camera will stop reacting to inputs.
  98368. * @param element Defines the element to stop listening the inputs from
  98369. */
  98370. detachControl(element: HTMLElement): void;
  98371. private _collisionMask;
  98372. /**
  98373. * Define a collision mask to limit the list of object the camera can collide with
  98374. */
  98375. get collisionMask(): number;
  98376. set collisionMask(mask: number);
  98377. /** @hidden */
  98378. _collideWithWorld(displacement: Vector3): void;
  98379. private _onCollisionPositionChange;
  98380. /** @hidden */
  98381. _checkInputs(): void;
  98382. /** @hidden */
  98383. _decideIfNeedsToMove(): boolean;
  98384. /** @hidden */
  98385. _updatePosition(): void;
  98386. /**
  98387. * Destroy the camera and release the current resources hold by it.
  98388. */
  98389. dispose(): void;
  98390. /**
  98391. * Gets the current object class name.
  98392. * @return the class name
  98393. */
  98394. getClassName(): string;
  98395. }
  98396. }
  98397. declare module BABYLON {
  98398. /**
  98399. * Represents a gamepad control stick position
  98400. */
  98401. export class StickValues {
  98402. /**
  98403. * The x component of the control stick
  98404. */
  98405. x: number;
  98406. /**
  98407. * The y component of the control stick
  98408. */
  98409. y: number;
  98410. /**
  98411. * Initializes the gamepad x and y control stick values
  98412. * @param x The x component of the gamepad control stick value
  98413. * @param y The y component of the gamepad control stick value
  98414. */
  98415. constructor(
  98416. /**
  98417. * The x component of the control stick
  98418. */
  98419. x: number,
  98420. /**
  98421. * The y component of the control stick
  98422. */
  98423. y: number);
  98424. }
  98425. /**
  98426. * An interface which manages callbacks for gamepad button changes
  98427. */
  98428. export interface GamepadButtonChanges {
  98429. /**
  98430. * Called when a gamepad has been changed
  98431. */
  98432. changed: boolean;
  98433. /**
  98434. * Called when a gamepad press event has been triggered
  98435. */
  98436. pressChanged: boolean;
  98437. /**
  98438. * Called when a touch event has been triggered
  98439. */
  98440. touchChanged: boolean;
  98441. /**
  98442. * Called when a value has changed
  98443. */
  98444. valueChanged: boolean;
  98445. }
  98446. /**
  98447. * Represents a gamepad
  98448. */
  98449. export class Gamepad {
  98450. /**
  98451. * The id of the gamepad
  98452. */
  98453. id: string;
  98454. /**
  98455. * The index of the gamepad
  98456. */
  98457. index: number;
  98458. /**
  98459. * The browser gamepad
  98460. */
  98461. browserGamepad: any;
  98462. /**
  98463. * Specifies what type of gamepad this represents
  98464. */
  98465. type: number;
  98466. private _leftStick;
  98467. private _rightStick;
  98468. /** @hidden */
  98469. _isConnected: boolean;
  98470. private _leftStickAxisX;
  98471. private _leftStickAxisY;
  98472. private _rightStickAxisX;
  98473. private _rightStickAxisY;
  98474. /**
  98475. * Triggered when the left control stick has been changed
  98476. */
  98477. private _onleftstickchanged;
  98478. /**
  98479. * Triggered when the right control stick has been changed
  98480. */
  98481. private _onrightstickchanged;
  98482. /**
  98483. * Represents a gamepad controller
  98484. */
  98485. static GAMEPAD: number;
  98486. /**
  98487. * Represents a generic controller
  98488. */
  98489. static GENERIC: number;
  98490. /**
  98491. * Represents an XBox controller
  98492. */
  98493. static XBOX: number;
  98494. /**
  98495. * Represents a pose-enabled controller
  98496. */
  98497. static POSE_ENABLED: number;
  98498. /**
  98499. * Represents an Dual Shock controller
  98500. */
  98501. static DUALSHOCK: number;
  98502. /**
  98503. * Specifies whether the left control stick should be Y-inverted
  98504. */
  98505. protected _invertLeftStickY: boolean;
  98506. /**
  98507. * Specifies if the gamepad has been connected
  98508. */
  98509. get isConnected(): boolean;
  98510. /**
  98511. * Initializes the gamepad
  98512. * @param id The id of the gamepad
  98513. * @param index The index of the gamepad
  98514. * @param browserGamepad The browser gamepad
  98515. * @param leftStickX The x component of the left joystick
  98516. * @param leftStickY The y component of the left joystick
  98517. * @param rightStickX The x component of the right joystick
  98518. * @param rightStickY The y component of the right joystick
  98519. */
  98520. constructor(
  98521. /**
  98522. * The id of the gamepad
  98523. */
  98524. id: string,
  98525. /**
  98526. * The index of the gamepad
  98527. */
  98528. index: number,
  98529. /**
  98530. * The browser gamepad
  98531. */
  98532. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98533. /**
  98534. * Callback triggered when the left joystick has changed
  98535. * @param callback
  98536. */
  98537. onleftstickchanged(callback: (values: StickValues) => void): void;
  98538. /**
  98539. * Callback triggered when the right joystick has changed
  98540. * @param callback
  98541. */
  98542. onrightstickchanged(callback: (values: StickValues) => void): void;
  98543. /**
  98544. * Gets the left joystick
  98545. */
  98546. get leftStick(): StickValues;
  98547. /**
  98548. * Sets the left joystick values
  98549. */
  98550. set leftStick(newValues: StickValues);
  98551. /**
  98552. * Gets the right joystick
  98553. */
  98554. get rightStick(): StickValues;
  98555. /**
  98556. * Sets the right joystick value
  98557. */
  98558. set rightStick(newValues: StickValues);
  98559. /**
  98560. * Updates the gamepad joystick positions
  98561. */
  98562. update(): void;
  98563. /**
  98564. * Disposes the gamepad
  98565. */
  98566. dispose(): void;
  98567. }
  98568. /**
  98569. * Represents a generic gamepad
  98570. */
  98571. export class GenericPad extends Gamepad {
  98572. private _buttons;
  98573. private _onbuttondown;
  98574. private _onbuttonup;
  98575. /**
  98576. * Observable triggered when a button has been pressed
  98577. */
  98578. onButtonDownObservable: Observable<number>;
  98579. /**
  98580. * Observable triggered when a button has been released
  98581. */
  98582. onButtonUpObservable: Observable<number>;
  98583. /**
  98584. * Callback triggered when a button has been pressed
  98585. * @param callback Called when a button has been pressed
  98586. */
  98587. onbuttondown(callback: (buttonPressed: number) => void): void;
  98588. /**
  98589. * Callback triggered when a button has been released
  98590. * @param callback Called when a button has been released
  98591. */
  98592. onbuttonup(callback: (buttonReleased: number) => void): void;
  98593. /**
  98594. * Initializes the generic gamepad
  98595. * @param id The id of the generic gamepad
  98596. * @param index The index of the generic gamepad
  98597. * @param browserGamepad The browser gamepad
  98598. */
  98599. constructor(id: string, index: number, browserGamepad: any);
  98600. private _setButtonValue;
  98601. /**
  98602. * Updates the generic gamepad
  98603. */
  98604. update(): void;
  98605. /**
  98606. * Disposes the generic gamepad
  98607. */
  98608. dispose(): void;
  98609. }
  98610. }
  98611. declare module BABYLON {
  98612. /**
  98613. * Defines the types of pose enabled controllers that are supported
  98614. */
  98615. export enum PoseEnabledControllerType {
  98616. /**
  98617. * HTC Vive
  98618. */
  98619. VIVE = 0,
  98620. /**
  98621. * Oculus Rift
  98622. */
  98623. OCULUS = 1,
  98624. /**
  98625. * Windows mixed reality
  98626. */
  98627. WINDOWS = 2,
  98628. /**
  98629. * Samsung gear VR
  98630. */
  98631. GEAR_VR = 3,
  98632. /**
  98633. * Google Daydream
  98634. */
  98635. DAYDREAM = 4,
  98636. /**
  98637. * Generic
  98638. */
  98639. GENERIC = 5
  98640. }
  98641. /**
  98642. * Defines the MutableGamepadButton interface for the state of a gamepad button
  98643. */
  98644. export interface MutableGamepadButton {
  98645. /**
  98646. * Value of the button/trigger
  98647. */
  98648. value: number;
  98649. /**
  98650. * If the button/trigger is currently touched
  98651. */
  98652. touched: boolean;
  98653. /**
  98654. * If the button/trigger is currently pressed
  98655. */
  98656. pressed: boolean;
  98657. }
  98658. /**
  98659. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  98660. * @hidden
  98661. */
  98662. export interface ExtendedGamepadButton extends GamepadButton {
  98663. /**
  98664. * If the button/trigger is currently pressed
  98665. */
  98666. readonly pressed: boolean;
  98667. /**
  98668. * If the button/trigger is currently touched
  98669. */
  98670. readonly touched: boolean;
  98671. /**
  98672. * Value of the button/trigger
  98673. */
  98674. readonly value: number;
  98675. }
  98676. /** @hidden */
  98677. export interface _GamePadFactory {
  98678. /**
  98679. * Returns whether or not the current gamepad can be created for this type of controller.
  98680. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  98681. * @returns true if it can be created, otherwise false
  98682. */
  98683. canCreate(gamepadInfo: any): boolean;
  98684. /**
  98685. * Creates a new instance of the Gamepad.
  98686. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  98687. * @returns the new gamepad instance
  98688. */
  98689. create(gamepadInfo: any): Gamepad;
  98690. }
  98691. /**
  98692. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  98693. */
  98694. export class PoseEnabledControllerHelper {
  98695. /** @hidden */
  98696. static _ControllerFactories: _GamePadFactory[];
  98697. /** @hidden */
  98698. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  98699. /**
  98700. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  98701. * @param vrGamepad the gamepad to initialized
  98702. * @returns a vr controller of the type the gamepad identified as
  98703. */
  98704. static InitiateController(vrGamepad: any): Gamepad;
  98705. }
  98706. /**
  98707. * Defines the PoseEnabledController object that contains state of a vr capable controller
  98708. */
  98709. export class PoseEnabledController extends Gamepad implements PoseControlled {
  98710. /**
  98711. * If the controller is used in a webXR session
  98712. */
  98713. isXR: boolean;
  98714. private _deviceRoomPosition;
  98715. private _deviceRoomRotationQuaternion;
  98716. /**
  98717. * The device position in babylon space
  98718. */
  98719. devicePosition: Vector3;
  98720. /**
  98721. * The device rotation in babylon space
  98722. */
  98723. deviceRotationQuaternion: Quaternion;
  98724. /**
  98725. * The scale factor of the device in babylon space
  98726. */
  98727. deviceScaleFactor: number;
  98728. /**
  98729. * (Likely devicePosition should be used instead) The device position in its room space
  98730. */
  98731. position: Vector3;
  98732. /**
  98733. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  98734. */
  98735. rotationQuaternion: Quaternion;
  98736. /**
  98737. * The type of controller (Eg. Windows mixed reality)
  98738. */
  98739. controllerType: PoseEnabledControllerType;
  98740. protected _calculatedPosition: Vector3;
  98741. private _calculatedRotation;
  98742. /**
  98743. * The raw pose from the device
  98744. */
  98745. rawPose: DevicePose;
  98746. private _trackPosition;
  98747. private _maxRotationDistFromHeadset;
  98748. private _draggedRoomRotation;
  98749. /**
  98750. * @hidden
  98751. */
  98752. _disableTrackPosition(fixedPosition: Vector3): void;
  98753. /**
  98754. * Internal, the mesh attached to the controller
  98755. * @hidden
  98756. */
  98757. _mesh: Nullable<AbstractMesh>;
  98758. private _poseControlledCamera;
  98759. private _leftHandSystemQuaternion;
  98760. /**
  98761. * Internal, matrix used to convert room space to babylon space
  98762. * @hidden
  98763. */
  98764. _deviceToWorld: Matrix;
  98765. /**
  98766. * Node to be used when casting a ray from the controller
  98767. * @hidden
  98768. */
  98769. _pointingPoseNode: Nullable<TransformNode>;
  98770. /**
  98771. * Name of the child mesh that can be used to cast a ray from the controller
  98772. */
  98773. static readonly POINTING_POSE: string;
  98774. /**
  98775. * Creates a new PoseEnabledController from a gamepad
  98776. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  98777. */
  98778. constructor(browserGamepad: any);
  98779. private _workingMatrix;
  98780. /**
  98781. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  98782. */
  98783. update(): void;
  98784. /**
  98785. * Updates only the pose device and mesh without doing any button event checking
  98786. */
  98787. protected _updatePoseAndMesh(): void;
  98788. /**
  98789. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  98790. * @param poseData raw pose fromthe device
  98791. */
  98792. updateFromDevice(poseData: DevicePose): void;
  98793. /**
  98794. * @hidden
  98795. */
  98796. _meshAttachedObservable: Observable<AbstractMesh>;
  98797. /**
  98798. * Attaches a mesh to the controller
  98799. * @param mesh the mesh to be attached
  98800. */
  98801. attachToMesh(mesh: AbstractMesh): void;
  98802. /**
  98803. * Attaches the controllers mesh to a camera
  98804. * @param camera the camera the mesh should be attached to
  98805. */
  98806. attachToPoseControlledCamera(camera: TargetCamera): void;
  98807. /**
  98808. * Disposes of the controller
  98809. */
  98810. dispose(): void;
  98811. /**
  98812. * The mesh that is attached to the controller
  98813. */
  98814. get mesh(): Nullable<AbstractMesh>;
  98815. /**
  98816. * Gets the ray of the controller in the direction the controller is pointing
  98817. * @param length the length the resulting ray should be
  98818. * @returns a ray in the direction the controller is pointing
  98819. */
  98820. getForwardRay(length?: number): Ray;
  98821. }
  98822. }
  98823. declare module BABYLON {
  98824. /**
  98825. * Defines the WebVRController object that represents controllers tracked in 3D space
  98826. */
  98827. export abstract class WebVRController extends PoseEnabledController {
  98828. /**
  98829. * Internal, the default controller model for the controller
  98830. */
  98831. protected _defaultModel: Nullable<AbstractMesh>;
  98832. /**
  98833. * Fired when the trigger state has changed
  98834. */
  98835. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  98836. /**
  98837. * Fired when the main button state has changed
  98838. */
  98839. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  98840. /**
  98841. * Fired when the secondary button state has changed
  98842. */
  98843. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  98844. /**
  98845. * Fired when the pad state has changed
  98846. */
  98847. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  98848. /**
  98849. * Fired when controllers stick values have changed
  98850. */
  98851. onPadValuesChangedObservable: Observable<StickValues>;
  98852. /**
  98853. * Array of button availible on the controller
  98854. */
  98855. protected _buttons: Array<MutableGamepadButton>;
  98856. private _onButtonStateChange;
  98857. /**
  98858. * Fired when a controller button's state has changed
  98859. * @param callback the callback containing the button that was modified
  98860. */
  98861. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  98862. /**
  98863. * X and Y axis corresponding to the controllers joystick
  98864. */
  98865. pad: StickValues;
  98866. /**
  98867. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  98868. */
  98869. hand: string;
  98870. /**
  98871. * The default controller model for the controller
  98872. */
  98873. get defaultModel(): Nullable<AbstractMesh>;
  98874. /**
  98875. * Creates a new WebVRController from a gamepad
  98876. * @param vrGamepad the gamepad that the WebVRController should be created from
  98877. */
  98878. constructor(vrGamepad: any);
  98879. /**
  98880. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  98881. */
  98882. update(): void;
  98883. /**
  98884. * Function to be called when a button is modified
  98885. */
  98886. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  98887. /**
  98888. * Loads a mesh and attaches it to the controller
  98889. * @param scene the scene the mesh should be added to
  98890. * @param meshLoaded callback for when the mesh has been loaded
  98891. */
  98892. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  98893. private _setButtonValue;
  98894. private _changes;
  98895. private _checkChanges;
  98896. /**
  98897. * Disposes of th webVRCOntroller
  98898. */
  98899. dispose(): void;
  98900. }
  98901. }
  98902. declare module BABYLON {
  98903. /**
  98904. * The HemisphericLight simulates the ambient environment light,
  98905. * so the passed direction is the light reflection direction, not the incoming direction.
  98906. */
  98907. export class HemisphericLight extends Light {
  98908. /**
  98909. * The groundColor is the light in the opposite direction to the one specified during creation.
  98910. * 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.
  98911. */
  98912. groundColor: Color3;
  98913. /**
  98914. * The light reflection direction, not the incoming direction.
  98915. */
  98916. direction: Vector3;
  98917. /**
  98918. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  98919. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  98920. * The HemisphericLight can't cast shadows.
  98921. * Documentation : https://doc.babylonjs.com/babylon101/lights
  98922. * @param name The friendly name of the light
  98923. * @param direction The direction of the light reflection
  98924. * @param scene The scene the light belongs to
  98925. */
  98926. constructor(name: string, direction: Vector3, scene: Scene);
  98927. protected _buildUniformLayout(): void;
  98928. /**
  98929. * Returns the string "HemisphericLight".
  98930. * @return The class name
  98931. */
  98932. getClassName(): string;
  98933. /**
  98934. * Sets the HemisphericLight direction towards the passed target (Vector3).
  98935. * Returns the updated direction.
  98936. * @param target The target the direction should point to
  98937. * @return The computed direction
  98938. */
  98939. setDirectionToTarget(target: Vector3): Vector3;
  98940. /**
  98941. * Returns the shadow generator associated to the light.
  98942. * @returns Always null for hemispheric lights because it does not support shadows.
  98943. */
  98944. getShadowGenerator(): Nullable<IShadowGenerator>;
  98945. /**
  98946. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  98947. * @param effect The effect to update
  98948. * @param lightIndex The index of the light in the effect to update
  98949. * @returns The hemispheric light
  98950. */
  98951. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  98952. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  98953. /**
  98954. * Computes the world matrix of the node
  98955. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  98956. * @param useWasUpdatedFlag defines a reserved property
  98957. * @returns the world matrix
  98958. */
  98959. computeWorldMatrix(): Matrix;
  98960. /**
  98961. * Returns the integer 3.
  98962. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  98963. */
  98964. getTypeID(): number;
  98965. /**
  98966. * Prepares the list of defines specific to the light type.
  98967. * @param defines the list of defines
  98968. * @param lightIndex defines the index of the light for the effect
  98969. */
  98970. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  98971. }
  98972. }
  98973. declare module BABYLON {
  98974. /** @hidden */
  98975. export var vrMultiviewToSingleviewPixelShader: {
  98976. name: string;
  98977. shader: string;
  98978. };
  98979. }
  98980. declare module BABYLON {
  98981. /**
  98982. * Renders to multiple views with a single draw call
  98983. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  98984. */
  98985. export class MultiviewRenderTarget extends RenderTargetTexture {
  98986. /**
  98987. * Creates a multiview render target
  98988. * @param scene scene used with the render target
  98989. * @param size the size of the render target (used for each view)
  98990. */
  98991. constructor(scene: Scene, size?: number | {
  98992. width: number;
  98993. height: number;
  98994. } | {
  98995. ratio: number;
  98996. });
  98997. /**
  98998. * @hidden
  98999. * @param faceIndex the face index, if its a cube texture
  99000. */
  99001. _bindFrameBuffer(faceIndex?: number): void;
  99002. /**
  99003. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99004. * @returns the view count
  99005. */
  99006. getViewCount(): number;
  99007. }
  99008. }
  99009. declare module BABYLON {
  99010. interface Engine {
  99011. /**
  99012. * Creates a new multiview render target
  99013. * @param width defines the width of the texture
  99014. * @param height defines the height of the texture
  99015. * @returns the created multiview texture
  99016. */
  99017. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99018. /**
  99019. * Binds a multiview framebuffer to be drawn to
  99020. * @param multiviewTexture texture to bind
  99021. */
  99022. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99023. }
  99024. interface Camera {
  99025. /**
  99026. * @hidden
  99027. * 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)
  99028. */
  99029. _useMultiviewToSingleView: boolean;
  99030. /**
  99031. * @hidden
  99032. * 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)
  99033. */
  99034. _multiviewTexture: Nullable<RenderTargetTexture>;
  99035. /**
  99036. * @hidden
  99037. * ensures the multiview texture of the camera exists and has the specified width/height
  99038. * @param width height to set on the multiview texture
  99039. * @param height width to set on the multiview texture
  99040. */
  99041. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99042. }
  99043. interface Scene {
  99044. /** @hidden */
  99045. _transformMatrixR: Matrix;
  99046. /** @hidden */
  99047. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99048. /** @hidden */
  99049. _createMultiviewUbo(): void;
  99050. /** @hidden */
  99051. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99052. /** @hidden */
  99053. _renderMultiviewToSingleView(camera: Camera): void;
  99054. }
  99055. }
  99056. declare module BABYLON {
  99057. /**
  99058. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99059. * This will not be used for webXR as it supports displaying texture arrays directly
  99060. */
  99061. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99062. /**
  99063. * Gets a string identifying the name of the class
  99064. * @returns "VRMultiviewToSingleviewPostProcess" string
  99065. */
  99066. getClassName(): string;
  99067. /**
  99068. * Initializes a VRMultiviewToSingleview
  99069. * @param name name of the post process
  99070. * @param camera camera to be applied to
  99071. * @param scaleFactor scaling factor to the size of the output texture
  99072. */
  99073. constructor(name: string, camera: Camera, scaleFactor: number);
  99074. }
  99075. }
  99076. declare module BABYLON {
  99077. /**
  99078. * Interface used to define additional presentation attributes
  99079. */
  99080. export interface IVRPresentationAttributes {
  99081. /**
  99082. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99083. */
  99084. highRefreshRate: boolean;
  99085. /**
  99086. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99087. */
  99088. foveationLevel: number;
  99089. }
  99090. interface Engine {
  99091. /** @hidden */
  99092. _vrDisplay: any;
  99093. /** @hidden */
  99094. _vrSupported: boolean;
  99095. /** @hidden */
  99096. _oldSize: Size;
  99097. /** @hidden */
  99098. _oldHardwareScaleFactor: number;
  99099. /** @hidden */
  99100. _vrExclusivePointerMode: boolean;
  99101. /** @hidden */
  99102. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99103. /** @hidden */
  99104. _onVRDisplayPointerRestricted: () => void;
  99105. /** @hidden */
  99106. _onVRDisplayPointerUnrestricted: () => void;
  99107. /** @hidden */
  99108. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99109. /** @hidden */
  99110. _onVrDisplayDisconnect: Nullable<() => void>;
  99111. /** @hidden */
  99112. _onVrDisplayPresentChange: Nullable<() => void>;
  99113. /**
  99114. * Observable signaled when VR display mode changes
  99115. */
  99116. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99117. /**
  99118. * Observable signaled when VR request present is complete
  99119. */
  99120. onVRRequestPresentComplete: Observable<boolean>;
  99121. /**
  99122. * Observable signaled when VR request present starts
  99123. */
  99124. onVRRequestPresentStart: Observable<Engine>;
  99125. /**
  99126. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99127. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99128. */
  99129. isInVRExclusivePointerMode: boolean;
  99130. /**
  99131. * Gets a boolean indicating if a webVR device was detected
  99132. * @returns true if a webVR device was detected
  99133. */
  99134. isVRDevicePresent(): boolean;
  99135. /**
  99136. * Gets the current webVR device
  99137. * @returns the current webVR device (or null)
  99138. */
  99139. getVRDevice(): any;
  99140. /**
  99141. * Initializes a webVR display and starts listening to display change events
  99142. * The onVRDisplayChangedObservable will be notified upon these changes
  99143. * @returns A promise containing a VRDisplay and if vr is supported
  99144. */
  99145. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99146. /** @hidden */
  99147. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99148. /**
  99149. * Gets or sets the presentation attributes used to configure VR rendering
  99150. */
  99151. vrPresentationAttributes?: IVRPresentationAttributes;
  99152. /**
  99153. * Call this function to switch to webVR mode
  99154. * Will do nothing if webVR is not supported or if there is no webVR device
  99155. * @param options the webvr options provided to the camera. mainly used for multiview
  99156. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99157. */
  99158. enableVR(options: WebVROptions): void;
  99159. /** @hidden */
  99160. _onVRFullScreenTriggered(): void;
  99161. }
  99162. }
  99163. declare module BABYLON {
  99164. /**
  99165. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99166. * IMPORTANT!! The data is right-hand data.
  99167. * @export
  99168. * @interface DevicePose
  99169. */
  99170. export interface DevicePose {
  99171. /**
  99172. * The position of the device, values in array are [x,y,z].
  99173. */
  99174. readonly position: Nullable<Float32Array>;
  99175. /**
  99176. * The linearVelocity of the device, values in array are [x,y,z].
  99177. */
  99178. readonly linearVelocity: Nullable<Float32Array>;
  99179. /**
  99180. * The linearAcceleration of the device, values in array are [x,y,z].
  99181. */
  99182. readonly linearAcceleration: Nullable<Float32Array>;
  99183. /**
  99184. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99185. */
  99186. readonly orientation: Nullable<Float32Array>;
  99187. /**
  99188. * The angularVelocity of the device, values in array are [x,y,z].
  99189. */
  99190. readonly angularVelocity: Nullable<Float32Array>;
  99191. /**
  99192. * The angularAcceleration of the device, values in array are [x,y,z].
  99193. */
  99194. readonly angularAcceleration: Nullable<Float32Array>;
  99195. }
  99196. /**
  99197. * Interface representing a pose controlled object in Babylon.
  99198. * A pose controlled object has both regular pose values as well as pose values
  99199. * from an external device such as a VR head mounted display
  99200. */
  99201. export interface PoseControlled {
  99202. /**
  99203. * The position of the object in babylon space.
  99204. */
  99205. position: Vector3;
  99206. /**
  99207. * The rotation quaternion of the object in babylon space.
  99208. */
  99209. rotationQuaternion: Quaternion;
  99210. /**
  99211. * The position of the device in babylon space.
  99212. */
  99213. devicePosition?: Vector3;
  99214. /**
  99215. * The rotation quaternion of the device in babylon space.
  99216. */
  99217. deviceRotationQuaternion: Quaternion;
  99218. /**
  99219. * The raw pose coming from the device.
  99220. */
  99221. rawPose: Nullable<DevicePose>;
  99222. /**
  99223. * The scale of the device to be used when translating from device space to babylon space.
  99224. */
  99225. deviceScaleFactor: number;
  99226. /**
  99227. * Updates the poseControlled values based on the input device pose.
  99228. * @param poseData the pose data to update the object with
  99229. */
  99230. updateFromDevice(poseData: DevicePose): void;
  99231. }
  99232. /**
  99233. * Set of options to customize the webVRCamera
  99234. */
  99235. export interface WebVROptions {
  99236. /**
  99237. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99238. */
  99239. trackPosition?: boolean;
  99240. /**
  99241. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99242. */
  99243. positionScale?: number;
  99244. /**
  99245. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99246. */
  99247. displayName?: string;
  99248. /**
  99249. * Should the native controller meshes be initialized. (default: true)
  99250. */
  99251. controllerMeshes?: boolean;
  99252. /**
  99253. * Creating a default HemiLight only on controllers. (default: true)
  99254. */
  99255. defaultLightingOnControllers?: boolean;
  99256. /**
  99257. * If you don't want to use the default VR button of the helper. (default: false)
  99258. */
  99259. useCustomVRButton?: boolean;
  99260. /**
  99261. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99262. */
  99263. customVRButton?: HTMLButtonElement;
  99264. /**
  99265. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99266. */
  99267. rayLength?: number;
  99268. /**
  99269. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99270. */
  99271. defaultHeight?: number;
  99272. /**
  99273. * If multiview should be used if availible (default: false)
  99274. */
  99275. useMultiview?: boolean;
  99276. }
  99277. /**
  99278. * This represents a WebVR camera.
  99279. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99280. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99281. */
  99282. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99283. private webVROptions;
  99284. /**
  99285. * @hidden
  99286. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99287. */
  99288. _vrDevice: any;
  99289. /**
  99290. * The rawPose of the vrDevice.
  99291. */
  99292. rawPose: Nullable<DevicePose>;
  99293. private _onVREnabled;
  99294. private _specsVersion;
  99295. private _attached;
  99296. private _frameData;
  99297. protected _descendants: Array<Node>;
  99298. private _deviceRoomPosition;
  99299. /** @hidden */
  99300. _deviceRoomRotationQuaternion: Quaternion;
  99301. private _standingMatrix;
  99302. /**
  99303. * Represents device position in babylon space.
  99304. */
  99305. devicePosition: Vector3;
  99306. /**
  99307. * Represents device rotation in babylon space.
  99308. */
  99309. deviceRotationQuaternion: Quaternion;
  99310. /**
  99311. * The scale of the device to be used when translating from device space to babylon space.
  99312. */
  99313. deviceScaleFactor: number;
  99314. private _deviceToWorld;
  99315. private _worldToDevice;
  99316. /**
  99317. * References to the webVR controllers for the vrDevice.
  99318. */
  99319. controllers: Array<WebVRController>;
  99320. /**
  99321. * Emits an event when a controller is attached.
  99322. */
  99323. onControllersAttachedObservable: Observable<WebVRController[]>;
  99324. /**
  99325. * Emits an event when a controller's mesh has been loaded;
  99326. */
  99327. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99328. /**
  99329. * Emits an event when the HMD's pose has been updated.
  99330. */
  99331. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99332. private _poseSet;
  99333. /**
  99334. * If the rig cameras be used as parent instead of this camera.
  99335. */
  99336. rigParenting: boolean;
  99337. private _lightOnControllers;
  99338. private _defaultHeight?;
  99339. /**
  99340. * Instantiates a WebVRFreeCamera.
  99341. * @param name The name of the WebVRFreeCamera
  99342. * @param position The starting anchor position for the camera
  99343. * @param scene The scene the camera belongs to
  99344. * @param webVROptions a set of customizable options for the webVRCamera
  99345. */
  99346. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99347. /**
  99348. * Gets the device distance from the ground in meters.
  99349. * @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.
  99350. */
  99351. deviceDistanceToRoomGround(): number;
  99352. /**
  99353. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99354. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99355. */
  99356. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99357. /**
  99358. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99359. * @returns A promise with a boolean set to if the standing matrix is supported.
  99360. */
  99361. useStandingMatrixAsync(): Promise<boolean>;
  99362. /**
  99363. * Disposes the camera
  99364. */
  99365. dispose(): void;
  99366. /**
  99367. * Gets a vrController by name.
  99368. * @param name The name of the controller to retreive
  99369. * @returns the controller matching the name specified or null if not found
  99370. */
  99371. getControllerByName(name: string): Nullable<WebVRController>;
  99372. private _leftController;
  99373. /**
  99374. * The controller corresponding to the users left hand.
  99375. */
  99376. get leftController(): Nullable<WebVRController>;
  99377. private _rightController;
  99378. /**
  99379. * The controller corresponding to the users right hand.
  99380. */
  99381. get rightController(): Nullable<WebVRController>;
  99382. /**
  99383. * Casts a ray forward from the vrCamera's gaze.
  99384. * @param length Length of the ray (default: 100)
  99385. * @returns the ray corresponding to the gaze
  99386. */
  99387. getForwardRay(length?: number): Ray;
  99388. /**
  99389. * @hidden
  99390. * Updates the camera based on device's frame data
  99391. */
  99392. _checkInputs(): void;
  99393. /**
  99394. * Updates the poseControlled values based on the input device pose.
  99395. * @param poseData Pose coming from the device
  99396. */
  99397. updateFromDevice(poseData: DevicePose): void;
  99398. private _htmlElementAttached;
  99399. private _detachIfAttached;
  99400. /**
  99401. * WebVR's attach control will start broadcasting frames to the device.
  99402. * Note that in certain browsers (chrome for example) this function must be called
  99403. * within a user-interaction callback. Example:
  99404. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99405. *
  99406. * @param element html element to attach the vrDevice to
  99407. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99408. */
  99409. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99410. /**
  99411. * Detaches the camera from the html element and disables VR
  99412. *
  99413. * @param element html element to detach from
  99414. */
  99415. detachControl(element: HTMLElement): void;
  99416. /**
  99417. * @returns the name of this class
  99418. */
  99419. getClassName(): string;
  99420. /**
  99421. * Calls resetPose on the vrDisplay
  99422. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99423. */
  99424. resetToCurrentRotation(): void;
  99425. /**
  99426. * @hidden
  99427. * Updates the rig cameras (left and right eye)
  99428. */
  99429. _updateRigCameras(): void;
  99430. private _workingVector;
  99431. private _oneVector;
  99432. private _workingMatrix;
  99433. private updateCacheCalled;
  99434. private _correctPositionIfNotTrackPosition;
  99435. /**
  99436. * @hidden
  99437. * Updates the cached values of the camera
  99438. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99439. */
  99440. _updateCache(ignoreParentClass?: boolean): void;
  99441. /**
  99442. * @hidden
  99443. * Get current device position in babylon world
  99444. */
  99445. _computeDevicePosition(): void;
  99446. /**
  99447. * Updates the current device position and rotation in the babylon world
  99448. */
  99449. update(): void;
  99450. /**
  99451. * @hidden
  99452. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99453. * @returns an identity matrix
  99454. */
  99455. _getViewMatrix(): Matrix;
  99456. private _tmpMatrix;
  99457. /**
  99458. * This function is called by the two RIG cameras.
  99459. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99460. * @hidden
  99461. */
  99462. _getWebVRViewMatrix(): Matrix;
  99463. /** @hidden */
  99464. _getWebVRProjectionMatrix(): Matrix;
  99465. private _onGamepadConnectedObserver;
  99466. private _onGamepadDisconnectedObserver;
  99467. private _updateCacheWhenTrackingDisabledObserver;
  99468. /**
  99469. * Initializes the controllers and their meshes
  99470. */
  99471. initControllers(): void;
  99472. }
  99473. }
  99474. declare module BABYLON {
  99475. /**
  99476. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99477. *
  99478. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99479. *
  99480. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99481. */
  99482. export class MaterialHelper {
  99483. /**
  99484. * Bind the current view position to an effect.
  99485. * @param effect The effect to be bound
  99486. * @param scene The scene the eyes position is used from
  99487. * @param variableName name of the shader variable that will hold the eye position
  99488. */
  99489. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99490. /**
  99491. * Helps preparing the defines values about the UVs in used in the effect.
  99492. * UVs are shared as much as we can accross channels in the shaders.
  99493. * @param texture The texture we are preparing the UVs for
  99494. * @param defines The defines to update
  99495. * @param key The channel key "diffuse", "specular"... used in the shader
  99496. */
  99497. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99498. /**
  99499. * Binds a texture matrix value to its corrsponding uniform
  99500. * @param texture The texture to bind the matrix for
  99501. * @param uniformBuffer The uniform buffer receivin the data
  99502. * @param key The channel key "diffuse", "specular"... used in the shader
  99503. */
  99504. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99505. /**
  99506. * Gets the current status of the fog (should it be enabled?)
  99507. * @param mesh defines the mesh to evaluate for fog support
  99508. * @param scene defines the hosting scene
  99509. * @returns true if fog must be enabled
  99510. */
  99511. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99512. /**
  99513. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99514. * @param mesh defines the current mesh
  99515. * @param scene defines the current scene
  99516. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99517. * @param pointsCloud defines if point cloud rendering has to be turned on
  99518. * @param fogEnabled defines if fog has to be turned on
  99519. * @param alphaTest defines if alpha testing has to be turned on
  99520. * @param defines defines the current list of defines
  99521. */
  99522. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99523. /**
  99524. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99525. * @param scene defines the current scene
  99526. * @param engine defines the current engine
  99527. * @param defines specifies the list of active defines
  99528. * @param useInstances defines if instances have to be turned on
  99529. * @param useClipPlane defines if clip plane have to be turned on
  99530. * @param useInstances defines if instances have to be turned on
  99531. * @param useThinInstances defines if thin instances have to be turned on
  99532. */
  99533. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99534. /**
  99535. * Prepares the defines for bones
  99536. * @param mesh The mesh containing the geometry data we will draw
  99537. * @param defines The defines to update
  99538. */
  99539. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99540. /**
  99541. * Prepares the defines for morph targets
  99542. * @param mesh The mesh containing the geometry data we will draw
  99543. * @param defines The defines to update
  99544. */
  99545. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99546. /**
  99547. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99548. * @param mesh The mesh containing the geometry data we will draw
  99549. * @param defines The defines to update
  99550. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  99551. * @param useBones Precise whether bones should be used or not (override mesh info)
  99552. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  99553. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  99554. * @returns false if defines are considered not dirty and have not been checked
  99555. */
  99556. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  99557. /**
  99558. * Prepares the defines related to multiview
  99559. * @param scene The scene we are intending to draw
  99560. * @param defines The defines to update
  99561. */
  99562. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  99563. /**
  99564. * Prepares the defines related to the prepass
  99565. * @param scene The scene we are intending to draw
  99566. * @param defines The defines to update
  99567. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  99568. */
  99569. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  99570. /**
  99571. * Prepares the defines related to the light information passed in parameter
  99572. * @param scene The scene we are intending to draw
  99573. * @param mesh The mesh the effect is compiling for
  99574. * @param light The light the effect is compiling for
  99575. * @param lightIndex The index of the light
  99576. * @param defines The defines to update
  99577. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99578. * @param state Defines the current state regarding what is needed (normals, etc...)
  99579. */
  99580. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  99581. needNormals: boolean;
  99582. needRebuild: boolean;
  99583. shadowEnabled: boolean;
  99584. specularEnabled: boolean;
  99585. lightmapMode: boolean;
  99586. }): void;
  99587. /**
  99588. * Prepares the defines related to the light information passed in parameter
  99589. * @param scene The scene we are intending to draw
  99590. * @param mesh The mesh the effect is compiling for
  99591. * @param defines The defines to update
  99592. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99593. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  99594. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  99595. * @returns true if normals will be required for the rest of the effect
  99596. */
  99597. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  99598. /**
  99599. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  99600. * @param lightIndex defines the light index
  99601. * @param uniformsList The uniform list
  99602. * @param samplersList The sampler list
  99603. * @param projectedLightTexture defines if projected texture must be used
  99604. * @param uniformBuffersList defines an optional list of uniform buffers
  99605. */
  99606. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  99607. /**
  99608. * Prepares the uniforms and samplers list to be used in the effect
  99609. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  99610. * @param samplersList The sampler list
  99611. * @param defines The defines helping in the list generation
  99612. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  99613. */
  99614. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  99615. /**
  99616. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  99617. * @param defines The defines to update while falling back
  99618. * @param fallbacks The authorized effect fallbacks
  99619. * @param maxSimultaneousLights The maximum number of lights allowed
  99620. * @param rank the current rank of the Effect
  99621. * @returns The newly affected rank
  99622. */
  99623. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  99624. private static _TmpMorphInfluencers;
  99625. /**
  99626. * Prepares the list of attributes required for morph targets according to the effect defines.
  99627. * @param attribs The current list of supported attribs
  99628. * @param mesh The mesh to prepare the morph targets attributes for
  99629. * @param influencers The number of influencers
  99630. */
  99631. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  99632. /**
  99633. * Prepares the list of attributes required for morph targets according to the effect defines.
  99634. * @param attribs The current list of supported attribs
  99635. * @param mesh The mesh to prepare the morph targets attributes for
  99636. * @param defines The current Defines of the effect
  99637. */
  99638. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  99639. /**
  99640. * Prepares the list of attributes required for bones according to the effect defines.
  99641. * @param attribs The current list of supported attribs
  99642. * @param mesh The mesh to prepare the bones attributes for
  99643. * @param defines The current Defines of the effect
  99644. * @param fallbacks The current efffect fallback strategy
  99645. */
  99646. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  99647. /**
  99648. * Check and prepare the list of attributes required for instances according to the effect defines.
  99649. * @param attribs The current list of supported attribs
  99650. * @param defines The current MaterialDefines of the effect
  99651. */
  99652. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  99653. /**
  99654. * Add the list of attributes required for instances to the attribs array.
  99655. * @param attribs The current list of supported attribs
  99656. */
  99657. static PushAttributesForInstances(attribs: string[]): void;
  99658. /**
  99659. * Binds the light information to the effect.
  99660. * @param light The light containing the generator
  99661. * @param effect The effect we are binding the data to
  99662. * @param lightIndex The light index in the effect used to render
  99663. */
  99664. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  99665. /**
  99666. * Binds the lights information from the scene to the effect for the given mesh.
  99667. * @param light Light to bind
  99668. * @param lightIndex Light index
  99669. * @param scene The scene where the light belongs to
  99670. * @param effect The effect we are binding the data to
  99671. * @param useSpecular Defines if specular is supported
  99672. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  99673. */
  99674. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  99675. /**
  99676. * Binds the lights information from the scene to the effect for the given mesh.
  99677. * @param scene The scene the lights belongs to
  99678. * @param mesh The mesh we are binding the information to render
  99679. * @param effect The effect we are binding the data to
  99680. * @param defines The generated defines for the effect
  99681. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  99682. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  99683. */
  99684. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  99685. private static _tempFogColor;
  99686. /**
  99687. * Binds the fog information from the scene to the effect for the given mesh.
  99688. * @param scene The scene the lights belongs to
  99689. * @param mesh The mesh we are binding the information to render
  99690. * @param effect The effect we are binding the data to
  99691. * @param linearSpace Defines if the fog effect is applied in linear space
  99692. */
  99693. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  99694. /**
  99695. * Binds the bones information from the mesh to the effect.
  99696. * @param mesh The mesh we are binding the information to render
  99697. * @param effect The effect we are binding the data to
  99698. */
  99699. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  99700. /**
  99701. * Binds the morph targets information from the mesh to the effect.
  99702. * @param abstractMesh The mesh we are binding the information to render
  99703. * @param effect The effect we are binding the data to
  99704. */
  99705. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  99706. /**
  99707. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  99708. * @param defines The generated defines used in the effect
  99709. * @param effect The effect we are binding the data to
  99710. * @param scene The scene we are willing to render with logarithmic scale for
  99711. */
  99712. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  99713. /**
  99714. * Binds the clip plane information from the scene to the effect.
  99715. * @param scene The scene the clip plane information are extracted from
  99716. * @param effect The effect we are binding the data to
  99717. */
  99718. static BindClipPlane(effect: Effect, scene: Scene): void;
  99719. }
  99720. }
  99721. declare module BABYLON {
  99722. /**
  99723. * Block used to expose an input value
  99724. */
  99725. export class InputBlock extends NodeMaterialBlock {
  99726. private _mode;
  99727. private _associatedVariableName;
  99728. private _storedValue;
  99729. private _valueCallback;
  99730. private _type;
  99731. private _animationType;
  99732. /** Gets or set a value used to limit the range of float values */
  99733. min: number;
  99734. /** Gets or set a value used to limit the range of float values */
  99735. max: number;
  99736. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  99737. isBoolean: boolean;
  99738. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  99739. matrixMode: number;
  99740. /** @hidden */
  99741. _systemValue: Nullable<NodeMaterialSystemValues>;
  99742. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  99743. visibleInInspector: boolean;
  99744. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  99745. isConstant: boolean;
  99746. /** Gets or sets the group to use to display this block in the Inspector */
  99747. groupInInspector: string;
  99748. /** Gets an observable raised when the value is changed */
  99749. onValueChangedObservable: Observable<InputBlock>;
  99750. /**
  99751. * Gets or sets the connection point type (default is float)
  99752. */
  99753. get type(): NodeMaterialBlockConnectionPointTypes;
  99754. /**
  99755. * Creates a new InputBlock
  99756. * @param name defines the block name
  99757. * @param target defines the target of that block (Vertex by default)
  99758. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  99759. */
  99760. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  99761. /**
  99762. * Validates if a name is a reserve word.
  99763. * @param newName the new name to be given to the node.
  99764. * @returns false if the name is a reserve word, else true.
  99765. */
  99766. validateBlockName(newName: string): boolean;
  99767. /**
  99768. * Gets the output component
  99769. */
  99770. get output(): NodeMaterialConnectionPoint;
  99771. /**
  99772. * Set the source of this connection point to a vertex attribute
  99773. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  99774. * @returns the current connection point
  99775. */
  99776. setAsAttribute(attributeName?: string): InputBlock;
  99777. /**
  99778. * Set the source of this connection point to a system value
  99779. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  99780. * @returns the current connection point
  99781. */
  99782. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  99783. /**
  99784. * Gets or sets the value of that point.
  99785. * Please note that this value will be ignored if valueCallback is defined
  99786. */
  99787. get value(): any;
  99788. set value(value: any);
  99789. /**
  99790. * Gets or sets a callback used to get the value of that point.
  99791. * Please note that setting this value will force the connection point to ignore the value property
  99792. */
  99793. get valueCallback(): () => any;
  99794. set valueCallback(value: () => any);
  99795. /**
  99796. * Gets or sets the associated variable name in the shader
  99797. */
  99798. get associatedVariableName(): string;
  99799. set associatedVariableName(value: string);
  99800. /** Gets or sets the type of animation applied to the input */
  99801. get animationType(): AnimatedInputBlockTypes;
  99802. set animationType(value: AnimatedInputBlockTypes);
  99803. /**
  99804. * Gets a boolean indicating that this connection point not defined yet
  99805. */
  99806. get isUndefined(): boolean;
  99807. /**
  99808. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  99809. * In this case the connection point name must be the name of the uniform to use.
  99810. * Can only be set on inputs
  99811. */
  99812. get isUniform(): boolean;
  99813. set isUniform(value: boolean);
  99814. /**
  99815. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  99816. * In this case the connection point name must be the name of the attribute to use
  99817. * Can only be set on inputs
  99818. */
  99819. get isAttribute(): boolean;
  99820. set isAttribute(value: boolean);
  99821. /**
  99822. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  99823. * Can only be set on exit points
  99824. */
  99825. get isVarying(): boolean;
  99826. set isVarying(value: boolean);
  99827. /**
  99828. * Gets a boolean indicating that the current connection point is a system value
  99829. */
  99830. get isSystemValue(): boolean;
  99831. /**
  99832. * Gets or sets the current well known value or null if not defined as a system value
  99833. */
  99834. get systemValue(): Nullable<NodeMaterialSystemValues>;
  99835. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  99836. /**
  99837. * Gets the current class name
  99838. * @returns the class name
  99839. */
  99840. getClassName(): string;
  99841. /**
  99842. * Animate the input if animationType !== None
  99843. * @param scene defines the rendering scene
  99844. */
  99845. animate(scene: Scene): void;
  99846. private _emitDefine;
  99847. initialize(state: NodeMaterialBuildState): void;
  99848. /**
  99849. * Set the input block to its default value (based on its type)
  99850. */
  99851. setDefaultValue(): void;
  99852. private _emitConstant;
  99853. /** @hidden */
  99854. get _noContextSwitch(): boolean;
  99855. private _emit;
  99856. /** @hidden */
  99857. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  99858. /** @hidden */
  99859. _transmit(effect: Effect, scene: Scene): void;
  99860. protected _buildBlock(state: NodeMaterialBuildState): void;
  99861. protected _dumpPropertiesCode(): string;
  99862. dispose(): void;
  99863. serialize(): any;
  99864. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99865. }
  99866. }
  99867. declare module BABYLON {
  99868. /**
  99869. * Enum used to define the compatibility state between two connection points
  99870. */
  99871. export enum NodeMaterialConnectionPointCompatibilityStates {
  99872. /** Points are compatibles */
  99873. Compatible = 0,
  99874. /** Points are incompatible because of their types */
  99875. TypeIncompatible = 1,
  99876. /** Points are incompatible because of their targets (vertex vs fragment) */
  99877. TargetIncompatible = 2
  99878. }
  99879. /**
  99880. * Defines the direction of a connection point
  99881. */
  99882. export enum NodeMaterialConnectionPointDirection {
  99883. /** Input */
  99884. Input = 0,
  99885. /** Output */
  99886. Output = 1
  99887. }
  99888. /**
  99889. * Defines a connection point for a block
  99890. */
  99891. export class NodeMaterialConnectionPoint {
  99892. /** @hidden */
  99893. _ownerBlock: NodeMaterialBlock;
  99894. /** @hidden */
  99895. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  99896. private _endpoints;
  99897. private _associatedVariableName;
  99898. private _direction;
  99899. /** @hidden */
  99900. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  99901. /** @hidden */
  99902. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  99903. private _type;
  99904. /** @hidden */
  99905. _enforceAssociatedVariableName: boolean;
  99906. /** Gets the direction of the point */
  99907. get direction(): NodeMaterialConnectionPointDirection;
  99908. /** Indicates that this connection point needs dual validation before being connected to another point */
  99909. needDualDirectionValidation: boolean;
  99910. /**
  99911. * Gets or sets the additional types supported by this connection point
  99912. */
  99913. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  99914. /**
  99915. * Gets or sets the additional types excluded by this connection point
  99916. */
  99917. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  99918. /**
  99919. * Observable triggered when this point is connected
  99920. */
  99921. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  99922. /**
  99923. * Gets or sets the associated variable name in the shader
  99924. */
  99925. get associatedVariableName(): string;
  99926. set associatedVariableName(value: string);
  99927. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  99928. get innerType(): NodeMaterialBlockConnectionPointTypes;
  99929. /**
  99930. * Gets or sets the connection point type (default is float)
  99931. */
  99932. get type(): NodeMaterialBlockConnectionPointTypes;
  99933. set type(value: NodeMaterialBlockConnectionPointTypes);
  99934. /**
  99935. * Gets or sets the connection point name
  99936. */
  99937. name: string;
  99938. /**
  99939. * Gets or sets the connection point name
  99940. */
  99941. displayName: string;
  99942. /**
  99943. * Gets or sets a boolean indicating that this connection point can be omitted
  99944. */
  99945. isOptional: boolean;
  99946. /**
  99947. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  99948. */
  99949. isExposedOnFrame: boolean;
  99950. /**
  99951. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  99952. */
  99953. define: string;
  99954. /** @hidden */
  99955. _prioritizeVertex: boolean;
  99956. private _target;
  99957. /** Gets or sets the target of that connection point */
  99958. get target(): NodeMaterialBlockTargets;
  99959. set target(value: NodeMaterialBlockTargets);
  99960. /**
  99961. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  99962. */
  99963. get isConnected(): boolean;
  99964. /**
  99965. * Gets a boolean indicating that the current point is connected to an input block
  99966. */
  99967. get isConnectedToInputBlock(): boolean;
  99968. /**
  99969. * Gets a the connected input block (if any)
  99970. */
  99971. get connectInputBlock(): Nullable<InputBlock>;
  99972. /** Get the other side of the connection (if any) */
  99973. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  99974. /** Get the block that owns this connection point */
  99975. get ownerBlock(): NodeMaterialBlock;
  99976. /** Get the block connected on the other side of this connection (if any) */
  99977. get sourceBlock(): Nullable<NodeMaterialBlock>;
  99978. /** Get the block connected on the endpoints of this connection (if any) */
  99979. get connectedBlocks(): Array<NodeMaterialBlock>;
  99980. /** Gets the list of connected endpoints */
  99981. get endpoints(): NodeMaterialConnectionPoint[];
  99982. /** Gets a boolean indicating if that output point is connected to at least one input */
  99983. get hasEndpoints(): boolean;
  99984. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  99985. get isConnectedInVertexShader(): boolean;
  99986. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  99987. get isConnectedInFragmentShader(): boolean;
  99988. /**
  99989. * Creates a block suitable to be used as an input for this input point.
  99990. * If null is returned, a block based on the point type will be created.
  99991. * @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
  99992. */
  99993. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  99994. /**
  99995. * Creates a new connection point
  99996. * @param name defines the connection point name
  99997. * @param ownerBlock defines the block hosting this connection point
  99998. * @param direction defines the direction of the connection point
  99999. */
  100000. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100001. /**
  100002. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100003. * @returns the class name
  100004. */
  100005. getClassName(): string;
  100006. /**
  100007. * Gets a boolean indicating if the current point can be connected to another point
  100008. * @param connectionPoint defines the other connection point
  100009. * @returns a boolean
  100010. */
  100011. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100012. /**
  100013. * Gets a number indicating if the current point can be connected to another point
  100014. * @param connectionPoint defines the other connection point
  100015. * @returns a number defining the compatibility state
  100016. */
  100017. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100018. /**
  100019. * Connect this point to another connection point
  100020. * @param connectionPoint defines the other connection point
  100021. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100022. * @returns the current connection point
  100023. */
  100024. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100025. /**
  100026. * Disconnect this point from one of his endpoint
  100027. * @param endpoint defines the other connection point
  100028. * @returns the current connection point
  100029. */
  100030. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100031. /**
  100032. * Serializes this point in a JSON representation
  100033. * @param isInput defines if the connection point is an input (default is true)
  100034. * @returns the serialized point object
  100035. */
  100036. serialize(isInput?: boolean): any;
  100037. /**
  100038. * Release resources
  100039. */
  100040. dispose(): void;
  100041. }
  100042. }
  100043. declare module BABYLON {
  100044. /**
  100045. * Enum used to define the material modes
  100046. */
  100047. export enum NodeMaterialModes {
  100048. /** Regular material */
  100049. Material = 0,
  100050. /** For post process */
  100051. PostProcess = 1,
  100052. /** For particle system */
  100053. Particle = 2
  100054. }
  100055. }
  100056. declare module BABYLON {
  100057. /**
  100058. * Block used to read a texture from a sampler
  100059. */
  100060. export class TextureBlock extends NodeMaterialBlock {
  100061. private _defineName;
  100062. private _linearDefineName;
  100063. private _gammaDefineName;
  100064. private _tempTextureRead;
  100065. private _samplerName;
  100066. private _transformedUVName;
  100067. private _textureTransformName;
  100068. private _textureInfoName;
  100069. private _mainUVName;
  100070. private _mainUVDefineName;
  100071. private _fragmentOnly;
  100072. /**
  100073. * Gets or sets the texture associated with the node
  100074. */
  100075. texture: Nullable<Texture>;
  100076. /**
  100077. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100078. */
  100079. convertToGammaSpace: boolean;
  100080. /**
  100081. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100082. */
  100083. convertToLinearSpace: boolean;
  100084. /**
  100085. * Create a new TextureBlock
  100086. * @param name defines the block name
  100087. */
  100088. constructor(name: string, fragmentOnly?: boolean);
  100089. /**
  100090. * Gets the current class name
  100091. * @returns the class name
  100092. */
  100093. getClassName(): string;
  100094. /**
  100095. * Gets the uv input component
  100096. */
  100097. get uv(): NodeMaterialConnectionPoint;
  100098. /**
  100099. * Gets the rgba output component
  100100. */
  100101. get rgba(): NodeMaterialConnectionPoint;
  100102. /**
  100103. * Gets the rgb output component
  100104. */
  100105. get rgb(): NodeMaterialConnectionPoint;
  100106. /**
  100107. * Gets the r output component
  100108. */
  100109. get r(): NodeMaterialConnectionPoint;
  100110. /**
  100111. * Gets the g output component
  100112. */
  100113. get g(): NodeMaterialConnectionPoint;
  100114. /**
  100115. * Gets the b output component
  100116. */
  100117. get b(): NodeMaterialConnectionPoint;
  100118. /**
  100119. * Gets the a output component
  100120. */
  100121. get a(): NodeMaterialConnectionPoint;
  100122. get target(): NodeMaterialBlockTargets;
  100123. autoConfigure(material: NodeMaterial): void;
  100124. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100125. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100126. isReady(): boolean;
  100127. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100128. private get _isMixed();
  100129. private _injectVertexCode;
  100130. private _writeTextureRead;
  100131. private _writeOutput;
  100132. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100133. protected _dumpPropertiesCode(): string;
  100134. serialize(): any;
  100135. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100136. }
  100137. }
  100138. declare module BABYLON {
  100139. /** @hidden */
  100140. export var reflectionFunction: {
  100141. name: string;
  100142. shader: string;
  100143. };
  100144. }
  100145. declare module BABYLON {
  100146. /**
  100147. * Base block used to read a reflection texture from a sampler
  100148. */
  100149. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100150. /** @hidden */
  100151. _define3DName: string;
  100152. /** @hidden */
  100153. _defineCubicName: string;
  100154. /** @hidden */
  100155. _defineExplicitName: string;
  100156. /** @hidden */
  100157. _defineProjectionName: string;
  100158. /** @hidden */
  100159. _defineLocalCubicName: string;
  100160. /** @hidden */
  100161. _defineSphericalName: string;
  100162. /** @hidden */
  100163. _definePlanarName: string;
  100164. /** @hidden */
  100165. _defineEquirectangularName: string;
  100166. /** @hidden */
  100167. _defineMirroredEquirectangularFixedName: string;
  100168. /** @hidden */
  100169. _defineEquirectangularFixedName: string;
  100170. /** @hidden */
  100171. _defineSkyboxName: string;
  100172. /** @hidden */
  100173. _defineOppositeZ: string;
  100174. /** @hidden */
  100175. _cubeSamplerName: string;
  100176. /** @hidden */
  100177. _2DSamplerName: string;
  100178. protected _positionUVWName: string;
  100179. protected _directionWName: string;
  100180. protected _reflectionVectorName: string;
  100181. /** @hidden */
  100182. _reflectionCoordsName: string;
  100183. /** @hidden */
  100184. _reflectionMatrixName: string;
  100185. protected _reflectionColorName: string;
  100186. /**
  100187. * Gets or sets the texture associated with the node
  100188. */
  100189. texture: Nullable<BaseTexture>;
  100190. /**
  100191. * Create a new ReflectionTextureBaseBlock
  100192. * @param name defines the block name
  100193. */
  100194. constructor(name: string);
  100195. /**
  100196. * Gets the current class name
  100197. * @returns the class name
  100198. */
  100199. getClassName(): string;
  100200. /**
  100201. * Gets the world position input component
  100202. */
  100203. abstract get position(): NodeMaterialConnectionPoint;
  100204. /**
  100205. * Gets the world position input component
  100206. */
  100207. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100208. /**
  100209. * Gets the world normal input component
  100210. */
  100211. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100212. /**
  100213. * Gets the world input component
  100214. */
  100215. abstract get world(): NodeMaterialConnectionPoint;
  100216. /**
  100217. * Gets the camera (or eye) position component
  100218. */
  100219. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100220. /**
  100221. * Gets the view input component
  100222. */
  100223. abstract get view(): NodeMaterialConnectionPoint;
  100224. protected _getTexture(): Nullable<BaseTexture>;
  100225. autoConfigure(material: NodeMaterial): void;
  100226. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100227. isReady(): boolean;
  100228. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100229. /**
  100230. * Gets the code to inject in the vertex shader
  100231. * @param state current state of the node material building
  100232. * @returns the shader code
  100233. */
  100234. handleVertexSide(state: NodeMaterialBuildState): string;
  100235. /**
  100236. * Handles the inits for the fragment code path
  100237. * @param state node material build state
  100238. */
  100239. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100240. /**
  100241. * Generates the reflection coords code for the fragment code path
  100242. * @param worldNormalVarName name of the world normal variable
  100243. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100244. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100245. * @returns the shader code
  100246. */
  100247. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100248. /**
  100249. * Generates the reflection color code for the fragment code path
  100250. * @param lodVarName name of the lod variable
  100251. * @param swizzleLookupTexture swizzle to use for the final color variable
  100252. * @returns the shader code
  100253. */
  100254. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100255. /**
  100256. * Generates the code corresponding to the connected output points
  100257. * @param state node material build state
  100258. * @param varName name of the variable to output
  100259. * @returns the shader code
  100260. */
  100261. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100262. protected _buildBlock(state: NodeMaterialBuildState): this;
  100263. protected _dumpPropertiesCode(): string;
  100264. serialize(): any;
  100265. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100266. }
  100267. }
  100268. declare module BABYLON {
  100269. /**
  100270. * Defines a connection point to be used for points with a custom object type
  100271. */
  100272. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100273. private _blockType;
  100274. private _blockName;
  100275. private _nameForCheking?;
  100276. /**
  100277. * Creates a new connection point
  100278. * @param name defines the connection point name
  100279. * @param ownerBlock defines the block hosting this connection point
  100280. * @param direction defines the direction of the connection point
  100281. */
  100282. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100283. /**
  100284. * Gets a number indicating if the current point can be connected to another point
  100285. * @param connectionPoint defines the other connection point
  100286. * @returns a number defining the compatibility state
  100287. */
  100288. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100289. /**
  100290. * Creates a block suitable to be used as an input for this input point.
  100291. * If null is returned, a block based on the point type will be created.
  100292. * @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
  100293. */
  100294. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100295. }
  100296. }
  100297. declare module BABYLON {
  100298. /**
  100299. * Enum defining the type of properties that can be edited in the property pages in the NME
  100300. */
  100301. export enum PropertyTypeForEdition {
  100302. /** property is a boolean */
  100303. Boolean = 0,
  100304. /** property is a float */
  100305. Float = 1,
  100306. /** property is a Vector2 */
  100307. Vector2 = 2,
  100308. /** property is a list of values */
  100309. List = 3
  100310. }
  100311. /**
  100312. * Interface that defines an option in a variable of type list
  100313. */
  100314. export interface IEditablePropertyListOption {
  100315. /** label of the option */
  100316. "label": string;
  100317. /** value of the option */
  100318. "value": number;
  100319. }
  100320. /**
  100321. * Interface that defines the options available for an editable property
  100322. */
  100323. export interface IEditablePropertyOption {
  100324. /** min value */
  100325. "min"?: number;
  100326. /** max value */
  100327. "max"?: number;
  100328. /** notifiers: indicates which actions to take when the property is changed */
  100329. "notifiers"?: {
  100330. /** the material should be rebuilt */
  100331. "rebuild"?: boolean;
  100332. /** the preview should be updated */
  100333. "update"?: boolean;
  100334. };
  100335. /** list of the options for a variable of type list */
  100336. "options"?: IEditablePropertyListOption[];
  100337. }
  100338. /**
  100339. * Interface that describes an editable property
  100340. */
  100341. export interface IPropertyDescriptionForEdition {
  100342. /** name of the property */
  100343. "propertyName": string;
  100344. /** display name of the property */
  100345. "displayName": string;
  100346. /** type of the property */
  100347. "type": PropertyTypeForEdition;
  100348. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100349. "groupName": string;
  100350. /** options for the property */
  100351. "options": IEditablePropertyOption;
  100352. }
  100353. /**
  100354. * Decorator that flags a property in a node material block as being editable
  100355. */
  100356. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100357. }
  100358. declare module BABYLON {
  100359. /**
  100360. * Block used to implement the refraction part of the sub surface module of the PBR material
  100361. */
  100362. export class RefractionBlock extends NodeMaterialBlock {
  100363. /** @hidden */
  100364. _define3DName: string;
  100365. /** @hidden */
  100366. _refractionMatrixName: string;
  100367. /** @hidden */
  100368. _defineLODRefractionAlpha: string;
  100369. /** @hidden */
  100370. _defineLinearSpecularRefraction: string;
  100371. /** @hidden */
  100372. _defineOppositeZ: string;
  100373. /** @hidden */
  100374. _cubeSamplerName: string;
  100375. /** @hidden */
  100376. _2DSamplerName: string;
  100377. /** @hidden */
  100378. _vRefractionMicrosurfaceInfosName: string;
  100379. /** @hidden */
  100380. _vRefractionInfosName: string;
  100381. private _scene;
  100382. /**
  100383. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100384. * Materials half opaque for instance using refraction could benefit from this control.
  100385. */
  100386. linkRefractionWithTransparency: boolean;
  100387. /**
  100388. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100389. */
  100390. invertRefractionY: boolean;
  100391. /**
  100392. * Gets or sets the texture associated with the node
  100393. */
  100394. texture: Nullable<BaseTexture>;
  100395. /**
  100396. * Create a new RefractionBlock
  100397. * @param name defines the block name
  100398. */
  100399. constructor(name: string);
  100400. /**
  100401. * Gets the current class name
  100402. * @returns the class name
  100403. */
  100404. getClassName(): string;
  100405. /**
  100406. * Gets the intensity input component
  100407. */
  100408. get intensity(): NodeMaterialConnectionPoint;
  100409. /**
  100410. * Gets the index of refraction input component
  100411. */
  100412. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100413. /**
  100414. * Gets the tint at distance input component
  100415. */
  100416. get tintAtDistance(): NodeMaterialConnectionPoint;
  100417. /**
  100418. * Gets the view input component
  100419. */
  100420. get view(): NodeMaterialConnectionPoint;
  100421. /**
  100422. * Gets the refraction object output component
  100423. */
  100424. get refraction(): NodeMaterialConnectionPoint;
  100425. /**
  100426. * Returns true if the block has a texture
  100427. */
  100428. get hasTexture(): boolean;
  100429. protected _getTexture(): Nullable<BaseTexture>;
  100430. autoConfigure(material: NodeMaterial): void;
  100431. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100432. isReady(): boolean;
  100433. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100434. /**
  100435. * Gets the main code of the block (fragment side)
  100436. * @param state current state of the node material building
  100437. * @returns the shader code
  100438. */
  100439. getCode(state: NodeMaterialBuildState): string;
  100440. protected _buildBlock(state: NodeMaterialBuildState): this;
  100441. protected _dumpPropertiesCode(): string;
  100442. serialize(): any;
  100443. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100444. }
  100445. }
  100446. declare module BABYLON {
  100447. /**
  100448. * Base block used as input for post process
  100449. */
  100450. export class CurrentScreenBlock extends NodeMaterialBlock {
  100451. private _samplerName;
  100452. private _linearDefineName;
  100453. private _gammaDefineName;
  100454. private _mainUVName;
  100455. private _tempTextureRead;
  100456. /**
  100457. * Gets or sets the texture associated with the node
  100458. */
  100459. texture: Nullable<BaseTexture>;
  100460. /**
  100461. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100462. */
  100463. convertToGammaSpace: boolean;
  100464. /**
  100465. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100466. */
  100467. convertToLinearSpace: boolean;
  100468. /**
  100469. * Create a new CurrentScreenBlock
  100470. * @param name defines the block name
  100471. */
  100472. constructor(name: string);
  100473. /**
  100474. * Gets the current class name
  100475. * @returns the class name
  100476. */
  100477. getClassName(): string;
  100478. /**
  100479. * Gets the uv input component
  100480. */
  100481. get uv(): NodeMaterialConnectionPoint;
  100482. /**
  100483. * Gets the rgba output component
  100484. */
  100485. get rgba(): NodeMaterialConnectionPoint;
  100486. /**
  100487. * Gets the rgb output component
  100488. */
  100489. get rgb(): NodeMaterialConnectionPoint;
  100490. /**
  100491. * Gets the r output component
  100492. */
  100493. get r(): NodeMaterialConnectionPoint;
  100494. /**
  100495. * Gets the g output component
  100496. */
  100497. get g(): NodeMaterialConnectionPoint;
  100498. /**
  100499. * Gets the b output component
  100500. */
  100501. get b(): NodeMaterialConnectionPoint;
  100502. /**
  100503. * Gets the a output component
  100504. */
  100505. get a(): NodeMaterialConnectionPoint;
  100506. /**
  100507. * Initialize the block and prepare the context for build
  100508. * @param state defines the state that will be used for the build
  100509. */
  100510. initialize(state: NodeMaterialBuildState): void;
  100511. get target(): NodeMaterialBlockTargets;
  100512. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100513. isReady(): boolean;
  100514. private _injectVertexCode;
  100515. private _writeTextureRead;
  100516. private _writeOutput;
  100517. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100518. serialize(): any;
  100519. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100520. }
  100521. }
  100522. declare module BABYLON {
  100523. /**
  100524. * Base block used for the particle texture
  100525. */
  100526. export class ParticleTextureBlock extends NodeMaterialBlock {
  100527. private _samplerName;
  100528. private _linearDefineName;
  100529. private _gammaDefineName;
  100530. private _tempTextureRead;
  100531. /**
  100532. * Gets or sets the texture associated with the node
  100533. */
  100534. texture: Nullable<BaseTexture>;
  100535. /**
  100536. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100537. */
  100538. convertToGammaSpace: boolean;
  100539. /**
  100540. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100541. */
  100542. convertToLinearSpace: boolean;
  100543. /**
  100544. * Create a new ParticleTextureBlock
  100545. * @param name defines the block name
  100546. */
  100547. constructor(name: string);
  100548. /**
  100549. * Gets the current class name
  100550. * @returns the class name
  100551. */
  100552. getClassName(): string;
  100553. /**
  100554. * Gets the uv input component
  100555. */
  100556. get uv(): NodeMaterialConnectionPoint;
  100557. /**
  100558. * Gets the rgba output component
  100559. */
  100560. get rgba(): NodeMaterialConnectionPoint;
  100561. /**
  100562. * Gets the rgb output component
  100563. */
  100564. get rgb(): NodeMaterialConnectionPoint;
  100565. /**
  100566. * Gets the r output component
  100567. */
  100568. get r(): NodeMaterialConnectionPoint;
  100569. /**
  100570. * Gets the g output component
  100571. */
  100572. get g(): NodeMaterialConnectionPoint;
  100573. /**
  100574. * Gets the b output component
  100575. */
  100576. get b(): NodeMaterialConnectionPoint;
  100577. /**
  100578. * Gets the a output component
  100579. */
  100580. get a(): NodeMaterialConnectionPoint;
  100581. /**
  100582. * Initialize the block and prepare the context for build
  100583. * @param state defines the state that will be used for the build
  100584. */
  100585. initialize(state: NodeMaterialBuildState): void;
  100586. autoConfigure(material: NodeMaterial): void;
  100587. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100588. isReady(): boolean;
  100589. private _writeOutput;
  100590. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100591. serialize(): any;
  100592. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100593. }
  100594. }
  100595. declare module BABYLON {
  100596. /**
  100597. * Class used to store shared data between 2 NodeMaterialBuildState
  100598. */
  100599. export class NodeMaterialBuildStateSharedData {
  100600. /**
  100601. * Gets the list of emitted varyings
  100602. */
  100603. temps: string[];
  100604. /**
  100605. * Gets the list of emitted varyings
  100606. */
  100607. varyings: string[];
  100608. /**
  100609. * Gets the varying declaration string
  100610. */
  100611. varyingDeclaration: string;
  100612. /**
  100613. * Input blocks
  100614. */
  100615. inputBlocks: InputBlock[];
  100616. /**
  100617. * Input blocks
  100618. */
  100619. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100620. /**
  100621. * Bindable blocks (Blocks that need to set data to the effect)
  100622. */
  100623. bindableBlocks: NodeMaterialBlock[];
  100624. /**
  100625. * List of blocks that can provide a compilation fallback
  100626. */
  100627. blocksWithFallbacks: NodeMaterialBlock[];
  100628. /**
  100629. * List of blocks that can provide a define update
  100630. */
  100631. blocksWithDefines: NodeMaterialBlock[];
  100632. /**
  100633. * List of blocks that can provide a repeatable content
  100634. */
  100635. repeatableContentBlocks: NodeMaterialBlock[];
  100636. /**
  100637. * List of blocks that can provide a dynamic list of uniforms
  100638. */
  100639. dynamicUniformBlocks: NodeMaterialBlock[];
  100640. /**
  100641. * List of blocks that can block the isReady function for the material
  100642. */
  100643. blockingBlocks: NodeMaterialBlock[];
  100644. /**
  100645. * Gets the list of animated inputs
  100646. */
  100647. animatedInputs: InputBlock[];
  100648. /**
  100649. * Build Id used to avoid multiple recompilations
  100650. */
  100651. buildId: number;
  100652. /** List of emitted variables */
  100653. variableNames: {
  100654. [key: string]: number;
  100655. };
  100656. /** List of emitted defines */
  100657. defineNames: {
  100658. [key: string]: number;
  100659. };
  100660. /** Should emit comments? */
  100661. emitComments: boolean;
  100662. /** Emit build activity */
  100663. verbose: boolean;
  100664. /** Gets or sets the hosting scene */
  100665. scene: Scene;
  100666. /**
  100667. * Gets the compilation hints emitted at compilation time
  100668. */
  100669. hints: {
  100670. needWorldViewMatrix: boolean;
  100671. needWorldViewProjectionMatrix: boolean;
  100672. needAlphaBlending: boolean;
  100673. needAlphaTesting: boolean;
  100674. };
  100675. /**
  100676. * List of compilation checks
  100677. */
  100678. checks: {
  100679. emitVertex: boolean;
  100680. emitFragment: boolean;
  100681. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  100682. };
  100683. /**
  100684. * Is vertex program allowed to be empty?
  100685. */
  100686. allowEmptyVertexProgram: boolean;
  100687. /** Creates a new shared data */
  100688. constructor();
  100689. /**
  100690. * Emits console errors and exceptions if there is a failing check
  100691. */
  100692. emitErrors(): void;
  100693. }
  100694. }
  100695. declare module BABYLON {
  100696. /**
  100697. * Class used to store node based material build state
  100698. */
  100699. export class NodeMaterialBuildState {
  100700. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  100701. supportUniformBuffers: boolean;
  100702. /**
  100703. * Gets the list of emitted attributes
  100704. */
  100705. attributes: string[];
  100706. /**
  100707. * Gets the list of emitted uniforms
  100708. */
  100709. uniforms: string[];
  100710. /**
  100711. * Gets the list of emitted constants
  100712. */
  100713. constants: string[];
  100714. /**
  100715. * Gets the list of emitted samplers
  100716. */
  100717. samplers: string[];
  100718. /**
  100719. * Gets the list of emitted functions
  100720. */
  100721. functions: {
  100722. [key: string]: string;
  100723. };
  100724. /**
  100725. * Gets the list of emitted extensions
  100726. */
  100727. extensions: {
  100728. [key: string]: string;
  100729. };
  100730. /**
  100731. * Gets the target of the compilation state
  100732. */
  100733. target: NodeMaterialBlockTargets;
  100734. /**
  100735. * Gets the list of emitted counters
  100736. */
  100737. counters: {
  100738. [key: string]: number;
  100739. };
  100740. /**
  100741. * Shared data between multiple NodeMaterialBuildState instances
  100742. */
  100743. sharedData: NodeMaterialBuildStateSharedData;
  100744. /** @hidden */
  100745. _vertexState: NodeMaterialBuildState;
  100746. /** @hidden */
  100747. _attributeDeclaration: string;
  100748. /** @hidden */
  100749. _uniformDeclaration: string;
  100750. /** @hidden */
  100751. _constantDeclaration: string;
  100752. /** @hidden */
  100753. _samplerDeclaration: string;
  100754. /** @hidden */
  100755. _varyingTransfer: string;
  100756. /** @hidden */
  100757. _injectAtEnd: string;
  100758. private _repeatableContentAnchorIndex;
  100759. /** @hidden */
  100760. _builtCompilationString: string;
  100761. /**
  100762. * Gets the emitted compilation strings
  100763. */
  100764. compilationString: string;
  100765. /**
  100766. * Finalize the compilation strings
  100767. * @param state defines the current compilation state
  100768. */
  100769. finalize(state: NodeMaterialBuildState): void;
  100770. /** @hidden */
  100771. get _repeatableContentAnchor(): string;
  100772. /** @hidden */
  100773. _getFreeVariableName(prefix: string): string;
  100774. /** @hidden */
  100775. _getFreeDefineName(prefix: string): string;
  100776. /** @hidden */
  100777. _excludeVariableName(name: string): void;
  100778. /** @hidden */
  100779. _emit2DSampler(name: string): void;
  100780. /** @hidden */
  100781. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  100782. /** @hidden */
  100783. _emitExtension(name: string, extension: string, define?: string): void;
  100784. /** @hidden */
  100785. _emitFunction(name: string, code: string, comments: string): void;
  100786. /** @hidden */
  100787. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  100788. replaceStrings?: {
  100789. search: RegExp;
  100790. replace: string;
  100791. }[];
  100792. repeatKey?: string;
  100793. }): string;
  100794. /** @hidden */
  100795. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  100796. repeatKey?: string;
  100797. removeAttributes?: boolean;
  100798. removeUniforms?: boolean;
  100799. removeVaryings?: boolean;
  100800. removeIfDef?: boolean;
  100801. replaceStrings?: {
  100802. search: RegExp;
  100803. replace: string;
  100804. }[];
  100805. }, storeKey?: string): void;
  100806. /** @hidden */
  100807. _registerTempVariable(name: string): boolean;
  100808. /** @hidden */
  100809. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  100810. /** @hidden */
  100811. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  100812. /** @hidden */
  100813. _emitFloat(value: number): string;
  100814. }
  100815. }
  100816. declare module BABYLON {
  100817. /**
  100818. * Helper class used to generate session unique ID
  100819. */
  100820. export class UniqueIdGenerator {
  100821. private static _UniqueIdCounter;
  100822. /**
  100823. * Gets an unique (relatively to the current scene) Id
  100824. */
  100825. static get UniqueId(): number;
  100826. }
  100827. }
  100828. declare module BABYLON {
  100829. /**
  100830. * Defines a block that can be used inside a node based material
  100831. */
  100832. export class NodeMaterialBlock {
  100833. private _buildId;
  100834. private _buildTarget;
  100835. private _target;
  100836. private _isFinalMerger;
  100837. private _isInput;
  100838. private _name;
  100839. protected _isUnique: boolean;
  100840. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  100841. inputsAreExclusive: boolean;
  100842. /** @hidden */
  100843. _codeVariableName: string;
  100844. /** @hidden */
  100845. _inputs: NodeMaterialConnectionPoint[];
  100846. /** @hidden */
  100847. _outputs: NodeMaterialConnectionPoint[];
  100848. /** @hidden */
  100849. _preparationId: number;
  100850. /**
  100851. * Gets the name of the block
  100852. */
  100853. get name(): string;
  100854. /**
  100855. * Sets the name of the block. Will check if the name is valid.
  100856. */
  100857. set name(newName: string);
  100858. /**
  100859. * Gets or sets the unique id of the node
  100860. */
  100861. uniqueId: number;
  100862. /**
  100863. * Gets or sets the comments associated with this block
  100864. */
  100865. comments: string;
  100866. /**
  100867. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  100868. */
  100869. get isUnique(): boolean;
  100870. /**
  100871. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  100872. */
  100873. get isFinalMerger(): boolean;
  100874. /**
  100875. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  100876. */
  100877. get isInput(): boolean;
  100878. /**
  100879. * Gets or sets the build Id
  100880. */
  100881. get buildId(): number;
  100882. set buildId(value: number);
  100883. /**
  100884. * Gets or sets the target of the block
  100885. */
  100886. get target(): NodeMaterialBlockTargets;
  100887. set target(value: NodeMaterialBlockTargets);
  100888. /**
  100889. * Gets the list of input points
  100890. */
  100891. get inputs(): NodeMaterialConnectionPoint[];
  100892. /** Gets the list of output points */
  100893. get outputs(): NodeMaterialConnectionPoint[];
  100894. /**
  100895. * Find an input by its name
  100896. * @param name defines the name of the input to look for
  100897. * @returns the input or null if not found
  100898. */
  100899. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  100900. /**
  100901. * Find an output by its name
  100902. * @param name defines the name of the outputto look for
  100903. * @returns the output or null if not found
  100904. */
  100905. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  100906. /**
  100907. * Creates a new NodeMaterialBlock
  100908. * @param name defines the block name
  100909. * @param target defines the target of that block (Vertex by default)
  100910. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  100911. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  100912. */
  100913. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  100914. /**
  100915. * Initialize the block and prepare the context for build
  100916. * @param state defines the state that will be used for the build
  100917. */
  100918. initialize(state: NodeMaterialBuildState): void;
  100919. /**
  100920. * Bind data to effect. Will only be called for blocks with isBindable === true
  100921. * @param effect defines the effect to bind data to
  100922. * @param nodeMaterial defines the hosting NodeMaterial
  100923. * @param mesh defines the mesh that will be rendered
  100924. * @param subMesh defines the submesh that will be rendered
  100925. */
  100926. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100927. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  100928. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  100929. protected _writeFloat(value: number): string;
  100930. /**
  100931. * Gets the current class name e.g. "NodeMaterialBlock"
  100932. * @returns the class name
  100933. */
  100934. getClassName(): string;
  100935. /**
  100936. * Register a new input. Must be called inside a block constructor
  100937. * @param name defines the connection point name
  100938. * @param type defines the connection point type
  100939. * @param isOptional defines a boolean indicating that this input can be omitted
  100940. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  100941. * @param point an already created connection point. If not provided, create a new one
  100942. * @returns the current block
  100943. */
  100944. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  100945. /**
  100946. * Register a new output. Must be called inside a block constructor
  100947. * @param name defines the connection point name
  100948. * @param type defines the connection point type
  100949. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  100950. * @param point an already created connection point. If not provided, create a new one
  100951. * @returns the current block
  100952. */
  100953. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  100954. /**
  100955. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  100956. * @param forOutput defines an optional connection point to check compatibility with
  100957. * @returns the first available input or null
  100958. */
  100959. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  100960. /**
  100961. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  100962. * @param forBlock defines an optional block to check compatibility with
  100963. * @returns the first available input or null
  100964. */
  100965. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  100966. /**
  100967. * Gets the sibling of the given output
  100968. * @param current defines the current output
  100969. * @returns the next output in the list or null
  100970. */
  100971. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  100972. /**
  100973. * Connect current block with another block
  100974. * @param other defines the block to connect with
  100975. * @param options define the various options to help pick the right connections
  100976. * @returns the current block
  100977. */
  100978. connectTo(other: NodeMaterialBlock, options?: {
  100979. input?: string;
  100980. output?: string;
  100981. outputSwizzle?: string;
  100982. }): this | undefined;
  100983. protected _buildBlock(state: NodeMaterialBuildState): void;
  100984. /**
  100985. * Add uniforms, samplers and uniform buffers at compilation time
  100986. * @param state defines the state to update
  100987. * @param nodeMaterial defines the node material requesting the update
  100988. * @param defines defines the material defines to update
  100989. * @param uniformBuffers defines the list of uniform buffer names
  100990. */
  100991. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  100992. /**
  100993. * Add potential fallbacks if shader compilation fails
  100994. * @param mesh defines the mesh to be rendered
  100995. * @param fallbacks defines the current prioritized list of fallbacks
  100996. */
  100997. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  100998. /**
  100999. * Initialize defines for shader compilation
  101000. * @param mesh defines the mesh to be rendered
  101001. * @param nodeMaterial defines the node material requesting the update
  101002. * @param defines defines the material defines to update
  101003. * @param useInstances specifies that instances should be used
  101004. */
  101005. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101006. /**
  101007. * Update defines for shader compilation
  101008. * @param mesh defines the mesh to be rendered
  101009. * @param nodeMaterial defines the node material requesting the update
  101010. * @param defines defines the material defines to update
  101011. * @param useInstances specifies that instances should be used
  101012. * @param subMesh defines which submesh to render
  101013. */
  101014. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101015. /**
  101016. * Lets the block try to connect some inputs automatically
  101017. * @param material defines the hosting NodeMaterial
  101018. */
  101019. autoConfigure(material: NodeMaterial): void;
  101020. /**
  101021. * Function called when a block is declared as repeatable content generator
  101022. * @param vertexShaderState defines the current compilation state for the vertex shader
  101023. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101024. * @param mesh defines the mesh to be rendered
  101025. * @param defines defines the material defines to update
  101026. */
  101027. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101028. /**
  101029. * Checks if the block is ready
  101030. * @param mesh defines the mesh to be rendered
  101031. * @param nodeMaterial defines the node material requesting the update
  101032. * @param defines defines the material defines to update
  101033. * @param useInstances specifies that instances should be used
  101034. * @returns true if the block is ready
  101035. */
  101036. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101037. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101038. private _processBuild;
  101039. /**
  101040. * Validates the new name for the block node.
  101041. * @param newName the new name to be given to the node.
  101042. * @returns false if the name is a reserve word, else true.
  101043. */
  101044. validateBlockName(newName: string): boolean;
  101045. /**
  101046. * Compile the current node and generate the shader code
  101047. * @param state defines the current compilation state (uniforms, samplers, current string)
  101048. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101049. * @returns true if already built
  101050. */
  101051. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101052. protected _inputRename(name: string): string;
  101053. protected _outputRename(name: string): string;
  101054. protected _dumpPropertiesCode(): string;
  101055. /** @hidden */
  101056. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101057. /** @hidden */
  101058. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101059. /**
  101060. * Clone the current block to a new identical block
  101061. * @param scene defines the hosting scene
  101062. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101063. * @returns a copy of the current block
  101064. */
  101065. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101066. /**
  101067. * Serializes this block in a JSON representation
  101068. * @returns the serialized block object
  101069. */
  101070. serialize(): any;
  101071. /** @hidden */
  101072. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101073. private _deserializePortDisplayNamesAndExposedOnFrame;
  101074. /**
  101075. * Release resources
  101076. */
  101077. dispose(): void;
  101078. }
  101079. }
  101080. declare module BABYLON {
  101081. /**
  101082. * Base class of materials working in push mode in babylon JS
  101083. * @hidden
  101084. */
  101085. export class PushMaterial extends Material {
  101086. protected _activeEffect: Effect;
  101087. protected _normalMatrix: Matrix;
  101088. constructor(name: string, scene: Scene);
  101089. getEffect(): Effect;
  101090. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101091. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101092. /**
  101093. * Binds the given world matrix to the active effect
  101094. *
  101095. * @param world the matrix to bind
  101096. */
  101097. bindOnlyWorldMatrix(world: Matrix): void;
  101098. /**
  101099. * Binds the given normal matrix to the active effect
  101100. *
  101101. * @param normalMatrix the matrix to bind
  101102. */
  101103. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101104. bind(world: Matrix, mesh?: Mesh): void;
  101105. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101106. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101107. }
  101108. }
  101109. declare module BABYLON {
  101110. /**
  101111. * Root class for all node material optimizers
  101112. */
  101113. export class NodeMaterialOptimizer {
  101114. /**
  101115. * Function used to optimize a NodeMaterial graph
  101116. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101117. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101118. */
  101119. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101120. }
  101121. }
  101122. declare module BABYLON {
  101123. /**
  101124. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101125. */
  101126. export class TransformBlock extends NodeMaterialBlock {
  101127. /**
  101128. * Defines the value to use to complement W value to transform it to a Vector4
  101129. */
  101130. complementW: number;
  101131. /**
  101132. * Defines the value to use to complement z value to transform it to a Vector4
  101133. */
  101134. complementZ: number;
  101135. /**
  101136. * Creates a new TransformBlock
  101137. * @param name defines the block name
  101138. */
  101139. constructor(name: string);
  101140. /**
  101141. * Gets the current class name
  101142. * @returns the class name
  101143. */
  101144. getClassName(): string;
  101145. /**
  101146. * Gets the vector input
  101147. */
  101148. get vector(): NodeMaterialConnectionPoint;
  101149. /**
  101150. * Gets the output component
  101151. */
  101152. get output(): NodeMaterialConnectionPoint;
  101153. /**
  101154. * Gets the xyz output component
  101155. */
  101156. get xyz(): NodeMaterialConnectionPoint;
  101157. /**
  101158. * Gets the matrix transform input
  101159. */
  101160. get transform(): NodeMaterialConnectionPoint;
  101161. protected _buildBlock(state: NodeMaterialBuildState): this;
  101162. /**
  101163. * Update defines for shader compilation
  101164. * @param mesh defines the mesh to be rendered
  101165. * @param nodeMaterial defines the node material requesting the update
  101166. * @param defines defines the material defines to update
  101167. * @param useInstances specifies that instances should be used
  101168. * @param subMesh defines which submesh to render
  101169. */
  101170. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101171. serialize(): any;
  101172. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101173. protected _dumpPropertiesCode(): string;
  101174. }
  101175. }
  101176. declare module BABYLON {
  101177. /**
  101178. * Block used to output the vertex position
  101179. */
  101180. export class VertexOutputBlock extends NodeMaterialBlock {
  101181. /**
  101182. * Creates a new VertexOutputBlock
  101183. * @param name defines the block name
  101184. */
  101185. constructor(name: string);
  101186. /**
  101187. * Gets the current class name
  101188. * @returns the class name
  101189. */
  101190. getClassName(): string;
  101191. /**
  101192. * Gets the vector input component
  101193. */
  101194. get vector(): NodeMaterialConnectionPoint;
  101195. protected _buildBlock(state: NodeMaterialBuildState): this;
  101196. }
  101197. }
  101198. declare module BABYLON {
  101199. /**
  101200. * Block used to output the final color
  101201. */
  101202. export class FragmentOutputBlock extends NodeMaterialBlock {
  101203. /**
  101204. * Create a new FragmentOutputBlock
  101205. * @param name defines the block name
  101206. */
  101207. constructor(name: string);
  101208. /**
  101209. * Gets the current class name
  101210. * @returns the class name
  101211. */
  101212. getClassName(): string;
  101213. /**
  101214. * Gets the rgba input component
  101215. */
  101216. get rgba(): NodeMaterialConnectionPoint;
  101217. /**
  101218. * Gets the rgb input component
  101219. */
  101220. get rgb(): NodeMaterialConnectionPoint;
  101221. /**
  101222. * Gets the a input component
  101223. */
  101224. get a(): NodeMaterialConnectionPoint;
  101225. protected _buildBlock(state: NodeMaterialBuildState): this;
  101226. }
  101227. }
  101228. declare module BABYLON {
  101229. /**
  101230. * Block used for the particle ramp gradient section
  101231. */
  101232. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101233. /**
  101234. * Create a new ParticleRampGradientBlock
  101235. * @param name defines the block name
  101236. */
  101237. constructor(name: string);
  101238. /**
  101239. * Gets the current class name
  101240. * @returns the class name
  101241. */
  101242. getClassName(): string;
  101243. /**
  101244. * Gets the color input component
  101245. */
  101246. get color(): NodeMaterialConnectionPoint;
  101247. /**
  101248. * Gets the rampColor output component
  101249. */
  101250. get rampColor(): NodeMaterialConnectionPoint;
  101251. /**
  101252. * Initialize the block and prepare the context for build
  101253. * @param state defines the state that will be used for the build
  101254. */
  101255. initialize(state: NodeMaterialBuildState): void;
  101256. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101257. }
  101258. }
  101259. declare module BABYLON {
  101260. /**
  101261. * Block used for the particle blend multiply section
  101262. */
  101263. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101264. /**
  101265. * Create a new ParticleBlendMultiplyBlock
  101266. * @param name defines the block name
  101267. */
  101268. constructor(name: string);
  101269. /**
  101270. * Gets the current class name
  101271. * @returns the class name
  101272. */
  101273. getClassName(): string;
  101274. /**
  101275. * Gets the color input component
  101276. */
  101277. get color(): NodeMaterialConnectionPoint;
  101278. /**
  101279. * Gets the alphaTexture input component
  101280. */
  101281. get alphaTexture(): NodeMaterialConnectionPoint;
  101282. /**
  101283. * Gets the alphaColor input component
  101284. */
  101285. get alphaColor(): NodeMaterialConnectionPoint;
  101286. /**
  101287. * Gets the blendColor output component
  101288. */
  101289. get blendColor(): NodeMaterialConnectionPoint;
  101290. /**
  101291. * Initialize the block and prepare the context for build
  101292. * @param state defines the state that will be used for the build
  101293. */
  101294. initialize(state: NodeMaterialBuildState): void;
  101295. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101296. }
  101297. }
  101298. declare module BABYLON {
  101299. /**
  101300. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101301. */
  101302. export class VectorMergerBlock extends NodeMaterialBlock {
  101303. /**
  101304. * Create a new VectorMergerBlock
  101305. * @param name defines the block name
  101306. */
  101307. constructor(name: string);
  101308. /**
  101309. * Gets the current class name
  101310. * @returns the class name
  101311. */
  101312. getClassName(): string;
  101313. /**
  101314. * Gets the xyz component (input)
  101315. */
  101316. get xyzIn(): NodeMaterialConnectionPoint;
  101317. /**
  101318. * Gets the xy component (input)
  101319. */
  101320. get xyIn(): NodeMaterialConnectionPoint;
  101321. /**
  101322. * Gets the x component (input)
  101323. */
  101324. get x(): NodeMaterialConnectionPoint;
  101325. /**
  101326. * Gets the y component (input)
  101327. */
  101328. get y(): NodeMaterialConnectionPoint;
  101329. /**
  101330. * Gets the z component (input)
  101331. */
  101332. get z(): NodeMaterialConnectionPoint;
  101333. /**
  101334. * Gets the w component (input)
  101335. */
  101336. get w(): NodeMaterialConnectionPoint;
  101337. /**
  101338. * Gets the xyzw component (output)
  101339. */
  101340. get xyzw(): NodeMaterialConnectionPoint;
  101341. /**
  101342. * Gets the xyz component (output)
  101343. */
  101344. get xyzOut(): NodeMaterialConnectionPoint;
  101345. /**
  101346. * Gets the xy component (output)
  101347. */
  101348. get xyOut(): NodeMaterialConnectionPoint;
  101349. /**
  101350. * Gets the xy component (output)
  101351. * @deprecated Please use xyOut instead.
  101352. */
  101353. get xy(): NodeMaterialConnectionPoint;
  101354. /**
  101355. * Gets the xyz component (output)
  101356. * @deprecated Please use xyzOut instead.
  101357. */
  101358. get xyz(): NodeMaterialConnectionPoint;
  101359. protected _buildBlock(state: NodeMaterialBuildState): this;
  101360. }
  101361. }
  101362. declare module BABYLON {
  101363. /**
  101364. * Block used to remap a float from a range to a new one
  101365. */
  101366. export class RemapBlock extends NodeMaterialBlock {
  101367. /**
  101368. * Gets or sets the source range
  101369. */
  101370. sourceRange: Vector2;
  101371. /**
  101372. * Gets or sets the target range
  101373. */
  101374. targetRange: Vector2;
  101375. /**
  101376. * Creates a new RemapBlock
  101377. * @param name defines the block name
  101378. */
  101379. constructor(name: string);
  101380. /**
  101381. * Gets the current class name
  101382. * @returns the class name
  101383. */
  101384. getClassName(): string;
  101385. /**
  101386. * Gets the input component
  101387. */
  101388. get input(): NodeMaterialConnectionPoint;
  101389. /**
  101390. * Gets the source min input component
  101391. */
  101392. get sourceMin(): NodeMaterialConnectionPoint;
  101393. /**
  101394. * Gets the source max input component
  101395. */
  101396. get sourceMax(): NodeMaterialConnectionPoint;
  101397. /**
  101398. * Gets the target min input component
  101399. */
  101400. get targetMin(): NodeMaterialConnectionPoint;
  101401. /**
  101402. * Gets the target max input component
  101403. */
  101404. get targetMax(): NodeMaterialConnectionPoint;
  101405. /**
  101406. * Gets the output component
  101407. */
  101408. get output(): NodeMaterialConnectionPoint;
  101409. protected _buildBlock(state: NodeMaterialBuildState): this;
  101410. protected _dumpPropertiesCode(): string;
  101411. serialize(): any;
  101412. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101413. }
  101414. }
  101415. declare module BABYLON {
  101416. /**
  101417. * Block used to multiply 2 values
  101418. */
  101419. export class MultiplyBlock extends NodeMaterialBlock {
  101420. /**
  101421. * Creates a new MultiplyBlock
  101422. * @param name defines the block name
  101423. */
  101424. constructor(name: string);
  101425. /**
  101426. * Gets the current class name
  101427. * @returns the class name
  101428. */
  101429. getClassName(): string;
  101430. /**
  101431. * Gets the left operand input component
  101432. */
  101433. get left(): NodeMaterialConnectionPoint;
  101434. /**
  101435. * Gets the right operand input component
  101436. */
  101437. get right(): NodeMaterialConnectionPoint;
  101438. /**
  101439. * Gets the output component
  101440. */
  101441. get output(): NodeMaterialConnectionPoint;
  101442. protected _buildBlock(state: NodeMaterialBuildState): this;
  101443. }
  101444. }
  101445. declare module BABYLON {
  101446. /**
  101447. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101448. */
  101449. export class ColorSplitterBlock extends NodeMaterialBlock {
  101450. /**
  101451. * Create a new ColorSplitterBlock
  101452. * @param name defines the block name
  101453. */
  101454. constructor(name: string);
  101455. /**
  101456. * Gets the current class name
  101457. * @returns the class name
  101458. */
  101459. getClassName(): string;
  101460. /**
  101461. * Gets the rgba component (input)
  101462. */
  101463. get rgba(): NodeMaterialConnectionPoint;
  101464. /**
  101465. * Gets the rgb component (input)
  101466. */
  101467. get rgbIn(): NodeMaterialConnectionPoint;
  101468. /**
  101469. * Gets the rgb component (output)
  101470. */
  101471. get rgbOut(): NodeMaterialConnectionPoint;
  101472. /**
  101473. * Gets the r component (output)
  101474. */
  101475. get r(): NodeMaterialConnectionPoint;
  101476. /**
  101477. * Gets the g component (output)
  101478. */
  101479. get g(): NodeMaterialConnectionPoint;
  101480. /**
  101481. * Gets the b component (output)
  101482. */
  101483. get b(): NodeMaterialConnectionPoint;
  101484. /**
  101485. * Gets the a component (output)
  101486. */
  101487. get a(): NodeMaterialConnectionPoint;
  101488. protected _inputRename(name: string): string;
  101489. protected _outputRename(name: string): string;
  101490. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101491. }
  101492. }
  101493. declare module BABYLON {
  101494. /**
  101495. * Interface used to configure the node material editor
  101496. */
  101497. export interface INodeMaterialEditorOptions {
  101498. /** Define the URl to load node editor script */
  101499. editorURL?: string;
  101500. }
  101501. /** @hidden */
  101502. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101503. NORMAL: boolean;
  101504. TANGENT: boolean;
  101505. UV1: boolean;
  101506. /** BONES */
  101507. NUM_BONE_INFLUENCERS: number;
  101508. BonesPerMesh: number;
  101509. BONETEXTURE: boolean;
  101510. /** MORPH TARGETS */
  101511. MORPHTARGETS: boolean;
  101512. MORPHTARGETS_NORMAL: boolean;
  101513. MORPHTARGETS_TANGENT: boolean;
  101514. MORPHTARGETS_UV: boolean;
  101515. NUM_MORPH_INFLUENCERS: number;
  101516. /** IMAGE PROCESSING */
  101517. IMAGEPROCESSING: boolean;
  101518. VIGNETTE: boolean;
  101519. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101520. VIGNETTEBLENDMODEOPAQUE: boolean;
  101521. TONEMAPPING: boolean;
  101522. TONEMAPPING_ACES: boolean;
  101523. CONTRAST: boolean;
  101524. EXPOSURE: boolean;
  101525. COLORCURVES: boolean;
  101526. COLORGRADING: boolean;
  101527. COLORGRADING3D: boolean;
  101528. SAMPLER3DGREENDEPTH: boolean;
  101529. SAMPLER3DBGRMAP: boolean;
  101530. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101531. /** MISC. */
  101532. BUMPDIRECTUV: number;
  101533. constructor();
  101534. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101535. }
  101536. /**
  101537. * Class used to configure NodeMaterial
  101538. */
  101539. export interface INodeMaterialOptions {
  101540. /**
  101541. * Defines if blocks should emit comments
  101542. */
  101543. emitComments: boolean;
  101544. }
  101545. /**
  101546. * Class used to create a node based material built by assembling shader blocks
  101547. */
  101548. export class NodeMaterial extends PushMaterial {
  101549. private static _BuildIdGenerator;
  101550. private _options;
  101551. private _vertexCompilationState;
  101552. private _fragmentCompilationState;
  101553. private _sharedData;
  101554. private _buildId;
  101555. private _buildWasSuccessful;
  101556. private _cachedWorldViewMatrix;
  101557. private _cachedWorldViewProjectionMatrix;
  101558. private _optimizers;
  101559. private _animationFrame;
  101560. /** Define the Url to load node editor script */
  101561. static EditorURL: string;
  101562. /** Define the Url to load snippets */
  101563. static SnippetUrl: string;
  101564. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  101565. static IgnoreTexturesAtLoadTime: boolean;
  101566. private BJSNODEMATERIALEDITOR;
  101567. /** Get the inspector from bundle or global */
  101568. private _getGlobalNodeMaterialEditor;
  101569. /**
  101570. * Snippet ID if the material was created from the snippet server
  101571. */
  101572. snippetId: string;
  101573. /**
  101574. * Gets or sets data used by visual editor
  101575. * @see https://nme.babylonjs.com
  101576. */
  101577. editorData: any;
  101578. /**
  101579. * 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)
  101580. */
  101581. ignoreAlpha: boolean;
  101582. /**
  101583. * Defines the maximum number of lights that can be used in the material
  101584. */
  101585. maxSimultaneousLights: number;
  101586. /**
  101587. * Observable raised when the material is built
  101588. */
  101589. onBuildObservable: Observable<NodeMaterial>;
  101590. /**
  101591. * Gets or sets the root nodes of the material vertex shader
  101592. */
  101593. _vertexOutputNodes: NodeMaterialBlock[];
  101594. /**
  101595. * Gets or sets the root nodes of the material fragment (pixel) shader
  101596. */
  101597. _fragmentOutputNodes: NodeMaterialBlock[];
  101598. /** Gets or sets options to control the node material overall behavior */
  101599. get options(): INodeMaterialOptions;
  101600. set options(options: INodeMaterialOptions);
  101601. /**
  101602. * Default configuration related to image processing available in the standard Material.
  101603. */
  101604. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101605. /**
  101606. * Gets the image processing configuration used either in this material.
  101607. */
  101608. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  101609. /**
  101610. * Sets the Default image processing configuration used either in the this material.
  101611. *
  101612. * If sets to null, the scene one is in use.
  101613. */
  101614. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  101615. /**
  101616. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  101617. */
  101618. attachedBlocks: NodeMaterialBlock[];
  101619. /**
  101620. * Specifies the mode of the node material
  101621. * @hidden
  101622. */
  101623. _mode: NodeMaterialModes;
  101624. /**
  101625. * Gets the mode property
  101626. */
  101627. get mode(): NodeMaterialModes;
  101628. /**
  101629. * Create a new node based material
  101630. * @param name defines the material name
  101631. * @param scene defines the hosting scene
  101632. * @param options defines creation option
  101633. */
  101634. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  101635. /**
  101636. * Gets the current class name of the material e.g. "NodeMaterial"
  101637. * @returns the class name
  101638. */
  101639. getClassName(): string;
  101640. /**
  101641. * Keep track of the image processing observer to allow dispose and replace.
  101642. */
  101643. private _imageProcessingObserver;
  101644. /**
  101645. * Attaches a new image processing configuration to the Standard Material.
  101646. * @param configuration
  101647. */
  101648. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  101649. /**
  101650. * Get a block by its name
  101651. * @param name defines the name of the block to retrieve
  101652. * @returns the required block or null if not found
  101653. */
  101654. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  101655. /**
  101656. * Get a block by its name
  101657. * @param predicate defines the predicate used to find the good candidate
  101658. * @returns the required block or null if not found
  101659. */
  101660. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  101661. /**
  101662. * Get an input block by its name
  101663. * @param predicate defines the predicate used to find the good candidate
  101664. * @returns the required input block or null if not found
  101665. */
  101666. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  101667. /**
  101668. * Gets the list of input blocks attached to this material
  101669. * @returns an array of InputBlocks
  101670. */
  101671. getInputBlocks(): InputBlock[];
  101672. /**
  101673. * Adds a new optimizer to the list of optimizers
  101674. * @param optimizer defines the optimizers to add
  101675. * @returns the current material
  101676. */
  101677. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  101678. /**
  101679. * Remove an optimizer from the list of optimizers
  101680. * @param optimizer defines the optimizers to remove
  101681. * @returns the current material
  101682. */
  101683. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  101684. /**
  101685. * Add a new block to the list of output nodes
  101686. * @param node defines the node to add
  101687. * @returns the current material
  101688. */
  101689. addOutputNode(node: NodeMaterialBlock): this;
  101690. /**
  101691. * Remove a block from the list of root nodes
  101692. * @param node defines the node to remove
  101693. * @returns the current material
  101694. */
  101695. removeOutputNode(node: NodeMaterialBlock): this;
  101696. private _addVertexOutputNode;
  101697. private _removeVertexOutputNode;
  101698. private _addFragmentOutputNode;
  101699. private _removeFragmentOutputNode;
  101700. /**
  101701. * Specifies if the material will require alpha blending
  101702. * @returns a boolean specifying if alpha blending is needed
  101703. */
  101704. needAlphaBlending(): boolean;
  101705. /**
  101706. * Specifies if this material should be rendered in alpha test mode
  101707. * @returns a boolean specifying if an alpha test is needed.
  101708. */
  101709. needAlphaTesting(): boolean;
  101710. private _initializeBlock;
  101711. private _resetDualBlocks;
  101712. /**
  101713. * Remove a block from the current node material
  101714. * @param block defines the block to remove
  101715. */
  101716. removeBlock(block: NodeMaterialBlock): void;
  101717. /**
  101718. * Build the material and generates the inner effect
  101719. * @param verbose defines if the build should log activity
  101720. */
  101721. build(verbose?: boolean): void;
  101722. /**
  101723. * Runs an otpimization phase to try to improve the shader code
  101724. */
  101725. optimize(): void;
  101726. private _prepareDefinesForAttributes;
  101727. /**
  101728. * Create a post process from the material
  101729. * @param camera The camera to apply the render pass to.
  101730. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  101731. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  101732. * @param engine The engine which the post process will be applied. (default: current engine)
  101733. * @param reusable If the post process can be reused on the same frame. (default: false)
  101734. * @param textureType Type of textures used when performing the post process. (default: 0)
  101735. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  101736. * @returns the post process created
  101737. */
  101738. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  101739. /**
  101740. * Create the post process effect from the material
  101741. * @param postProcess The post process to create the effect for
  101742. */
  101743. createEffectForPostProcess(postProcess: PostProcess): void;
  101744. private _createEffectOrPostProcess;
  101745. private _createEffectForParticles;
  101746. /**
  101747. * Create the effect to be used as the custom effect for a particle system
  101748. * @param particleSystem Particle system to create the effect for
  101749. * @param onCompiled defines a function to call when the effect creation is successful
  101750. * @param onError defines a function to call when the effect creation has failed
  101751. */
  101752. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  101753. private _processDefines;
  101754. /**
  101755. * Get if the submesh is ready to be used and all its information available.
  101756. * Child classes can use it to update shaders
  101757. * @param mesh defines the mesh to check
  101758. * @param subMesh defines which submesh to check
  101759. * @param useInstances specifies that instances should be used
  101760. * @returns a boolean indicating that the submesh is ready or not
  101761. */
  101762. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  101763. /**
  101764. * Get a string representing the shaders built by the current node graph
  101765. */
  101766. get compiledShaders(): string;
  101767. /**
  101768. * Binds the world matrix to the material
  101769. * @param world defines the world transformation matrix
  101770. */
  101771. bindOnlyWorldMatrix(world: Matrix): void;
  101772. /**
  101773. * Binds the submesh to this material by preparing the effect and shader to draw
  101774. * @param world defines the world transformation matrix
  101775. * @param mesh defines the mesh containing the submesh
  101776. * @param subMesh defines the submesh to bind the material to
  101777. */
  101778. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  101779. /**
  101780. * Gets the active textures from the material
  101781. * @returns an array of textures
  101782. */
  101783. getActiveTextures(): BaseTexture[];
  101784. /**
  101785. * Gets the list of texture blocks
  101786. * @returns an array of texture blocks
  101787. */
  101788. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  101789. /**
  101790. * Specifies if the material uses a texture
  101791. * @param texture defines the texture to check against the material
  101792. * @returns a boolean specifying if the material uses the texture
  101793. */
  101794. hasTexture(texture: BaseTexture): boolean;
  101795. /**
  101796. * Disposes the material
  101797. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  101798. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  101799. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  101800. */
  101801. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  101802. /** Creates the node editor window. */
  101803. private _createNodeEditor;
  101804. /**
  101805. * Launch the node material editor
  101806. * @param config Define the configuration of the editor
  101807. * @return a promise fulfilled when the node editor is visible
  101808. */
  101809. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  101810. /**
  101811. * Clear the current material
  101812. */
  101813. clear(): void;
  101814. /**
  101815. * Clear the current material and set it to a default state
  101816. */
  101817. setToDefault(): void;
  101818. /**
  101819. * Clear the current material and set it to a default state for post process
  101820. */
  101821. setToDefaultPostProcess(): void;
  101822. /**
  101823. * Clear the current material and set it to a default state for particle
  101824. */
  101825. setToDefaultParticle(): void;
  101826. /**
  101827. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  101828. * @param url defines the url to load from
  101829. * @returns a promise that will fullfil when the material is fully loaded
  101830. */
  101831. loadAsync(url: string): Promise<void>;
  101832. private _gatherBlocks;
  101833. /**
  101834. * Generate a string containing the code declaration required to create an equivalent of this material
  101835. * @returns a string
  101836. */
  101837. generateCode(): string;
  101838. /**
  101839. * Serializes this material in a JSON representation
  101840. * @returns the serialized material object
  101841. */
  101842. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  101843. private _restoreConnections;
  101844. /**
  101845. * Clear the current graph and load a new one from a serialization object
  101846. * @param source defines the JSON representation of the material
  101847. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101848. * @param merge defines whether or not the source must be merged or replace the current content
  101849. */
  101850. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  101851. /**
  101852. * Makes a duplicate of the current material.
  101853. * @param name - name to use for the new material.
  101854. */
  101855. clone(name: string): NodeMaterial;
  101856. /**
  101857. * Creates a node material from parsed material data
  101858. * @param source defines the JSON representation of the material
  101859. * @param scene defines the hosting scene
  101860. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101861. * @returns a new node material
  101862. */
  101863. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  101864. /**
  101865. * Creates a node material from a snippet saved in a remote file
  101866. * @param name defines the name of the material to create
  101867. * @param url defines the url to load from
  101868. * @param scene defines the hosting scene
  101869. * @returns a promise that will resolve to the new node material
  101870. */
  101871. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  101872. /**
  101873. * Creates a node material from a snippet saved by the node material editor
  101874. * @param snippetId defines the snippet to load
  101875. * @param scene defines the hosting scene
  101876. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101877. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  101878. * @returns a promise that will resolve to the new node material
  101879. */
  101880. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  101881. /**
  101882. * Creates a new node material set to default basic configuration
  101883. * @param name defines the name of the material
  101884. * @param scene defines the hosting scene
  101885. * @returns a new NodeMaterial
  101886. */
  101887. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  101888. }
  101889. }
  101890. declare module BABYLON {
  101891. /**
  101892. * Size options for a post process
  101893. */
  101894. export type PostProcessOptions = {
  101895. width: number;
  101896. height: number;
  101897. };
  101898. /**
  101899. * PostProcess can be used to apply a shader to a texture after it has been rendered
  101900. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  101901. */
  101902. export class PostProcess {
  101903. /**
  101904. * Gets or sets the unique id of the post process
  101905. */
  101906. uniqueId: number;
  101907. /** Name of the PostProcess. */
  101908. name: string;
  101909. /**
  101910. * Width of the texture to apply the post process on
  101911. */
  101912. width: number;
  101913. /**
  101914. * Height of the texture to apply the post process on
  101915. */
  101916. height: number;
  101917. /**
  101918. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  101919. */
  101920. nodeMaterialSource: Nullable<NodeMaterial>;
  101921. /**
  101922. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  101923. * @hidden
  101924. */
  101925. _outputTexture: Nullable<InternalTexture>;
  101926. /**
  101927. * Sampling mode used by the shader
  101928. * See https://doc.babylonjs.com/classes/3.1/texture
  101929. */
  101930. renderTargetSamplingMode: number;
  101931. /**
  101932. * Clear color to use when screen clearing
  101933. */
  101934. clearColor: Color4;
  101935. /**
  101936. * If the buffer needs to be cleared before applying the post process. (default: true)
  101937. * Should be set to false if shader will overwrite all previous pixels.
  101938. */
  101939. autoClear: boolean;
  101940. /**
  101941. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  101942. */
  101943. alphaMode: number;
  101944. /**
  101945. * Sets the setAlphaBlendConstants of the babylon engine
  101946. */
  101947. alphaConstants: Color4;
  101948. /**
  101949. * Animations to be used for the post processing
  101950. */
  101951. animations: Animation[];
  101952. /**
  101953. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  101954. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  101955. */
  101956. enablePixelPerfectMode: boolean;
  101957. /**
  101958. * Force the postprocess to be applied without taking in account viewport
  101959. */
  101960. forceFullscreenViewport: boolean;
  101961. /**
  101962. * List of inspectable custom properties (used by the Inspector)
  101963. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  101964. */
  101965. inspectableCustomProperties: IInspectable[];
  101966. /**
  101967. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  101968. *
  101969. * | Value | Type | Description |
  101970. * | ----- | ----------------------------------- | ----------- |
  101971. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  101972. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  101973. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  101974. *
  101975. */
  101976. scaleMode: number;
  101977. /**
  101978. * Force textures to be a power of two (default: false)
  101979. */
  101980. alwaysForcePOT: boolean;
  101981. private _samples;
  101982. /**
  101983. * Number of sample textures (default: 1)
  101984. */
  101985. get samples(): number;
  101986. set samples(n: number);
  101987. /**
  101988. * Modify the scale of the post process to be the same as the viewport (default: false)
  101989. */
  101990. adaptScaleToCurrentViewport: boolean;
  101991. private _camera;
  101992. protected _scene: Scene;
  101993. private _engine;
  101994. private _options;
  101995. private _reusable;
  101996. private _textureType;
  101997. private _textureFormat;
  101998. /**
  101999. * Smart array of input and output textures for the post process.
  102000. * @hidden
  102001. */
  102002. _textures: SmartArray<InternalTexture>;
  102003. /**
  102004. * The index in _textures that corresponds to the output texture.
  102005. * @hidden
  102006. */
  102007. _currentRenderTextureInd: number;
  102008. private _effect;
  102009. private _samplers;
  102010. private _fragmentUrl;
  102011. private _vertexUrl;
  102012. private _parameters;
  102013. private _scaleRatio;
  102014. protected _indexParameters: any;
  102015. private _shareOutputWithPostProcess;
  102016. private _texelSize;
  102017. private _forcedOutputTexture;
  102018. /**
  102019. * Returns the fragment url or shader name used in the post process.
  102020. * @returns the fragment url or name in the shader store.
  102021. */
  102022. getEffectName(): string;
  102023. /**
  102024. * An event triggered when the postprocess is activated.
  102025. */
  102026. onActivateObservable: Observable<Camera>;
  102027. private _onActivateObserver;
  102028. /**
  102029. * A function that is added to the onActivateObservable
  102030. */
  102031. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102032. /**
  102033. * An event triggered when the postprocess changes its size.
  102034. */
  102035. onSizeChangedObservable: Observable<PostProcess>;
  102036. private _onSizeChangedObserver;
  102037. /**
  102038. * A function that is added to the onSizeChangedObservable
  102039. */
  102040. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102041. /**
  102042. * An event triggered when the postprocess applies its effect.
  102043. */
  102044. onApplyObservable: Observable<Effect>;
  102045. private _onApplyObserver;
  102046. /**
  102047. * A function that is added to the onApplyObservable
  102048. */
  102049. set onApply(callback: (effect: Effect) => void);
  102050. /**
  102051. * An event triggered before rendering the postprocess
  102052. */
  102053. onBeforeRenderObservable: Observable<Effect>;
  102054. private _onBeforeRenderObserver;
  102055. /**
  102056. * A function that is added to the onBeforeRenderObservable
  102057. */
  102058. set onBeforeRender(callback: (effect: Effect) => void);
  102059. /**
  102060. * An event triggered after rendering the postprocess
  102061. */
  102062. onAfterRenderObservable: Observable<Effect>;
  102063. private _onAfterRenderObserver;
  102064. /**
  102065. * A function that is added to the onAfterRenderObservable
  102066. */
  102067. set onAfterRender(callback: (efect: Effect) => void);
  102068. /**
  102069. * 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
  102070. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102071. */
  102072. get inputTexture(): InternalTexture;
  102073. set inputTexture(value: InternalTexture);
  102074. /**
  102075. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102076. * the only way to unset it is to use this function to restore its internal state
  102077. */
  102078. restoreDefaultInputTexture(): void;
  102079. /**
  102080. * Gets the camera which post process is applied to.
  102081. * @returns The camera the post process is applied to.
  102082. */
  102083. getCamera(): Camera;
  102084. /**
  102085. * Gets the texel size of the postprocess.
  102086. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102087. */
  102088. get texelSize(): Vector2;
  102089. /**
  102090. * Creates a new instance PostProcess
  102091. * @param name The name of the PostProcess.
  102092. * @param fragmentUrl The url of the fragment shader to be used.
  102093. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102094. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102095. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102096. * @param camera The camera to apply the render pass to.
  102097. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102098. * @param engine The engine which the post process will be applied. (default: current engine)
  102099. * @param reusable If the post process can be reused on the same frame. (default: false)
  102100. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102101. * @param textureType Type of textures used when performing the post process. (default: 0)
  102102. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102103. * @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
  102104. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102105. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102106. */
  102107. 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);
  102108. /**
  102109. * Gets a string identifying the name of the class
  102110. * @returns "PostProcess" string
  102111. */
  102112. getClassName(): string;
  102113. /**
  102114. * Gets the engine which this post process belongs to.
  102115. * @returns The engine the post process was enabled with.
  102116. */
  102117. getEngine(): Engine;
  102118. /**
  102119. * The effect that is created when initializing the post process.
  102120. * @returns The created effect corresponding the the postprocess.
  102121. */
  102122. getEffect(): Effect;
  102123. /**
  102124. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102125. * @param postProcess The post process to share the output with.
  102126. * @returns This post process.
  102127. */
  102128. shareOutputWith(postProcess: PostProcess): PostProcess;
  102129. /**
  102130. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102131. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102132. */
  102133. useOwnOutput(): void;
  102134. /**
  102135. * Updates the effect with the current post process compile time values and recompiles the shader.
  102136. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102137. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102138. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102139. * @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
  102140. * @param onCompiled Called when the shader has been compiled.
  102141. * @param onError Called if there is an error when compiling a shader.
  102142. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102143. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102144. */
  102145. 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;
  102146. /**
  102147. * The post process is reusable if it can be used multiple times within one frame.
  102148. * @returns If the post process is reusable
  102149. */
  102150. isReusable(): boolean;
  102151. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102152. markTextureDirty(): void;
  102153. /**
  102154. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102155. * 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.
  102156. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102157. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102158. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102159. * @returns The target texture that was bound to be written to.
  102160. */
  102161. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102162. /**
  102163. * If the post process is supported.
  102164. */
  102165. get isSupported(): boolean;
  102166. /**
  102167. * The aspect ratio of the output texture.
  102168. */
  102169. get aspectRatio(): number;
  102170. /**
  102171. * Get a value indicating if the post-process is ready to be used
  102172. * @returns true if the post-process is ready (shader is compiled)
  102173. */
  102174. isReady(): boolean;
  102175. /**
  102176. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102177. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102178. */
  102179. apply(): Nullable<Effect>;
  102180. private _disposeTextures;
  102181. /**
  102182. * Disposes the post process.
  102183. * @param camera The camera to dispose the post process on.
  102184. */
  102185. dispose(camera?: Camera): void;
  102186. /**
  102187. * Serializes the particle system to a JSON object
  102188. * @returns the JSON object
  102189. */
  102190. serialize(): any;
  102191. /**
  102192. * Creates a material from parsed material data
  102193. * @param parsedPostProcess defines parsed post process data
  102194. * @param scene defines the hosting scene
  102195. * @param rootUrl defines the root URL to use to load textures
  102196. * @returns a new post process
  102197. */
  102198. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102199. }
  102200. }
  102201. declare module BABYLON {
  102202. /** @hidden */
  102203. export var kernelBlurVaryingDeclaration: {
  102204. name: string;
  102205. shader: string;
  102206. };
  102207. }
  102208. declare module BABYLON {
  102209. /** @hidden */
  102210. export var kernelBlurFragment: {
  102211. name: string;
  102212. shader: string;
  102213. };
  102214. }
  102215. declare module BABYLON {
  102216. /** @hidden */
  102217. export var kernelBlurFragment2: {
  102218. name: string;
  102219. shader: string;
  102220. };
  102221. }
  102222. declare module BABYLON {
  102223. /** @hidden */
  102224. export var kernelBlurPixelShader: {
  102225. name: string;
  102226. shader: string;
  102227. };
  102228. }
  102229. declare module BABYLON {
  102230. /** @hidden */
  102231. export var kernelBlurVertex: {
  102232. name: string;
  102233. shader: string;
  102234. };
  102235. }
  102236. declare module BABYLON {
  102237. /** @hidden */
  102238. export var kernelBlurVertexShader: {
  102239. name: string;
  102240. shader: string;
  102241. };
  102242. }
  102243. declare module BABYLON {
  102244. /**
  102245. * The Blur Post Process which blurs an image based on a kernel and direction.
  102246. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102247. */
  102248. export class BlurPostProcess extends PostProcess {
  102249. private blockCompilation;
  102250. protected _kernel: number;
  102251. protected _idealKernel: number;
  102252. protected _packedFloat: boolean;
  102253. private _staticDefines;
  102254. /** The direction in which to blur the image. */
  102255. direction: Vector2;
  102256. /**
  102257. * Sets the length in pixels of the blur sample region
  102258. */
  102259. set kernel(v: number);
  102260. /**
  102261. * Gets the length in pixels of the blur sample region
  102262. */
  102263. get kernel(): number;
  102264. /**
  102265. * Sets wether or not the blur needs to unpack/repack floats
  102266. */
  102267. set packedFloat(v: boolean);
  102268. /**
  102269. * Gets wether or not the blur is unpacking/repacking floats
  102270. */
  102271. get packedFloat(): boolean;
  102272. /**
  102273. * Gets a string identifying the name of the class
  102274. * @returns "BlurPostProcess" string
  102275. */
  102276. getClassName(): string;
  102277. /**
  102278. * Creates a new instance BlurPostProcess
  102279. * @param name The name of the effect.
  102280. * @param direction The direction in which to blur the image.
  102281. * @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.
  102282. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102283. * @param camera The camera to apply the render pass to.
  102284. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102285. * @param engine The engine which the post process will be applied. (default: current engine)
  102286. * @param reusable If the post process can be reused on the same frame. (default: false)
  102287. * @param textureType Type of textures used when performing the post process. (default: 0)
  102288. * @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)
  102289. */
  102290. 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);
  102291. /**
  102292. * Updates the effect with the current post process compile time values and recompiles the shader.
  102293. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102294. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102295. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102296. * @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
  102297. * @param onCompiled Called when the shader has been compiled.
  102298. * @param onError Called if there is an error when compiling a shader.
  102299. */
  102300. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102301. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102302. /**
  102303. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102304. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102305. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102306. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102307. * The gaps between physical kernels are compensated for in the weighting of the samples
  102308. * @param idealKernel Ideal blur kernel.
  102309. * @return Nearest best kernel.
  102310. */
  102311. protected _nearestBestKernel(idealKernel: number): number;
  102312. /**
  102313. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102314. * @param x The point on the Gaussian distribution to sample.
  102315. * @return the value of the Gaussian function at x.
  102316. */
  102317. protected _gaussianWeight(x: number): number;
  102318. /**
  102319. * Generates a string that can be used as a floating point number in GLSL.
  102320. * @param x Value to print.
  102321. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102322. * @return GLSL float string.
  102323. */
  102324. protected _glslFloat(x: number, decimalFigures?: number): string;
  102325. /** @hidden */
  102326. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102327. }
  102328. }
  102329. declare module BABYLON {
  102330. /**
  102331. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102332. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102333. * You can then easily use it as a reflectionTexture on a flat surface.
  102334. * In case the surface is not a plane, please consider relying on reflection probes.
  102335. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102336. */
  102337. export class MirrorTexture extends RenderTargetTexture {
  102338. private scene;
  102339. /**
  102340. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102341. * 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.
  102342. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102343. */
  102344. mirrorPlane: Plane;
  102345. /**
  102346. * Define the blur ratio used to blur the reflection if needed.
  102347. */
  102348. set blurRatio(value: number);
  102349. get blurRatio(): number;
  102350. /**
  102351. * Define the adaptive blur kernel used to blur the reflection if needed.
  102352. * This will autocompute the closest best match for the `blurKernel`
  102353. */
  102354. set adaptiveBlurKernel(value: number);
  102355. /**
  102356. * Define the blur kernel used to blur the reflection if needed.
  102357. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102358. */
  102359. set blurKernel(value: number);
  102360. /**
  102361. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102362. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102363. */
  102364. set blurKernelX(value: number);
  102365. get blurKernelX(): number;
  102366. /**
  102367. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102368. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102369. */
  102370. set blurKernelY(value: number);
  102371. get blurKernelY(): number;
  102372. private _autoComputeBlurKernel;
  102373. protected _onRatioRescale(): void;
  102374. private _updateGammaSpace;
  102375. private _imageProcessingConfigChangeObserver;
  102376. private _transformMatrix;
  102377. private _mirrorMatrix;
  102378. private _savedViewMatrix;
  102379. private _blurX;
  102380. private _blurY;
  102381. private _adaptiveBlurKernel;
  102382. private _blurKernelX;
  102383. private _blurKernelY;
  102384. private _blurRatio;
  102385. /**
  102386. * Instantiates a Mirror Texture.
  102387. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102388. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102389. * You can then easily use it as a reflectionTexture on a flat surface.
  102390. * In case the surface is not a plane, please consider relying on reflection probes.
  102391. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102392. * @param name
  102393. * @param size
  102394. * @param scene
  102395. * @param generateMipMaps
  102396. * @param type
  102397. * @param samplingMode
  102398. * @param generateDepthBuffer
  102399. */
  102400. constructor(name: string, size: number | {
  102401. width: number;
  102402. height: number;
  102403. } | {
  102404. ratio: number;
  102405. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102406. private _preparePostProcesses;
  102407. /**
  102408. * Clone the mirror texture.
  102409. * @returns the cloned texture
  102410. */
  102411. clone(): MirrorTexture;
  102412. /**
  102413. * Serialize the texture to a JSON representation you could use in Parse later on
  102414. * @returns the serialized JSON representation
  102415. */
  102416. serialize(): any;
  102417. /**
  102418. * Dispose the texture and release its associated resources.
  102419. */
  102420. dispose(): void;
  102421. }
  102422. }
  102423. declare module BABYLON {
  102424. /**
  102425. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102426. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102427. */
  102428. export class Texture extends BaseTexture {
  102429. /**
  102430. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102431. */
  102432. static SerializeBuffers: boolean;
  102433. /** @hidden */
  102434. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102435. /** @hidden */
  102436. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102437. /** @hidden */
  102438. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102439. /** nearest is mag = nearest and min = nearest and mip = linear */
  102440. static readonly NEAREST_SAMPLINGMODE: number;
  102441. /** nearest is mag = nearest and min = nearest and mip = linear */
  102442. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102443. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102444. static readonly BILINEAR_SAMPLINGMODE: number;
  102445. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102446. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102447. /** Trilinear is mag = linear and min = linear and mip = linear */
  102448. static readonly TRILINEAR_SAMPLINGMODE: number;
  102449. /** Trilinear is mag = linear and min = linear and mip = linear */
  102450. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102451. /** mag = nearest and min = nearest and mip = nearest */
  102452. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102453. /** mag = nearest and min = linear and mip = nearest */
  102454. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102455. /** mag = nearest and min = linear and mip = linear */
  102456. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102457. /** mag = nearest and min = linear and mip = none */
  102458. static readonly NEAREST_LINEAR: number;
  102459. /** mag = nearest and min = nearest and mip = none */
  102460. static readonly NEAREST_NEAREST: number;
  102461. /** mag = linear and min = nearest and mip = nearest */
  102462. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102463. /** mag = linear and min = nearest and mip = linear */
  102464. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102465. /** mag = linear and min = linear and mip = none */
  102466. static readonly LINEAR_LINEAR: number;
  102467. /** mag = linear and min = nearest and mip = none */
  102468. static readonly LINEAR_NEAREST: number;
  102469. /** Explicit coordinates mode */
  102470. static readonly EXPLICIT_MODE: number;
  102471. /** Spherical coordinates mode */
  102472. static readonly SPHERICAL_MODE: number;
  102473. /** Planar coordinates mode */
  102474. static readonly PLANAR_MODE: number;
  102475. /** Cubic coordinates mode */
  102476. static readonly CUBIC_MODE: number;
  102477. /** Projection coordinates mode */
  102478. static readonly PROJECTION_MODE: number;
  102479. /** Inverse Cubic coordinates mode */
  102480. static readonly SKYBOX_MODE: number;
  102481. /** Inverse Cubic coordinates mode */
  102482. static readonly INVCUBIC_MODE: number;
  102483. /** Equirectangular coordinates mode */
  102484. static readonly EQUIRECTANGULAR_MODE: number;
  102485. /** Equirectangular Fixed coordinates mode */
  102486. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102487. /** Equirectangular Fixed Mirrored coordinates mode */
  102488. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102489. /** Texture is not repeating outside of 0..1 UVs */
  102490. static readonly CLAMP_ADDRESSMODE: number;
  102491. /** Texture is repeating outside of 0..1 UVs */
  102492. static readonly WRAP_ADDRESSMODE: number;
  102493. /** Texture is repeating and mirrored */
  102494. static readonly MIRROR_ADDRESSMODE: number;
  102495. /**
  102496. * 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
  102497. */
  102498. static UseSerializedUrlIfAny: boolean;
  102499. /**
  102500. * Define the url of the texture.
  102501. */
  102502. url: Nullable<string>;
  102503. /**
  102504. * Define an offset on the texture to offset the u coordinates of the UVs
  102505. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102506. */
  102507. uOffset: number;
  102508. /**
  102509. * Define an offset on the texture to offset the v coordinates of the UVs
  102510. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102511. */
  102512. vOffset: number;
  102513. /**
  102514. * Define an offset on the texture to scale the u coordinates of the UVs
  102515. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102516. */
  102517. uScale: number;
  102518. /**
  102519. * Define an offset on the texture to scale the v coordinates of the UVs
  102520. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102521. */
  102522. vScale: number;
  102523. /**
  102524. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102525. * @see https://doc.babylonjs.com/how_to/more_materials
  102526. */
  102527. uAng: number;
  102528. /**
  102529. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102530. * @see https://doc.babylonjs.com/how_to/more_materials
  102531. */
  102532. vAng: number;
  102533. /**
  102534. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102535. * @see https://doc.babylonjs.com/how_to/more_materials
  102536. */
  102537. wAng: number;
  102538. /**
  102539. * Defines the center of rotation (U)
  102540. */
  102541. uRotationCenter: number;
  102542. /**
  102543. * Defines the center of rotation (V)
  102544. */
  102545. vRotationCenter: number;
  102546. /**
  102547. * Defines the center of rotation (W)
  102548. */
  102549. wRotationCenter: number;
  102550. /**
  102551. * Are mip maps generated for this texture or not.
  102552. */
  102553. get noMipmap(): boolean;
  102554. /**
  102555. * List of inspectable custom properties (used by the Inspector)
  102556. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102557. */
  102558. inspectableCustomProperties: Nullable<IInspectable[]>;
  102559. private _noMipmap;
  102560. /** @hidden */
  102561. _invertY: boolean;
  102562. private _rowGenerationMatrix;
  102563. private _cachedTextureMatrix;
  102564. private _projectionModeMatrix;
  102565. private _t0;
  102566. private _t1;
  102567. private _t2;
  102568. private _cachedUOffset;
  102569. private _cachedVOffset;
  102570. private _cachedUScale;
  102571. private _cachedVScale;
  102572. private _cachedUAng;
  102573. private _cachedVAng;
  102574. private _cachedWAng;
  102575. private _cachedProjectionMatrixId;
  102576. private _cachedCoordinatesMode;
  102577. /** @hidden */
  102578. protected _initialSamplingMode: number;
  102579. /** @hidden */
  102580. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  102581. private _deleteBuffer;
  102582. protected _format: Nullable<number>;
  102583. private _delayedOnLoad;
  102584. private _delayedOnError;
  102585. private _mimeType?;
  102586. /**
  102587. * Observable triggered once the texture has been loaded.
  102588. */
  102589. onLoadObservable: Observable<Texture>;
  102590. protected _isBlocking: boolean;
  102591. /**
  102592. * Is the texture preventing material to render while loading.
  102593. * If false, a default texture will be used instead of the loading one during the preparation step.
  102594. */
  102595. set isBlocking(value: boolean);
  102596. get isBlocking(): boolean;
  102597. /**
  102598. * Get the current sampling mode associated with the texture.
  102599. */
  102600. get samplingMode(): number;
  102601. /**
  102602. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  102603. */
  102604. get invertY(): boolean;
  102605. /**
  102606. * Instantiates a new texture.
  102607. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102608. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102609. * @param url defines the url of the picture to load as a texture
  102610. * @param sceneOrEngine defines the scene or engine the texture will belong to
  102611. * @param noMipmap defines if the texture will require mip maps or not
  102612. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  102613. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102614. * @param onLoad defines a callback triggered when the texture has been loaded
  102615. * @param onError defines a callback triggered when an error occurred during the loading session
  102616. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  102617. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  102618. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102619. * @param mimeType defines an optional mime type information
  102620. */
  102621. 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);
  102622. /**
  102623. * Update the url (and optional buffer) of this texture if url was null during construction.
  102624. * @param url the url of the texture
  102625. * @param buffer the buffer of the texture (defaults to null)
  102626. * @param onLoad callback called when the texture is loaded (defaults to null)
  102627. */
  102628. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  102629. /**
  102630. * Finish the loading sequence of a texture flagged as delayed load.
  102631. * @hidden
  102632. */
  102633. delayLoad(): void;
  102634. private _prepareRowForTextureGeneration;
  102635. /**
  102636. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  102637. * @returns the transform matrix of the texture.
  102638. */
  102639. getTextureMatrix(uBase?: number): Matrix;
  102640. /**
  102641. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  102642. * @returns The reflection texture transform
  102643. */
  102644. getReflectionTextureMatrix(): Matrix;
  102645. /**
  102646. * Clones the texture.
  102647. * @returns the cloned texture
  102648. */
  102649. clone(): Texture;
  102650. /**
  102651. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  102652. * @returns The JSON representation of the texture
  102653. */
  102654. serialize(): any;
  102655. /**
  102656. * Get the current class name of the texture useful for serialization or dynamic coding.
  102657. * @returns "Texture"
  102658. */
  102659. getClassName(): string;
  102660. /**
  102661. * Dispose the texture and release its associated resources.
  102662. */
  102663. dispose(): void;
  102664. /**
  102665. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  102666. * @param parsedTexture Define the JSON representation of the texture
  102667. * @param scene Define the scene the parsed texture should be instantiated in
  102668. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  102669. * @returns The parsed texture if successful
  102670. */
  102671. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  102672. /**
  102673. * Creates a texture from its base 64 representation.
  102674. * @param data Define the base64 payload without the data: prefix
  102675. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  102676. * @param scene Define the scene the texture should belong to
  102677. * @param noMipmap Forces the texture to not create mip map information if true
  102678. * @param invertY define if the texture needs to be inverted on the y axis during loading
  102679. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102680. * @param onLoad define a callback triggered when the texture has been loaded
  102681. * @param onError define a callback triggered when an error occurred during the loading session
  102682. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102683. * @returns the created texture
  102684. */
  102685. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  102686. /**
  102687. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  102688. * @param data Define the base64 payload without the data: prefix
  102689. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  102690. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  102691. * @param scene Define the scene the texture should belong to
  102692. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  102693. * @param noMipmap Forces the texture to not create mip map information if true
  102694. * @param invertY define if the texture needs to be inverted on the y axis during loading
  102695. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102696. * @param onLoad define a callback triggered when the texture has been loaded
  102697. * @param onError define a callback triggered when an error occurred during the loading session
  102698. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102699. * @returns the created texture
  102700. */
  102701. 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;
  102702. }
  102703. }
  102704. declare module BABYLON {
  102705. /**
  102706. * PostProcessManager is used to manage one or more post processes or post process pipelines
  102707. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102708. */
  102709. export class PostProcessManager {
  102710. private _scene;
  102711. private _indexBuffer;
  102712. private _vertexBuffers;
  102713. /**
  102714. * Creates a new instance PostProcess
  102715. * @param scene The scene that the post process is associated with.
  102716. */
  102717. constructor(scene: Scene);
  102718. private _prepareBuffers;
  102719. private _buildIndexBuffer;
  102720. /**
  102721. * Rebuilds the vertex buffers of the manager.
  102722. * @hidden
  102723. */
  102724. _rebuild(): void;
  102725. /**
  102726. * Prepares a frame to be run through a post process.
  102727. * @param sourceTexture The input texture to the post procesess. (default: null)
  102728. * @param postProcesses An array of post processes to be run. (default: null)
  102729. * @returns True if the post processes were able to be run.
  102730. * @hidden
  102731. */
  102732. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  102733. /**
  102734. * Manually render a set of post processes to a texture.
  102735. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  102736. * @param postProcesses An array of post processes to be run.
  102737. * @param targetTexture The target texture to render to.
  102738. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  102739. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  102740. * @param lodLevel defines which lod of the texture to render to
  102741. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  102742. */
  102743. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  102744. /**
  102745. * Finalize the result of the output of the postprocesses.
  102746. * @param doNotPresent If true the result will not be displayed to the screen.
  102747. * @param targetTexture The target texture to render to.
  102748. * @param faceIndex The index of the face to bind the target texture to.
  102749. * @param postProcesses The array of post processes to render.
  102750. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  102751. * @hidden
  102752. */
  102753. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  102754. /**
  102755. * Disposes of the post process manager.
  102756. */
  102757. dispose(): void;
  102758. }
  102759. }
  102760. declare module BABYLON {
  102761. /**
  102762. * This Helps creating a texture that will be created from a camera in your scene.
  102763. * It is basically a dynamic texture that could be used to create special effects for instance.
  102764. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  102765. */
  102766. export class RenderTargetTexture extends Texture {
  102767. isCube: boolean;
  102768. /**
  102769. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  102770. */
  102771. static readonly REFRESHRATE_RENDER_ONCE: number;
  102772. /**
  102773. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  102774. */
  102775. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  102776. /**
  102777. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  102778. * the central point of your effect and can save a lot of performances.
  102779. */
  102780. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  102781. /**
  102782. * Use this predicate to dynamically define the list of mesh you want to render.
  102783. * If set, the renderList property will be overwritten.
  102784. */
  102785. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  102786. private _renderList;
  102787. /**
  102788. * Use this list to define the list of mesh you want to render.
  102789. */
  102790. get renderList(): Nullable<Array<AbstractMesh>>;
  102791. set renderList(value: Nullable<Array<AbstractMesh>>);
  102792. /**
  102793. * Use this function to overload the renderList array at rendering time.
  102794. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  102795. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  102796. * the cube (if the RTT is a cube, else layerOrFace=0).
  102797. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  102798. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  102799. * hold dummy elements!
  102800. */
  102801. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  102802. private _hookArray;
  102803. /**
  102804. * Define if particles should be rendered in your texture.
  102805. */
  102806. renderParticles: boolean;
  102807. /**
  102808. * Define if sprites should be rendered in your texture.
  102809. */
  102810. renderSprites: boolean;
  102811. /**
  102812. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  102813. */
  102814. coordinatesMode: number;
  102815. /**
  102816. * Define the camera used to render the texture.
  102817. */
  102818. activeCamera: Nullable<Camera>;
  102819. /**
  102820. * Override the mesh isReady function with your own one.
  102821. */
  102822. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  102823. /**
  102824. * Override the render function of the texture with your own one.
  102825. */
  102826. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  102827. /**
  102828. * Define if camera post processes should be use while rendering the texture.
  102829. */
  102830. useCameraPostProcesses: boolean;
  102831. /**
  102832. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  102833. */
  102834. ignoreCameraViewport: boolean;
  102835. private _postProcessManager;
  102836. private _postProcesses;
  102837. private _resizeObserver;
  102838. /**
  102839. * An event triggered when the texture is unbind.
  102840. */
  102841. onBeforeBindObservable: Observable<RenderTargetTexture>;
  102842. /**
  102843. * An event triggered when the texture is unbind.
  102844. */
  102845. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  102846. private _onAfterUnbindObserver;
  102847. /**
  102848. * Set a after unbind callback in the texture.
  102849. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  102850. */
  102851. set onAfterUnbind(callback: () => void);
  102852. /**
  102853. * An event triggered before rendering the texture
  102854. */
  102855. onBeforeRenderObservable: Observable<number>;
  102856. private _onBeforeRenderObserver;
  102857. /**
  102858. * Set a before render callback in the texture.
  102859. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  102860. */
  102861. set onBeforeRender(callback: (faceIndex: number) => void);
  102862. /**
  102863. * An event triggered after rendering the texture
  102864. */
  102865. onAfterRenderObservable: Observable<number>;
  102866. private _onAfterRenderObserver;
  102867. /**
  102868. * Set a after render callback in the texture.
  102869. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  102870. */
  102871. set onAfterRender(callback: (faceIndex: number) => void);
  102872. /**
  102873. * An event triggered after the texture clear
  102874. */
  102875. onClearObservable: Observable<Engine>;
  102876. private _onClearObserver;
  102877. /**
  102878. * Set a clear callback in the texture.
  102879. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  102880. */
  102881. set onClear(callback: (Engine: Engine) => void);
  102882. /**
  102883. * An event triggered when the texture is resized.
  102884. */
  102885. onResizeObservable: Observable<RenderTargetTexture>;
  102886. /**
  102887. * Define the clear color of the Render Target if it should be different from the scene.
  102888. */
  102889. clearColor: Color4;
  102890. protected _size: number | {
  102891. width: number;
  102892. height: number;
  102893. layers?: number;
  102894. };
  102895. protected _initialSizeParameter: number | {
  102896. width: number;
  102897. height: number;
  102898. } | {
  102899. ratio: number;
  102900. };
  102901. protected _sizeRatio: Nullable<number>;
  102902. /** @hidden */
  102903. _generateMipMaps: boolean;
  102904. protected _renderingManager: RenderingManager;
  102905. /** @hidden */
  102906. _waitingRenderList: string[];
  102907. protected _doNotChangeAspectRatio: boolean;
  102908. protected _currentRefreshId: number;
  102909. protected _refreshRate: number;
  102910. protected _textureMatrix: Matrix;
  102911. protected _samples: number;
  102912. protected _renderTargetOptions: RenderTargetCreationOptions;
  102913. /**
  102914. * Gets render target creation options that were used.
  102915. */
  102916. get renderTargetOptions(): RenderTargetCreationOptions;
  102917. protected _onRatioRescale(): void;
  102918. /**
  102919. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  102920. * It must define where the camera used to render the texture is set
  102921. */
  102922. boundingBoxPosition: Vector3;
  102923. private _boundingBoxSize;
  102924. /**
  102925. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  102926. * When defined, the cubemap will switch to local mode
  102927. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  102928. * @example https://www.babylonjs-playground.com/#RNASML
  102929. */
  102930. set boundingBoxSize(value: Vector3);
  102931. get boundingBoxSize(): Vector3;
  102932. /**
  102933. * In case the RTT has been created with a depth texture, get the associated
  102934. * depth texture.
  102935. * Otherwise, return null.
  102936. */
  102937. get depthStencilTexture(): Nullable<InternalTexture>;
  102938. /**
  102939. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  102940. * or used a shadow, depth texture...
  102941. * @param name The friendly name of the texture
  102942. * @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)
  102943. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  102944. * @param generateMipMaps True if mip maps need to be generated after render.
  102945. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  102946. * @param type The type of the buffer in the RTT (int, half float, float...)
  102947. * @param isCube True if a cube texture needs to be created
  102948. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  102949. * @param generateDepthBuffer True to generate a depth buffer
  102950. * @param generateStencilBuffer True to generate a stencil buffer
  102951. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  102952. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  102953. * @param delayAllocation if the texture allocation should be delayed (default: false)
  102954. */
  102955. constructor(name: string, size: number | {
  102956. width: number;
  102957. height: number;
  102958. layers?: number;
  102959. } | {
  102960. ratio: number;
  102961. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  102962. /**
  102963. * Creates a depth stencil texture.
  102964. * This is only available in WebGL 2 or with the depth texture extension available.
  102965. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  102966. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  102967. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  102968. */
  102969. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  102970. private _processSizeParameter;
  102971. /**
  102972. * Define the number of samples to use in case of MSAA.
  102973. * It defaults to one meaning no MSAA has been enabled.
  102974. */
  102975. get samples(): number;
  102976. set samples(value: number);
  102977. /**
  102978. * Resets the refresh counter of the texture and start bak from scratch.
  102979. * Could be useful to regenerate the texture if it is setup to render only once.
  102980. */
  102981. resetRefreshCounter(): void;
  102982. /**
  102983. * Define the refresh rate of the texture or the rendering frequency.
  102984. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  102985. */
  102986. get refreshRate(): number;
  102987. set refreshRate(value: number);
  102988. /**
  102989. * Adds a post process to the render target rendering passes.
  102990. * @param postProcess define the post process to add
  102991. */
  102992. addPostProcess(postProcess: PostProcess): void;
  102993. /**
  102994. * Clear all the post processes attached to the render target
  102995. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  102996. */
  102997. clearPostProcesses(dispose?: boolean): void;
  102998. /**
  102999. * Remove one of the post process from the list of attached post processes to the texture
  103000. * @param postProcess define the post process to remove from the list
  103001. */
  103002. removePostProcess(postProcess: PostProcess): void;
  103003. /** @hidden */
  103004. _shouldRender(): boolean;
  103005. /**
  103006. * Gets the actual render size of the texture.
  103007. * @returns the width of the render size
  103008. */
  103009. getRenderSize(): number;
  103010. /**
  103011. * Gets the actual render width of the texture.
  103012. * @returns the width of the render size
  103013. */
  103014. getRenderWidth(): number;
  103015. /**
  103016. * Gets the actual render height of the texture.
  103017. * @returns the height of the render size
  103018. */
  103019. getRenderHeight(): number;
  103020. /**
  103021. * Gets the actual number of layers of the texture.
  103022. * @returns the number of layers
  103023. */
  103024. getRenderLayers(): number;
  103025. /**
  103026. * Get if the texture can be rescaled or not.
  103027. */
  103028. get canRescale(): boolean;
  103029. /**
  103030. * Resize the texture using a ratio.
  103031. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103032. */
  103033. scale(ratio: number): void;
  103034. /**
  103035. * Get the texture reflection matrix used to rotate/transform the reflection.
  103036. * @returns the reflection matrix
  103037. */
  103038. getReflectionTextureMatrix(): Matrix;
  103039. /**
  103040. * Resize the texture to a new desired size.
  103041. * Be carrefull as it will recreate all the data in the new texture.
  103042. * @param size Define the new size. It can be:
  103043. * - a number for squared texture,
  103044. * - an object containing { width: number, height: number }
  103045. * - or an object containing a ratio { ratio: number }
  103046. */
  103047. resize(size: number | {
  103048. width: number;
  103049. height: number;
  103050. } | {
  103051. ratio: number;
  103052. }): void;
  103053. private _defaultRenderListPrepared;
  103054. /**
  103055. * Renders all the objects from the render list into the texture.
  103056. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103057. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103058. */
  103059. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103060. private _bestReflectionRenderTargetDimension;
  103061. private _prepareRenderingManager;
  103062. /**
  103063. * @hidden
  103064. * @param faceIndex face index to bind to if this is a cubetexture
  103065. * @param layer defines the index of the texture to bind in the array
  103066. */
  103067. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103068. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103069. private renderToTarget;
  103070. /**
  103071. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103072. * This allowed control for front to back rendering or reversly depending of the special needs.
  103073. *
  103074. * @param renderingGroupId The rendering group id corresponding to its index
  103075. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103076. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103077. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103078. */
  103079. 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;
  103080. /**
  103081. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103082. *
  103083. * @param renderingGroupId The rendering group id corresponding to its index
  103084. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103085. */
  103086. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103087. /**
  103088. * Clones the texture.
  103089. * @returns the cloned texture
  103090. */
  103091. clone(): RenderTargetTexture;
  103092. /**
  103093. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103094. * @returns The JSON representation of the texture
  103095. */
  103096. serialize(): any;
  103097. /**
  103098. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103099. */
  103100. disposeFramebufferObjects(): void;
  103101. /**
  103102. * Dispose the texture and release its associated resources.
  103103. */
  103104. dispose(): void;
  103105. /** @hidden */
  103106. _rebuild(): void;
  103107. /**
  103108. * Clear the info related to rendering groups preventing retention point in material dispose.
  103109. */
  103110. freeRenderingGroups(): void;
  103111. /**
  103112. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103113. * @returns the view count
  103114. */
  103115. getViewCount(): number;
  103116. }
  103117. }
  103118. declare module BABYLON {
  103119. /**
  103120. * Class used to manipulate GUIDs
  103121. */
  103122. export class GUID {
  103123. /**
  103124. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103125. * Be aware Math.random() could cause collisions, but:
  103126. * "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"
  103127. * @returns a pseudo random id
  103128. */
  103129. static RandomId(): string;
  103130. }
  103131. }
  103132. declare module BABYLON {
  103133. /**
  103134. * Options to be used when creating a shadow depth material
  103135. */
  103136. export interface IIOptionShadowDepthMaterial {
  103137. /** Variables in the vertex shader code that need to have their names remapped.
  103138. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103139. * "var_name" should be either: worldPos or vNormalW
  103140. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103141. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103142. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103143. */
  103144. remappedVariables?: string[];
  103145. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103146. standalone?: boolean;
  103147. }
  103148. /**
  103149. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103150. */
  103151. export class ShadowDepthWrapper {
  103152. private _scene;
  103153. private _options?;
  103154. private _baseMaterial;
  103155. private _onEffectCreatedObserver;
  103156. private _subMeshToEffect;
  103157. private _subMeshToDepthEffect;
  103158. private _meshes;
  103159. /** @hidden */
  103160. _matriceNames: any;
  103161. /** Gets the standalone status of the wrapper */
  103162. get standalone(): boolean;
  103163. /** Gets the base material the wrapper is built upon */
  103164. get baseMaterial(): Material;
  103165. /**
  103166. * Instantiate a new shadow depth wrapper.
  103167. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103168. * generate the shadow depth map. For more information, please refer to the documentation:
  103169. * https://doc.babylonjs.com/babylon101/shadows
  103170. * @param baseMaterial Material to wrap
  103171. * @param scene Define the scene the material belongs to
  103172. * @param options Options used to create the wrapper
  103173. */
  103174. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103175. /**
  103176. * Gets the effect to use to generate the depth map
  103177. * @param subMesh subMesh to get the effect for
  103178. * @param shadowGenerator shadow generator to get the effect for
  103179. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103180. */
  103181. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103182. /**
  103183. * Specifies that the submesh is ready to be used for depth rendering
  103184. * @param subMesh submesh to check
  103185. * @param defines the list of defines to take into account when checking the effect
  103186. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103187. * @param useInstances specifies that instances should be used
  103188. * @returns a boolean indicating that the submesh is ready or not
  103189. */
  103190. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103191. /**
  103192. * Disposes the resources
  103193. */
  103194. dispose(): void;
  103195. private _makeEffect;
  103196. }
  103197. }
  103198. declare module BABYLON {
  103199. interface ThinEngine {
  103200. /**
  103201. * Unbind a list of render target textures from the webGL context
  103202. * This is used only when drawBuffer extension or webGL2 are active
  103203. * @param textures defines the render target textures to unbind
  103204. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103205. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103206. */
  103207. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103208. /**
  103209. * Create a multi render target texture
  103210. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103211. * @param size defines the size of the texture
  103212. * @param options defines the creation options
  103213. * @returns the cube texture as an InternalTexture
  103214. */
  103215. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103216. /**
  103217. * Update the sample count for a given multiple render target texture
  103218. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103219. * @param textures defines the textures to update
  103220. * @param samples defines the sample count to set
  103221. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103222. */
  103223. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103224. /**
  103225. * Select a subsets of attachments to draw to.
  103226. * @param attachments gl attachments
  103227. */
  103228. bindAttachments(attachments: number[]): void;
  103229. }
  103230. }
  103231. declare module BABYLON {
  103232. /**
  103233. * Creation options of the multi render target texture.
  103234. */
  103235. export interface IMultiRenderTargetOptions {
  103236. /**
  103237. * Define if the texture needs to create mip maps after render.
  103238. */
  103239. generateMipMaps?: boolean;
  103240. /**
  103241. * Define the types of all the draw buffers we want to create
  103242. */
  103243. types?: number[];
  103244. /**
  103245. * Define the sampling modes of all the draw buffers we want to create
  103246. */
  103247. samplingModes?: number[];
  103248. /**
  103249. * Define if a depth buffer is required
  103250. */
  103251. generateDepthBuffer?: boolean;
  103252. /**
  103253. * Define if a stencil buffer is required
  103254. */
  103255. generateStencilBuffer?: boolean;
  103256. /**
  103257. * Define if a depth texture is required instead of a depth buffer
  103258. */
  103259. generateDepthTexture?: boolean;
  103260. /**
  103261. * Define the number of desired draw buffers
  103262. */
  103263. textureCount?: number;
  103264. /**
  103265. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103266. */
  103267. doNotChangeAspectRatio?: boolean;
  103268. /**
  103269. * Define the default type of the buffers we are creating
  103270. */
  103271. defaultType?: number;
  103272. }
  103273. /**
  103274. * A multi render target, like a render target provides the ability to render to a texture.
  103275. * Unlike the render target, it can render to several draw buffers in one draw.
  103276. * This is specially interesting in deferred rendering or for any effects requiring more than
  103277. * just one color from a single pass.
  103278. */
  103279. export class MultiRenderTarget extends RenderTargetTexture {
  103280. private _internalTextures;
  103281. private _textures;
  103282. private _multiRenderTargetOptions;
  103283. private _count;
  103284. /**
  103285. * Get if draw buffers are currently supported by the used hardware and browser.
  103286. */
  103287. get isSupported(): boolean;
  103288. /**
  103289. * Get the list of textures generated by the multi render target.
  103290. */
  103291. get textures(): Texture[];
  103292. /**
  103293. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103294. */
  103295. get count(): number;
  103296. /**
  103297. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103298. */
  103299. get depthTexture(): Texture;
  103300. /**
  103301. * Set the wrapping mode on U of all the textures we are rendering to.
  103302. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103303. */
  103304. set wrapU(wrap: number);
  103305. /**
  103306. * Set the wrapping mode on V of all the textures we are rendering to.
  103307. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103308. */
  103309. set wrapV(wrap: number);
  103310. /**
  103311. * Instantiate a new multi render target texture.
  103312. * A multi render target, like a render target provides the ability to render to a texture.
  103313. * Unlike the render target, it can render to several draw buffers in one draw.
  103314. * This is specially interesting in deferred rendering or for any effects requiring more than
  103315. * just one color from a single pass.
  103316. * @param name Define the name of the texture
  103317. * @param size Define the size of the buffers to render to
  103318. * @param count Define the number of target we are rendering into
  103319. * @param scene Define the scene the texture belongs to
  103320. * @param options Define the options used to create the multi render target
  103321. */
  103322. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103323. /** @hidden */
  103324. _rebuild(): void;
  103325. private _createInternalTextures;
  103326. private _createTextures;
  103327. /**
  103328. * Define the number of samples used if MSAA is enabled.
  103329. */
  103330. get samples(): number;
  103331. set samples(value: number);
  103332. /**
  103333. * Resize all the textures in the multi render target.
  103334. * Be carrefull as it will recreate all the data in the new texture.
  103335. * @param size Define the new size
  103336. */
  103337. resize(size: any): void;
  103338. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103339. /**
  103340. * Dispose the render targets and their associated resources
  103341. */
  103342. dispose(): void;
  103343. /**
  103344. * Release all the underlying texture used as draw buffers.
  103345. */
  103346. releaseInternalTextures(): void;
  103347. }
  103348. }
  103349. declare module BABYLON {
  103350. /** @hidden */
  103351. export var imageProcessingPixelShader: {
  103352. name: string;
  103353. shader: string;
  103354. };
  103355. }
  103356. declare module BABYLON {
  103357. /**
  103358. * ImageProcessingPostProcess
  103359. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103360. */
  103361. export class ImageProcessingPostProcess extends PostProcess {
  103362. /**
  103363. * Default configuration related to image processing available in the PBR Material.
  103364. */
  103365. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103366. /**
  103367. * Gets the image processing configuration used either in this material.
  103368. */
  103369. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103370. /**
  103371. * Sets the Default image processing configuration used either in the this material.
  103372. *
  103373. * If sets to null, the scene one is in use.
  103374. */
  103375. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103376. /**
  103377. * Keep track of the image processing observer to allow dispose and replace.
  103378. */
  103379. private _imageProcessingObserver;
  103380. /**
  103381. * Attaches a new image processing configuration to the PBR Material.
  103382. * @param configuration
  103383. */
  103384. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103385. /**
  103386. * If the post process is supported.
  103387. */
  103388. get isSupported(): boolean;
  103389. /**
  103390. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103391. */
  103392. get colorCurves(): Nullable<ColorCurves>;
  103393. /**
  103394. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103395. */
  103396. set colorCurves(value: Nullable<ColorCurves>);
  103397. /**
  103398. * Gets wether the color curves effect is enabled.
  103399. */
  103400. get colorCurvesEnabled(): boolean;
  103401. /**
  103402. * Sets wether the color curves effect is enabled.
  103403. */
  103404. set colorCurvesEnabled(value: boolean);
  103405. /**
  103406. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103407. */
  103408. get colorGradingTexture(): Nullable<BaseTexture>;
  103409. /**
  103410. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103411. */
  103412. set colorGradingTexture(value: Nullable<BaseTexture>);
  103413. /**
  103414. * Gets wether the color grading effect is enabled.
  103415. */
  103416. get colorGradingEnabled(): boolean;
  103417. /**
  103418. * Gets wether the color grading effect is enabled.
  103419. */
  103420. set colorGradingEnabled(value: boolean);
  103421. /**
  103422. * Gets exposure used in the effect.
  103423. */
  103424. get exposure(): number;
  103425. /**
  103426. * Sets exposure used in the effect.
  103427. */
  103428. set exposure(value: number);
  103429. /**
  103430. * Gets wether tonemapping is enabled or not.
  103431. */
  103432. get toneMappingEnabled(): boolean;
  103433. /**
  103434. * Sets wether tonemapping is enabled or not
  103435. */
  103436. set toneMappingEnabled(value: boolean);
  103437. /**
  103438. * Gets the type of tone mapping effect.
  103439. */
  103440. get toneMappingType(): number;
  103441. /**
  103442. * Sets the type of tone mapping effect.
  103443. */
  103444. set toneMappingType(value: number);
  103445. /**
  103446. * Gets contrast used in the effect.
  103447. */
  103448. get contrast(): number;
  103449. /**
  103450. * Sets contrast used in the effect.
  103451. */
  103452. set contrast(value: number);
  103453. /**
  103454. * Gets Vignette stretch size.
  103455. */
  103456. get vignetteStretch(): number;
  103457. /**
  103458. * Sets Vignette stretch size.
  103459. */
  103460. set vignetteStretch(value: number);
  103461. /**
  103462. * Gets Vignette centre X Offset.
  103463. */
  103464. get vignetteCentreX(): number;
  103465. /**
  103466. * Sets Vignette centre X Offset.
  103467. */
  103468. set vignetteCentreX(value: number);
  103469. /**
  103470. * Gets Vignette centre Y Offset.
  103471. */
  103472. get vignetteCentreY(): number;
  103473. /**
  103474. * Sets Vignette centre Y Offset.
  103475. */
  103476. set vignetteCentreY(value: number);
  103477. /**
  103478. * Gets Vignette weight or intensity of the vignette effect.
  103479. */
  103480. get vignetteWeight(): number;
  103481. /**
  103482. * Sets Vignette weight or intensity of the vignette effect.
  103483. */
  103484. set vignetteWeight(value: number);
  103485. /**
  103486. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103487. * if vignetteEnabled is set to true.
  103488. */
  103489. get vignetteColor(): Color4;
  103490. /**
  103491. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103492. * if vignetteEnabled is set to true.
  103493. */
  103494. set vignetteColor(value: Color4);
  103495. /**
  103496. * Gets Camera field of view used by the Vignette effect.
  103497. */
  103498. get vignetteCameraFov(): number;
  103499. /**
  103500. * Sets Camera field of view used by the Vignette effect.
  103501. */
  103502. set vignetteCameraFov(value: number);
  103503. /**
  103504. * Gets the vignette blend mode allowing different kind of effect.
  103505. */
  103506. get vignetteBlendMode(): number;
  103507. /**
  103508. * Sets the vignette blend mode allowing different kind of effect.
  103509. */
  103510. set vignetteBlendMode(value: number);
  103511. /**
  103512. * Gets wether the vignette effect is enabled.
  103513. */
  103514. get vignetteEnabled(): boolean;
  103515. /**
  103516. * Sets wether the vignette effect is enabled.
  103517. */
  103518. set vignetteEnabled(value: boolean);
  103519. private _fromLinearSpace;
  103520. /**
  103521. * Gets wether the input of the processing is in Gamma or Linear Space.
  103522. */
  103523. get fromLinearSpace(): boolean;
  103524. /**
  103525. * Sets wether the input of the processing is in Gamma or Linear Space.
  103526. */
  103527. set fromLinearSpace(value: boolean);
  103528. /**
  103529. * Defines cache preventing GC.
  103530. */
  103531. private _defines;
  103532. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103533. /**
  103534. * "ImageProcessingPostProcess"
  103535. * @returns "ImageProcessingPostProcess"
  103536. */
  103537. getClassName(): string;
  103538. /**
  103539. * @hidden
  103540. */
  103541. _updateParameters(): void;
  103542. dispose(camera?: Camera): void;
  103543. }
  103544. }
  103545. declare module BABYLON {
  103546. /** @hidden */
  103547. export var fibonacci: {
  103548. name: string;
  103549. shader: string;
  103550. };
  103551. }
  103552. declare module BABYLON {
  103553. /** @hidden */
  103554. export var subSurfaceScatteringFunctions: {
  103555. name: string;
  103556. shader: string;
  103557. };
  103558. }
  103559. declare module BABYLON {
  103560. /** @hidden */
  103561. export var diffusionProfile: {
  103562. name: string;
  103563. shader: string;
  103564. };
  103565. }
  103566. declare module BABYLON {
  103567. /** @hidden */
  103568. export var subSurfaceScatteringPixelShader: {
  103569. name: string;
  103570. shader: string;
  103571. };
  103572. }
  103573. declare module BABYLON {
  103574. /**
  103575. * Sub surface scattering post process
  103576. */
  103577. export class SubSurfaceScatteringPostProcess extends PostProcess {
  103578. /**
  103579. * Gets a string identifying the name of the class
  103580. * @returns "SubSurfaceScatteringPostProcess" string
  103581. */
  103582. getClassName(): string;
  103583. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  103584. }
  103585. }
  103586. declare module BABYLON {
  103587. /**
  103588. * Interface for defining prepass effects in the prepass post-process pipeline
  103589. */
  103590. export interface PrePassEffectConfiguration {
  103591. /**
  103592. * Post process to attach for this effect
  103593. */
  103594. postProcess: PostProcess;
  103595. /**
  103596. * Is the effect enabled
  103597. */
  103598. enabled: boolean;
  103599. /**
  103600. * Disposes the effect configuration
  103601. */
  103602. dispose(): void;
  103603. /**
  103604. * Disposes the effect configuration
  103605. */
  103606. createPostProcess: () => PostProcess;
  103607. }
  103608. }
  103609. declare module BABYLON {
  103610. /**
  103611. * Contains all parameters needed for the prepass to perform
  103612. * screen space subsurface scattering
  103613. */
  103614. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  103615. private _ssDiffusionS;
  103616. private _ssFilterRadii;
  103617. private _ssDiffusionD;
  103618. /**
  103619. * Post process to attach for screen space subsurface scattering
  103620. */
  103621. postProcess: SubSurfaceScatteringPostProcess;
  103622. /**
  103623. * Diffusion profile color for subsurface scattering
  103624. */
  103625. get ssDiffusionS(): number[];
  103626. /**
  103627. * Diffusion profile max color channel value for subsurface scattering
  103628. */
  103629. get ssDiffusionD(): number[];
  103630. /**
  103631. * Diffusion profile filter radius for subsurface scattering
  103632. */
  103633. get ssFilterRadii(): number[];
  103634. /**
  103635. * Is subsurface enabled
  103636. */
  103637. enabled: boolean;
  103638. /**
  103639. * Diffusion profile colors for subsurface scattering
  103640. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  103641. * See ...
  103642. * Note that you can only store up to 5 of them
  103643. */
  103644. ssDiffusionProfileColors: Color3[];
  103645. /**
  103646. * Defines the ratio real world => scene units.
  103647. * Used for subsurface scattering
  103648. */
  103649. metersPerUnit: number;
  103650. private _scene;
  103651. /**
  103652. * Builds a subsurface configuration object
  103653. * @param scene The scene
  103654. */
  103655. constructor(scene: Scene);
  103656. /**
  103657. * Adds a new diffusion profile.
  103658. * Useful for more realistic subsurface scattering on diverse materials.
  103659. * @param color The color of the diffusion profile. Should be the average color of the material.
  103660. * @return The index of the diffusion profile for the material subsurface configuration
  103661. */
  103662. addDiffusionProfile(color: Color3): number;
  103663. /**
  103664. * Creates the sss post process
  103665. * @return The created post process
  103666. */
  103667. createPostProcess(): SubSurfaceScatteringPostProcess;
  103668. /**
  103669. * Deletes all diffusion profiles.
  103670. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  103671. */
  103672. clearAllDiffusionProfiles(): void;
  103673. /**
  103674. * Disposes this object
  103675. */
  103676. dispose(): void;
  103677. /**
  103678. * @hidden
  103679. * https://zero-radiance.github.io/post/sampling-diffusion/
  103680. *
  103681. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  103682. * ------------------------------------------------------------------------------------
  103683. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  103684. * PDF[r, phi, s] = r * R[r, phi, s]
  103685. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  103686. * ------------------------------------------------------------------------------------
  103687. * We importance sample the color channel with the widest scattering distance.
  103688. */
  103689. getDiffusionProfileParameters(color: Color3): number;
  103690. /**
  103691. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  103692. * 'u' is the random number (the value of the CDF): [0, 1).
  103693. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  103694. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  103695. */
  103696. private _sampleBurleyDiffusionProfile;
  103697. }
  103698. }
  103699. declare module BABYLON {
  103700. /**
  103701. * Renders a pre pass of the scene
  103702. * This means every mesh in the scene will be rendered to a render target texture
  103703. * And then this texture will be composited to the rendering canvas with post processes
  103704. * It is necessary for effects like subsurface scattering or deferred shading
  103705. */
  103706. export class PrePassRenderer {
  103707. /** @hidden */
  103708. static _SceneComponentInitialization: (scene: Scene) => void;
  103709. private _scene;
  103710. private _engine;
  103711. private _isDirty;
  103712. /**
  103713. * Number of textures in the multi render target texture where the scene is directly rendered
  103714. */
  103715. readonly mrtCount: number;
  103716. /**
  103717. * The render target where the scene is directly rendered
  103718. */
  103719. prePassRT: MultiRenderTarget;
  103720. private _mrtTypes;
  103721. private _multiRenderAttachments;
  103722. private _defaultAttachments;
  103723. private _clearAttachments;
  103724. private _postProcesses;
  103725. private readonly _clearColor;
  103726. /**
  103727. * Image processing post process for composition
  103728. */
  103729. imageProcessingPostProcess: ImageProcessingPostProcess;
  103730. /**
  103731. * Configuration for sub surface scattering post process
  103732. */
  103733. subSurfaceConfiguration: SubSurfaceConfiguration;
  103734. /**
  103735. * Should materials render their geometry on the MRT
  103736. */
  103737. materialsShouldRenderGeometry: boolean;
  103738. /**
  103739. * Should materials render the irradiance information on the MRT
  103740. */
  103741. materialsShouldRenderIrradiance: boolean;
  103742. private _enabled;
  103743. /**
  103744. * Indicates if the prepass is enabled
  103745. */
  103746. get enabled(): boolean;
  103747. /**
  103748. * How many samples are used for MSAA of the scene render target
  103749. */
  103750. get samples(): number;
  103751. set samples(n: number);
  103752. /**
  103753. * Instanciates a prepass renderer
  103754. * @param scene The scene
  103755. */
  103756. constructor(scene: Scene);
  103757. private _initializeAttachments;
  103758. private _createCompositionEffect;
  103759. /**
  103760. * Indicates if rendering a prepass is supported
  103761. */
  103762. get isSupported(): boolean;
  103763. /**
  103764. * Sets the proper output textures to draw in the engine.
  103765. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  103766. */
  103767. bindAttachmentsForEffect(effect: Effect): void;
  103768. /**
  103769. * @hidden
  103770. */
  103771. _beforeCameraDraw(): void;
  103772. /**
  103773. * @hidden
  103774. */
  103775. _afterCameraDraw(): void;
  103776. private _checkRTSize;
  103777. private _bindFrameBuffer;
  103778. /**
  103779. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  103780. */
  103781. clear(): void;
  103782. private _setState;
  103783. private _enable;
  103784. private _disable;
  103785. private _resetPostProcessChain;
  103786. private _bindPostProcessChain;
  103787. /**
  103788. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  103789. */
  103790. markAsDirty(): void;
  103791. private _update;
  103792. /**
  103793. * Disposes the prepass renderer.
  103794. */
  103795. dispose(): void;
  103796. }
  103797. }
  103798. declare module BABYLON {
  103799. /**
  103800. * Options for compiling materials.
  103801. */
  103802. export interface IMaterialCompilationOptions {
  103803. /**
  103804. * Defines whether clip planes are enabled.
  103805. */
  103806. clipPlane: boolean;
  103807. /**
  103808. * Defines whether instances are enabled.
  103809. */
  103810. useInstances: boolean;
  103811. }
  103812. /**
  103813. * Options passed when calling customShaderNameResolve
  103814. */
  103815. export interface ICustomShaderNameResolveOptions {
  103816. /**
  103817. * 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
  103818. */
  103819. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  103820. }
  103821. /**
  103822. * Base class for the main features of a material in Babylon.js
  103823. */
  103824. export class Material implements IAnimatable {
  103825. /**
  103826. * Returns the triangle fill mode
  103827. */
  103828. static readonly TriangleFillMode: number;
  103829. /**
  103830. * Returns the wireframe mode
  103831. */
  103832. static readonly WireFrameFillMode: number;
  103833. /**
  103834. * Returns the point fill mode
  103835. */
  103836. static readonly PointFillMode: number;
  103837. /**
  103838. * Returns the point list draw mode
  103839. */
  103840. static readonly PointListDrawMode: number;
  103841. /**
  103842. * Returns the line list draw mode
  103843. */
  103844. static readonly LineListDrawMode: number;
  103845. /**
  103846. * Returns the line loop draw mode
  103847. */
  103848. static readonly LineLoopDrawMode: number;
  103849. /**
  103850. * Returns the line strip draw mode
  103851. */
  103852. static readonly LineStripDrawMode: number;
  103853. /**
  103854. * Returns the triangle strip draw mode
  103855. */
  103856. static readonly TriangleStripDrawMode: number;
  103857. /**
  103858. * Returns the triangle fan draw mode
  103859. */
  103860. static readonly TriangleFanDrawMode: number;
  103861. /**
  103862. * Stores the clock-wise side orientation
  103863. */
  103864. static readonly ClockWiseSideOrientation: number;
  103865. /**
  103866. * Stores the counter clock-wise side orientation
  103867. */
  103868. static readonly CounterClockWiseSideOrientation: number;
  103869. /**
  103870. * The dirty texture flag value
  103871. */
  103872. static readonly TextureDirtyFlag: number;
  103873. /**
  103874. * The dirty light flag value
  103875. */
  103876. static readonly LightDirtyFlag: number;
  103877. /**
  103878. * The dirty fresnel flag value
  103879. */
  103880. static readonly FresnelDirtyFlag: number;
  103881. /**
  103882. * The dirty attribute flag value
  103883. */
  103884. static readonly AttributesDirtyFlag: number;
  103885. /**
  103886. * The dirty misc flag value
  103887. */
  103888. static readonly MiscDirtyFlag: number;
  103889. /**
  103890. * The all dirty flag value
  103891. */
  103892. static readonly AllDirtyFlag: number;
  103893. /**
  103894. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  103895. */
  103896. static readonly MATERIAL_OPAQUE: number;
  103897. /**
  103898. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  103899. */
  103900. static readonly MATERIAL_ALPHATEST: number;
  103901. /**
  103902. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  103903. */
  103904. static readonly MATERIAL_ALPHABLEND: number;
  103905. /**
  103906. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  103907. * They are also discarded below the alpha cutoff threshold to improve performances.
  103908. */
  103909. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  103910. /**
  103911. * The Whiteout method is used to blend normals.
  103912. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  103913. */
  103914. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  103915. /**
  103916. * The Reoriented Normal Mapping method is used to blend normals.
  103917. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  103918. */
  103919. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  103920. /**
  103921. * Custom callback helping to override the default shader used in the material.
  103922. */
  103923. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  103924. /**
  103925. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  103926. */
  103927. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  103928. /**
  103929. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  103930. * This means that the material can keep using a previous shader while a new one is being compiled.
  103931. * This is mostly used when shader parallel compilation is supported (true by default)
  103932. */
  103933. allowShaderHotSwapping: boolean;
  103934. /**
  103935. * The ID of the material
  103936. */
  103937. id: string;
  103938. /**
  103939. * Gets or sets the unique id of the material
  103940. */
  103941. uniqueId: number;
  103942. /**
  103943. * The name of the material
  103944. */
  103945. name: string;
  103946. /**
  103947. * Gets or sets user defined metadata
  103948. */
  103949. metadata: any;
  103950. /**
  103951. * For internal use only. Please do not use.
  103952. */
  103953. reservedDataStore: any;
  103954. /**
  103955. * Specifies if the ready state should be checked on each call
  103956. */
  103957. checkReadyOnEveryCall: boolean;
  103958. /**
  103959. * Specifies if the ready state should be checked once
  103960. */
  103961. checkReadyOnlyOnce: boolean;
  103962. /**
  103963. * The state of the material
  103964. */
  103965. state: string;
  103966. /**
  103967. * If the material can be rendered to several textures with MRT extension
  103968. */
  103969. get canRenderToMRT(): boolean;
  103970. /**
  103971. * The alpha value of the material
  103972. */
  103973. protected _alpha: number;
  103974. /**
  103975. * List of inspectable custom properties (used by the Inspector)
  103976. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  103977. */
  103978. inspectableCustomProperties: IInspectable[];
  103979. /**
  103980. * Sets the alpha value of the material
  103981. */
  103982. set alpha(value: number);
  103983. /**
  103984. * Gets the alpha value of the material
  103985. */
  103986. get alpha(): number;
  103987. /**
  103988. * Specifies if back face culling is enabled
  103989. */
  103990. protected _backFaceCulling: boolean;
  103991. /**
  103992. * Sets the back-face culling state
  103993. */
  103994. set backFaceCulling(value: boolean);
  103995. /**
  103996. * Gets the back-face culling state
  103997. */
  103998. get backFaceCulling(): boolean;
  103999. /**
  104000. * Stores the value for side orientation
  104001. */
  104002. sideOrientation: number;
  104003. /**
  104004. * Callback triggered when the material is compiled
  104005. */
  104006. onCompiled: Nullable<(effect: Effect) => void>;
  104007. /**
  104008. * Callback triggered when an error occurs
  104009. */
  104010. onError: Nullable<(effect: Effect, errors: string) => void>;
  104011. /**
  104012. * Callback triggered to get the render target textures
  104013. */
  104014. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104015. /**
  104016. * Gets a boolean indicating that current material needs to register RTT
  104017. */
  104018. get hasRenderTargetTextures(): boolean;
  104019. /**
  104020. * Specifies if the material should be serialized
  104021. */
  104022. doNotSerialize: boolean;
  104023. /**
  104024. * @hidden
  104025. */
  104026. _storeEffectOnSubMeshes: boolean;
  104027. /**
  104028. * Stores the animations for the material
  104029. */
  104030. animations: Nullable<Array<Animation>>;
  104031. /**
  104032. * An event triggered when the material is disposed
  104033. */
  104034. onDisposeObservable: Observable<Material>;
  104035. /**
  104036. * An observer which watches for dispose events
  104037. */
  104038. private _onDisposeObserver;
  104039. private _onUnBindObservable;
  104040. /**
  104041. * Called during a dispose event
  104042. */
  104043. set onDispose(callback: () => void);
  104044. private _onBindObservable;
  104045. /**
  104046. * An event triggered when the material is bound
  104047. */
  104048. get onBindObservable(): Observable<AbstractMesh>;
  104049. /**
  104050. * An observer which watches for bind events
  104051. */
  104052. private _onBindObserver;
  104053. /**
  104054. * Called during a bind event
  104055. */
  104056. set onBind(callback: (Mesh: AbstractMesh) => void);
  104057. /**
  104058. * An event triggered when the material is unbound
  104059. */
  104060. get onUnBindObservable(): Observable<Material>;
  104061. protected _onEffectCreatedObservable: Nullable<Observable<{
  104062. effect: Effect;
  104063. subMesh: Nullable<SubMesh>;
  104064. }>>;
  104065. /**
  104066. * An event triggered when the effect is (re)created
  104067. */
  104068. get onEffectCreatedObservable(): Observable<{
  104069. effect: Effect;
  104070. subMesh: Nullable<SubMesh>;
  104071. }>;
  104072. /**
  104073. * Stores the value of the alpha mode
  104074. */
  104075. private _alphaMode;
  104076. /**
  104077. * Sets the value of the alpha mode.
  104078. *
  104079. * | Value | Type | Description |
  104080. * | --- | --- | --- |
  104081. * | 0 | ALPHA_DISABLE | |
  104082. * | 1 | ALPHA_ADD | |
  104083. * | 2 | ALPHA_COMBINE | |
  104084. * | 3 | ALPHA_SUBTRACT | |
  104085. * | 4 | ALPHA_MULTIPLY | |
  104086. * | 5 | ALPHA_MAXIMIZED | |
  104087. * | 6 | ALPHA_ONEONE | |
  104088. * | 7 | ALPHA_PREMULTIPLIED | |
  104089. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104090. * | 9 | ALPHA_INTERPOLATE | |
  104091. * | 10 | ALPHA_SCREENMODE | |
  104092. *
  104093. */
  104094. set alphaMode(value: number);
  104095. /**
  104096. * Gets the value of the alpha mode
  104097. */
  104098. get alphaMode(): number;
  104099. /**
  104100. * Stores the state of the need depth pre-pass value
  104101. */
  104102. private _needDepthPrePass;
  104103. /**
  104104. * Sets the need depth pre-pass value
  104105. */
  104106. set needDepthPrePass(value: boolean);
  104107. /**
  104108. * Gets the depth pre-pass value
  104109. */
  104110. get needDepthPrePass(): boolean;
  104111. /**
  104112. * Specifies if depth writing should be disabled
  104113. */
  104114. disableDepthWrite: boolean;
  104115. /**
  104116. * Specifies if color writing should be disabled
  104117. */
  104118. disableColorWrite: boolean;
  104119. /**
  104120. * Specifies if depth writing should be forced
  104121. */
  104122. forceDepthWrite: boolean;
  104123. /**
  104124. * Specifies the depth function that should be used. 0 means the default engine function
  104125. */
  104126. depthFunction: number;
  104127. /**
  104128. * Specifies if there should be a separate pass for culling
  104129. */
  104130. separateCullingPass: boolean;
  104131. /**
  104132. * Stores the state specifing if fog should be enabled
  104133. */
  104134. private _fogEnabled;
  104135. /**
  104136. * Sets the state for enabling fog
  104137. */
  104138. set fogEnabled(value: boolean);
  104139. /**
  104140. * Gets the value of the fog enabled state
  104141. */
  104142. get fogEnabled(): boolean;
  104143. /**
  104144. * Stores the size of points
  104145. */
  104146. pointSize: number;
  104147. /**
  104148. * Stores the z offset value
  104149. */
  104150. zOffset: number;
  104151. get wireframe(): boolean;
  104152. /**
  104153. * Sets the state of wireframe mode
  104154. */
  104155. set wireframe(value: boolean);
  104156. /**
  104157. * Gets the value specifying if point clouds are enabled
  104158. */
  104159. get pointsCloud(): boolean;
  104160. /**
  104161. * Sets the state of point cloud mode
  104162. */
  104163. set pointsCloud(value: boolean);
  104164. /**
  104165. * Gets the material fill mode
  104166. */
  104167. get fillMode(): number;
  104168. /**
  104169. * Sets the material fill mode
  104170. */
  104171. set fillMode(value: number);
  104172. /**
  104173. * @hidden
  104174. * Stores the effects for the material
  104175. */
  104176. _effect: Nullable<Effect>;
  104177. /**
  104178. * Specifies if uniform buffers should be used
  104179. */
  104180. private _useUBO;
  104181. /**
  104182. * Stores a reference to the scene
  104183. */
  104184. private _scene;
  104185. /**
  104186. * Stores the fill mode state
  104187. */
  104188. private _fillMode;
  104189. /**
  104190. * Specifies if the depth write state should be cached
  104191. */
  104192. private _cachedDepthWriteState;
  104193. /**
  104194. * Specifies if the color write state should be cached
  104195. */
  104196. private _cachedColorWriteState;
  104197. /**
  104198. * Specifies if the depth function state should be cached
  104199. */
  104200. private _cachedDepthFunctionState;
  104201. /**
  104202. * Stores the uniform buffer
  104203. */
  104204. protected _uniformBuffer: UniformBuffer;
  104205. /** @hidden */
  104206. _indexInSceneMaterialArray: number;
  104207. /** @hidden */
  104208. meshMap: Nullable<{
  104209. [id: string]: AbstractMesh | undefined;
  104210. }>;
  104211. /**
  104212. * Creates a material instance
  104213. * @param name defines the name of the material
  104214. * @param scene defines the scene to reference
  104215. * @param doNotAdd specifies if the material should be added to the scene
  104216. */
  104217. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104218. /**
  104219. * Returns a string representation of the current material
  104220. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104221. * @returns a string with material information
  104222. */
  104223. toString(fullDetails?: boolean): string;
  104224. /**
  104225. * Gets the class name of the material
  104226. * @returns a string with the class name of the material
  104227. */
  104228. getClassName(): string;
  104229. /**
  104230. * Specifies if updates for the material been locked
  104231. */
  104232. get isFrozen(): boolean;
  104233. /**
  104234. * Locks updates for the material
  104235. */
  104236. freeze(): void;
  104237. /**
  104238. * Unlocks updates for the material
  104239. */
  104240. unfreeze(): void;
  104241. /**
  104242. * Specifies if the material is ready to be used
  104243. * @param mesh defines the mesh to check
  104244. * @param useInstances specifies if instances should be used
  104245. * @returns a boolean indicating if the material is ready to be used
  104246. */
  104247. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104248. /**
  104249. * Specifies that the submesh is ready to be used
  104250. * @param mesh defines the mesh to check
  104251. * @param subMesh defines which submesh to check
  104252. * @param useInstances specifies that instances should be used
  104253. * @returns a boolean indicating that the submesh is ready or not
  104254. */
  104255. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104256. /**
  104257. * Returns the material effect
  104258. * @returns the effect associated with the material
  104259. */
  104260. getEffect(): Nullable<Effect>;
  104261. /**
  104262. * Returns the current scene
  104263. * @returns a Scene
  104264. */
  104265. getScene(): Scene;
  104266. /**
  104267. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104268. */
  104269. protected _forceAlphaTest: boolean;
  104270. /**
  104271. * The transparency mode of the material.
  104272. */
  104273. protected _transparencyMode: Nullable<number>;
  104274. /**
  104275. * Gets the current transparency mode.
  104276. */
  104277. get transparencyMode(): Nullable<number>;
  104278. /**
  104279. * Sets the transparency mode of the material.
  104280. *
  104281. * | Value | Type | Description |
  104282. * | ----- | ----------------------------------- | ----------- |
  104283. * | 0 | OPAQUE | |
  104284. * | 1 | ALPHATEST | |
  104285. * | 2 | ALPHABLEND | |
  104286. * | 3 | ALPHATESTANDBLEND | |
  104287. *
  104288. */
  104289. set transparencyMode(value: Nullable<number>);
  104290. /**
  104291. * Returns true if alpha blending should be disabled.
  104292. */
  104293. protected get _disableAlphaBlending(): boolean;
  104294. /**
  104295. * Specifies whether or not this material should be rendered in alpha blend mode.
  104296. * @returns a boolean specifying if alpha blending is needed
  104297. */
  104298. needAlphaBlending(): boolean;
  104299. /**
  104300. * Specifies if the mesh will require alpha blending
  104301. * @param mesh defines the mesh to check
  104302. * @returns a boolean specifying if alpha blending is needed for the mesh
  104303. */
  104304. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104305. /**
  104306. * Specifies whether or not this material should be rendered in alpha test mode.
  104307. * @returns a boolean specifying if an alpha test is needed.
  104308. */
  104309. needAlphaTesting(): boolean;
  104310. /**
  104311. * Specifies if material alpha testing should be turned on for the mesh
  104312. * @param mesh defines the mesh to check
  104313. */
  104314. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104315. /**
  104316. * Gets the texture used for the alpha test
  104317. * @returns the texture to use for alpha testing
  104318. */
  104319. getAlphaTestTexture(): Nullable<BaseTexture>;
  104320. /**
  104321. * Marks the material to indicate that it needs to be re-calculated
  104322. */
  104323. markDirty(): void;
  104324. /** @hidden */
  104325. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104326. /**
  104327. * Binds the material to the mesh
  104328. * @param world defines the world transformation matrix
  104329. * @param mesh defines the mesh to bind the material to
  104330. */
  104331. bind(world: Matrix, mesh?: Mesh): void;
  104332. /**
  104333. * Binds the submesh to the material
  104334. * @param world defines the world transformation matrix
  104335. * @param mesh defines the mesh containing the submesh
  104336. * @param subMesh defines the submesh to bind the material to
  104337. */
  104338. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104339. /**
  104340. * Binds the world matrix to the material
  104341. * @param world defines the world transformation matrix
  104342. */
  104343. bindOnlyWorldMatrix(world: Matrix): void;
  104344. /**
  104345. * Binds the scene's uniform buffer to the effect.
  104346. * @param effect defines the effect to bind to the scene uniform buffer
  104347. * @param sceneUbo defines the uniform buffer storing scene data
  104348. */
  104349. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104350. /**
  104351. * Binds the view matrix to the effect
  104352. * @param effect defines the effect to bind the view matrix to
  104353. */
  104354. bindView(effect: Effect): void;
  104355. /**
  104356. * Binds the view projection matrix to the effect
  104357. * @param effect defines the effect to bind the view projection matrix to
  104358. */
  104359. bindViewProjection(effect: Effect): void;
  104360. /**
  104361. * Processes to execute after binding the material to a mesh
  104362. * @param mesh defines the rendered mesh
  104363. */
  104364. protected _afterBind(mesh?: Mesh): void;
  104365. /**
  104366. * Unbinds the material from the mesh
  104367. */
  104368. unbind(): void;
  104369. /**
  104370. * Gets the active textures from the material
  104371. * @returns an array of textures
  104372. */
  104373. getActiveTextures(): BaseTexture[];
  104374. /**
  104375. * Specifies if the material uses a texture
  104376. * @param texture defines the texture to check against the material
  104377. * @returns a boolean specifying if the material uses the texture
  104378. */
  104379. hasTexture(texture: BaseTexture): boolean;
  104380. /**
  104381. * Makes a duplicate of the material, and gives it a new name
  104382. * @param name defines the new name for the duplicated material
  104383. * @returns the cloned material
  104384. */
  104385. clone(name: string): Nullable<Material>;
  104386. /**
  104387. * Gets the meshes bound to the material
  104388. * @returns an array of meshes bound to the material
  104389. */
  104390. getBindedMeshes(): AbstractMesh[];
  104391. /**
  104392. * Force shader compilation
  104393. * @param mesh defines the mesh associated with this material
  104394. * @param onCompiled defines a function to execute once the material is compiled
  104395. * @param options defines the options to configure the compilation
  104396. * @param onError defines a function to execute if the material fails compiling
  104397. */
  104398. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104399. /**
  104400. * Force shader compilation
  104401. * @param mesh defines the mesh that will use this material
  104402. * @param options defines additional options for compiling the shaders
  104403. * @returns a promise that resolves when the compilation completes
  104404. */
  104405. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104406. private static readonly _AllDirtyCallBack;
  104407. private static readonly _ImageProcessingDirtyCallBack;
  104408. private static readonly _TextureDirtyCallBack;
  104409. private static readonly _FresnelDirtyCallBack;
  104410. private static readonly _MiscDirtyCallBack;
  104411. private static readonly _LightsDirtyCallBack;
  104412. private static readonly _AttributeDirtyCallBack;
  104413. private static _FresnelAndMiscDirtyCallBack;
  104414. private static _TextureAndMiscDirtyCallBack;
  104415. private static readonly _DirtyCallbackArray;
  104416. private static readonly _RunDirtyCallBacks;
  104417. /**
  104418. * Marks a define in the material to indicate that it needs to be re-computed
  104419. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104420. */
  104421. markAsDirty(flag: number): void;
  104422. /**
  104423. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104424. * @param func defines a function which checks material defines against the submeshes
  104425. */
  104426. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104427. /**
  104428. * Indicates that the scene should check if the rendering now needs a prepass
  104429. */
  104430. protected _markScenePrePassDirty(): void;
  104431. /**
  104432. * Indicates that we need to re-calculated for all submeshes
  104433. */
  104434. protected _markAllSubMeshesAsAllDirty(): void;
  104435. /**
  104436. * Indicates that image processing needs to be re-calculated for all submeshes
  104437. */
  104438. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104439. /**
  104440. * Indicates that textures need to be re-calculated for all submeshes
  104441. */
  104442. protected _markAllSubMeshesAsTexturesDirty(): void;
  104443. /**
  104444. * Indicates that fresnel needs to be re-calculated for all submeshes
  104445. */
  104446. protected _markAllSubMeshesAsFresnelDirty(): void;
  104447. /**
  104448. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104449. */
  104450. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104451. /**
  104452. * Indicates that lights need to be re-calculated for all submeshes
  104453. */
  104454. protected _markAllSubMeshesAsLightsDirty(): void;
  104455. /**
  104456. * Indicates that attributes need to be re-calculated for all submeshes
  104457. */
  104458. protected _markAllSubMeshesAsAttributesDirty(): void;
  104459. /**
  104460. * Indicates that misc needs to be re-calculated for all submeshes
  104461. */
  104462. protected _markAllSubMeshesAsMiscDirty(): void;
  104463. /**
  104464. * Indicates that textures and misc need to be re-calculated for all submeshes
  104465. */
  104466. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104467. /**
  104468. * Sets the required values to the prepass renderer.
  104469. * @param prePassRenderer defines the prepass renderer to setup.
  104470. * @returns true if the pre pass is needed.
  104471. */
  104472. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104473. /**
  104474. * Disposes the material
  104475. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104476. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104477. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104478. */
  104479. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104480. /** @hidden */
  104481. private releaseVertexArrayObject;
  104482. /**
  104483. * Serializes this material
  104484. * @returns the serialized material object
  104485. */
  104486. serialize(): any;
  104487. /**
  104488. * Creates a material from parsed material data
  104489. * @param parsedMaterial defines parsed material data
  104490. * @param scene defines the hosting scene
  104491. * @param rootUrl defines the root URL to use to load textures
  104492. * @returns a new material
  104493. */
  104494. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104495. }
  104496. }
  104497. declare module BABYLON {
  104498. /**
  104499. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104500. * separate meshes. This can be use to improve performances.
  104501. * @see https://doc.babylonjs.com/how_to/multi_materials
  104502. */
  104503. export class MultiMaterial extends Material {
  104504. private _subMaterials;
  104505. /**
  104506. * Gets or Sets the list of Materials used within the multi material.
  104507. * They need to be ordered according to the submeshes order in the associated mesh
  104508. */
  104509. get subMaterials(): Nullable<Material>[];
  104510. set subMaterials(value: Nullable<Material>[]);
  104511. /**
  104512. * Function used to align with Node.getChildren()
  104513. * @returns the list of Materials used within the multi material
  104514. */
  104515. getChildren(): Nullable<Material>[];
  104516. /**
  104517. * Instantiates a new Multi Material
  104518. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104519. * separate meshes. This can be use to improve performances.
  104520. * @see https://doc.babylonjs.com/how_to/multi_materials
  104521. * @param name Define the name in the scene
  104522. * @param scene Define the scene the material belongs to
  104523. */
  104524. constructor(name: string, scene: Scene);
  104525. private _hookArray;
  104526. /**
  104527. * Get one of the submaterial by its index in the submaterials array
  104528. * @param index The index to look the sub material at
  104529. * @returns The Material if the index has been defined
  104530. */
  104531. getSubMaterial(index: number): Nullable<Material>;
  104532. /**
  104533. * Get the list of active textures for the whole sub materials list.
  104534. * @returns All the textures that will be used during the rendering
  104535. */
  104536. getActiveTextures(): BaseTexture[];
  104537. /**
  104538. * Gets the current class name of the material e.g. "MultiMaterial"
  104539. * Mainly use in serialization.
  104540. * @returns the class name
  104541. */
  104542. getClassName(): string;
  104543. /**
  104544. * Checks if the material is ready to render the requested sub mesh
  104545. * @param mesh Define the mesh the submesh belongs to
  104546. * @param subMesh Define the sub mesh to look readyness for
  104547. * @param useInstances Define whether or not the material is used with instances
  104548. * @returns true if ready, otherwise false
  104549. */
  104550. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104551. /**
  104552. * Clones the current material and its related sub materials
  104553. * @param name Define the name of the newly cloned material
  104554. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  104555. * @returns the cloned material
  104556. */
  104557. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  104558. /**
  104559. * Serializes the materials into a JSON representation.
  104560. * @returns the JSON representation
  104561. */
  104562. serialize(): any;
  104563. /**
  104564. * Dispose the material and release its associated resources
  104565. * @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)
  104566. * @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)
  104567. * @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)
  104568. */
  104569. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  104570. /**
  104571. * Creates a MultiMaterial from parsed MultiMaterial data.
  104572. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  104573. * @param scene defines the hosting scene
  104574. * @returns a new MultiMaterial
  104575. */
  104576. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  104577. }
  104578. }
  104579. declare module BABYLON {
  104580. /**
  104581. * Defines a subdivision inside a mesh
  104582. */
  104583. export class SubMesh implements ICullable {
  104584. /** the material index to use */
  104585. materialIndex: number;
  104586. /** vertex index start */
  104587. verticesStart: number;
  104588. /** vertices count */
  104589. verticesCount: number;
  104590. /** index start */
  104591. indexStart: number;
  104592. /** indices count */
  104593. indexCount: number;
  104594. /** @hidden */
  104595. _materialDefines: Nullable<MaterialDefines>;
  104596. /** @hidden */
  104597. _materialEffect: Nullable<Effect>;
  104598. /** @hidden */
  104599. _effectOverride: Nullable<Effect>;
  104600. /**
  104601. * Gets material defines used by the effect associated to the sub mesh
  104602. */
  104603. get materialDefines(): Nullable<MaterialDefines>;
  104604. /**
  104605. * Sets material defines used by the effect associated to the sub mesh
  104606. */
  104607. set materialDefines(defines: Nullable<MaterialDefines>);
  104608. /**
  104609. * Gets associated effect
  104610. */
  104611. get effect(): Nullable<Effect>;
  104612. /**
  104613. * Sets associated effect (effect used to render this submesh)
  104614. * @param effect defines the effect to associate with
  104615. * @param defines defines the set of defines used to compile this effect
  104616. */
  104617. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  104618. /** @hidden */
  104619. _linesIndexCount: number;
  104620. private _mesh;
  104621. private _renderingMesh;
  104622. private _boundingInfo;
  104623. private _linesIndexBuffer;
  104624. /** @hidden */
  104625. _lastColliderWorldVertices: Nullable<Vector3[]>;
  104626. /** @hidden */
  104627. _trianglePlanes: Plane[];
  104628. /** @hidden */
  104629. _lastColliderTransformMatrix: Nullable<Matrix>;
  104630. /** @hidden */
  104631. _renderId: number;
  104632. /** @hidden */
  104633. _alphaIndex: number;
  104634. /** @hidden */
  104635. _distanceToCamera: number;
  104636. /** @hidden */
  104637. _id: number;
  104638. private _currentMaterial;
  104639. /**
  104640. * Add a new submesh to a mesh
  104641. * @param materialIndex defines the material index to use
  104642. * @param verticesStart defines vertex index start
  104643. * @param verticesCount defines vertices count
  104644. * @param indexStart defines index start
  104645. * @param indexCount defines indices count
  104646. * @param mesh defines the parent mesh
  104647. * @param renderingMesh defines an optional rendering mesh
  104648. * @param createBoundingBox defines if bounding box should be created for this submesh
  104649. * @returns the new submesh
  104650. */
  104651. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  104652. /**
  104653. * Creates a new submesh
  104654. * @param materialIndex defines the material index to use
  104655. * @param verticesStart defines vertex index start
  104656. * @param verticesCount defines vertices count
  104657. * @param indexStart defines index start
  104658. * @param indexCount defines indices count
  104659. * @param mesh defines the parent mesh
  104660. * @param renderingMesh defines an optional rendering mesh
  104661. * @param createBoundingBox defines if bounding box should be created for this submesh
  104662. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  104663. */
  104664. constructor(
  104665. /** the material index to use */
  104666. materialIndex: number,
  104667. /** vertex index start */
  104668. verticesStart: number,
  104669. /** vertices count */
  104670. verticesCount: number,
  104671. /** index start */
  104672. indexStart: number,
  104673. /** indices count */
  104674. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  104675. /**
  104676. * Returns true if this submesh covers the entire parent mesh
  104677. * @ignorenaming
  104678. */
  104679. get IsGlobal(): boolean;
  104680. /**
  104681. * Returns the submesh BoudingInfo object
  104682. * @returns current bounding info (or mesh's one if the submesh is global)
  104683. */
  104684. getBoundingInfo(): BoundingInfo;
  104685. /**
  104686. * Sets the submesh BoundingInfo
  104687. * @param boundingInfo defines the new bounding info to use
  104688. * @returns the SubMesh
  104689. */
  104690. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  104691. /**
  104692. * Returns the mesh of the current submesh
  104693. * @return the parent mesh
  104694. */
  104695. getMesh(): AbstractMesh;
  104696. /**
  104697. * Returns the rendering mesh of the submesh
  104698. * @returns the rendering mesh (could be different from parent mesh)
  104699. */
  104700. getRenderingMesh(): Mesh;
  104701. /**
  104702. * Returns the replacement mesh of the submesh
  104703. * @returns the replacement mesh (could be different from parent mesh)
  104704. */
  104705. getReplacementMesh(): Nullable<AbstractMesh>;
  104706. /**
  104707. * Returns the effective mesh of the submesh
  104708. * @returns the effective mesh (could be different from parent mesh)
  104709. */
  104710. getEffectiveMesh(): AbstractMesh;
  104711. /**
  104712. * Returns the submesh material
  104713. * @returns null or the current material
  104714. */
  104715. getMaterial(): Nullable<Material>;
  104716. private _IsMultiMaterial;
  104717. /**
  104718. * Sets a new updated BoundingInfo object to the submesh
  104719. * @param data defines an optional position array to use to determine the bounding info
  104720. * @returns the SubMesh
  104721. */
  104722. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  104723. /** @hidden */
  104724. _checkCollision(collider: Collider): boolean;
  104725. /**
  104726. * Updates the submesh BoundingInfo
  104727. * @param world defines the world matrix to use to update the bounding info
  104728. * @returns the submesh
  104729. */
  104730. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  104731. /**
  104732. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  104733. * @param frustumPlanes defines the frustum planes
  104734. * @returns true if the submesh is intersecting with the frustum
  104735. */
  104736. isInFrustum(frustumPlanes: Plane[]): boolean;
  104737. /**
  104738. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  104739. * @param frustumPlanes defines the frustum planes
  104740. * @returns true if the submesh is inside the frustum
  104741. */
  104742. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  104743. /**
  104744. * Renders the submesh
  104745. * @param enableAlphaMode defines if alpha needs to be used
  104746. * @returns the submesh
  104747. */
  104748. render(enableAlphaMode: boolean): SubMesh;
  104749. /**
  104750. * @hidden
  104751. */
  104752. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  104753. /**
  104754. * Checks if the submesh intersects with a ray
  104755. * @param ray defines the ray to test
  104756. * @returns true is the passed ray intersects the submesh bounding box
  104757. */
  104758. canIntersects(ray: Ray): boolean;
  104759. /**
  104760. * Intersects current submesh with a ray
  104761. * @param ray defines the ray to test
  104762. * @param positions defines mesh's positions array
  104763. * @param indices defines mesh's indices array
  104764. * @param fastCheck defines if the first intersection will be used (and not the closest)
  104765. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  104766. * @returns intersection info or null if no intersection
  104767. */
  104768. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  104769. /** @hidden */
  104770. private _intersectLines;
  104771. /** @hidden */
  104772. private _intersectUnIndexedLines;
  104773. /** @hidden */
  104774. private _intersectTriangles;
  104775. /** @hidden */
  104776. private _intersectUnIndexedTriangles;
  104777. /** @hidden */
  104778. _rebuild(): void;
  104779. /**
  104780. * Creates a new submesh from the passed mesh
  104781. * @param newMesh defines the new hosting mesh
  104782. * @param newRenderingMesh defines an optional rendering mesh
  104783. * @returns the new submesh
  104784. */
  104785. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  104786. /**
  104787. * Release associated resources
  104788. */
  104789. dispose(): void;
  104790. /**
  104791. * Gets the class name
  104792. * @returns the string "SubMesh".
  104793. */
  104794. getClassName(): string;
  104795. /**
  104796. * Creates a new submesh from indices data
  104797. * @param materialIndex the index of the main mesh material
  104798. * @param startIndex the index where to start the copy in the mesh indices array
  104799. * @param indexCount the number of indices to copy then from the startIndex
  104800. * @param mesh the main mesh to create the submesh from
  104801. * @param renderingMesh the optional rendering mesh
  104802. * @returns a new submesh
  104803. */
  104804. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  104805. }
  104806. }
  104807. declare module BABYLON {
  104808. /**
  104809. * Class used to represent data loading progression
  104810. */
  104811. export class SceneLoaderFlags {
  104812. private static _ForceFullSceneLoadingForIncremental;
  104813. private static _ShowLoadingScreen;
  104814. private static _CleanBoneMatrixWeights;
  104815. private static _loggingLevel;
  104816. /**
  104817. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  104818. */
  104819. static get ForceFullSceneLoadingForIncremental(): boolean;
  104820. static set ForceFullSceneLoadingForIncremental(value: boolean);
  104821. /**
  104822. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  104823. */
  104824. static get ShowLoadingScreen(): boolean;
  104825. static set ShowLoadingScreen(value: boolean);
  104826. /**
  104827. * Defines the current logging level (while loading the scene)
  104828. * @ignorenaming
  104829. */
  104830. static get loggingLevel(): number;
  104831. static set loggingLevel(value: number);
  104832. /**
  104833. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  104834. */
  104835. static get CleanBoneMatrixWeights(): boolean;
  104836. static set CleanBoneMatrixWeights(value: boolean);
  104837. }
  104838. }
  104839. declare module BABYLON {
  104840. /**
  104841. * Class used to store geometry data (vertex buffers + index buffer)
  104842. */
  104843. export class Geometry implements IGetSetVerticesData {
  104844. /**
  104845. * Gets or sets the ID of the geometry
  104846. */
  104847. id: string;
  104848. /**
  104849. * Gets or sets the unique ID of the geometry
  104850. */
  104851. uniqueId: number;
  104852. /**
  104853. * Gets the delay loading state of the geometry (none by default which means not delayed)
  104854. */
  104855. delayLoadState: number;
  104856. /**
  104857. * Gets the file containing the data to load when running in delay load state
  104858. */
  104859. delayLoadingFile: Nullable<string>;
  104860. /**
  104861. * Callback called when the geometry is updated
  104862. */
  104863. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  104864. private _scene;
  104865. private _engine;
  104866. private _meshes;
  104867. private _totalVertices;
  104868. /** @hidden */
  104869. _indices: IndicesArray;
  104870. /** @hidden */
  104871. _vertexBuffers: {
  104872. [key: string]: VertexBuffer;
  104873. };
  104874. private _isDisposed;
  104875. private _extend;
  104876. private _boundingBias;
  104877. /** @hidden */
  104878. _delayInfo: Array<string>;
  104879. private _indexBuffer;
  104880. private _indexBufferIsUpdatable;
  104881. /** @hidden */
  104882. _boundingInfo: Nullable<BoundingInfo>;
  104883. /** @hidden */
  104884. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  104885. /** @hidden */
  104886. _softwareSkinningFrameId: number;
  104887. private _vertexArrayObjects;
  104888. private _updatable;
  104889. /** @hidden */
  104890. _positions: Nullable<Vector3[]>;
  104891. /**
  104892. * 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
  104893. */
  104894. get boundingBias(): Vector2;
  104895. /**
  104896. * 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
  104897. */
  104898. set boundingBias(value: Vector2);
  104899. /**
  104900. * Static function used to attach a new empty geometry to a mesh
  104901. * @param mesh defines the mesh to attach the geometry to
  104902. * @returns the new Geometry
  104903. */
  104904. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  104905. /** Get the list of meshes using this geometry */
  104906. get meshes(): Mesh[];
  104907. /**
  104908. * 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
  104909. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  104910. */
  104911. useBoundingInfoFromGeometry: boolean;
  104912. /**
  104913. * Creates a new geometry
  104914. * @param id defines the unique ID
  104915. * @param scene defines the hosting scene
  104916. * @param vertexData defines the VertexData used to get geometry data
  104917. * @param updatable defines if geometry must be updatable (false by default)
  104918. * @param mesh defines the mesh that will be associated with the geometry
  104919. */
  104920. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  104921. /**
  104922. * Gets the current extend of the geometry
  104923. */
  104924. get extend(): {
  104925. minimum: Vector3;
  104926. maximum: Vector3;
  104927. };
  104928. /**
  104929. * Gets the hosting scene
  104930. * @returns the hosting Scene
  104931. */
  104932. getScene(): Scene;
  104933. /**
  104934. * Gets the hosting engine
  104935. * @returns the hosting Engine
  104936. */
  104937. getEngine(): Engine;
  104938. /**
  104939. * Defines if the geometry is ready to use
  104940. * @returns true if the geometry is ready to be used
  104941. */
  104942. isReady(): boolean;
  104943. /**
  104944. * Gets a value indicating that the geometry should not be serialized
  104945. */
  104946. get doNotSerialize(): boolean;
  104947. /** @hidden */
  104948. _rebuild(): void;
  104949. /**
  104950. * Affects all geometry data in one call
  104951. * @param vertexData defines the geometry data
  104952. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  104953. */
  104954. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  104955. /**
  104956. * Set specific vertex data
  104957. * @param kind defines the data kind (Position, normal, etc...)
  104958. * @param data defines the vertex data to use
  104959. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  104960. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  104961. */
  104962. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  104963. /**
  104964. * Removes a specific vertex data
  104965. * @param kind defines the data kind (Position, normal, etc...)
  104966. */
  104967. removeVerticesData(kind: string): void;
  104968. /**
  104969. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  104970. * @param buffer defines the vertex buffer to use
  104971. * @param totalVertices defines the total number of vertices for position kind (could be null)
  104972. */
  104973. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  104974. /**
  104975. * Update a specific vertex buffer
  104976. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  104977. * It will do nothing if the buffer is not updatable
  104978. * @param kind defines the data kind (Position, normal, etc...)
  104979. * @param data defines the data to use
  104980. * @param offset defines the offset in the target buffer where to store the data
  104981. * @param useBytes set to true if the offset is in bytes
  104982. */
  104983. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  104984. /**
  104985. * Update a specific vertex buffer
  104986. * This function will create a new buffer if the current one is not updatable
  104987. * @param kind defines the data kind (Position, normal, etc...)
  104988. * @param data defines the data to use
  104989. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  104990. */
  104991. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  104992. private _updateBoundingInfo;
  104993. /** @hidden */
  104994. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  104995. /**
  104996. * Gets total number of vertices
  104997. * @returns the total number of vertices
  104998. */
  104999. getTotalVertices(): number;
  105000. /**
  105001. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105002. * @param kind defines the data kind (Position, normal, etc...)
  105003. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105004. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105005. * @returns a float array containing vertex data
  105006. */
  105007. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105008. /**
  105009. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105010. * @param kind defines the data kind (Position, normal, etc...)
  105011. * @returns true if the vertex buffer with the specified kind is updatable
  105012. */
  105013. isVertexBufferUpdatable(kind: string): boolean;
  105014. /**
  105015. * Gets a specific vertex buffer
  105016. * @param kind defines the data kind (Position, normal, etc...)
  105017. * @returns a VertexBuffer
  105018. */
  105019. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105020. /**
  105021. * Returns all vertex buffers
  105022. * @return an object holding all vertex buffers indexed by kind
  105023. */
  105024. getVertexBuffers(): Nullable<{
  105025. [key: string]: VertexBuffer;
  105026. }>;
  105027. /**
  105028. * Gets a boolean indicating if specific vertex buffer is present
  105029. * @param kind defines the data kind (Position, normal, etc...)
  105030. * @returns true if data is present
  105031. */
  105032. isVerticesDataPresent(kind: string): boolean;
  105033. /**
  105034. * Gets a list of all attached data kinds (Position, normal, etc...)
  105035. * @returns a list of string containing all kinds
  105036. */
  105037. getVerticesDataKinds(): string[];
  105038. /**
  105039. * Update index buffer
  105040. * @param indices defines the indices to store in the index buffer
  105041. * @param offset defines the offset in the target buffer where to store the data
  105042. * @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)
  105043. */
  105044. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105045. /**
  105046. * Creates a new index buffer
  105047. * @param indices defines the indices to store in the index buffer
  105048. * @param totalVertices defines the total number of vertices (could be null)
  105049. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105050. */
  105051. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105052. /**
  105053. * Return the total number of indices
  105054. * @returns the total number of indices
  105055. */
  105056. getTotalIndices(): number;
  105057. /**
  105058. * Gets the index buffer array
  105059. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105060. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105061. * @returns the index buffer array
  105062. */
  105063. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105064. /**
  105065. * Gets the index buffer
  105066. * @return the index buffer
  105067. */
  105068. getIndexBuffer(): Nullable<DataBuffer>;
  105069. /** @hidden */
  105070. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105071. /**
  105072. * Release the associated resources for a specific mesh
  105073. * @param mesh defines the source mesh
  105074. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105075. */
  105076. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105077. /**
  105078. * Apply current geometry to a given mesh
  105079. * @param mesh defines the mesh to apply geometry to
  105080. */
  105081. applyToMesh(mesh: Mesh): void;
  105082. private _updateExtend;
  105083. private _applyToMesh;
  105084. private notifyUpdate;
  105085. /**
  105086. * Load the geometry if it was flagged as delay loaded
  105087. * @param scene defines the hosting scene
  105088. * @param onLoaded defines a callback called when the geometry is loaded
  105089. */
  105090. load(scene: Scene, onLoaded?: () => void): void;
  105091. private _queueLoad;
  105092. /**
  105093. * Invert the geometry to move from a right handed system to a left handed one.
  105094. */
  105095. toLeftHanded(): void;
  105096. /** @hidden */
  105097. _resetPointsArrayCache(): void;
  105098. /** @hidden */
  105099. _generatePointsArray(): boolean;
  105100. /**
  105101. * Gets a value indicating if the geometry is disposed
  105102. * @returns true if the geometry was disposed
  105103. */
  105104. isDisposed(): boolean;
  105105. private _disposeVertexArrayObjects;
  105106. /**
  105107. * Free all associated resources
  105108. */
  105109. dispose(): void;
  105110. /**
  105111. * Clone the current geometry into a new geometry
  105112. * @param id defines the unique ID of the new geometry
  105113. * @returns a new geometry object
  105114. */
  105115. copy(id: string): Geometry;
  105116. /**
  105117. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105118. * @return a JSON representation of the current geometry data (without the vertices data)
  105119. */
  105120. serialize(): any;
  105121. private toNumberArray;
  105122. /**
  105123. * Serialize all vertices data into a JSON oject
  105124. * @returns a JSON representation of the current geometry data
  105125. */
  105126. serializeVerticeData(): any;
  105127. /**
  105128. * Extracts a clone of a mesh geometry
  105129. * @param mesh defines the source mesh
  105130. * @param id defines the unique ID of the new geometry object
  105131. * @returns the new geometry object
  105132. */
  105133. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105134. /**
  105135. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105136. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105137. * Be aware Math.random() could cause collisions, but:
  105138. * "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"
  105139. * @returns a string containing a new GUID
  105140. */
  105141. static RandomId(): string;
  105142. /** @hidden */
  105143. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105144. private static _CleanMatricesWeights;
  105145. /**
  105146. * Create a new geometry from persisted data (Using .babylon file format)
  105147. * @param parsedVertexData defines the persisted data
  105148. * @param scene defines the hosting scene
  105149. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105150. * @returns the new geometry object
  105151. */
  105152. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105153. }
  105154. }
  105155. declare module BABYLON {
  105156. /**
  105157. * Define an interface for all classes that will get and set the data on vertices
  105158. */
  105159. export interface IGetSetVerticesData {
  105160. /**
  105161. * Gets a boolean indicating if specific vertex data is present
  105162. * @param kind defines the vertex data kind to use
  105163. * @returns true is data kind is present
  105164. */
  105165. isVerticesDataPresent(kind: string): boolean;
  105166. /**
  105167. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105168. * @param kind defines the data kind (Position, normal, etc...)
  105169. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105170. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105171. * @returns a float array containing vertex data
  105172. */
  105173. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105174. /**
  105175. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105176. * @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.
  105177. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105178. * @returns the indices array or an empty array if the mesh has no geometry
  105179. */
  105180. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105181. /**
  105182. * Set specific vertex data
  105183. * @param kind defines the data kind (Position, normal, etc...)
  105184. * @param data defines the vertex data to use
  105185. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105186. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105187. */
  105188. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105189. /**
  105190. * Update a specific associated vertex buffer
  105191. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105192. * - VertexBuffer.PositionKind
  105193. * - VertexBuffer.UVKind
  105194. * - VertexBuffer.UV2Kind
  105195. * - VertexBuffer.UV3Kind
  105196. * - VertexBuffer.UV4Kind
  105197. * - VertexBuffer.UV5Kind
  105198. * - VertexBuffer.UV6Kind
  105199. * - VertexBuffer.ColorKind
  105200. * - VertexBuffer.MatricesIndicesKind
  105201. * - VertexBuffer.MatricesIndicesExtraKind
  105202. * - VertexBuffer.MatricesWeightsKind
  105203. * - VertexBuffer.MatricesWeightsExtraKind
  105204. * @param data defines the data source
  105205. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105206. * @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)
  105207. */
  105208. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105209. /**
  105210. * Creates a new index buffer
  105211. * @param indices defines the indices to store in the index buffer
  105212. * @param totalVertices defines the total number of vertices (could be null)
  105213. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105214. */
  105215. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105216. }
  105217. /**
  105218. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105219. */
  105220. export class VertexData {
  105221. /**
  105222. * Mesh side orientation : usually the external or front surface
  105223. */
  105224. static readonly FRONTSIDE: number;
  105225. /**
  105226. * Mesh side orientation : usually the internal or back surface
  105227. */
  105228. static readonly BACKSIDE: number;
  105229. /**
  105230. * Mesh side orientation : both internal and external or front and back surfaces
  105231. */
  105232. static readonly DOUBLESIDE: number;
  105233. /**
  105234. * Mesh side orientation : by default, `FRONTSIDE`
  105235. */
  105236. static readonly DEFAULTSIDE: number;
  105237. /**
  105238. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105239. */
  105240. positions: Nullable<FloatArray>;
  105241. /**
  105242. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105243. */
  105244. normals: Nullable<FloatArray>;
  105245. /**
  105246. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105247. */
  105248. tangents: Nullable<FloatArray>;
  105249. /**
  105250. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105251. */
  105252. uvs: Nullable<FloatArray>;
  105253. /**
  105254. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105255. */
  105256. uvs2: Nullable<FloatArray>;
  105257. /**
  105258. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105259. */
  105260. uvs3: Nullable<FloatArray>;
  105261. /**
  105262. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105263. */
  105264. uvs4: Nullable<FloatArray>;
  105265. /**
  105266. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105267. */
  105268. uvs5: Nullable<FloatArray>;
  105269. /**
  105270. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105271. */
  105272. uvs6: Nullable<FloatArray>;
  105273. /**
  105274. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105275. */
  105276. colors: Nullable<FloatArray>;
  105277. /**
  105278. * 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).
  105279. */
  105280. matricesIndices: Nullable<FloatArray>;
  105281. /**
  105282. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105283. */
  105284. matricesWeights: Nullable<FloatArray>;
  105285. /**
  105286. * An array extending the number of possible indices
  105287. */
  105288. matricesIndicesExtra: Nullable<FloatArray>;
  105289. /**
  105290. * An array extending the number of possible weights when the number of indices is extended
  105291. */
  105292. matricesWeightsExtra: Nullable<FloatArray>;
  105293. /**
  105294. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105295. */
  105296. indices: Nullable<IndicesArray>;
  105297. /**
  105298. * Uses the passed data array to set the set the values for the specified kind of data
  105299. * @param data a linear array of floating numbers
  105300. * @param kind the type of data that is being set, eg positions, colors etc
  105301. */
  105302. set(data: FloatArray, kind: string): void;
  105303. /**
  105304. * Associates the vertexData to the passed Mesh.
  105305. * Sets it as updatable or not (default `false`)
  105306. * @param mesh the mesh the vertexData is applied to
  105307. * @param updatable when used and having the value true allows new data to update the vertexData
  105308. * @returns the VertexData
  105309. */
  105310. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105311. /**
  105312. * Associates the vertexData to the passed Geometry.
  105313. * Sets it as updatable or not (default `false`)
  105314. * @param geometry the geometry the vertexData is applied to
  105315. * @param updatable when used and having the value true allows new data to update the vertexData
  105316. * @returns VertexData
  105317. */
  105318. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105319. /**
  105320. * Updates the associated mesh
  105321. * @param mesh the mesh to be updated
  105322. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105323. * @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
  105324. * @returns VertexData
  105325. */
  105326. updateMesh(mesh: Mesh): VertexData;
  105327. /**
  105328. * Updates the associated geometry
  105329. * @param geometry the geometry to be updated
  105330. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105331. * @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
  105332. * @returns VertexData.
  105333. */
  105334. updateGeometry(geometry: Geometry): VertexData;
  105335. private _applyTo;
  105336. private _update;
  105337. /**
  105338. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105339. * @param matrix the transforming matrix
  105340. * @returns the VertexData
  105341. */
  105342. transform(matrix: Matrix): VertexData;
  105343. /**
  105344. * Merges the passed VertexData into the current one
  105345. * @param other the VertexData to be merged into the current one
  105346. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105347. * @returns the modified VertexData
  105348. */
  105349. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105350. private _mergeElement;
  105351. private _validate;
  105352. /**
  105353. * Serializes the VertexData
  105354. * @returns a serialized object
  105355. */
  105356. serialize(): any;
  105357. /**
  105358. * Extracts the vertexData from a mesh
  105359. * @param mesh the mesh from which to extract the VertexData
  105360. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105361. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105362. * @returns the object VertexData associated to the passed mesh
  105363. */
  105364. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105365. /**
  105366. * Extracts the vertexData from the geometry
  105367. * @param geometry the geometry from which to extract the VertexData
  105368. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105369. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105370. * @returns the object VertexData associated to the passed mesh
  105371. */
  105372. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105373. private static _ExtractFrom;
  105374. /**
  105375. * Creates the VertexData for a Ribbon
  105376. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105377. * * pathArray array of paths, each of which an array of successive Vector3
  105378. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105379. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105380. * * 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
  105381. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105382. * * 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)
  105383. * * 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)
  105384. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105385. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105386. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105387. * @returns the VertexData of the ribbon
  105388. */
  105389. static CreateRibbon(options: {
  105390. pathArray: Vector3[][];
  105391. closeArray?: boolean;
  105392. closePath?: boolean;
  105393. offset?: number;
  105394. sideOrientation?: number;
  105395. frontUVs?: Vector4;
  105396. backUVs?: Vector4;
  105397. invertUV?: boolean;
  105398. uvs?: Vector2[];
  105399. colors?: Color4[];
  105400. }): VertexData;
  105401. /**
  105402. * Creates the VertexData for a box
  105403. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105404. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105405. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105406. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105407. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105408. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105409. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105410. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105411. * * 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)
  105412. * * 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)
  105413. * @returns the VertexData of the box
  105414. */
  105415. static CreateBox(options: {
  105416. size?: number;
  105417. width?: number;
  105418. height?: number;
  105419. depth?: number;
  105420. faceUV?: Vector4[];
  105421. faceColors?: Color4[];
  105422. sideOrientation?: number;
  105423. frontUVs?: Vector4;
  105424. backUVs?: Vector4;
  105425. }): VertexData;
  105426. /**
  105427. * Creates the VertexData for a tiled box
  105428. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105429. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105430. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105431. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105432. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105433. * @returns the VertexData of the box
  105434. */
  105435. static CreateTiledBox(options: {
  105436. pattern?: number;
  105437. width?: number;
  105438. height?: number;
  105439. depth?: number;
  105440. tileSize?: number;
  105441. tileWidth?: number;
  105442. tileHeight?: number;
  105443. alignHorizontal?: number;
  105444. alignVertical?: number;
  105445. faceUV?: Vector4[];
  105446. faceColors?: Color4[];
  105447. sideOrientation?: number;
  105448. }): VertexData;
  105449. /**
  105450. * Creates the VertexData for a tiled plane
  105451. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105452. * * pattern a limited pattern arrangement depending on the number
  105453. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105454. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105455. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105456. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105457. * * 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)
  105458. * * 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)
  105459. * @returns the VertexData of the tiled plane
  105460. */
  105461. static CreateTiledPlane(options: {
  105462. pattern?: number;
  105463. tileSize?: number;
  105464. tileWidth?: number;
  105465. tileHeight?: number;
  105466. size?: number;
  105467. width?: number;
  105468. height?: number;
  105469. alignHorizontal?: number;
  105470. alignVertical?: number;
  105471. sideOrientation?: number;
  105472. frontUVs?: Vector4;
  105473. backUVs?: Vector4;
  105474. }): VertexData;
  105475. /**
  105476. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105477. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105478. * * segments sets the number of horizontal strips optional, default 32
  105479. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105480. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105481. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105482. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105483. * * 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
  105484. * * 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
  105485. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105486. * * 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)
  105487. * * 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)
  105488. * @returns the VertexData of the ellipsoid
  105489. */
  105490. static CreateSphere(options: {
  105491. segments?: number;
  105492. diameter?: number;
  105493. diameterX?: number;
  105494. diameterY?: number;
  105495. diameterZ?: number;
  105496. arc?: number;
  105497. slice?: number;
  105498. sideOrientation?: number;
  105499. frontUVs?: Vector4;
  105500. backUVs?: Vector4;
  105501. }): VertexData;
  105502. /**
  105503. * Creates the VertexData for a cylinder, cone or prism
  105504. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105505. * * height sets the height (y direction) of the cylinder, optional, default 2
  105506. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105507. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105508. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105509. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105510. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105511. * * 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
  105512. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105513. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105514. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105515. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105516. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105517. * * 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)
  105518. * * 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)
  105519. * @returns the VertexData of the cylinder, cone or prism
  105520. */
  105521. static CreateCylinder(options: {
  105522. height?: number;
  105523. diameterTop?: number;
  105524. diameterBottom?: number;
  105525. diameter?: number;
  105526. tessellation?: number;
  105527. subdivisions?: number;
  105528. arc?: number;
  105529. faceColors?: Color4[];
  105530. faceUV?: Vector4[];
  105531. hasRings?: boolean;
  105532. enclose?: boolean;
  105533. sideOrientation?: number;
  105534. frontUVs?: Vector4;
  105535. backUVs?: Vector4;
  105536. }): VertexData;
  105537. /**
  105538. * Creates the VertexData for a torus
  105539. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105540. * * diameter the diameter of the torus, optional default 1
  105541. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105542. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105543. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105544. * * 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)
  105545. * * 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)
  105546. * @returns the VertexData of the torus
  105547. */
  105548. static CreateTorus(options: {
  105549. diameter?: number;
  105550. thickness?: number;
  105551. tessellation?: number;
  105552. sideOrientation?: number;
  105553. frontUVs?: Vector4;
  105554. backUVs?: Vector4;
  105555. }): VertexData;
  105556. /**
  105557. * Creates the VertexData of the LineSystem
  105558. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  105559. * - lines an array of lines, each line being an array of successive Vector3
  105560. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  105561. * @returns the VertexData of the LineSystem
  105562. */
  105563. static CreateLineSystem(options: {
  105564. lines: Vector3[][];
  105565. colors?: Nullable<Color4[][]>;
  105566. }): VertexData;
  105567. /**
  105568. * Create the VertexData for a DashedLines
  105569. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  105570. * - points an array successive Vector3
  105571. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  105572. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  105573. * - dashNb the intended total number of dashes, optional, default 200
  105574. * @returns the VertexData for the DashedLines
  105575. */
  105576. static CreateDashedLines(options: {
  105577. points: Vector3[];
  105578. dashSize?: number;
  105579. gapSize?: number;
  105580. dashNb?: number;
  105581. }): VertexData;
  105582. /**
  105583. * Creates the VertexData for a Ground
  105584. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105585. * - width the width (x direction) of the ground, optional, default 1
  105586. * - height the height (z direction) of the ground, optional, default 1
  105587. * - subdivisions the number of subdivisions per side, optional, default 1
  105588. * @returns the VertexData of the Ground
  105589. */
  105590. static CreateGround(options: {
  105591. width?: number;
  105592. height?: number;
  105593. subdivisions?: number;
  105594. subdivisionsX?: number;
  105595. subdivisionsY?: number;
  105596. }): VertexData;
  105597. /**
  105598. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  105599. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105600. * * xmin the ground minimum X coordinate, optional, default -1
  105601. * * zmin the ground minimum Z coordinate, optional, default -1
  105602. * * xmax the ground maximum X coordinate, optional, default 1
  105603. * * zmax the ground maximum Z coordinate, optional, default 1
  105604. * * 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}
  105605. * * 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}
  105606. * @returns the VertexData of the TiledGround
  105607. */
  105608. static CreateTiledGround(options: {
  105609. xmin: number;
  105610. zmin: number;
  105611. xmax: number;
  105612. zmax: number;
  105613. subdivisions?: {
  105614. w: number;
  105615. h: number;
  105616. };
  105617. precision?: {
  105618. w: number;
  105619. h: number;
  105620. };
  105621. }): VertexData;
  105622. /**
  105623. * Creates the VertexData of the Ground designed from a heightmap
  105624. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  105625. * * width the width (x direction) of the ground
  105626. * * height the height (z direction) of the ground
  105627. * * subdivisions the number of subdivisions per side
  105628. * * minHeight the minimum altitude on the ground, optional, default 0
  105629. * * maxHeight the maximum altitude on the ground, optional default 1
  105630. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  105631. * * buffer the array holding the image color data
  105632. * * bufferWidth the width of image
  105633. * * bufferHeight the height of image
  105634. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  105635. * @returns the VertexData of the Ground designed from a heightmap
  105636. */
  105637. static CreateGroundFromHeightMap(options: {
  105638. width: number;
  105639. height: number;
  105640. subdivisions: number;
  105641. minHeight: number;
  105642. maxHeight: number;
  105643. colorFilter: Color3;
  105644. buffer: Uint8Array;
  105645. bufferWidth: number;
  105646. bufferHeight: number;
  105647. alphaFilter: number;
  105648. }): VertexData;
  105649. /**
  105650. * Creates the VertexData for a Plane
  105651. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  105652. * * size sets the width and height of the plane to the value of size, optional default 1
  105653. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  105654. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  105655. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105656. * * 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)
  105657. * * 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)
  105658. * @returns the VertexData of the box
  105659. */
  105660. static CreatePlane(options: {
  105661. size?: number;
  105662. width?: number;
  105663. height?: number;
  105664. sideOrientation?: number;
  105665. frontUVs?: Vector4;
  105666. backUVs?: Vector4;
  105667. }): VertexData;
  105668. /**
  105669. * Creates the VertexData of the Disc or regular Polygon
  105670. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  105671. * * radius the radius of the disc, optional default 0.5
  105672. * * tessellation the number of polygon sides, optional, default 64
  105673. * * 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
  105674. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105675. * * 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)
  105676. * * 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)
  105677. * @returns the VertexData of the box
  105678. */
  105679. static CreateDisc(options: {
  105680. radius?: number;
  105681. tessellation?: number;
  105682. arc?: number;
  105683. sideOrientation?: number;
  105684. frontUVs?: Vector4;
  105685. backUVs?: Vector4;
  105686. }): VertexData;
  105687. /**
  105688. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  105689. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  105690. * @param polygon a mesh built from polygonTriangulation.build()
  105691. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105692. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105693. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105694. * @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)
  105695. * @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)
  105696. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  105697. * @returns the VertexData of the Polygon
  105698. */
  105699. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  105700. /**
  105701. * Creates the VertexData of the IcoSphere
  105702. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  105703. * * radius the radius of the IcoSphere, optional default 1
  105704. * * radiusX allows stretching in the x direction, optional, default radius
  105705. * * radiusY allows stretching in the y direction, optional, default radius
  105706. * * radiusZ allows stretching in the z direction, optional, default radius
  105707. * * flat when true creates a flat shaded mesh, optional, default true
  105708. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  105709. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105710. * * 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)
  105711. * * 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)
  105712. * @returns the VertexData of the IcoSphere
  105713. */
  105714. static CreateIcoSphere(options: {
  105715. radius?: number;
  105716. radiusX?: number;
  105717. radiusY?: number;
  105718. radiusZ?: number;
  105719. flat?: boolean;
  105720. subdivisions?: number;
  105721. sideOrientation?: number;
  105722. frontUVs?: Vector4;
  105723. backUVs?: Vector4;
  105724. }): VertexData;
  105725. /**
  105726. * Creates the VertexData for a Polyhedron
  105727. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  105728. * * type provided types are:
  105729. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  105730. * * 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)
  105731. * * size the size of the IcoSphere, optional default 1
  105732. * * sizeX allows stretching in the x direction, optional, default size
  105733. * * sizeY allows stretching in the y direction, optional, default size
  105734. * * sizeZ allows stretching in the z direction, optional, default size
  105735. * * 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
  105736. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105737. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105738. * * flat when true creates a flat shaded mesh, optional, default true
  105739. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  105740. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105741. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  105742. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  105743. * @returns the VertexData of the Polyhedron
  105744. */
  105745. static CreatePolyhedron(options: {
  105746. type?: number;
  105747. size?: number;
  105748. sizeX?: number;
  105749. sizeY?: number;
  105750. sizeZ?: number;
  105751. custom?: any;
  105752. faceUV?: Vector4[];
  105753. faceColors?: Color4[];
  105754. flat?: boolean;
  105755. sideOrientation?: number;
  105756. frontUVs?: Vector4;
  105757. backUVs?: Vector4;
  105758. }): VertexData;
  105759. /**
  105760. * Creates the VertexData for a TorusKnot
  105761. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  105762. * * radius the radius of the torus knot, optional, default 2
  105763. * * tube the thickness of the tube, optional, default 0.5
  105764. * * radialSegments the number of sides on each tube segments, optional, default 32
  105765. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  105766. * * p the number of windings around the z axis, optional, default 2
  105767. * * q the number of windings around the x axis, optional, default 3
  105768. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105769. * * 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)
  105770. * * 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)
  105771. * @returns the VertexData of the Torus Knot
  105772. */
  105773. static CreateTorusKnot(options: {
  105774. radius?: number;
  105775. tube?: number;
  105776. radialSegments?: number;
  105777. tubularSegments?: number;
  105778. p?: number;
  105779. q?: number;
  105780. sideOrientation?: number;
  105781. frontUVs?: Vector4;
  105782. backUVs?: Vector4;
  105783. }): VertexData;
  105784. /**
  105785. * Compute normals for given positions and indices
  105786. * @param positions an array of vertex positions, [...., x, y, z, ......]
  105787. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  105788. * @param normals an array of vertex normals, [...., x, y, z, ......]
  105789. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  105790. * * facetNormals : optional array of facet normals (vector3)
  105791. * * facetPositions : optional array of facet positions (vector3)
  105792. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  105793. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  105794. * * bInfo : optional bounding info, required for facetPartitioning computation
  105795. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  105796. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  105797. * * useRightHandedSystem: optional boolean to for right handed system computation
  105798. * * depthSort : optional boolean to enable the facet depth sort computation
  105799. * * distanceTo : optional Vector3 to compute the facet depth from this location
  105800. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  105801. */
  105802. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  105803. facetNormals?: any;
  105804. facetPositions?: any;
  105805. facetPartitioning?: any;
  105806. ratio?: number;
  105807. bInfo?: any;
  105808. bbSize?: Vector3;
  105809. subDiv?: any;
  105810. useRightHandedSystem?: boolean;
  105811. depthSort?: boolean;
  105812. distanceTo?: Vector3;
  105813. depthSortedFacets?: any;
  105814. }): void;
  105815. /** @hidden */
  105816. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  105817. /**
  105818. * Applies VertexData created from the imported parameters to the geometry
  105819. * @param parsedVertexData the parsed data from an imported file
  105820. * @param geometry the geometry to apply the VertexData to
  105821. */
  105822. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  105823. }
  105824. }
  105825. declare module BABYLON {
  105826. /**
  105827. * Defines a target to use with MorphTargetManager
  105828. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  105829. */
  105830. export class MorphTarget implements IAnimatable {
  105831. /** defines the name of the target */
  105832. name: string;
  105833. /**
  105834. * Gets or sets the list of animations
  105835. */
  105836. animations: Animation[];
  105837. private _scene;
  105838. private _positions;
  105839. private _normals;
  105840. private _tangents;
  105841. private _uvs;
  105842. private _influence;
  105843. private _uniqueId;
  105844. /**
  105845. * Observable raised when the influence changes
  105846. */
  105847. onInfluenceChanged: Observable<boolean>;
  105848. /** @hidden */
  105849. _onDataLayoutChanged: Observable<void>;
  105850. /**
  105851. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  105852. */
  105853. get influence(): number;
  105854. set influence(influence: number);
  105855. /**
  105856. * Gets or sets the id of the morph Target
  105857. */
  105858. id: string;
  105859. private _animationPropertiesOverride;
  105860. /**
  105861. * Gets or sets the animation properties override
  105862. */
  105863. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  105864. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  105865. /**
  105866. * Creates a new MorphTarget
  105867. * @param name defines the name of the target
  105868. * @param influence defines the influence to use
  105869. * @param scene defines the scene the morphtarget belongs to
  105870. */
  105871. constructor(
  105872. /** defines the name of the target */
  105873. name: string, influence?: number, scene?: Nullable<Scene>);
  105874. /**
  105875. * Gets the unique ID of this manager
  105876. */
  105877. get uniqueId(): number;
  105878. /**
  105879. * Gets a boolean defining if the target contains position data
  105880. */
  105881. get hasPositions(): boolean;
  105882. /**
  105883. * Gets a boolean defining if the target contains normal data
  105884. */
  105885. get hasNormals(): boolean;
  105886. /**
  105887. * Gets a boolean defining if the target contains tangent data
  105888. */
  105889. get hasTangents(): boolean;
  105890. /**
  105891. * Gets a boolean defining if the target contains texture coordinates data
  105892. */
  105893. get hasUVs(): boolean;
  105894. /**
  105895. * Affects position data to this target
  105896. * @param data defines the position data to use
  105897. */
  105898. setPositions(data: Nullable<FloatArray>): void;
  105899. /**
  105900. * Gets the position data stored in this target
  105901. * @returns a FloatArray containing the position data (or null if not present)
  105902. */
  105903. getPositions(): Nullable<FloatArray>;
  105904. /**
  105905. * Affects normal data to this target
  105906. * @param data defines the normal data to use
  105907. */
  105908. setNormals(data: Nullable<FloatArray>): void;
  105909. /**
  105910. * Gets the normal data stored in this target
  105911. * @returns a FloatArray containing the normal data (or null if not present)
  105912. */
  105913. getNormals(): Nullable<FloatArray>;
  105914. /**
  105915. * Affects tangent data to this target
  105916. * @param data defines the tangent data to use
  105917. */
  105918. setTangents(data: Nullable<FloatArray>): void;
  105919. /**
  105920. * Gets the tangent data stored in this target
  105921. * @returns a FloatArray containing the tangent data (or null if not present)
  105922. */
  105923. getTangents(): Nullable<FloatArray>;
  105924. /**
  105925. * Affects texture coordinates data to this target
  105926. * @param data defines the texture coordinates data to use
  105927. */
  105928. setUVs(data: Nullable<FloatArray>): void;
  105929. /**
  105930. * Gets the texture coordinates data stored in this target
  105931. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  105932. */
  105933. getUVs(): Nullable<FloatArray>;
  105934. /**
  105935. * Clone the current target
  105936. * @returns a new MorphTarget
  105937. */
  105938. clone(): MorphTarget;
  105939. /**
  105940. * Serializes the current target into a Serialization object
  105941. * @returns the serialized object
  105942. */
  105943. serialize(): any;
  105944. /**
  105945. * Returns the string "MorphTarget"
  105946. * @returns "MorphTarget"
  105947. */
  105948. getClassName(): string;
  105949. /**
  105950. * Creates a new target from serialized data
  105951. * @param serializationObject defines the serialized data to use
  105952. * @returns a new MorphTarget
  105953. */
  105954. static Parse(serializationObject: any): MorphTarget;
  105955. /**
  105956. * Creates a MorphTarget from mesh data
  105957. * @param mesh defines the source mesh
  105958. * @param name defines the name to use for the new target
  105959. * @param influence defines the influence to attach to the target
  105960. * @returns a new MorphTarget
  105961. */
  105962. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  105963. }
  105964. }
  105965. declare module BABYLON {
  105966. /**
  105967. * This class is used to deform meshes using morphing between different targets
  105968. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  105969. */
  105970. export class MorphTargetManager {
  105971. private _targets;
  105972. private _targetInfluenceChangedObservers;
  105973. private _targetDataLayoutChangedObservers;
  105974. private _activeTargets;
  105975. private _scene;
  105976. private _influences;
  105977. private _supportsNormals;
  105978. private _supportsTangents;
  105979. private _supportsUVs;
  105980. private _vertexCount;
  105981. private _uniqueId;
  105982. private _tempInfluences;
  105983. /**
  105984. * Gets or sets a boolean indicating if normals must be morphed
  105985. */
  105986. enableNormalMorphing: boolean;
  105987. /**
  105988. * Gets or sets a boolean indicating if tangents must be morphed
  105989. */
  105990. enableTangentMorphing: boolean;
  105991. /**
  105992. * Gets or sets a boolean indicating if UV must be morphed
  105993. */
  105994. enableUVMorphing: boolean;
  105995. /**
  105996. * Creates a new MorphTargetManager
  105997. * @param scene defines the current scene
  105998. */
  105999. constructor(scene?: Nullable<Scene>);
  106000. /**
  106001. * Gets the unique ID of this manager
  106002. */
  106003. get uniqueId(): number;
  106004. /**
  106005. * Gets the number of vertices handled by this manager
  106006. */
  106007. get vertexCount(): number;
  106008. /**
  106009. * Gets a boolean indicating if this manager supports morphing of normals
  106010. */
  106011. get supportsNormals(): boolean;
  106012. /**
  106013. * Gets a boolean indicating if this manager supports morphing of tangents
  106014. */
  106015. get supportsTangents(): boolean;
  106016. /**
  106017. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106018. */
  106019. get supportsUVs(): boolean;
  106020. /**
  106021. * Gets the number of targets stored in this manager
  106022. */
  106023. get numTargets(): number;
  106024. /**
  106025. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106026. */
  106027. get numInfluencers(): number;
  106028. /**
  106029. * Gets the list of influences (one per target)
  106030. */
  106031. get influences(): Float32Array;
  106032. /**
  106033. * Gets the active target at specified index. An active target is a target with an influence > 0
  106034. * @param index defines the index to check
  106035. * @returns the requested target
  106036. */
  106037. getActiveTarget(index: number): MorphTarget;
  106038. /**
  106039. * Gets the target at specified index
  106040. * @param index defines the index to check
  106041. * @returns the requested target
  106042. */
  106043. getTarget(index: number): MorphTarget;
  106044. /**
  106045. * Add a new target to this manager
  106046. * @param target defines the target to add
  106047. */
  106048. addTarget(target: MorphTarget): void;
  106049. /**
  106050. * Removes a target from the manager
  106051. * @param target defines the target to remove
  106052. */
  106053. removeTarget(target: MorphTarget): void;
  106054. /**
  106055. * Clone the current manager
  106056. * @returns a new MorphTargetManager
  106057. */
  106058. clone(): MorphTargetManager;
  106059. /**
  106060. * Serializes the current manager into a Serialization object
  106061. * @returns the serialized object
  106062. */
  106063. serialize(): any;
  106064. private _syncActiveTargets;
  106065. /**
  106066. * Syncrhonize the targets with all the meshes using this morph target manager
  106067. */
  106068. synchronize(): void;
  106069. /**
  106070. * Creates a new MorphTargetManager from serialized data
  106071. * @param serializationObject defines the serialized data
  106072. * @param scene defines the hosting scene
  106073. * @returns the new MorphTargetManager
  106074. */
  106075. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106076. }
  106077. }
  106078. declare module BABYLON {
  106079. /**
  106080. * Class used to represent a specific level of detail of a mesh
  106081. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106082. */
  106083. export class MeshLODLevel {
  106084. /** Defines the distance where this level should start being displayed */
  106085. distance: number;
  106086. /** Defines the mesh to use to render this level */
  106087. mesh: Nullable<Mesh>;
  106088. /**
  106089. * Creates a new LOD level
  106090. * @param distance defines the distance where this level should star being displayed
  106091. * @param mesh defines the mesh to use to render this level
  106092. */
  106093. constructor(
  106094. /** Defines the distance where this level should start being displayed */
  106095. distance: number,
  106096. /** Defines the mesh to use to render this level */
  106097. mesh: Nullable<Mesh>);
  106098. }
  106099. }
  106100. declare module BABYLON {
  106101. /**
  106102. * Helper class used to generate a canvas to manipulate images
  106103. */
  106104. export class CanvasGenerator {
  106105. /**
  106106. * Create a new canvas (or offscreen canvas depending on the context)
  106107. * @param width defines the expected width
  106108. * @param height defines the expected height
  106109. * @return a new canvas or offscreen canvas
  106110. */
  106111. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106112. }
  106113. }
  106114. declare module BABYLON {
  106115. /**
  106116. * Mesh representing the gorund
  106117. */
  106118. export class GroundMesh extends Mesh {
  106119. /** If octree should be generated */
  106120. generateOctree: boolean;
  106121. private _heightQuads;
  106122. /** @hidden */
  106123. _subdivisionsX: number;
  106124. /** @hidden */
  106125. _subdivisionsY: number;
  106126. /** @hidden */
  106127. _width: number;
  106128. /** @hidden */
  106129. _height: number;
  106130. /** @hidden */
  106131. _minX: number;
  106132. /** @hidden */
  106133. _maxX: number;
  106134. /** @hidden */
  106135. _minZ: number;
  106136. /** @hidden */
  106137. _maxZ: number;
  106138. constructor(name: string, scene: Scene);
  106139. /**
  106140. * "GroundMesh"
  106141. * @returns "GroundMesh"
  106142. */
  106143. getClassName(): string;
  106144. /**
  106145. * The minimum of x and y subdivisions
  106146. */
  106147. get subdivisions(): number;
  106148. /**
  106149. * X subdivisions
  106150. */
  106151. get subdivisionsX(): number;
  106152. /**
  106153. * Y subdivisions
  106154. */
  106155. get subdivisionsY(): number;
  106156. /**
  106157. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106158. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106159. * @param chunksCount the number of subdivisions for x and y
  106160. * @param octreeBlocksSize (Default: 32)
  106161. */
  106162. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106163. /**
  106164. * Returns a height (y) value in the Worl system :
  106165. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106166. * @param x x coordinate
  106167. * @param z z coordinate
  106168. * @returns the ground y position if (x, z) are outside the ground surface.
  106169. */
  106170. getHeightAtCoordinates(x: number, z: number): number;
  106171. /**
  106172. * Returns a normalized vector (Vector3) orthogonal to the ground
  106173. * at the ground coordinates (x, z) expressed in the World system.
  106174. * @param x x coordinate
  106175. * @param z z coordinate
  106176. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106177. */
  106178. getNormalAtCoordinates(x: number, z: number): Vector3;
  106179. /**
  106180. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106181. * at the ground coordinates (x, z) expressed in the World system.
  106182. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106183. * @param x x coordinate
  106184. * @param z z coordinate
  106185. * @param ref vector to store the result
  106186. * @returns the GroundMesh.
  106187. */
  106188. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106189. /**
  106190. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106191. * if the ground has been updated.
  106192. * This can be used in the render loop.
  106193. * @returns the GroundMesh.
  106194. */
  106195. updateCoordinateHeights(): GroundMesh;
  106196. private _getFacetAt;
  106197. private _initHeightQuads;
  106198. private _computeHeightQuads;
  106199. /**
  106200. * Serializes this ground mesh
  106201. * @param serializationObject object to write serialization to
  106202. */
  106203. serialize(serializationObject: any): void;
  106204. /**
  106205. * Parses a serialized ground mesh
  106206. * @param parsedMesh the serialized mesh
  106207. * @param scene the scene to create the ground mesh in
  106208. * @returns the created ground mesh
  106209. */
  106210. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106211. }
  106212. }
  106213. declare module BABYLON {
  106214. /**
  106215. * Interface for Physics-Joint data
  106216. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106217. */
  106218. export interface PhysicsJointData {
  106219. /**
  106220. * The main pivot of the joint
  106221. */
  106222. mainPivot?: Vector3;
  106223. /**
  106224. * The connected pivot of the joint
  106225. */
  106226. connectedPivot?: Vector3;
  106227. /**
  106228. * The main axis of the joint
  106229. */
  106230. mainAxis?: Vector3;
  106231. /**
  106232. * The connected axis of the joint
  106233. */
  106234. connectedAxis?: Vector3;
  106235. /**
  106236. * The collision of the joint
  106237. */
  106238. collision?: boolean;
  106239. /**
  106240. * Native Oimo/Cannon/Energy data
  106241. */
  106242. nativeParams?: any;
  106243. }
  106244. /**
  106245. * This is a holder class for the physics joint created by the physics plugin
  106246. * It holds a set of functions to control the underlying joint
  106247. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106248. */
  106249. export class PhysicsJoint {
  106250. /**
  106251. * The type of the physics joint
  106252. */
  106253. type: number;
  106254. /**
  106255. * The data for the physics joint
  106256. */
  106257. jointData: PhysicsJointData;
  106258. private _physicsJoint;
  106259. protected _physicsPlugin: IPhysicsEnginePlugin;
  106260. /**
  106261. * Initializes the physics joint
  106262. * @param type The type of the physics joint
  106263. * @param jointData The data for the physics joint
  106264. */
  106265. constructor(
  106266. /**
  106267. * The type of the physics joint
  106268. */
  106269. type: number,
  106270. /**
  106271. * The data for the physics joint
  106272. */
  106273. jointData: PhysicsJointData);
  106274. /**
  106275. * Gets the physics joint
  106276. */
  106277. get physicsJoint(): any;
  106278. /**
  106279. * Sets the physics joint
  106280. */
  106281. set physicsJoint(newJoint: any);
  106282. /**
  106283. * Sets the physics plugin
  106284. */
  106285. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106286. /**
  106287. * Execute a function that is physics-plugin specific.
  106288. * @param {Function} func the function that will be executed.
  106289. * It accepts two parameters: the physics world and the physics joint
  106290. */
  106291. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106292. /**
  106293. * Distance-Joint type
  106294. */
  106295. static DistanceJoint: number;
  106296. /**
  106297. * Hinge-Joint type
  106298. */
  106299. static HingeJoint: number;
  106300. /**
  106301. * Ball-and-Socket joint type
  106302. */
  106303. static BallAndSocketJoint: number;
  106304. /**
  106305. * Wheel-Joint type
  106306. */
  106307. static WheelJoint: number;
  106308. /**
  106309. * Slider-Joint type
  106310. */
  106311. static SliderJoint: number;
  106312. /**
  106313. * Prismatic-Joint type
  106314. */
  106315. static PrismaticJoint: number;
  106316. /**
  106317. * Universal-Joint type
  106318. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106319. */
  106320. static UniversalJoint: number;
  106321. /**
  106322. * Hinge-Joint 2 type
  106323. */
  106324. static Hinge2Joint: number;
  106325. /**
  106326. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106327. */
  106328. static PointToPointJoint: number;
  106329. /**
  106330. * Spring-Joint type
  106331. */
  106332. static SpringJoint: number;
  106333. /**
  106334. * Lock-Joint type
  106335. */
  106336. static LockJoint: number;
  106337. }
  106338. /**
  106339. * A class representing a physics distance joint
  106340. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106341. */
  106342. export class DistanceJoint extends PhysicsJoint {
  106343. /**
  106344. *
  106345. * @param jointData The data for the Distance-Joint
  106346. */
  106347. constructor(jointData: DistanceJointData);
  106348. /**
  106349. * Update the predefined distance.
  106350. * @param maxDistance The maximum preferred distance
  106351. * @param minDistance The minimum preferred distance
  106352. */
  106353. updateDistance(maxDistance: number, minDistance?: number): void;
  106354. }
  106355. /**
  106356. * Represents a Motor-Enabled Joint
  106357. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106358. */
  106359. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106360. /**
  106361. * Initializes the Motor-Enabled Joint
  106362. * @param type The type of the joint
  106363. * @param jointData The physica joint data for the joint
  106364. */
  106365. constructor(type: number, jointData: PhysicsJointData);
  106366. /**
  106367. * Set the motor values.
  106368. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106369. * @param force the force to apply
  106370. * @param maxForce max force for this motor.
  106371. */
  106372. setMotor(force?: number, maxForce?: number): void;
  106373. /**
  106374. * Set the motor's limits.
  106375. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106376. * @param upperLimit The upper limit of the motor
  106377. * @param lowerLimit The lower limit of the motor
  106378. */
  106379. setLimit(upperLimit: number, lowerLimit?: number): void;
  106380. }
  106381. /**
  106382. * This class represents a single physics Hinge-Joint
  106383. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106384. */
  106385. export class HingeJoint extends MotorEnabledJoint {
  106386. /**
  106387. * Initializes the Hinge-Joint
  106388. * @param jointData The joint data for the Hinge-Joint
  106389. */
  106390. constructor(jointData: PhysicsJointData);
  106391. /**
  106392. * Set the motor values.
  106393. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106394. * @param {number} force the force to apply
  106395. * @param {number} maxForce max force for this motor.
  106396. */
  106397. setMotor(force?: number, maxForce?: number): void;
  106398. /**
  106399. * Set the motor's limits.
  106400. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106401. * @param upperLimit The upper limit of the motor
  106402. * @param lowerLimit The lower limit of the motor
  106403. */
  106404. setLimit(upperLimit: number, lowerLimit?: number): void;
  106405. }
  106406. /**
  106407. * This class represents a dual hinge physics joint (same as wheel joint)
  106408. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106409. */
  106410. export class Hinge2Joint extends MotorEnabledJoint {
  106411. /**
  106412. * Initializes the Hinge2-Joint
  106413. * @param jointData The joint data for the Hinge2-Joint
  106414. */
  106415. constructor(jointData: PhysicsJointData);
  106416. /**
  106417. * Set the motor values.
  106418. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106419. * @param {number} targetSpeed the speed the motor is to reach
  106420. * @param {number} maxForce max force for this motor.
  106421. * @param {motorIndex} the motor's index, 0 or 1.
  106422. */
  106423. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106424. /**
  106425. * Set the motor limits.
  106426. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106427. * @param {number} upperLimit the upper limit
  106428. * @param {number} lowerLimit lower limit
  106429. * @param {motorIndex} the motor's index, 0 or 1.
  106430. */
  106431. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106432. }
  106433. /**
  106434. * Interface for a motor enabled joint
  106435. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106436. */
  106437. export interface IMotorEnabledJoint {
  106438. /**
  106439. * Physics joint
  106440. */
  106441. physicsJoint: any;
  106442. /**
  106443. * Sets the motor of the motor-enabled joint
  106444. * @param force The force of the motor
  106445. * @param maxForce The maximum force of the motor
  106446. * @param motorIndex The index of the motor
  106447. */
  106448. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106449. /**
  106450. * Sets the limit of the motor
  106451. * @param upperLimit The upper limit of the motor
  106452. * @param lowerLimit The lower limit of the motor
  106453. * @param motorIndex The index of the motor
  106454. */
  106455. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106456. }
  106457. /**
  106458. * Joint data for a Distance-Joint
  106459. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106460. */
  106461. export interface DistanceJointData extends PhysicsJointData {
  106462. /**
  106463. * Max distance the 2 joint objects can be apart
  106464. */
  106465. maxDistance: number;
  106466. }
  106467. /**
  106468. * Joint data from a spring joint
  106469. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106470. */
  106471. export interface SpringJointData extends PhysicsJointData {
  106472. /**
  106473. * Length of the spring
  106474. */
  106475. length: number;
  106476. /**
  106477. * Stiffness of the spring
  106478. */
  106479. stiffness: number;
  106480. /**
  106481. * Damping of the spring
  106482. */
  106483. damping: number;
  106484. /** this callback will be called when applying the force to the impostors. */
  106485. forceApplicationCallback: () => void;
  106486. }
  106487. }
  106488. declare module BABYLON {
  106489. /**
  106490. * Holds the data for the raycast result
  106491. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106492. */
  106493. export class PhysicsRaycastResult {
  106494. private _hasHit;
  106495. private _hitDistance;
  106496. private _hitNormalWorld;
  106497. private _hitPointWorld;
  106498. private _rayFromWorld;
  106499. private _rayToWorld;
  106500. /**
  106501. * Gets if there was a hit
  106502. */
  106503. get hasHit(): boolean;
  106504. /**
  106505. * Gets the distance from the hit
  106506. */
  106507. get hitDistance(): number;
  106508. /**
  106509. * Gets the hit normal/direction in the world
  106510. */
  106511. get hitNormalWorld(): Vector3;
  106512. /**
  106513. * Gets the hit point in the world
  106514. */
  106515. get hitPointWorld(): Vector3;
  106516. /**
  106517. * Gets the ray "start point" of the ray in the world
  106518. */
  106519. get rayFromWorld(): Vector3;
  106520. /**
  106521. * Gets the ray "end point" of the ray in the world
  106522. */
  106523. get rayToWorld(): Vector3;
  106524. /**
  106525. * Sets the hit data (normal & point in world space)
  106526. * @param hitNormalWorld defines the normal in world space
  106527. * @param hitPointWorld defines the point in world space
  106528. */
  106529. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106530. /**
  106531. * Sets the distance from the start point to the hit point
  106532. * @param distance
  106533. */
  106534. setHitDistance(distance: number): void;
  106535. /**
  106536. * Calculates the distance manually
  106537. */
  106538. calculateHitDistance(): void;
  106539. /**
  106540. * Resets all the values to default
  106541. * @param from The from point on world space
  106542. * @param to The to point on world space
  106543. */
  106544. reset(from?: Vector3, to?: Vector3): void;
  106545. }
  106546. /**
  106547. * Interface for the size containing width and height
  106548. */
  106549. interface IXYZ {
  106550. /**
  106551. * X
  106552. */
  106553. x: number;
  106554. /**
  106555. * Y
  106556. */
  106557. y: number;
  106558. /**
  106559. * Z
  106560. */
  106561. z: number;
  106562. }
  106563. }
  106564. declare module BABYLON {
  106565. /**
  106566. * Interface used to describe a physics joint
  106567. */
  106568. export interface PhysicsImpostorJoint {
  106569. /** Defines the main impostor to which the joint is linked */
  106570. mainImpostor: PhysicsImpostor;
  106571. /** Defines the impostor that is connected to the main impostor using this joint */
  106572. connectedImpostor: PhysicsImpostor;
  106573. /** Defines the joint itself */
  106574. joint: PhysicsJoint;
  106575. }
  106576. /** @hidden */
  106577. export interface IPhysicsEnginePlugin {
  106578. world: any;
  106579. name: string;
  106580. setGravity(gravity: Vector3): void;
  106581. setTimeStep(timeStep: number): void;
  106582. getTimeStep(): number;
  106583. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  106584. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106585. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106586. generatePhysicsBody(impostor: PhysicsImpostor): void;
  106587. removePhysicsBody(impostor: PhysicsImpostor): void;
  106588. generateJoint(joint: PhysicsImpostorJoint): void;
  106589. removeJoint(joint: PhysicsImpostorJoint): void;
  106590. isSupported(): boolean;
  106591. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  106592. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  106593. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106594. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106595. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106596. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106597. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  106598. getBodyMass(impostor: PhysicsImpostor): number;
  106599. getBodyFriction(impostor: PhysicsImpostor): number;
  106600. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  106601. getBodyRestitution(impostor: PhysicsImpostor): number;
  106602. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  106603. getBodyPressure?(impostor: PhysicsImpostor): number;
  106604. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  106605. getBodyStiffness?(impostor: PhysicsImpostor): number;
  106606. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  106607. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  106608. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  106609. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  106610. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  106611. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106612. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106613. sleepBody(impostor: PhysicsImpostor): void;
  106614. wakeUpBody(impostor: PhysicsImpostor): void;
  106615. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106616. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  106617. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  106618. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106619. getRadius(impostor: PhysicsImpostor): number;
  106620. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  106621. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  106622. dispose(): void;
  106623. }
  106624. /**
  106625. * Interface used to define a physics engine
  106626. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106627. */
  106628. export interface IPhysicsEngine {
  106629. /**
  106630. * Gets the gravity vector used by the simulation
  106631. */
  106632. gravity: Vector3;
  106633. /**
  106634. * Sets the gravity vector used by the simulation
  106635. * @param gravity defines the gravity vector to use
  106636. */
  106637. setGravity(gravity: Vector3): void;
  106638. /**
  106639. * Set the time step of the physics engine.
  106640. * Default is 1/60.
  106641. * To slow it down, enter 1/600 for example.
  106642. * To speed it up, 1/30
  106643. * @param newTimeStep the new timestep to apply to this world.
  106644. */
  106645. setTimeStep(newTimeStep: number): void;
  106646. /**
  106647. * Get the time step of the physics engine.
  106648. * @returns the current time step
  106649. */
  106650. getTimeStep(): number;
  106651. /**
  106652. * Set the sub time step of the physics engine.
  106653. * Default is 0 meaning there is no sub steps
  106654. * To increase physics resolution precision, set a small value (like 1 ms)
  106655. * @param subTimeStep defines the new sub timestep used for physics resolution.
  106656. */
  106657. setSubTimeStep(subTimeStep: number): void;
  106658. /**
  106659. * Get the sub time step of the physics engine.
  106660. * @returns the current sub time step
  106661. */
  106662. getSubTimeStep(): number;
  106663. /**
  106664. * Release all resources
  106665. */
  106666. dispose(): void;
  106667. /**
  106668. * Gets the name of the current physics plugin
  106669. * @returns the name of the plugin
  106670. */
  106671. getPhysicsPluginName(): string;
  106672. /**
  106673. * Adding a new impostor for the impostor tracking.
  106674. * This will be done by the impostor itself.
  106675. * @param impostor the impostor to add
  106676. */
  106677. addImpostor(impostor: PhysicsImpostor): void;
  106678. /**
  106679. * Remove an impostor from the engine.
  106680. * This impostor and its mesh will not longer be updated by the physics engine.
  106681. * @param impostor the impostor to remove
  106682. */
  106683. removeImpostor(impostor: PhysicsImpostor): void;
  106684. /**
  106685. * Add a joint to the physics engine
  106686. * @param mainImpostor defines the main impostor to which the joint is added.
  106687. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  106688. * @param joint defines the joint that will connect both impostors.
  106689. */
  106690. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  106691. /**
  106692. * Removes a joint from the simulation
  106693. * @param mainImpostor defines the impostor used with the joint
  106694. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  106695. * @param joint defines the joint to remove
  106696. */
  106697. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  106698. /**
  106699. * Gets the current plugin used to run the simulation
  106700. * @returns current plugin
  106701. */
  106702. getPhysicsPlugin(): IPhysicsEnginePlugin;
  106703. /**
  106704. * Gets the list of physic impostors
  106705. * @returns an array of PhysicsImpostor
  106706. */
  106707. getImpostors(): Array<PhysicsImpostor>;
  106708. /**
  106709. * Gets the impostor for a physics enabled object
  106710. * @param object defines the object impersonated by the impostor
  106711. * @returns the PhysicsImpostor or null if not found
  106712. */
  106713. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  106714. /**
  106715. * Gets the impostor for a physics body object
  106716. * @param body defines physics body used by the impostor
  106717. * @returns the PhysicsImpostor or null if not found
  106718. */
  106719. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  106720. /**
  106721. * Does a raycast in the physics world
  106722. * @param from when should the ray start?
  106723. * @param to when should the ray end?
  106724. * @returns PhysicsRaycastResult
  106725. */
  106726. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106727. /**
  106728. * Called by the scene. No need to call it.
  106729. * @param delta defines the timespam between frames
  106730. */
  106731. _step(delta: number): void;
  106732. }
  106733. }
  106734. declare module BABYLON {
  106735. /**
  106736. * The interface for the physics imposter parameters
  106737. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106738. */
  106739. export interface PhysicsImpostorParameters {
  106740. /**
  106741. * The mass of the physics imposter
  106742. */
  106743. mass: number;
  106744. /**
  106745. * The friction of the physics imposter
  106746. */
  106747. friction?: number;
  106748. /**
  106749. * The coefficient of restitution of the physics imposter
  106750. */
  106751. restitution?: number;
  106752. /**
  106753. * The native options of the physics imposter
  106754. */
  106755. nativeOptions?: any;
  106756. /**
  106757. * Specifies if the parent should be ignored
  106758. */
  106759. ignoreParent?: boolean;
  106760. /**
  106761. * Specifies if bi-directional transformations should be disabled
  106762. */
  106763. disableBidirectionalTransformation?: boolean;
  106764. /**
  106765. * The pressure inside the physics imposter, soft object only
  106766. */
  106767. pressure?: number;
  106768. /**
  106769. * The stiffness the physics imposter, soft object only
  106770. */
  106771. stiffness?: number;
  106772. /**
  106773. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  106774. */
  106775. velocityIterations?: number;
  106776. /**
  106777. * The number of iterations used in maintaining consistent vertex positions, soft object only
  106778. */
  106779. positionIterations?: number;
  106780. /**
  106781. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  106782. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  106783. * Add to fix multiple points
  106784. */
  106785. fixedPoints?: number;
  106786. /**
  106787. * The collision margin around a soft object
  106788. */
  106789. margin?: number;
  106790. /**
  106791. * The collision margin around a soft object
  106792. */
  106793. damping?: number;
  106794. /**
  106795. * The path for a rope based on an extrusion
  106796. */
  106797. path?: any;
  106798. /**
  106799. * The shape of an extrusion used for a rope based on an extrusion
  106800. */
  106801. shape?: any;
  106802. }
  106803. /**
  106804. * Interface for a physics-enabled object
  106805. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106806. */
  106807. export interface IPhysicsEnabledObject {
  106808. /**
  106809. * The position of the physics-enabled object
  106810. */
  106811. position: Vector3;
  106812. /**
  106813. * The rotation of the physics-enabled object
  106814. */
  106815. rotationQuaternion: Nullable<Quaternion>;
  106816. /**
  106817. * The scale of the physics-enabled object
  106818. */
  106819. scaling: Vector3;
  106820. /**
  106821. * The rotation of the physics-enabled object
  106822. */
  106823. rotation?: Vector3;
  106824. /**
  106825. * The parent of the physics-enabled object
  106826. */
  106827. parent?: any;
  106828. /**
  106829. * The bounding info of the physics-enabled object
  106830. * @returns The bounding info of the physics-enabled object
  106831. */
  106832. getBoundingInfo(): BoundingInfo;
  106833. /**
  106834. * Computes the world matrix
  106835. * @param force Specifies if the world matrix should be computed by force
  106836. * @returns A world matrix
  106837. */
  106838. computeWorldMatrix(force: boolean): Matrix;
  106839. /**
  106840. * Gets the world matrix
  106841. * @returns A world matrix
  106842. */
  106843. getWorldMatrix?(): Matrix;
  106844. /**
  106845. * Gets the child meshes
  106846. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  106847. * @returns An array of abstract meshes
  106848. */
  106849. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  106850. /**
  106851. * Gets the vertex data
  106852. * @param kind The type of vertex data
  106853. * @returns A nullable array of numbers, or a float32 array
  106854. */
  106855. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  106856. /**
  106857. * Gets the indices from the mesh
  106858. * @returns A nullable array of index arrays
  106859. */
  106860. getIndices?(): Nullable<IndicesArray>;
  106861. /**
  106862. * Gets the scene from the mesh
  106863. * @returns the indices array or null
  106864. */
  106865. getScene?(): Scene;
  106866. /**
  106867. * Gets the absolute position from the mesh
  106868. * @returns the absolute position
  106869. */
  106870. getAbsolutePosition(): Vector3;
  106871. /**
  106872. * Gets the absolute pivot point from the mesh
  106873. * @returns the absolute pivot point
  106874. */
  106875. getAbsolutePivotPoint(): Vector3;
  106876. /**
  106877. * Rotates the mesh
  106878. * @param axis The axis of rotation
  106879. * @param amount The amount of rotation
  106880. * @param space The space of the rotation
  106881. * @returns The rotation transform node
  106882. */
  106883. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  106884. /**
  106885. * Translates the mesh
  106886. * @param axis The axis of translation
  106887. * @param distance The distance of translation
  106888. * @param space The space of the translation
  106889. * @returns The transform node
  106890. */
  106891. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  106892. /**
  106893. * Sets the absolute position of the mesh
  106894. * @param absolutePosition The absolute position of the mesh
  106895. * @returns The transform node
  106896. */
  106897. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  106898. /**
  106899. * Gets the class name of the mesh
  106900. * @returns The class name
  106901. */
  106902. getClassName(): string;
  106903. }
  106904. /**
  106905. * Represents a physics imposter
  106906. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106907. */
  106908. export class PhysicsImpostor {
  106909. /**
  106910. * The physics-enabled object used as the physics imposter
  106911. */
  106912. object: IPhysicsEnabledObject;
  106913. /**
  106914. * The type of the physics imposter
  106915. */
  106916. type: number;
  106917. private _options;
  106918. private _scene?;
  106919. /**
  106920. * The default object size of the imposter
  106921. */
  106922. static DEFAULT_OBJECT_SIZE: Vector3;
  106923. /**
  106924. * The identity quaternion of the imposter
  106925. */
  106926. static IDENTITY_QUATERNION: Quaternion;
  106927. /** @hidden */
  106928. _pluginData: any;
  106929. private _physicsEngine;
  106930. private _physicsBody;
  106931. private _bodyUpdateRequired;
  106932. private _onBeforePhysicsStepCallbacks;
  106933. private _onAfterPhysicsStepCallbacks;
  106934. /** @hidden */
  106935. _onPhysicsCollideCallbacks: Array<{
  106936. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  106937. otherImpostors: Array<PhysicsImpostor>;
  106938. }>;
  106939. private _deltaPosition;
  106940. private _deltaRotation;
  106941. private _deltaRotationConjugated;
  106942. /** @hidden */
  106943. _isFromLine: boolean;
  106944. private _parent;
  106945. private _isDisposed;
  106946. private static _tmpVecs;
  106947. private static _tmpQuat;
  106948. /**
  106949. * Specifies if the physics imposter is disposed
  106950. */
  106951. get isDisposed(): boolean;
  106952. /**
  106953. * Gets the mass of the physics imposter
  106954. */
  106955. get mass(): number;
  106956. set mass(value: number);
  106957. /**
  106958. * Gets the coefficient of friction
  106959. */
  106960. get friction(): number;
  106961. /**
  106962. * Sets the coefficient of friction
  106963. */
  106964. set friction(value: number);
  106965. /**
  106966. * Gets the coefficient of restitution
  106967. */
  106968. get restitution(): number;
  106969. /**
  106970. * Sets the coefficient of restitution
  106971. */
  106972. set restitution(value: number);
  106973. /**
  106974. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  106975. */
  106976. get pressure(): number;
  106977. /**
  106978. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  106979. */
  106980. set pressure(value: number);
  106981. /**
  106982. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  106983. */
  106984. get stiffness(): number;
  106985. /**
  106986. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  106987. */
  106988. set stiffness(value: number);
  106989. /**
  106990. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  106991. */
  106992. get velocityIterations(): number;
  106993. /**
  106994. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  106995. */
  106996. set velocityIterations(value: number);
  106997. /**
  106998. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  106999. */
  107000. get positionIterations(): number;
  107001. /**
  107002. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107003. */
  107004. set positionIterations(value: number);
  107005. /**
  107006. * The unique id of the physics imposter
  107007. * set by the physics engine when adding this impostor to the array
  107008. */
  107009. uniqueId: number;
  107010. /**
  107011. * @hidden
  107012. */
  107013. soft: boolean;
  107014. /**
  107015. * @hidden
  107016. */
  107017. segments: number;
  107018. private _joints;
  107019. /**
  107020. * Initializes the physics imposter
  107021. * @param object The physics-enabled object used as the physics imposter
  107022. * @param type The type of the physics imposter
  107023. * @param _options The options for the physics imposter
  107024. * @param _scene The Babylon scene
  107025. */
  107026. constructor(
  107027. /**
  107028. * The physics-enabled object used as the physics imposter
  107029. */
  107030. object: IPhysicsEnabledObject,
  107031. /**
  107032. * The type of the physics imposter
  107033. */
  107034. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107035. /**
  107036. * This function will completly initialize this impostor.
  107037. * It will create a new body - but only if this mesh has no parent.
  107038. * If it has, this impostor will not be used other than to define the impostor
  107039. * of the child mesh.
  107040. * @hidden
  107041. */
  107042. _init(): void;
  107043. private _getPhysicsParent;
  107044. /**
  107045. * Should a new body be generated.
  107046. * @returns boolean specifying if body initialization is required
  107047. */
  107048. isBodyInitRequired(): boolean;
  107049. /**
  107050. * Sets the updated scaling
  107051. * @param updated Specifies if the scaling is updated
  107052. */
  107053. setScalingUpdated(): void;
  107054. /**
  107055. * Force a regeneration of this or the parent's impostor's body.
  107056. * Use under cautious - This will remove all joints already implemented.
  107057. */
  107058. forceUpdate(): void;
  107059. /**
  107060. * Gets the body that holds this impostor. Either its own, or its parent.
  107061. */
  107062. get physicsBody(): any;
  107063. /**
  107064. * Get the parent of the physics imposter
  107065. * @returns Physics imposter or null
  107066. */
  107067. get parent(): Nullable<PhysicsImpostor>;
  107068. /**
  107069. * Sets the parent of the physics imposter
  107070. */
  107071. set parent(value: Nullable<PhysicsImpostor>);
  107072. /**
  107073. * Set the physics body. Used mainly by the physics engine/plugin
  107074. */
  107075. set physicsBody(physicsBody: any);
  107076. /**
  107077. * Resets the update flags
  107078. */
  107079. resetUpdateFlags(): void;
  107080. /**
  107081. * Gets the object extend size
  107082. * @returns the object extend size
  107083. */
  107084. getObjectExtendSize(): Vector3;
  107085. /**
  107086. * Gets the object center
  107087. * @returns The object center
  107088. */
  107089. getObjectCenter(): Vector3;
  107090. /**
  107091. * Get a specific parameter from the options parameters
  107092. * @param paramName The object parameter name
  107093. * @returns The object parameter
  107094. */
  107095. getParam(paramName: string): any;
  107096. /**
  107097. * Sets a specific parameter in the options given to the physics plugin
  107098. * @param paramName The parameter name
  107099. * @param value The value of the parameter
  107100. */
  107101. setParam(paramName: string, value: number): void;
  107102. /**
  107103. * Specifically change the body's mass option. Won't recreate the physics body object
  107104. * @param mass The mass of the physics imposter
  107105. */
  107106. setMass(mass: number): void;
  107107. /**
  107108. * Gets the linear velocity
  107109. * @returns linear velocity or null
  107110. */
  107111. getLinearVelocity(): Nullable<Vector3>;
  107112. /**
  107113. * Sets the linear velocity
  107114. * @param velocity linear velocity or null
  107115. */
  107116. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107117. /**
  107118. * Gets the angular velocity
  107119. * @returns angular velocity or null
  107120. */
  107121. getAngularVelocity(): Nullable<Vector3>;
  107122. /**
  107123. * Sets the angular velocity
  107124. * @param velocity The velocity or null
  107125. */
  107126. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107127. /**
  107128. * Execute a function with the physics plugin native code
  107129. * Provide a function the will have two variables - the world object and the physics body object
  107130. * @param func The function to execute with the physics plugin native code
  107131. */
  107132. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107133. /**
  107134. * Register a function that will be executed before the physics world is stepping forward
  107135. * @param func The function to execute before the physics world is stepped forward
  107136. */
  107137. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107138. /**
  107139. * Unregister a function that will be executed before the physics world is stepping forward
  107140. * @param func The function to execute before the physics world is stepped forward
  107141. */
  107142. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107143. /**
  107144. * Register a function that will be executed after the physics step
  107145. * @param func The function to execute after physics step
  107146. */
  107147. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107148. /**
  107149. * Unregisters a function that will be executed after the physics step
  107150. * @param func The function to execute after physics step
  107151. */
  107152. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107153. /**
  107154. * register a function that will be executed when this impostor collides against a different body
  107155. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107156. * @param func Callback that is executed on collision
  107157. */
  107158. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107159. /**
  107160. * Unregisters the physics imposter on contact
  107161. * @param collideAgainst The physics object to collide against
  107162. * @param func Callback to execute on collision
  107163. */
  107164. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107165. private _tmpQuat;
  107166. private _tmpQuat2;
  107167. /**
  107168. * Get the parent rotation
  107169. * @returns The parent rotation
  107170. */
  107171. getParentsRotation(): Quaternion;
  107172. /**
  107173. * this function is executed by the physics engine.
  107174. */
  107175. beforeStep: () => void;
  107176. /**
  107177. * this function is executed by the physics engine
  107178. */
  107179. afterStep: () => void;
  107180. /**
  107181. * Legacy collision detection event support
  107182. */
  107183. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107184. /**
  107185. * event and body object due to cannon's event-based architecture.
  107186. */
  107187. onCollide: (e: {
  107188. body: any;
  107189. }) => void;
  107190. /**
  107191. * Apply a force
  107192. * @param force The force to apply
  107193. * @param contactPoint The contact point for the force
  107194. * @returns The physics imposter
  107195. */
  107196. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107197. /**
  107198. * Apply an impulse
  107199. * @param force The impulse force
  107200. * @param contactPoint The contact point for the impulse force
  107201. * @returns The physics imposter
  107202. */
  107203. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107204. /**
  107205. * A help function to create a joint
  107206. * @param otherImpostor A physics imposter used to create a joint
  107207. * @param jointType The type of joint
  107208. * @param jointData The data for the joint
  107209. * @returns The physics imposter
  107210. */
  107211. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107212. /**
  107213. * Add a joint to this impostor with a different impostor
  107214. * @param otherImpostor A physics imposter used to add a joint
  107215. * @param joint The joint to add
  107216. * @returns The physics imposter
  107217. */
  107218. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107219. /**
  107220. * Add an anchor to a cloth impostor
  107221. * @param otherImpostor rigid impostor to anchor to
  107222. * @param width ratio across width from 0 to 1
  107223. * @param height ratio up height from 0 to 1
  107224. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107225. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107226. * @returns impostor the soft imposter
  107227. */
  107228. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107229. /**
  107230. * Add a hook to a rope impostor
  107231. * @param otherImpostor rigid impostor to anchor to
  107232. * @param length ratio across rope from 0 to 1
  107233. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107234. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107235. * @returns impostor the rope imposter
  107236. */
  107237. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107238. /**
  107239. * Will keep this body still, in a sleep mode.
  107240. * @returns the physics imposter
  107241. */
  107242. sleep(): PhysicsImpostor;
  107243. /**
  107244. * Wake the body up.
  107245. * @returns The physics imposter
  107246. */
  107247. wakeUp(): PhysicsImpostor;
  107248. /**
  107249. * Clones the physics imposter
  107250. * @param newObject The physics imposter clones to this physics-enabled object
  107251. * @returns A nullable physics imposter
  107252. */
  107253. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107254. /**
  107255. * Disposes the physics imposter
  107256. */
  107257. dispose(): void;
  107258. /**
  107259. * Sets the delta position
  107260. * @param position The delta position amount
  107261. */
  107262. setDeltaPosition(position: Vector3): void;
  107263. /**
  107264. * Sets the delta rotation
  107265. * @param rotation The delta rotation amount
  107266. */
  107267. setDeltaRotation(rotation: Quaternion): void;
  107268. /**
  107269. * Gets the box size of the physics imposter and stores the result in the input parameter
  107270. * @param result Stores the box size
  107271. * @returns The physics imposter
  107272. */
  107273. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107274. /**
  107275. * Gets the radius of the physics imposter
  107276. * @returns Radius of the physics imposter
  107277. */
  107278. getRadius(): number;
  107279. /**
  107280. * Sync a bone with this impostor
  107281. * @param bone The bone to sync to the impostor.
  107282. * @param boneMesh The mesh that the bone is influencing.
  107283. * @param jointPivot The pivot of the joint / bone in local space.
  107284. * @param distToJoint Optional distance from the impostor to the joint.
  107285. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107286. */
  107287. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107288. /**
  107289. * Sync impostor to a bone
  107290. * @param bone The bone that the impostor will be synced to.
  107291. * @param boneMesh The mesh that the bone is influencing.
  107292. * @param jointPivot The pivot of the joint / bone in local space.
  107293. * @param distToJoint Optional distance from the impostor to the joint.
  107294. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107295. * @param boneAxis Optional vector3 axis the bone is aligned with
  107296. */
  107297. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107298. /**
  107299. * No-Imposter type
  107300. */
  107301. static NoImpostor: number;
  107302. /**
  107303. * Sphere-Imposter type
  107304. */
  107305. static SphereImpostor: number;
  107306. /**
  107307. * Box-Imposter type
  107308. */
  107309. static BoxImpostor: number;
  107310. /**
  107311. * Plane-Imposter type
  107312. */
  107313. static PlaneImpostor: number;
  107314. /**
  107315. * Mesh-imposter type
  107316. */
  107317. static MeshImpostor: number;
  107318. /**
  107319. * Capsule-Impostor type (Ammo.js plugin only)
  107320. */
  107321. static CapsuleImpostor: number;
  107322. /**
  107323. * Cylinder-Imposter type
  107324. */
  107325. static CylinderImpostor: number;
  107326. /**
  107327. * Particle-Imposter type
  107328. */
  107329. static ParticleImpostor: number;
  107330. /**
  107331. * Heightmap-Imposter type
  107332. */
  107333. static HeightmapImpostor: number;
  107334. /**
  107335. * ConvexHull-Impostor type (Ammo.js plugin only)
  107336. */
  107337. static ConvexHullImpostor: number;
  107338. /**
  107339. * Custom-Imposter type (Ammo.js plugin only)
  107340. */
  107341. static CustomImpostor: number;
  107342. /**
  107343. * Rope-Imposter type
  107344. */
  107345. static RopeImpostor: number;
  107346. /**
  107347. * Cloth-Imposter type
  107348. */
  107349. static ClothImpostor: number;
  107350. /**
  107351. * Softbody-Imposter type
  107352. */
  107353. static SoftbodyImpostor: number;
  107354. }
  107355. }
  107356. declare module BABYLON {
  107357. /**
  107358. * @hidden
  107359. **/
  107360. export class _CreationDataStorage {
  107361. closePath?: boolean;
  107362. closeArray?: boolean;
  107363. idx: number[];
  107364. dashSize: number;
  107365. gapSize: number;
  107366. path3D: Path3D;
  107367. pathArray: Vector3[][];
  107368. arc: number;
  107369. radius: number;
  107370. cap: number;
  107371. tessellation: number;
  107372. }
  107373. /**
  107374. * @hidden
  107375. **/
  107376. class _InstanceDataStorage {
  107377. visibleInstances: any;
  107378. batchCache: _InstancesBatch;
  107379. instancesBufferSize: number;
  107380. instancesBuffer: Nullable<Buffer>;
  107381. instancesData: Float32Array;
  107382. overridenInstanceCount: number;
  107383. isFrozen: boolean;
  107384. previousBatch: Nullable<_InstancesBatch>;
  107385. hardwareInstancedRendering: boolean;
  107386. sideOrientation: number;
  107387. manualUpdate: boolean;
  107388. }
  107389. /**
  107390. * @hidden
  107391. **/
  107392. export class _InstancesBatch {
  107393. mustReturn: boolean;
  107394. visibleInstances: Nullable<InstancedMesh[]>[];
  107395. renderSelf: boolean[];
  107396. hardwareInstancedRendering: boolean[];
  107397. }
  107398. /**
  107399. * @hidden
  107400. **/
  107401. class _ThinInstanceDataStorage {
  107402. instancesCount: number;
  107403. matrixBuffer: Nullable<Buffer>;
  107404. matrixBufferSize: number;
  107405. matrixData: Nullable<Float32Array>;
  107406. boundingVectors: Array<Vector3>;
  107407. worldMatrices: Nullable<Matrix[]>;
  107408. }
  107409. /**
  107410. * Class used to represent renderable models
  107411. */
  107412. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107413. /**
  107414. * Mesh side orientation : usually the external or front surface
  107415. */
  107416. static readonly FRONTSIDE: number;
  107417. /**
  107418. * Mesh side orientation : usually the internal or back surface
  107419. */
  107420. static readonly BACKSIDE: number;
  107421. /**
  107422. * Mesh side orientation : both internal and external or front and back surfaces
  107423. */
  107424. static readonly DOUBLESIDE: number;
  107425. /**
  107426. * Mesh side orientation : by default, `FRONTSIDE`
  107427. */
  107428. static readonly DEFAULTSIDE: number;
  107429. /**
  107430. * Mesh cap setting : no cap
  107431. */
  107432. static readonly NO_CAP: number;
  107433. /**
  107434. * Mesh cap setting : one cap at the beginning of the mesh
  107435. */
  107436. static readonly CAP_START: number;
  107437. /**
  107438. * Mesh cap setting : one cap at the end of the mesh
  107439. */
  107440. static readonly CAP_END: number;
  107441. /**
  107442. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107443. */
  107444. static readonly CAP_ALL: number;
  107445. /**
  107446. * Mesh pattern setting : no flip or rotate
  107447. */
  107448. static readonly NO_FLIP: number;
  107449. /**
  107450. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107451. */
  107452. static readonly FLIP_TILE: number;
  107453. /**
  107454. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107455. */
  107456. static readonly ROTATE_TILE: number;
  107457. /**
  107458. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107459. */
  107460. static readonly FLIP_ROW: number;
  107461. /**
  107462. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107463. */
  107464. static readonly ROTATE_ROW: number;
  107465. /**
  107466. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107467. */
  107468. static readonly FLIP_N_ROTATE_TILE: number;
  107469. /**
  107470. * Mesh pattern setting : rotate pattern and rotate
  107471. */
  107472. static readonly FLIP_N_ROTATE_ROW: number;
  107473. /**
  107474. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107475. */
  107476. static readonly CENTER: number;
  107477. /**
  107478. * Mesh tile positioning : part tiles on left
  107479. */
  107480. static readonly LEFT: number;
  107481. /**
  107482. * Mesh tile positioning : part tiles on right
  107483. */
  107484. static readonly RIGHT: number;
  107485. /**
  107486. * Mesh tile positioning : part tiles on top
  107487. */
  107488. static readonly TOP: number;
  107489. /**
  107490. * Mesh tile positioning : part tiles on bottom
  107491. */
  107492. static readonly BOTTOM: number;
  107493. /**
  107494. * Gets the default side orientation.
  107495. * @param orientation the orientation to value to attempt to get
  107496. * @returns the default orientation
  107497. * @hidden
  107498. */
  107499. static _GetDefaultSideOrientation(orientation?: number): number;
  107500. private _internalMeshDataInfo;
  107501. get computeBonesUsingShaders(): boolean;
  107502. set computeBonesUsingShaders(value: boolean);
  107503. /**
  107504. * An event triggered before rendering the mesh
  107505. */
  107506. get onBeforeRenderObservable(): Observable<Mesh>;
  107507. /**
  107508. * An event triggered before binding the mesh
  107509. */
  107510. get onBeforeBindObservable(): Observable<Mesh>;
  107511. /**
  107512. * An event triggered after rendering the mesh
  107513. */
  107514. get onAfterRenderObservable(): Observable<Mesh>;
  107515. /**
  107516. * An event triggered before drawing the mesh
  107517. */
  107518. get onBeforeDrawObservable(): Observable<Mesh>;
  107519. private _onBeforeDrawObserver;
  107520. /**
  107521. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107522. */
  107523. set onBeforeDraw(callback: () => void);
  107524. get hasInstances(): boolean;
  107525. get hasThinInstances(): boolean;
  107526. /**
  107527. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107528. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107529. */
  107530. delayLoadState: number;
  107531. /**
  107532. * Gets the list of instances created from this mesh
  107533. * it is not supposed to be modified manually.
  107534. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107535. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107536. */
  107537. instances: InstancedMesh[];
  107538. /**
  107539. * Gets the file containing delay loading data for this mesh
  107540. */
  107541. delayLoadingFile: string;
  107542. /** @hidden */
  107543. _binaryInfo: any;
  107544. /**
  107545. * User defined function used to change how LOD level selection is done
  107546. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107547. */
  107548. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107549. /**
  107550. * Gets or sets the morph target manager
  107551. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107552. */
  107553. get morphTargetManager(): Nullable<MorphTargetManager>;
  107554. set morphTargetManager(value: Nullable<MorphTargetManager>);
  107555. /** @hidden */
  107556. _creationDataStorage: Nullable<_CreationDataStorage>;
  107557. /** @hidden */
  107558. _geometry: Nullable<Geometry>;
  107559. /** @hidden */
  107560. _delayInfo: Array<string>;
  107561. /** @hidden */
  107562. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  107563. /** @hidden */
  107564. _instanceDataStorage: _InstanceDataStorage;
  107565. /** @hidden */
  107566. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  107567. private _effectiveMaterial;
  107568. /** @hidden */
  107569. _shouldGenerateFlatShading: boolean;
  107570. /** @hidden */
  107571. _originalBuilderSideOrientation: number;
  107572. /**
  107573. * Use this property to change the original side orientation defined at construction time
  107574. */
  107575. overrideMaterialSideOrientation: Nullable<number>;
  107576. /**
  107577. * Gets the source mesh (the one used to clone this one from)
  107578. */
  107579. get source(): Nullable<Mesh>;
  107580. /**
  107581. * Gets or sets a boolean indicating that this mesh does not use index buffer
  107582. */
  107583. get isUnIndexed(): boolean;
  107584. set isUnIndexed(value: boolean);
  107585. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  107586. get worldMatrixInstancedBuffer(): Float32Array;
  107587. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  107588. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  107589. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  107590. /**
  107591. * @constructor
  107592. * @param name The value used by scene.getMeshByName() to do a lookup.
  107593. * @param scene The scene to add this mesh to.
  107594. * @param parent The parent of this mesh, if it has one
  107595. * @param source An optional Mesh from which geometry is shared, cloned.
  107596. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  107597. * When false, achieved by calling a clone(), also passing False.
  107598. * This will make creation of children, recursive.
  107599. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  107600. */
  107601. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  107602. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  107603. doNotInstantiate: boolean;
  107604. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  107605. /**
  107606. * Gets the class name
  107607. * @returns the string "Mesh".
  107608. */
  107609. getClassName(): string;
  107610. /** @hidden */
  107611. get _isMesh(): boolean;
  107612. /**
  107613. * Returns a description of this mesh
  107614. * @param fullDetails define if full details about this mesh must be used
  107615. * @returns a descriptive string representing this mesh
  107616. */
  107617. toString(fullDetails?: boolean): string;
  107618. /** @hidden */
  107619. _unBindEffect(): void;
  107620. /**
  107621. * Gets a boolean indicating if this mesh has LOD
  107622. */
  107623. get hasLODLevels(): boolean;
  107624. /**
  107625. * Gets the list of MeshLODLevel associated with the current mesh
  107626. * @returns an array of MeshLODLevel
  107627. */
  107628. getLODLevels(): MeshLODLevel[];
  107629. private _sortLODLevels;
  107630. /**
  107631. * Add a mesh as LOD level triggered at the given distance.
  107632. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107633. * @param distance The distance from the center of the object to show this level
  107634. * @param mesh The mesh to be added as LOD level (can be null)
  107635. * @return This mesh (for chaining)
  107636. */
  107637. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  107638. /**
  107639. * Returns the LOD level mesh at the passed distance or null if not found.
  107640. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107641. * @param distance The distance from the center of the object to show this level
  107642. * @returns a Mesh or `null`
  107643. */
  107644. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  107645. /**
  107646. * Remove a mesh from the LOD array
  107647. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107648. * @param mesh defines the mesh to be removed
  107649. * @return This mesh (for chaining)
  107650. */
  107651. removeLODLevel(mesh: Mesh): Mesh;
  107652. /**
  107653. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  107654. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107655. * @param camera defines the camera to use to compute distance
  107656. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  107657. * @return This mesh (for chaining)
  107658. */
  107659. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  107660. /**
  107661. * Gets the mesh internal Geometry object
  107662. */
  107663. get geometry(): Nullable<Geometry>;
  107664. /**
  107665. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  107666. * @returns the total number of vertices
  107667. */
  107668. getTotalVertices(): number;
  107669. /**
  107670. * Returns the content of an associated vertex buffer
  107671. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  107672. * - VertexBuffer.PositionKind
  107673. * - VertexBuffer.UVKind
  107674. * - VertexBuffer.UV2Kind
  107675. * - VertexBuffer.UV3Kind
  107676. * - VertexBuffer.UV4Kind
  107677. * - VertexBuffer.UV5Kind
  107678. * - VertexBuffer.UV6Kind
  107679. * - VertexBuffer.ColorKind
  107680. * - VertexBuffer.MatricesIndicesKind
  107681. * - VertexBuffer.MatricesIndicesExtraKind
  107682. * - VertexBuffer.MatricesWeightsKind
  107683. * - VertexBuffer.MatricesWeightsExtraKind
  107684. * @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
  107685. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  107686. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  107687. */
  107688. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  107689. /**
  107690. * Returns the mesh VertexBuffer object from the requested `kind`
  107691. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  107692. * - VertexBuffer.PositionKind
  107693. * - VertexBuffer.NormalKind
  107694. * - VertexBuffer.UVKind
  107695. * - VertexBuffer.UV2Kind
  107696. * - VertexBuffer.UV3Kind
  107697. * - VertexBuffer.UV4Kind
  107698. * - VertexBuffer.UV5Kind
  107699. * - VertexBuffer.UV6Kind
  107700. * - VertexBuffer.ColorKind
  107701. * - VertexBuffer.MatricesIndicesKind
  107702. * - VertexBuffer.MatricesIndicesExtraKind
  107703. * - VertexBuffer.MatricesWeightsKind
  107704. * - VertexBuffer.MatricesWeightsExtraKind
  107705. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  107706. */
  107707. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  107708. /**
  107709. * Tests if a specific vertex buffer is associated with this mesh
  107710. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  107711. * - VertexBuffer.PositionKind
  107712. * - VertexBuffer.NormalKind
  107713. * - VertexBuffer.UVKind
  107714. * - VertexBuffer.UV2Kind
  107715. * - VertexBuffer.UV3Kind
  107716. * - VertexBuffer.UV4Kind
  107717. * - VertexBuffer.UV5Kind
  107718. * - VertexBuffer.UV6Kind
  107719. * - VertexBuffer.ColorKind
  107720. * - VertexBuffer.MatricesIndicesKind
  107721. * - VertexBuffer.MatricesIndicesExtraKind
  107722. * - VertexBuffer.MatricesWeightsKind
  107723. * - VertexBuffer.MatricesWeightsExtraKind
  107724. * @returns a boolean
  107725. */
  107726. isVerticesDataPresent(kind: string): boolean;
  107727. /**
  107728. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  107729. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  107730. * - VertexBuffer.PositionKind
  107731. * - VertexBuffer.UVKind
  107732. * - VertexBuffer.UV2Kind
  107733. * - VertexBuffer.UV3Kind
  107734. * - VertexBuffer.UV4Kind
  107735. * - VertexBuffer.UV5Kind
  107736. * - VertexBuffer.UV6Kind
  107737. * - VertexBuffer.ColorKind
  107738. * - VertexBuffer.MatricesIndicesKind
  107739. * - VertexBuffer.MatricesIndicesExtraKind
  107740. * - VertexBuffer.MatricesWeightsKind
  107741. * - VertexBuffer.MatricesWeightsExtraKind
  107742. * @returns a boolean
  107743. */
  107744. isVertexBufferUpdatable(kind: string): boolean;
  107745. /**
  107746. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  107747. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  107748. * - VertexBuffer.PositionKind
  107749. * - VertexBuffer.NormalKind
  107750. * - VertexBuffer.UVKind
  107751. * - VertexBuffer.UV2Kind
  107752. * - VertexBuffer.UV3Kind
  107753. * - VertexBuffer.UV4Kind
  107754. * - VertexBuffer.UV5Kind
  107755. * - VertexBuffer.UV6Kind
  107756. * - VertexBuffer.ColorKind
  107757. * - VertexBuffer.MatricesIndicesKind
  107758. * - VertexBuffer.MatricesIndicesExtraKind
  107759. * - VertexBuffer.MatricesWeightsKind
  107760. * - VertexBuffer.MatricesWeightsExtraKind
  107761. * @returns an array of strings
  107762. */
  107763. getVerticesDataKinds(): string[];
  107764. /**
  107765. * Returns a positive integer : the total number of indices in this mesh geometry.
  107766. * @returns the numner of indices or zero if the mesh has no geometry.
  107767. */
  107768. getTotalIndices(): number;
  107769. /**
  107770. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  107771. * @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.
  107772. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  107773. * @returns the indices array or an empty array if the mesh has no geometry
  107774. */
  107775. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  107776. get isBlocked(): boolean;
  107777. /**
  107778. * Determine if the current mesh is ready to be rendered
  107779. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  107780. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  107781. * @returns true if all associated assets are ready (material, textures, shaders)
  107782. */
  107783. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  107784. /**
  107785. * 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.
  107786. */
  107787. get areNormalsFrozen(): boolean;
  107788. /**
  107789. * 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.
  107790. * @returns the current mesh
  107791. */
  107792. freezeNormals(): Mesh;
  107793. /**
  107794. * 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
  107795. * @returns the current mesh
  107796. */
  107797. unfreezeNormals(): Mesh;
  107798. /**
  107799. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  107800. */
  107801. set overridenInstanceCount(count: number);
  107802. /** @hidden */
  107803. _preActivate(): Mesh;
  107804. /** @hidden */
  107805. _preActivateForIntermediateRendering(renderId: number): Mesh;
  107806. /** @hidden */
  107807. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  107808. protected _afterComputeWorldMatrix(): void;
  107809. /** @hidden */
  107810. _postActivate(): void;
  107811. /**
  107812. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  107813. * This means the mesh underlying bounding box and sphere are recomputed.
  107814. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  107815. * @returns the current mesh
  107816. */
  107817. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  107818. /** @hidden */
  107819. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  107820. /**
  107821. * This function will subdivide the mesh into multiple submeshes
  107822. * @param count defines the expected number of submeshes
  107823. */
  107824. subdivide(count: number): void;
  107825. /**
  107826. * Copy a FloatArray into a specific associated vertex buffer
  107827. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  107828. * - VertexBuffer.PositionKind
  107829. * - VertexBuffer.UVKind
  107830. * - VertexBuffer.UV2Kind
  107831. * - VertexBuffer.UV3Kind
  107832. * - VertexBuffer.UV4Kind
  107833. * - VertexBuffer.UV5Kind
  107834. * - VertexBuffer.UV6Kind
  107835. * - VertexBuffer.ColorKind
  107836. * - VertexBuffer.MatricesIndicesKind
  107837. * - VertexBuffer.MatricesIndicesExtraKind
  107838. * - VertexBuffer.MatricesWeightsKind
  107839. * - VertexBuffer.MatricesWeightsExtraKind
  107840. * @param data defines the data source
  107841. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  107842. * @param stride defines the data stride size (can be null)
  107843. * @returns the current mesh
  107844. */
  107845. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  107846. /**
  107847. * Delete a vertex buffer associated with this mesh
  107848. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  107849. * - VertexBuffer.PositionKind
  107850. * - VertexBuffer.UVKind
  107851. * - VertexBuffer.UV2Kind
  107852. * - VertexBuffer.UV3Kind
  107853. * - VertexBuffer.UV4Kind
  107854. * - VertexBuffer.UV5Kind
  107855. * - VertexBuffer.UV6Kind
  107856. * - VertexBuffer.ColorKind
  107857. * - VertexBuffer.MatricesIndicesKind
  107858. * - VertexBuffer.MatricesIndicesExtraKind
  107859. * - VertexBuffer.MatricesWeightsKind
  107860. * - VertexBuffer.MatricesWeightsExtraKind
  107861. */
  107862. removeVerticesData(kind: string): void;
  107863. /**
  107864. * Flags an associated vertex buffer as updatable
  107865. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  107866. * - VertexBuffer.PositionKind
  107867. * - VertexBuffer.UVKind
  107868. * - VertexBuffer.UV2Kind
  107869. * - VertexBuffer.UV3Kind
  107870. * - VertexBuffer.UV4Kind
  107871. * - VertexBuffer.UV5Kind
  107872. * - VertexBuffer.UV6Kind
  107873. * - VertexBuffer.ColorKind
  107874. * - VertexBuffer.MatricesIndicesKind
  107875. * - VertexBuffer.MatricesIndicesExtraKind
  107876. * - VertexBuffer.MatricesWeightsKind
  107877. * - VertexBuffer.MatricesWeightsExtraKind
  107878. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  107879. */
  107880. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  107881. /**
  107882. * Sets the mesh global Vertex Buffer
  107883. * @param buffer defines the buffer to use
  107884. * @returns the current mesh
  107885. */
  107886. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  107887. /**
  107888. * Update a specific associated vertex buffer
  107889. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  107890. * - VertexBuffer.PositionKind
  107891. * - VertexBuffer.UVKind
  107892. * - VertexBuffer.UV2Kind
  107893. * - VertexBuffer.UV3Kind
  107894. * - VertexBuffer.UV4Kind
  107895. * - VertexBuffer.UV5Kind
  107896. * - VertexBuffer.UV6Kind
  107897. * - VertexBuffer.ColorKind
  107898. * - VertexBuffer.MatricesIndicesKind
  107899. * - VertexBuffer.MatricesIndicesExtraKind
  107900. * - VertexBuffer.MatricesWeightsKind
  107901. * - VertexBuffer.MatricesWeightsExtraKind
  107902. * @param data defines the data source
  107903. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  107904. * @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)
  107905. * @returns the current mesh
  107906. */
  107907. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  107908. /**
  107909. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  107910. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  107911. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  107912. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  107913. * @returns the current mesh
  107914. */
  107915. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  107916. /**
  107917. * Creates a un-shared specific occurence of the geometry for the mesh.
  107918. * @returns the current mesh
  107919. */
  107920. makeGeometryUnique(): Mesh;
  107921. /**
  107922. * Set the index buffer of this mesh
  107923. * @param indices defines the source data
  107924. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  107925. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  107926. * @returns the current mesh
  107927. */
  107928. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  107929. /**
  107930. * Update the current index buffer
  107931. * @param indices defines the source data
  107932. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  107933. * @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)
  107934. * @returns the current mesh
  107935. */
  107936. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  107937. /**
  107938. * Invert the geometry to move from a right handed system to a left handed one.
  107939. * @returns the current mesh
  107940. */
  107941. toLeftHanded(): Mesh;
  107942. /** @hidden */
  107943. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  107944. /** @hidden */
  107945. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  107946. /**
  107947. * Registers for this mesh a javascript function called just before the rendering process
  107948. * @param func defines the function to call before rendering this mesh
  107949. * @returns the current mesh
  107950. */
  107951. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  107952. /**
  107953. * Disposes a previously registered javascript function called before the rendering
  107954. * @param func defines the function to remove
  107955. * @returns the current mesh
  107956. */
  107957. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  107958. /**
  107959. * Registers for this mesh a javascript function called just after the rendering is complete
  107960. * @param func defines the function to call after rendering this mesh
  107961. * @returns the current mesh
  107962. */
  107963. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  107964. /**
  107965. * Disposes a previously registered javascript function called after the rendering.
  107966. * @param func defines the function to remove
  107967. * @returns the current mesh
  107968. */
  107969. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  107970. /** @hidden */
  107971. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  107972. /** @hidden */
  107973. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  107974. /** @hidden */
  107975. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  107976. /** @hidden */
  107977. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  107978. /** @hidden */
  107979. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  107980. /** @hidden */
  107981. _rebuild(): void;
  107982. /** @hidden */
  107983. _freeze(): void;
  107984. /** @hidden */
  107985. _unFreeze(): void;
  107986. /**
  107987. * 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
  107988. * @param subMesh defines the subMesh to render
  107989. * @param enableAlphaMode defines if alpha mode can be changed
  107990. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  107991. * @returns the current mesh
  107992. */
  107993. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  107994. private _onBeforeDraw;
  107995. /**
  107996. * Renormalize the mesh and patch it up if there are no weights
  107997. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  107998. * However in the case of zero weights then we set just a single influence to 1.
  107999. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108000. */
  108001. cleanMatrixWeights(): void;
  108002. private normalizeSkinFourWeights;
  108003. private normalizeSkinWeightsAndExtra;
  108004. /**
  108005. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108006. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108007. * the user know there was an issue with importing the mesh
  108008. * @returns a validation object with skinned, valid and report string
  108009. */
  108010. validateSkinning(): {
  108011. skinned: boolean;
  108012. valid: boolean;
  108013. report: string;
  108014. };
  108015. /** @hidden */
  108016. _checkDelayState(): Mesh;
  108017. private _queueLoad;
  108018. /**
  108019. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108020. * A mesh is in the frustum if its bounding box intersects the frustum
  108021. * @param frustumPlanes defines the frustum to test
  108022. * @returns true if the mesh is in the frustum planes
  108023. */
  108024. isInFrustum(frustumPlanes: Plane[]): boolean;
  108025. /**
  108026. * Sets the mesh material by the material or multiMaterial `id` property
  108027. * @param id is a string identifying the material or the multiMaterial
  108028. * @returns the current mesh
  108029. */
  108030. setMaterialByID(id: string): Mesh;
  108031. /**
  108032. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108033. * @returns an array of IAnimatable
  108034. */
  108035. getAnimatables(): IAnimatable[];
  108036. /**
  108037. * Modifies the mesh geometry according to the passed transformation matrix.
  108038. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108039. * The mesh normals are modified using the same transformation.
  108040. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108041. * @param transform defines the transform matrix to use
  108042. * @see https://doc.babylonjs.com/resources/baking_transformations
  108043. * @returns the current mesh
  108044. */
  108045. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108046. /**
  108047. * Modifies the mesh geometry according to its own current World Matrix.
  108048. * The mesh World Matrix is then reset.
  108049. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108050. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108051. * @see https://doc.babylonjs.com/resources/baking_transformations
  108052. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108053. * @returns the current mesh
  108054. */
  108055. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108056. /** @hidden */
  108057. get _positions(): Nullable<Vector3[]>;
  108058. /** @hidden */
  108059. _resetPointsArrayCache(): Mesh;
  108060. /** @hidden */
  108061. _generatePointsArray(): boolean;
  108062. /**
  108063. * Returns a new Mesh object generated from the current mesh properties.
  108064. * This method must not get confused with createInstance()
  108065. * @param name is a string, the name given to the new mesh
  108066. * @param newParent can be any Node object (default `null`)
  108067. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108068. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108069. * @returns a new mesh
  108070. */
  108071. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108072. /**
  108073. * Releases resources associated with this mesh.
  108074. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108075. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108076. */
  108077. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108078. /** @hidden */
  108079. _disposeInstanceSpecificData(): void;
  108080. /** @hidden */
  108081. _disposeThinInstanceSpecificData(): void;
  108082. /**
  108083. * Modifies the mesh geometry according to a displacement map.
  108084. * 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.
  108085. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108086. * @param url is a string, the URL from the image file is to be downloaded.
  108087. * @param minHeight is the lower limit of the displacement.
  108088. * @param maxHeight is the upper limit of the displacement.
  108089. * @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.
  108090. * @param uvOffset is an optional vector2 used to offset UV.
  108091. * @param uvScale is an optional vector2 used to scale UV.
  108092. * @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.
  108093. * @returns the Mesh.
  108094. */
  108095. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108096. /**
  108097. * Modifies the mesh geometry according to a displacementMap buffer.
  108098. * 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.
  108099. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108100. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108101. * @param heightMapWidth is the width of the buffer image.
  108102. * @param heightMapHeight is the height of the buffer image.
  108103. * @param minHeight is the lower limit of the displacement.
  108104. * @param maxHeight is the upper limit of the displacement.
  108105. * @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.
  108106. * @param uvOffset is an optional vector2 used to offset UV.
  108107. * @param uvScale is an optional vector2 used to scale UV.
  108108. * @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.
  108109. * @returns the Mesh.
  108110. */
  108111. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108112. /**
  108113. * Modify the mesh to get a flat shading rendering.
  108114. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108115. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108116. * @returns current mesh
  108117. */
  108118. convertToFlatShadedMesh(): Mesh;
  108119. /**
  108120. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108121. * In other words, more vertices, no more indices and a single bigger VBO.
  108122. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108123. * @returns current mesh
  108124. */
  108125. convertToUnIndexedMesh(): Mesh;
  108126. /**
  108127. * Inverses facet orientations.
  108128. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108129. * @param flipNormals will also inverts the normals
  108130. * @returns current mesh
  108131. */
  108132. flipFaces(flipNormals?: boolean): Mesh;
  108133. /**
  108134. * Increase the number of facets and hence vertices in a mesh
  108135. * Vertex normals are interpolated from existing vertex normals
  108136. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108137. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108138. */
  108139. increaseVertices(numberPerEdge: number): void;
  108140. /**
  108141. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108142. * This will undo any application of covertToFlatShadedMesh
  108143. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108144. */
  108145. forceSharedVertices(): void;
  108146. /** @hidden */
  108147. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108148. /** @hidden */
  108149. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108150. /**
  108151. * Creates a new InstancedMesh object from the mesh model.
  108152. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108153. * @param name defines the name of the new instance
  108154. * @returns a new InstancedMesh
  108155. */
  108156. createInstance(name: string): InstancedMesh;
  108157. /**
  108158. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108159. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108160. * @returns the current mesh
  108161. */
  108162. synchronizeInstances(): Mesh;
  108163. /**
  108164. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108165. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108166. * This should be used together with the simplification to avoid disappearing triangles.
  108167. * @param successCallback an optional success callback to be called after the optimization finished.
  108168. * @returns the current mesh
  108169. */
  108170. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108171. /**
  108172. * Serialize current mesh
  108173. * @param serializationObject defines the object which will receive the serialization data
  108174. */
  108175. serialize(serializationObject: any): void;
  108176. /** @hidden */
  108177. _syncGeometryWithMorphTargetManager(): void;
  108178. /** @hidden */
  108179. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108180. /**
  108181. * Returns a new Mesh object parsed from the source provided.
  108182. * @param parsedMesh is the source
  108183. * @param scene defines the hosting scene
  108184. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108185. * @returns a new Mesh
  108186. */
  108187. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108188. /**
  108189. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108190. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108191. * @param name defines the name of the mesh to create
  108192. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108193. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108194. * @param closePath creates a seam between the first and the last points of each path of the path array
  108195. * @param offset is taken in account only if the `pathArray` is containing a single path
  108196. * @param scene defines the hosting scene
  108197. * @param updatable defines if the mesh must be flagged as updatable
  108198. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108199. * @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)
  108200. * @returns a new Mesh
  108201. */
  108202. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108203. /**
  108204. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108205. * @param name defines the name of the mesh to create
  108206. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108207. * @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
  108208. * @param scene defines the hosting scene
  108209. * @param updatable defines if the mesh must be flagged as updatable
  108210. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108211. * @returns a new Mesh
  108212. */
  108213. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108214. /**
  108215. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108216. * @param name defines the name of the mesh to create
  108217. * @param size sets the size (float) of each box side (default 1)
  108218. * @param scene defines the hosting scene
  108219. * @param updatable defines if the mesh must be flagged as updatable
  108220. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108221. * @returns a new Mesh
  108222. */
  108223. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108224. /**
  108225. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108226. * @param name defines the name of the mesh to create
  108227. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108228. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108229. * @param scene defines the hosting scene
  108230. * @param updatable defines if the mesh must be flagged as updatable
  108231. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108232. * @returns a new Mesh
  108233. */
  108234. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108235. /**
  108236. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108237. * @param name defines the name of the mesh to create
  108238. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108239. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108240. * @param scene defines the hosting scene
  108241. * @returns a new Mesh
  108242. */
  108243. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108244. /**
  108245. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108246. * @param name defines the name of the mesh to create
  108247. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108248. * @param diameterTop set the top cap diameter (floats, default 1)
  108249. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108250. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108251. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108252. * @param scene defines the hosting scene
  108253. * @param updatable defines if the mesh must be flagged as updatable
  108254. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108255. * @returns a new Mesh
  108256. */
  108257. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108258. /**
  108259. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108260. * @param name defines the name of the mesh to create
  108261. * @param diameter sets the diameter size (float) of the torus (default 1)
  108262. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108263. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108264. * @param scene defines the hosting scene
  108265. * @param updatable defines if the mesh must be flagged as updatable
  108266. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108267. * @returns a new Mesh
  108268. */
  108269. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108270. /**
  108271. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108272. * @param name defines the name of the mesh to create
  108273. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108274. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108275. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108276. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108277. * @param p the number of windings on X axis (positive integers, default 2)
  108278. * @param q the number of windings on Y axis (positive integers, default 3)
  108279. * @param scene defines the hosting scene
  108280. * @param updatable defines if the mesh must be flagged as updatable
  108281. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108282. * @returns a new Mesh
  108283. */
  108284. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108285. /**
  108286. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108287. * @param name defines the name of the mesh to create
  108288. * @param points is an array successive Vector3
  108289. * @param scene defines the hosting scene
  108290. * @param updatable defines if the mesh must be flagged as updatable
  108291. * @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).
  108292. * @returns a new Mesh
  108293. */
  108294. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108295. /**
  108296. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108297. * @param name defines the name of the mesh to create
  108298. * @param points is an array successive Vector3
  108299. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108300. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108301. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108302. * @param scene defines the hosting scene
  108303. * @param updatable defines if the mesh must be flagged as updatable
  108304. * @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)
  108305. * @returns a new Mesh
  108306. */
  108307. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108308. /**
  108309. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108310. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108311. * 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.
  108312. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108313. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108314. * Remember you can only change the shape positions, not their number when updating a polygon.
  108315. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108316. * @param name defines the name of the mesh to create
  108317. * @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
  108318. * @param scene defines the hosting scene
  108319. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108320. * @param updatable defines if the mesh must be flagged as updatable
  108321. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108322. * @param earcutInjection can be used to inject your own earcut reference
  108323. * @returns a new Mesh
  108324. */
  108325. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108326. /**
  108327. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108328. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108329. * @param name defines the name of the mesh to create
  108330. * @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
  108331. * @param depth defines the height of extrusion
  108332. * @param scene defines the hosting scene
  108333. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108334. * @param updatable defines if the mesh must be flagged as updatable
  108335. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108336. * @param earcutInjection can be used to inject your own earcut reference
  108337. * @returns a new Mesh
  108338. */
  108339. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108340. /**
  108341. * Creates an extruded shape mesh.
  108342. * 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
  108343. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108344. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108345. * @param name defines the name of the mesh to create
  108346. * @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
  108347. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108348. * @param scale is the value to scale the shape
  108349. * @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
  108350. * @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
  108351. * @param scene defines the hosting scene
  108352. * @param updatable defines if the mesh must be flagged as updatable
  108353. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108354. * @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)
  108355. * @returns a new Mesh
  108356. */
  108357. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108358. /**
  108359. * Creates an custom extruded shape mesh.
  108360. * The custom extrusion is a parametric shape.
  108361. * It has no predefined shape. Its final shape will depend on the input parameters.
  108362. * Please consider using the same method from the MeshBuilder class instead
  108363. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108364. * @param name defines the name of the mesh to create
  108365. * @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
  108366. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108367. * @param scaleFunction is a custom Javascript function called on each path point
  108368. * @param rotationFunction is a custom Javascript function called on each path point
  108369. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108370. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108371. * @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
  108372. * @param scene defines the hosting scene
  108373. * @param updatable defines if the mesh must be flagged as updatable
  108374. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108375. * @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)
  108376. * @returns a new Mesh
  108377. */
  108378. 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;
  108379. /**
  108380. * Creates lathe mesh.
  108381. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108382. * Please consider using the same method from the MeshBuilder class instead
  108383. * @param name defines the name of the mesh to create
  108384. * @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
  108385. * @param radius is the radius value of the lathe
  108386. * @param tessellation is the side number of the lathe.
  108387. * @param scene defines the hosting scene
  108388. * @param updatable defines if the mesh must be flagged as updatable
  108389. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108390. * @returns a new Mesh
  108391. */
  108392. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108393. /**
  108394. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108395. * @param name defines the name of the mesh to create
  108396. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108397. * @param scene defines the hosting scene
  108398. * @param updatable defines if the mesh must be flagged as updatable
  108399. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108400. * @returns a new Mesh
  108401. */
  108402. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108403. /**
  108404. * Creates a ground mesh.
  108405. * Please consider using the same method from the MeshBuilder class instead
  108406. * @param name defines the name of the mesh to create
  108407. * @param width set the width of the ground
  108408. * @param height set the height of the ground
  108409. * @param subdivisions sets the number of subdivisions per side
  108410. * @param scene defines the hosting scene
  108411. * @param updatable defines if the mesh must be flagged as updatable
  108412. * @returns a new Mesh
  108413. */
  108414. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108415. /**
  108416. * Creates a tiled ground mesh.
  108417. * Please consider using the same method from the MeshBuilder class instead
  108418. * @param name defines the name of the mesh to create
  108419. * @param xmin set the ground minimum X coordinate
  108420. * @param zmin set the ground minimum Y coordinate
  108421. * @param xmax set the ground maximum X coordinate
  108422. * @param zmax set the ground maximum Z coordinate
  108423. * @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
  108424. * @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
  108425. * @param scene defines the hosting scene
  108426. * @param updatable defines if the mesh must be flagged as updatable
  108427. * @returns a new Mesh
  108428. */
  108429. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108430. w: number;
  108431. h: number;
  108432. }, precision: {
  108433. w: number;
  108434. h: number;
  108435. }, scene: Scene, updatable?: boolean): Mesh;
  108436. /**
  108437. * Creates a ground mesh from a height map.
  108438. * Please consider using the same method from the MeshBuilder class instead
  108439. * @see https://doc.babylonjs.com/babylon101/height_map
  108440. * @param name defines the name of the mesh to create
  108441. * @param url sets the URL of the height map image resource
  108442. * @param width set the ground width size
  108443. * @param height set the ground height size
  108444. * @param subdivisions sets the number of subdivision per side
  108445. * @param minHeight is the minimum altitude on the ground
  108446. * @param maxHeight is the maximum altitude on the ground
  108447. * @param scene defines the hosting scene
  108448. * @param updatable defines if the mesh must be flagged as updatable
  108449. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108450. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108451. * @returns a new Mesh
  108452. */
  108453. 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;
  108454. /**
  108455. * Creates a tube mesh.
  108456. * The tube is a parametric shape.
  108457. * It has no predefined shape. Its final shape will depend on the input parameters.
  108458. * Please consider using the same method from the MeshBuilder class instead
  108459. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108460. * @param name defines the name of the mesh to create
  108461. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108462. * @param radius sets the tube radius size
  108463. * @param tessellation is the number of sides on the tubular surface
  108464. * @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
  108465. * @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
  108466. * @param scene defines the hosting scene
  108467. * @param updatable defines if the mesh must be flagged as updatable
  108468. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108469. * @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)
  108470. * @returns a new Mesh
  108471. */
  108472. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108473. (i: number, distance: number): number;
  108474. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108475. /**
  108476. * Creates a polyhedron mesh.
  108477. * Please consider using the same method from the MeshBuilder class instead.
  108478. * * 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
  108479. * * The parameter `size` (positive float, default 1) sets the polygon size
  108480. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108481. * * 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`
  108482. * * 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
  108483. * * 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)`)
  108484. * * 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
  108485. * * 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
  108486. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108487. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108488. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108489. * @param name defines the name of the mesh to create
  108490. * @param options defines the options used to create the mesh
  108491. * @param scene defines the hosting scene
  108492. * @returns a new Mesh
  108493. */
  108494. static CreatePolyhedron(name: string, options: {
  108495. type?: number;
  108496. size?: number;
  108497. sizeX?: number;
  108498. sizeY?: number;
  108499. sizeZ?: number;
  108500. custom?: any;
  108501. faceUV?: Vector4[];
  108502. faceColors?: Color4[];
  108503. updatable?: boolean;
  108504. sideOrientation?: number;
  108505. }, scene: Scene): Mesh;
  108506. /**
  108507. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108508. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108509. * * 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`)
  108510. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108511. * * 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
  108512. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108513. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108514. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108515. * @param name defines the name of the mesh
  108516. * @param options defines the options used to create the mesh
  108517. * @param scene defines the hosting scene
  108518. * @returns a new Mesh
  108519. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108520. */
  108521. static CreateIcoSphere(name: string, options: {
  108522. radius?: number;
  108523. flat?: boolean;
  108524. subdivisions?: number;
  108525. sideOrientation?: number;
  108526. updatable?: boolean;
  108527. }, scene: Scene): Mesh;
  108528. /**
  108529. * Creates a decal mesh.
  108530. * Please consider using the same method from the MeshBuilder class instead.
  108531. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108532. * @param name defines the name of the mesh
  108533. * @param sourceMesh defines the mesh receiving the decal
  108534. * @param position sets the position of the decal in world coordinates
  108535. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108536. * @param size sets the decal scaling
  108537. * @param angle sets the angle to rotate the decal
  108538. * @returns a new Mesh
  108539. */
  108540. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108541. /**
  108542. * Prepare internal position array for software CPU skinning
  108543. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108544. */
  108545. setPositionsForCPUSkinning(): Float32Array;
  108546. /**
  108547. * Prepare internal normal array for software CPU skinning
  108548. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  108549. */
  108550. setNormalsForCPUSkinning(): Float32Array;
  108551. /**
  108552. * Updates the vertex buffer by applying transformation from the bones
  108553. * @param skeleton defines the skeleton to apply to current mesh
  108554. * @returns the current mesh
  108555. */
  108556. applySkeleton(skeleton: Skeleton): Mesh;
  108557. /**
  108558. * 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
  108559. * @param meshes defines the list of meshes to scan
  108560. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  108561. */
  108562. static MinMax(meshes: AbstractMesh[]): {
  108563. min: Vector3;
  108564. max: Vector3;
  108565. };
  108566. /**
  108567. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  108568. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  108569. * @returns a vector3
  108570. */
  108571. static Center(meshesOrMinMaxVector: {
  108572. min: Vector3;
  108573. max: Vector3;
  108574. } | AbstractMesh[]): Vector3;
  108575. /**
  108576. * Merge the array of meshes into a single mesh for performance reasons.
  108577. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  108578. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  108579. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  108580. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  108581. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  108582. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  108583. * @returns a new mesh
  108584. */
  108585. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  108586. /** @hidden */
  108587. addInstance(instance: InstancedMesh): void;
  108588. /** @hidden */
  108589. removeInstance(instance: InstancedMesh): void;
  108590. }
  108591. }
  108592. declare module BABYLON {
  108593. /**
  108594. * This is the base class of all the camera used in the application.
  108595. * @see https://doc.babylonjs.com/features/cameras
  108596. */
  108597. export class Camera extends Node {
  108598. /** @hidden */
  108599. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  108600. /**
  108601. * This is the default projection mode used by the cameras.
  108602. * It helps recreating a feeling of perspective and better appreciate depth.
  108603. * This is the best way to simulate real life cameras.
  108604. */
  108605. static readonly PERSPECTIVE_CAMERA: number;
  108606. /**
  108607. * This helps creating camera with an orthographic mode.
  108608. * 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.
  108609. */
  108610. static readonly ORTHOGRAPHIC_CAMERA: number;
  108611. /**
  108612. * This is the default FOV mode for perspective cameras.
  108613. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  108614. */
  108615. static readonly FOVMODE_VERTICAL_FIXED: number;
  108616. /**
  108617. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  108618. */
  108619. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  108620. /**
  108621. * This specifies ther is no need for a camera rig.
  108622. * Basically only one eye is rendered corresponding to the camera.
  108623. */
  108624. static readonly RIG_MODE_NONE: number;
  108625. /**
  108626. * Simulates a camera Rig with one blue eye and one red eye.
  108627. * This can be use with 3d blue and red glasses.
  108628. */
  108629. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  108630. /**
  108631. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  108632. */
  108633. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  108634. /**
  108635. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  108636. */
  108637. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  108638. /**
  108639. * Defines that both eyes of the camera will be rendered over under each other.
  108640. */
  108641. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  108642. /**
  108643. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  108644. */
  108645. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  108646. /**
  108647. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  108648. */
  108649. static readonly RIG_MODE_VR: number;
  108650. /**
  108651. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  108652. */
  108653. static readonly RIG_MODE_WEBVR: number;
  108654. /**
  108655. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  108656. */
  108657. static readonly RIG_MODE_CUSTOM: number;
  108658. /**
  108659. * Defines if by default attaching controls should prevent the default javascript event to continue.
  108660. */
  108661. static ForceAttachControlToAlwaysPreventDefault: boolean;
  108662. /**
  108663. * Define the input manager associated with the camera.
  108664. */
  108665. inputs: CameraInputsManager<Camera>;
  108666. /** @hidden */
  108667. _position: Vector3;
  108668. /**
  108669. * Define the current local position of the camera in the scene
  108670. */
  108671. get position(): Vector3;
  108672. set position(newPosition: Vector3);
  108673. /**
  108674. * The vector the camera should consider as up.
  108675. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  108676. */
  108677. upVector: Vector3;
  108678. /**
  108679. * Define the current limit on the left side for an orthographic camera
  108680. * In scene unit
  108681. */
  108682. orthoLeft: Nullable<number>;
  108683. /**
  108684. * Define the current limit on the right side for an orthographic camera
  108685. * In scene unit
  108686. */
  108687. orthoRight: Nullable<number>;
  108688. /**
  108689. * Define the current limit on the bottom side for an orthographic camera
  108690. * In scene unit
  108691. */
  108692. orthoBottom: Nullable<number>;
  108693. /**
  108694. * Define the current limit on the top side for an orthographic camera
  108695. * In scene unit
  108696. */
  108697. orthoTop: Nullable<number>;
  108698. /**
  108699. * Field Of View is set in Radians. (default is 0.8)
  108700. */
  108701. fov: number;
  108702. /**
  108703. * Define the minimum distance the camera can see from.
  108704. * This is important to note that the depth buffer are not infinite and the closer it starts
  108705. * the more your scene might encounter depth fighting issue.
  108706. */
  108707. minZ: number;
  108708. /**
  108709. * Define the maximum distance the camera can see to.
  108710. * This is important to note that the depth buffer are not infinite and the further it end
  108711. * the more your scene might encounter depth fighting issue.
  108712. */
  108713. maxZ: number;
  108714. /**
  108715. * Define the default inertia of the camera.
  108716. * This helps giving a smooth feeling to the camera movement.
  108717. */
  108718. inertia: number;
  108719. /**
  108720. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  108721. */
  108722. mode: number;
  108723. /**
  108724. * Define whether the camera is intermediate.
  108725. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  108726. */
  108727. isIntermediate: boolean;
  108728. /**
  108729. * Define the viewport of the camera.
  108730. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  108731. */
  108732. viewport: Viewport;
  108733. /**
  108734. * Restricts the camera to viewing objects with the same layerMask.
  108735. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  108736. */
  108737. layerMask: number;
  108738. /**
  108739. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  108740. */
  108741. fovMode: number;
  108742. /**
  108743. * Rig mode of the camera.
  108744. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  108745. * This is normally controlled byt the camera themselves as internal use.
  108746. */
  108747. cameraRigMode: number;
  108748. /**
  108749. * Defines the distance between both "eyes" in case of a RIG
  108750. */
  108751. interaxialDistance: number;
  108752. /**
  108753. * Defines if stereoscopic rendering is done side by side or over under.
  108754. */
  108755. isStereoscopicSideBySide: boolean;
  108756. /**
  108757. * 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
  108758. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  108759. * else in the scene. (Eg. security camera)
  108760. *
  108761. * 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)
  108762. */
  108763. customRenderTargets: RenderTargetTexture[];
  108764. /**
  108765. * When set, the camera will render to this render target instead of the default canvas
  108766. *
  108767. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  108768. */
  108769. outputRenderTarget: Nullable<RenderTargetTexture>;
  108770. /**
  108771. * Observable triggered when the camera view matrix has changed.
  108772. */
  108773. onViewMatrixChangedObservable: Observable<Camera>;
  108774. /**
  108775. * Observable triggered when the camera Projection matrix has changed.
  108776. */
  108777. onProjectionMatrixChangedObservable: Observable<Camera>;
  108778. /**
  108779. * Observable triggered when the inputs have been processed.
  108780. */
  108781. onAfterCheckInputsObservable: Observable<Camera>;
  108782. /**
  108783. * Observable triggered when reset has been called and applied to the camera.
  108784. */
  108785. onRestoreStateObservable: Observable<Camera>;
  108786. /**
  108787. * Is this camera a part of a rig system?
  108788. */
  108789. isRigCamera: boolean;
  108790. /**
  108791. * If isRigCamera set to true this will be set with the parent camera.
  108792. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  108793. */
  108794. rigParent?: Camera;
  108795. /** @hidden */
  108796. _cameraRigParams: any;
  108797. /** @hidden */
  108798. _rigCameras: Camera[];
  108799. /** @hidden */
  108800. _rigPostProcess: Nullable<PostProcess>;
  108801. protected _webvrViewMatrix: Matrix;
  108802. /** @hidden */
  108803. _skipRendering: boolean;
  108804. /** @hidden */
  108805. _projectionMatrix: Matrix;
  108806. /** @hidden */
  108807. _postProcesses: Nullable<PostProcess>[];
  108808. /** @hidden */
  108809. _activeMeshes: SmartArray<AbstractMesh>;
  108810. protected _globalPosition: Vector3;
  108811. /** @hidden */
  108812. _computedViewMatrix: Matrix;
  108813. private _doNotComputeProjectionMatrix;
  108814. private _transformMatrix;
  108815. private _frustumPlanes;
  108816. private _refreshFrustumPlanes;
  108817. private _storedFov;
  108818. private _stateStored;
  108819. /**
  108820. * Instantiates a new camera object.
  108821. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  108822. * @see https://doc.babylonjs.com/features/cameras
  108823. * @param name Defines the name of the camera in the scene
  108824. * @param position Defines the position of the camera
  108825. * @param scene Defines the scene the camera belongs too
  108826. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  108827. */
  108828. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  108829. /**
  108830. * Store current camera state (fov, position, etc..)
  108831. * @returns the camera
  108832. */
  108833. storeState(): Camera;
  108834. /**
  108835. * Restores the camera state values if it has been stored. You must call storeState() first
  108836. */
  108837. protected _restoreStateValues(): boolean;
  108838. /**
  108839. * Restored camera state. You must call storeState() first.
  108840. * @returns true if restored and false otherwise
  108841. */
  108842. restoreState(): boolean;
  108843. /**
  108844. * Gets the class name of the camera.
  108845. * @returns the class name
  108846. */
  108847. getClassName(): string;
  108848. /** @hidden */
  108849. readonly _isCamera: boolean;
  108850. /**
  108851. * Gets a string representation of the camera useful for debug purpose.
  108852. * @param fullDetails Defines that a more verboe level of logging is required
  108853. * @returns the string representation
  108854. */
  108855. toString(fullDetails?: boolean): string;
  108856. /**
  108857. * Gets the current world space position of the camera.
  108858. */
  108859. get globalPosition(): Vector3;
  108860. /**
  108861. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  108862. * @returns the active meshe list
  108863. */
  108864. getActiveMeshes(): SmartArray<AbstractMesh>;
  108865. /**
  108866. * Check whether a mesh is part of the current active mesh list of the camera
  108867. * @param mesh Defines the mesh to check
  108868. * @returns true if active, false otherwise
  108869. */
  108870. isActiveMesh(mesh: Mesh): boolean;
  108871. /**
  108872. * Is this camera ready to be used/rendered
  108873. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  108874. * @return true if the camera is ready
  108875. */
  108876. isReady(completeCheck?: boolean): boolean;
  108877. /** @hidden */
  108878. _initCache(): void;
  108879. /** @hidden */
  108880. _updateCache(ignoreParentClass?: boolean): void;
  108881. /** @hidden */
  108882. _isSynchronized(): boolean;
  108883. /** @hidden */
  108884. _isSynchronizedViewMatrix(): boolean;
  108885. /** @hidden */
  108886. _isSynchronizedProjectionMatrix(): boolean;
  108887. /**
  108888. * Attach the input controls to a specific dom element to get the input from.
  108889. * @param element Defines the element the controls should be listened from
  108890. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  108891. */
  108892. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  108893. /**
  108894. * Detach the current controls from the specified dom element.
  108895. * @param element Defines the element to stop listening the inputs from
  108896. */
  108897. detachControl(element: HTMLElement): void;
  108898. /**
  108899. * Update the camera state according to the different inputs gathered during the frame.
  108900. */
  108901. update(): void;
  108902. /** @hidden */
  108903. _checkInputs(): void;
  108904. /** @hidden */
  108905. get rigCameras(): Camera[];
  108906. /**
  108907. * Gets the post process used by the rig cameras
  108908. */
  108909. get rigPostProcess(): Nullable<PostProcess>;
  108910. /**
  108911. * Internal, gets the first post proces.
  108912. * @returns the first post process to be run on this camera.
  108913. */
  108914. _getFirstPostProcess(): Nullable<PostProcess>;
  108915. private _cascadePostProcessesToRigCams;
  108916. /**
  108917. * Attach a post process to the camera.
  108918. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  108919. * @param postProcess The post process to attach to the camera
  108920. * @param insertAt The position of the post process in case several of them are in use in the scene
  108921. * @returns the position the post process has been inserted at
  108922. */
  108923. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  108924. /**
  108925. * Detach a post process to the camera.
  108926. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  108927. * @param postProcess The post process to detach from the camera
  108928. */
  108929. detachPostProcess(postProcess: PostProcess): void;
  108930. /**
  108931. * Gets the current world matrix of the camera
  108932. */
  108933. getWorldMatrix(): Matrix;
  108934. /** @hidden */
  108935. _getViewMatrix(): Matrix;
  108936. /**
  108937. * Gets the current view matrix of the camera.
  108938. * @param force forces the camera to recompute the matrix without looking at the cached state
  108939. * @returns the view matrix
  108940. */
  108941. getViewMatrix(force?: boolean): Matrix;
  108942. /**
  108943. * Freeze the projection matrix.
  108944. * It will prevent the cache check of the camera projection compute and can speed up perf
  108945. * if no parameter of the camera are meant to change
  108946. * @param projection Defines manually a projection if necessary
  108947. */
  108948. freezeProjectionMatrix(projection?: Matrix): void;
  108949. /**
  108950. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  108951. */
  108952. unfreezeProjectionMatrix(): void;
  108953. /**
  108954. * Gets the current projection matrix of the camera.
  108955. * @param force forces the camera to recompute the matrix without looking at the cached state
  108956. * @returns the projection matrix
  108957. */
  108958. getProjectionMatrix(force?: boolean): Matrix;
  108959. /**
  108960. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  108961. * @returns a Matrix
  108962. */
  108963. getTransformationMatrix(): Matrix;
  108964. private _updateFrustumPlanes;
  108965. /**
  108966. * Checks if a cullable object (mesh...) is in the camera frustum
  108967. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  108968. * @param target The object to check
  108969. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  108970. * @returns true if the object is in frustum otherwise false
  108971. */
  108972. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  108973. /**
  108974. * Checks if a cullable object (mesh...) is in the camera frustum
  108975. * Unlike isInFrustum this cheks the full bounding box
  108976. * @param target The object to check
  108977. * @returns true if the object is in frustum otherwise false
  108978. */
  108979. isCompletelyInFrustum(target: ICullable): boolean;
  108980. /**
  108981. * Gets a ray in the forward direction from the camera.
  108982. * @param length Defines the length of the ray to create
  108983. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  108984. * @param origin Defines the start point of the ray which defaults to the camera position
  108985. * @returns the forward ray
  108986. */
  108987. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  108988. /**
  108989. * Gets a ray in the forward direction from the camera.
  108990. * @param refRay the ray to (re)use when setting the values
  108991. * @param length Defines the length of the ray to create
  108992. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  108993. * @param origin Defines the start point of the ray which defaults to the camera position
  108994. * @returns the forward ray
  108995. */
  108996. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  108997. /**
  108998. * Releases resources associated with this node.
  108999. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109000. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109001. */
  109002. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109003. /** @hidden */
  109004. _isLeftCamera: boolean;
  109005. /**
  109006. * Gets the left camera of a rig setup in case of Rigged Camera
  109007. */
  109008. get isLeftCamera(): boolean;
  109009. /** @hidden */
  109010. _isRightCamera: boolean;
  109011. /**
  109012. * Gets the right camera of a rig setup in case of Rigged Camera
  109013. */
  109014. get isRightCamera(): boolean;
  109015. /**
  109016. * Gets the left camera of a rig setup in case of Rigged Camera
  109017. */
  109018. get leftCamera(): Nullable<FreeCamera>;
  109019. /**
  109020. * Gets the right camera of a rig setup in case of Rigged Camera
  109021. */
  109022. get rightCamera(): Nullable<FreeCamera>;
  109023. /**
  109024. * Gets the left camera target of a rig setup in case of Rigged Camera
  109025. * @returns the target position
  109026. */
  109027. getLeftTarget(): Nullable<Vector3>;
  109028. /**
  109029. * Gets the right camera target of a rig setup in case of Rigged Camera
  109030. * @returns the target position
  109031. */
  109032. getRightTarget(): Nullable<Vector3>;
  109033. /**
  109034. * @hidden
  109035. */
  109036. setCameraRigMode(mode: number, rigParams: any): void;
  109037. /** @hidden */
  109038. static _setStereoscopicRigMode(camera: Camera): void;
  109039. /** @hidden */
  109040. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109041. /** @hidden */
  109042. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109043. /** @hidden */
  109044. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109045. /** @hidden */
  109046. _getVRProjectionMatrix(): Matrix;
  109047. protected _updateCameraRotationMatrix(): void;
  109048. protected _updateWebVRCameraRotationMatrix(): void;
  109049. /**
  109050. * This function MUST be overwritten by the different WebVR cameras available.
  109051. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109052. * @hidden
  109053. */
  109054. _getWebVRProjectionMatrix(): Matrix;
  109055. /**
  109056. * This function MUST be overwritten by the different WebVR cameras available.
  109057. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109058. * @hidden
  109059. */
  109060. _getWebVRViewMatrix(): Matrix;
  109061. /** @hidden */
  109062. setCameraRigParameter(name: string, value: any): void;
  109063. /**
  109064. * needs to be overridden by children so sub has required properties to be copied
  109065. * @hidden
  109066. */
  109067. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109068. /**
  109069. * May need to be overridden by children
  109070. * @hidden
  109071. */
  109072. _updateRigCameras(): void;
  109073. /** @hidden */
  109074. _setupInputs(): void;
  109075. /**
  109076. * Serialiaze the camera setup to a json represention
  109077. * @returns the JSON representation
  109078. */
  109079. serialize(): any;
  109080. /**
  109081. * Clones the current camera.
  109082. * @param name The cloned camera name
  109083. * @returns the cloned camera
  109084. */
  109085. clone(name: string): Camera;
  109086. /**
  109087. * Gets the direction of the camera relative to a given local axis.
  109088. * @param localAxis Defines the reference axis to provide a relative direction.
  109089. * @return the direction
  109090. */
  109091. getDirection(localAxis: Vector3): Vector3;
  109092. /**
  109093. * Returns the current camera absolute rotation
  109094. */
  109095. get absoluteRotation(): Quaternion;
  109096. /**
  109097. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109098. * @param localAxis Defines the reference axis to provide a relative direction.
  109099. * @param result Defines the vector to store the result in
  109100. */
  109101. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109102. /**
  109103. * Gets a camera constructor for a given camera type
  109104. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109105. * @param name The name of the camera the result will be able to instantiate
  109106. * @param scene The scene the result will construct the camera in
  109107. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109108. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109109. * @returns a factory method to construc the camera
  109110. */
  109111. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109112. /**
  109113. * Compute the world matrix of the camera.
  109114. * @returns the camera world matrix
  109115. */
  109116. computeWorldMatrix(): Matrix;
  109117. /**
  109118. * Parse a JSON and creates the camera from the parsed information
  109119. * @param parsedCamera The JSON to parse
  109120. * @param scene The scene to instantiate the camera in
  109121. * @returns the newly constructed camera
  109122. */
  109123. static Parse(parsedCamera: any, scene: Scene): Camera;
  109124. }
  109125. }
  109126. declare module BABYLON {
  109127. /**
  109128. * Class containing static functions to help procedurally build meshes
  109129. */
  109130. export class DiscBuilder {
  109131. /**
  109132. * Creates a plane polygonal mesh. By default, this is a disc
  109133. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109134. * * 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
  109135. * * 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
  109136. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109137. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109138. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109139. * @param name defines the name of the mesh
  109140. * @param options defines the options used to create the mesh
  109141. * @param scene defines the hosting scene
  109142. * @returns the plane polygonal mesh
  109143. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109144. */
  109145. static CreateDisc(name: string, options: {
  109146. radius?: number;
  109147. tessellation?: number;
  109148. arc?: number;
  109149. updatable?: boolean;
  109150. sideOrientation?: number;
  109151. frontUVs?: Vector4;
  109152. backUVs?: Vector4;
  109153. }, scene?: Nullable<Scene>): Mesh;
  109154. }
  109155. }
  109156. declare module BABYLON {
  109157. /**
  109158. * Options to be used when creating a FresnelParameters.
  109159. */
  109160. export type IFresnelParametersCreationOptions = {
  109161. /**
  109162. * Define the color used on edges (grazing angle)
  109163. */
  109164. leftColor?: Color3;
  109165. /**
  109166. * Define the color used on center
  109167. */
  109168. rightColor?: Color3;
  109169. /**
  109170. * Define bias applied to computed fresnel term
  109171. */
  109172. bias?: number;
  109173. /**
  109174. * Defined the power exponent applied to fresnel term
  109175. */
  109176. power?: number;
  109177. /**
  109178. * Define if the fresnel effect is enable or not.
  109179. */
  109180. isEnabled?: boolean;
  109181. };
  109182. /**
  109183. * Serialized format for FresnelParameters.
  109184. */
  109185. export type IFresnelParametersSerialized = {
  109186. /**
  109187. * Define the color used on edges (grazing angle) [as an array]
  109188. */
  109189. leftColor: number[];
  109190. /**
  109191. * Define the color used on center [as an array]
  109192. */
  109193. rightColor: number[];
  109194. /**
  109195. * Define bias applied to computed fresnel term
  109196. */
  109197. bias: number;
  109198. /**
  109199. * Defined the power exponent applied to fresnel term
  109200. */
  109201. power?: number;
  109202. /**
  109203. * Define if the fresnel effect is enable or not.
  109204. */
  109205. isEnabled: boolean;
  109206. };
  109207. /**
  109208. * This represents all the required information to add a fresnel effect on a material:
  109209. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109210. */
  109211. export class FresnelParameters {
  109212. private _isEnabled;
  109213. /**
  109214. * Define if the fresnel effect is enable or not.
  109215. */
  109216. get isEnabled(): boolean;
  109217. set isEnabled(value: boolean);
  109218. /**
  109219. * Define the color used on edges (grazing angle)
  109220. */
  109221. leftColor: Color3;
  109222. /**
  109223. * Define the color used on center
  109224. */
  109225. rightColor: Color3;
  109226. /**
  109227. * Define bias applied to computed fresnel term
  109228. */
  109229. bias: number;
  109230. /**
  109231. * Defined the power exponent applied to fresnel term
  109232. */
  109233. power: number;
  109234. /**
  109235. * Creates a new FresnelParameters object.
  109236. *
  109237. * @param options provide your own settings to optionally to override defaults
  109238. */
  109239. constructor(options?: IFresnelParametersCreationOptions);
  109240. /**
  109241. * Clones the current fresnel and its valuues
  109242. * @returns a clone fresnel configuration
  109243. */
  109244. clone(): FresnelParameters;
  109245. /**
  109246. * Determines equality between FresnelParameters objects
  109247. * @param otherFresnelParameters defines the second operand
  109248. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109249. */
  109250. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109251. /**
  109252. * Serializes the current fresnel parameters to a JSON representation.
  109253. * @return the JSON serialization
  109254. */
  109255. serialize(): IFresnelParametersSerialized;
  109256. /**
  109257. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109258. * @param parsedFresnelParameters Define the JSON representation
  109259. * @returns the parsed parameters
  109260. */
  109261. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109262. }
  109263. }
  109264. declare module BABYLON {
  109265. /**
  109266. * This groups all the flags used to control the materials channel.
  109267. */
  109268. export class MaterialFlags {
  109269. private static _DiffuseTextureEnabled;
  109270. /**
  109271. * Are diffuse textures enabled in the application.
  109272. */
  109273. static get DiffuseTextureEnabled(): boolean;
  109274. static set DiffuseTextureEnabled(value: boolean);
  109275. private static _DetailTextureEnabled;
  109276. /**
  109277. * Are detail textures enabled in the application.
  109278. */
  109279. static get DetailTextureEnabled(): boolean;
  109280. static set DetailTextureEnabled(value: boolean);
  109281. private static _AmbientTextureEnabled;
  109282. /**
  109283. * Are ambient textures enabled in the application.
  109284. */
  109285. static get AmbientTextureEnabled(): boolean;
  109286. static set AmbientTextureEnabled(value: boolean);
  109287. private static _OpacityTextureEnabled;
  109288. /**
  109289. * Are opacity textures enabled in the application.
  109290. */
  109291. static get OpacityTextureEnabled(): boolean;
  109292. static set OpacityTextureEnabled(value: boolean);
  109293. private static _ReflectionTextureEnabled;
  109294. /**
  109295. * Are reflection textures enabled in the application.
  109296. */
  109297. static get ReflectionTextureEnabled(): boolean;
  109298. static set ReflectionTextureEnabled(value: boolean);
  109299. private static _EmissiveTextureEnabled;
  109300. /**
  109301. * Are emissive textures enabled in the application.
  109302. */
  109303. static get EmissiveTextureEnabled(): boolean;
  109304. static set EmissiveTextureEnabled(value: boolean);
  109305. private static _SpecularTextureEnabled;
  109306. /**
  109307. * Are specular textures enabled in the application.
  109308. */
  109309. static get SpecularTextureEnabled(): boolean;
  109310. static set SpecularTextureEnabled(value: boolean);
  109311. private static _BumpTextureEnabled;
  109312. /**
  109313. * Are bump textures enabled in the application.
  109314. */
  109315. static get BumpTextureEnabled(): boolean;
  109316. static set BumpTextureEnabled(value: boolean);
  109317. private static _LightmapTextureEnabled;
  109318. /**
  109319. * Are lightmap textures enabled in the application.
  109320. */
  109321. static get LightmapTextureEnabled(): boolean;
  109322. static set LightmapTextureEnabled(value: boolean);
  109323. private static _RefractionTextureEnabled;
  109324. /**
  109325. * Are refraction textures enabled in the application.
  109326. */
  109327. static get RefractionTextureEnabled(): boolean;
  109328. static set RefractionTextureEnabled(value: boolean);
  109329. private static _ColorGradingTextureEnabled;
  109330. /**
  109331. * Are color grading textures enabled in the application.
  109332. */
  109333. static get ColorGradingTextureEnabled(): boolean;
  109334. static set ColorGradingTextureEnabled(value: boolean);
  109335. private static _FresnelEnabled;
  109336. /**
  109337. * Are fresnels enabled in the application.
  109338. */
  109339. static get FresnelEnabled(): boolean;
  109340. static set FresnelEnabled(value: boolean);
  109341. private static _ClearCoatTextureEnabled;
  109342. /**
  109343. * Are clear coat textures enabled in the application.
  109344. */
  109345. static get ClearCoatTextureEnabled(): boolean;
  109346. static set ClearCoatTextureEnabled(value: boolean);
  109347. private static _ClearCoatBumpTextureEnabled;
  109348. /**
  109349. * Are clear coat bump textures enabled in the application.
  109350. */
  109351. static get ClearCoatBumpTextureEnabled(): boolean;
  109352. static set ClearCoatBumpTextureEnabled(value: boolean);
  109353. private static _ClearCoatTintTextureEnabled;
  109354. /**
  109355. * Are clear coat tint textures enabled in the application.
  109356. */
  109357. static get ClearCoatTintTextureEnabled(): boolean;
  109358. static set ClearCoatTintTextureEnabled(value: boolean);
  109359. private static _SheenTextureEnabled;
  109360. /**
  109361. * Are sheen textures enabled in the application.
  109362. */
  109363. static get SheenTextureEnabled(): boolean;
  109364. static set SheenTextureEnabled(value: boolean);
  109365. private static _AnisotropicTextureEnabled;
  109366. /**
  109367. * Are anisotropic textures enabled in the application.
  109368. */
  109369. static get AnisotropicTextureEnabled(): boolean;
  109370. static set AnisotropicTextureEnabled(value: boolean);
  109371. private static _ThicknessTextureEnabled;
  109372. /**
  109373. * Are thickness textures enabled in the application.
  109374. */
  109375. static get ThicknessTextureEnabled(): boolean;
  109376. static set ThicknessTextureEnabled(value: boolean);
  109377. }
  109378. }
  109379. declare module BABYLON {
  109380. /** @hidden */
  109381. export var defaultFragmentDeclaration: {
  109382. name: string;
  109383. shader: string;
  109384. };
  109385. }
  109386. declare module BABYLON {
  109387. /** @hidden */
  109388. export var defaultUboDeclaration: {
  109389. name: string;
  109390. shader: string;
  109391. };
  109392. }
  109393. declare module BABYLON {
  109394. /** @hidden */
  109395. export var prePassDeclaration: {
  109396. name: string;
  109397. shader: string;
  109398. };
  109399. }
  109400. declare module BABYLON {
  109401. /** @hidden */
  109402. export var lightFragmentDeclaration: {
  109403. name: string;
  109404. shader: string;
  109405. };
  109406. }
  109407. declare module BABYLON {
  109408. /** @hidden */
  109409. export var lightUboDeclaration: {
  109410. name: string;
  109411. shader: string;
  109412. };
  109413. }
  109414. declare module BABYLON {
  109415. /** @hidden */
  109416. export var lightsFragmentFunctions: {
  109417. name: string;
  109418. shader: string;
  109419. };
  109420. }
  109421. declare module BABYLON {
  109422. /** @hidden */
  109423. export var shadowsFragmentFunctions: {
  109424. name: string;
  109425. shader: string;
  109426. };
  109427. }
  109428. declare module BABYLON {
  109429. /** @hidden */
  109430. export var fresnelFunction: {
  109431. name: string;
  109432. shader: string;
  109433. };
  109434. }
  109435. declare module BABYLON {
  109436. /** @hidden */
  109437. export var bumpFragmentMainFunctions: {
  109438. name: string;
  109439. shader: string;
  109440. };
  109441. }
  109442. declare module BABYLON {
  109443. /** @hidden */
  109444. export var bumpFragmentFunctions: {
  109445. name: string;
  109446. shader: string;
  109447. };
  109448. }
  109449. declare module BABYLON {
  109450. /** @hidden */
  109451. export var logDepthDeclaration: {
  109452. name: string;
  109453. shader: string;
  109454. };
  109455. }
  109456. declare module BABYLON {
  109457. /** @hidden */
  109458. export var bumpFragment: {
  109459. name: string;
  109460. shader: string;
  109461. };
  109462. }
  109463. declare module BABYLON {
  109464. /** @hidden */
  109465. export var depthPrePass: {
  109466. name: string;
  109467. shader: string;
  109468. };
  109469. }
  109470. declare module BABYLON {
  109471. /** @hidden */
  109472. export var lightFragment: {
  109473. name: string;
  109474. shader: string;
  109475. };
  109476. }
  109477. declare module BABYLON {
  109478. /** @hidden */
  109479. export var logDepthFragment: {
  109480. name: string;
  109481. shader: string;
  109482. };
  109483. }
  109484. declare module BABYLON {
  109485. /** @hidden */
  109486. export var defaultPixelShader: {
  109487. name: string;
  109488. shader: string;
  109489. };
  109490. }
  109491. declare module BABYLON {
  109492. /** @hidden */
  109493. export var defaultVertexDeclaration: {
  109494. name: string;
  109495. shader: string;
  109496. };
  109497. }
  109498. declare module BABYLON {
  109499. /** @hidden */
  109500. export var bumpVertexDeclaration: {
  109501. name: string;
  109502. shader: string;
  109503. };
  109504. }
  109505. declare module BABYLON {
  109506. /** @hidden */
  109507. export var bumpVertex: {
  109508. name: string;
  109509. shader: string;
  109510. };
  109511. }
  109512. declare module BABYLON {
  109513. /** @hidden */
  109514. export var fogVertex: {
  109515. name: string;
  109516. shader: string;
  109517. };
  109518. }
  109519. declare module BABYLON {
  109520. /** @hidden */
  109521. export var shadowsVertex: {
  109522. name: string;
  109523. shader: string;
  109524. };
  109525. }
  109526. declare module BABYLON {
  109527. /** @hidden */
  109528. export var pointCloudVertex: {
  109529. name: string;
  109530. shader: string;
  109531. };
  109532. }
  109533. declare module BABYLON {
  109534. /** @hidden */
  109535. export var logDepthVertex: {
  109536. name: string;
  109537. shader: string;
  109538. };
  109539. }
  109540. declare module BABYLON {
  109541. /** @hidden */
  109542. export var defaultVertexShader: {
  109543. name: string;
  109544. shader: string;
  109545. };
  109546. }
  109547. declare module BABYLON {
  109548. /**
  109549. * @hidden
  109550. */
  109551. export interface IMaterialDetailMapDefines {
  109552. DETAIL: boolean;
  109553. DETAILDIRECTUV: number;
  109554. DETAIL_NORMALBLENDMETHOD: number;
  109555. /** @hidden */
  109556. _areTexturesDirty: boolean;
  109557. }
  109558. /**
  109559. * Define the code related to the detail map parameters of a material
  109560. *
  109561. * Inspired from:
  109562. * 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
  109563. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  109564. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  109565. */
  109566. export class DetailMapConfiguration {
  109567. private _texture;
  109568. /**
  109569. * The detail texture of the material.
  109570. */
  109571. texture: Nullable<BaseTexture>;
  109572. /**
  109573. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  109574. * Bigger values mean stronger blending
  109575. */
  109576. diffuseBlendLevel: number;
  109577. /**
  109578. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  109579. * Bigger values mean stronger blending. Only used with PBR materials
  109580. */
  109581. roughnessBlendLevel: number;
  109582. /**
  109583. * Defines how strong the bump effect from the detail map is
  109584. * Bigger values mean stronger effect
  109585. */
  109586. bumpLevel: number;
  109587. private _normalBlendMethod;
  109588. /**
  109589. * The method used to blend the bump and detail normals together
  109590. */
  109591. normalBlendMethod: number;
  109592. private _isEnabled;
  109593. /**
  109594. * Enable or disable the detail map on this material
  109595. */
  109596. isEnabled: boolean;
  109597. /** @hidden */
  109598. private _internalMarkAllSubMeshesAsTexturesDirty;
  109599. /** @hidden */
  109600. _markAllSubMeshesAsTexturesDirty(): void;
  109601. /**
  109602. * Instantiate a new detail map
  109603. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109604. */
  109605. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109606. /**
  109607. * Gets whether the submesh is ready to be used or not.
  109608. * @param defines the list of "defines" to update.
  109609. * @param scene defines the scene the material belongs to.
  109610. * @returns - boolean indicating that the submesh is ready or not.
  109611. */
  109612. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  109613. /**
  109614. * Update the defines for detail map usage
  109615. * @param defines the list of "defines" to update.
  109616. * @param scene defines the scene the material belongs to.
  109617. */
  109618. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  109619. /**
  109620. * Binds the material data.
  109621. * @param uniformBuffer defines the Uniform buffer to fill in.
  109622. * @param scene defines the scene the material belongs to.
  109623. * @param isFrozen defines whether the material is frozen or not.
  109624. */
  109625. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  109626. /**
  109627. * Checks to see if a texture is used in the material.
  109628. * @param texture - Base texture to use.
  109629. * @returns - Boolean specifying if a texture is used in the material.
  109630. */
  109631. hasTexture(texture: BaseTexture): boolean;
  109632. /**
  109633. * Returns an array of the actively used textures.
  109634. * @param activeTextures Array of BaseTextures
  109635. */
  109636. getActiveTextures(activeTextures: BaseTexture[]): void;
  109637. /**
  109638. * Returns the animatable textures.
  109639. * @param animatables Array of animatable textures.
  109640. */
  109641. getAnimatables(animatables: IAnimatable[]): void;
  109642. /**
  109643. * Disposes the resources of the material.
  109644. * @param forceDisposeTextures - Forces the disposal of all textures.
  109645. */
  109646. dispose(forceDisposeTextures?: boolean): void;
  109647. /**
  109648. * Get the current class name useful for serialization or dynamic coding.
  109649. * @returns "DetailMap"
  109650. */
  109651. getClassName(): string;
  109652. /**
  109653. * Add the required uniforms to the current list.
  109654. * @param uniforms defines the current uniform list.
  109655. */
  109656. static AddUniforms(uniforms: string[]): void;
  109657. /**
  109658. * Add the required samplers to the current list.
  109659. * @param samplers defines the current sampler list.
  109660. */
  109661. static AddSamplers(samplers: string[]): void;
  109662. /**
  109663. * Add the required uniforms to the current buffer.
  109664. * @param uniformBuffer defines the current uniform buffer.
  109665. */
  109666. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  109667. /**
  109668. * Makes a duplicate of the current instance into another one.
  109669. * @param detailMap define the instance where to copy the info
  109670. */
  109671. copyTo(detailMap: DetailMapConfiguration): void;
  109672. /**
  109673. * Serializes this detail map instance
  109674. * @returns - An object with the serialized instance.
  109675. */
  109676. serialize(): any;
  109677. /**
  109678. * Parses a detail map setting from a serialized object.
  109679. * @param source - Serialized object.
  109680. * @param scene Defines the scene we are parsing for
  109681. * @param rootUrl Defines the rootUrl to load from
  109682. */
  109683. parse(source: any, scene: Scene, rootUrl: string): void;
  109684. }
  109685. }
  109686. declare module BABYLON {
  109687. /** @hidden */
  109688. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  109689. MAINUV1: boolean;
  109690. MAINUV2: boolean;
  109691. DIFFUSE: boolean;
  109692. DIFFUSEDIRECTUV: number;
  109693. DETAIL: boolean;
  109694. DETAILDIRECTUV: number;
  109695. DETAIL_NORMALBLENDMETHOD: number;
  109696. AMBIENT: boolean;
  109697. AMBIENTDIRECTUV: number;
  109698. OPACITY: boolean;
  109699. OPACITYDIRECTUV: number;
  109700. OPACITYRGB: boolean;
  109701. REFLECTION: boolean;
  109702. EMISSIVE: boolean;
  109703. EMISSIVEDIRECTUV: number;
  109704. SPECULAR: boolean;
  109705. SPECULARDIRECTUV: number;
  109706. BUMP: boolean;
  109707. BUMPDIRECTUV: number;
  109708. PARALLAX: boolean;
  109709. PARALLAXOCCLUSION: boolean;
  109710. SPECULAROVERALPHA: boolean;
  109711. CLIPPLANE: boolean;
  109712. CLIPPLANE2: boolean;
  109713. CLIPPLANE3: boolean;
  109714. CLIPPLANE4: boolean;
  109715. CLIPPLANE5: boolean;
  109716. CLIPPLANE6: boolean;
  109717. ALPHATEST: boolean;
  109718. DEPTHPREPASS: boolean;
  109719. ALPHAFROMDIFFUSE: boolean;
  109720. POINTSIZE: boolean;
  109721. FOG: boolean;
  109722. SPECULARTERM: boolean;
  109723. DIFFUSEFRESNEL: boolean;
  109724. OPACITYFRESNEL: boolean;
  109725. REFLECTIONFRESNEL: boolean;
  109726. REFRACTIONFRESNEL: boolean;
  109727. EMISSIVEFRESNEL: boolean;
  109728. FRESNEL: boolean;
  109729. NORMAL: boolean;
  109730. UV1: boolean;
  109731. UV2: boolean;
  109732. VERTEXCOLOR: boolean;
  109733. VERTEXALPHA: boolean;
  109734. NUM_BONE_INFLUENCERS: number;
  109735. BonesPerMesh: number;
  109736. BONETEXTURE: boolean;
  109737. INSTANCES: boolean;
  109738. THIN_INSTANCES: boolean;
  109739. GLOSSINESS: boolean;
  109740. ROUGHNESS: boolean;
  109741. EMISSIVEASILLUMINATION: boolean;
  109742. LINKEMISSIVEWITHDIFFUSE: boolean;
  109743. REFLECTIONFRESNELFROMSPECULAR: boolean;
  109744. LIGHTMAP: boolean;
  109745. LIGHTMAPDIRECTUV: number;
  109746. OBJECTSPACE_NORMALMAP: boolean;
  109747. USELIGHTMAPASSHADOWMAP: boolean;
  109748. REFLECTIONMAP_3D: boolean;
  109749. REFLECTIONMAP_SPHERICAL: boolean;
  109750. REFLECTIONMAP_PLANAR: boolean;
  109751. REFLECTIONMAP_CUBIC: boolean;
  109752. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  109753. REFLECTIONMAP_PROJECTION: boolean;
  109754. REFLECTIONMAP_SKYBOX: boolean;
  109755. REFLECTIONMAP_EXPLICIT: boolean;
  109756. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  109757. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  109758. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  109759. INVERTCUBICMAP: boolean;
  109760. LOGARITHMICDEPTH: boolean;
  109761. REFRACTION: boolean;
  109762. REFRACTIONMAP_3D: boolean;
  109763. REFLECTIONOVERALPHA: boolean;
  109764. TWOSIDEDLIGHTING: boolean;
  109765. SHADOWFLOAT: boolean;
  109766. MORPHTARGETS: boolean;
  109767. MORPHTARGETS_NORMAL: boolean;
  109768. MORPHTARGETS_TANGENT: boolean;
  109769. MORPHTARGETS_UV: boolean;
  109770. NUM_MORPH_INFLUENCERS: number;
  109771. NONUNIFORMSCALING: boolean;
  109772. PREMULTIPLYALPHA: boolean;
  109773. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  109774. ALPHABLEND: boolean;
  109775. PREPASS: boolean;
  109776. SCENE_MRT_COUNT: number;
  109777. RGBDLIGHTMAP: boolean;
  109778. RGBDREFLECTION: boolean;
  109779. RGBDREFRACTION: boolean;
  109780. IMAGEPROCESSING: boolean;
  109781. VIGNETTE: boolean;
  109782. VIGNETTEBLENDMODEMULTIPLY: boolean;
  109783. VIGNETTEBLENDMODEOPAQUE: boolean;
  109784. TONEMAPPING: boolean;
  109785. TONEMAPPING_ACES: boolean;
  109786. CONTRAST: boolean;
  109787. COLORCURVES: boolean;
  109788. COLORGRADING: boolean;
  109789. COLORGRADING3D: boolean;
  109790. SAMPLER3DGREENDEPTH: boolean;
  109791. SAMPLER3DBGRMAP: boolean;
  109792. IMAGEPROCESSINGPOSTPROCESS: boolean;
  109793. MULTIVIEW: boolean;
  109794. /**
  109795. * If the reflection texture on this material is in linear color space
  109796. * @hidden
  109797. */
  109798. IS_REFLECTION_LINEAR: boolean;
  109799. /**
  109800. * If the refraction texture on this material is in linear color space
  109801. * @hidden
  109802. */
  109803. IS_REFRACTION_LINEAR: boolean;
  109804. EXPOSURE: boolean;
  109805. constructor();
  109806. setReflectionMode(modeToEnable: string): void;
  109807. }
  109808. /**
  109809. * This is the default material used in Babylon. It is the best trade off between quality
  109810. * and performances.
  109811. * @see https://doc.babylonjs.com/babylon101/materials
  109812. */
  109813. export class StandardMaterial extends PushMaterial {
  109814. private _diffuseTexture;
  109815. /**
  109816. * The basic texture of the material as viewed under a light.
  109817. */
  109818. diffuseTexture: Nullable<BaseTexture>;
  109819. private _ambientTexture;
  109820. /**
  109821. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  109822. */
  109823. ambientTexture: Nullable<BaseTexture>;
  109824. private _opacityTexture;
  109825. /**
  109826. * Define the transparency of the material from a texture.
  109827. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  109828. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  109829. */
  109830. opacityTexture: Nullable<BaseTexture>;
  109831. private _reflectionTexture;
  109832. /**
  109833. * Define the texture used to display the reflection.
  109834. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109835. */
  109836. reflectionTexture: Nullable<BaseTexture>;
  109837. private _emissiveTexture;
  109838. /**
  109839. * Define texture of the material as if self lit.
  109840. * This will be mixed in the final result even in the absence of light.
  109841. */
  109842. emissiveTexture: Nullable<BaseTexture>;
  109843. private _specularTexture;
  109844. /**
  109845. * Define how the color and intensity of the highlight given by the light in the material.
  109846. */
  109847. specularTexture: Nullable<BaseTexture>;
  109848. private _bumpTexture;
  109849. /**
  109850. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  109851. * 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.
  109852. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  109853. */
  109854. bumpTexture: Nullable<BaseTexture>;
  109855. private _lightmapTexture;
  109856. /**
  109857. * Complex lighting can be computationally expensive to compute at runtime.
  109858. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  109859. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  109860. */
  109861. lightmapTexture: Nullable<BaseTexture>;
  109862. private _refractionTexture;
  109863. /**
  109864. * Define the texture used to display the refraction.
  109865. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109866. */
  109867. refractionTexture: Nullable<BaseTexture>;
  109868. /**
  109869. * The color of the material lit by the environmental background lighting.
  109870. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  109871. */
  109872. ambientColor: Color3;
  109873. /**
  109874. * The basic color of the material as viewed under a light.
  109875. */
  109876. diffuseColor: Color3;
  109877. /**
  109878. * Define how the color and intensity of the highlight given by the light in the material.
  109879. */
  109880. specularColor: Color3;
  109881. /**
  109882. * Define the color of the material as if self lit.
  109883. * This will be mixed in the final result even in the absence of light.
  109884. */
  109885. emissiveColor: Color3;
  109886. /**
  109887. * Defines how sharp are the highlights in the material.
  109888. * The bigger the value the sharper giving a more glossy feeling to the result.
  109889. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  109890. */
  109891. specularPower: number;
  109892. private _useAlphaFromDiffuseTexture;
  109893. /**
  109894. * Does the transparency come from the diffuse texture alpha channel.
  109895. */
  109896. useAlphaFromDiffuseTexture: boolean;
  109897. private _useEmissiveAsIllumination;
  109898. /**
  109899. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  109900. */
  109901. useEmissiveAsIllumination: boolean;
  109902. private _linkEmissiveWithDiffuse;
  109903. /**
  109904. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  109905. * the emissive level when the final color is close to one.
  109906. */
  109907. linkEmissiveWithDiffuse: boolean;
  109908. private _useSpecularOverAlpha;
  109909. /**
  109910. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  109911. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  109912. */
  109913. useSpecularOverAlpha: boolean;
  109914. private _useReflectionOverAlpha;
  109915. /**
  109916. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  109917. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  109918. */
  109919. useReflectionOverAlpha: boolean;
  109920. private _disableLighting;
  109921. /**
  109922. * Does lights from the scene impacts this material.
  109923. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  109924. */
  109925. disableLighting: boolean;
  109926. private _useObjectSpaceNormalMap;
  109927. /**
  109928. * Allows using an object space normal map (instead of tangent space).
  109929. */
  109930. useObjectSpaceNormalMap: boolean;
  109931. private _useParallax;
  109932. /**
  109933. * Is parallax enabled or not.
  109934. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  109935. */
  109936. useParallax: boolean;
  109937. private _useParallaxOcclusion;
  109938. /**
  109939. * Is parallax occlusion enabled or not.
  109940. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  109941. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  109942. */
  109943. useParallaxOcclusion: boolean;
  109944. /**
  109945. * 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.
  109946. */
  109947. parallaxScaleBias: number;
  109948. private _roughness;
  109949. /**
  109950. * Helps to define how blurry the reflections should appears in the material.
  109951. */
  109952. roughness: number;
  109953. /**
  109954. * In case of refraction, define the value of the index of refraction.
  109955. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109956. */
  109957. indexOfRefraction: number;
  109958. /**
  109959. * Invert the refraction texture alongside the y axis.
  109960. * It can be useful with procedural textures or probe for instance.
  109961. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109962. */
  109963. invertRefractionY: boolean;
  109964. /**
  109965. * Defines the alpha limits in alpha test mode.
  109966. */
  109967. alphaCutOff: number;
  109968. private _useLightmapAsShadowmap;
  109969. /**
  109970. * In case of light mapping, define whether the map contains light or shadow informations.
  109971. */
  109972. useLightmapAsShadowmap: boolean;
  109973. private _diffuseFresnelParameters;
  109974. /**
  109975. * Define the diffuse fresnel parameters of the material.
  109976. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109977. */
  109978. diffuseFresnelParameters: FresnelParameters;
  109979. private _opacityFresnelParameters;
  109980. /**
  109981. * Define the opacity fresnel parameters of the material.
  109982. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109983. */
  109984. opacityFresnelParameters: FresnelParameters;
  109985. private _reflectionFresnelParameters;
  109986. /**
  109987. * Define the reflection fresnel parameters of the material.
  109988. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109989. */
  109990. reflectionFresnelParameters: FresnelParameters;
  109991. private _refractionFresnelParameters;
  109992. /**
  109993. * Define the refraction fresnel parameters of the material.
  109994. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109995. */
  109996. refractionFresnelParameters: FresnelParameters;
  109997. private _emissiveFresnelParameters;
  109998. /**
  109999. * Define the emissive fresnel parameters of the material.
  110000. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110001. */
  110002. emissiveFresnelParameters: FresnelParameters;
  110003. private _useReflectionFresnelFromSpecular;
  110004. /**
  110005. * If true automatically deducts the fresnels values from the material specularity.
  110006. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110007. */
  110008. useReflectionFresnelFromSpecular: boolean;
  110009. private _useGlossinessFromSpecularMapAlpha;
  110010. /**
  110011. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110012. */
  110013. useGlossinessFromSpecularMapAlpha: boolean;
  110014. private _maxSimultaneousLights;
  110015. /**
  110016. * Defines the maximum number of lights that can be used in the material
  110017. */
  110018. maxSimultaneousLights: number;
  110019. private _invertNormalMapX;
  110020. /**
  110021. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110022. */
  110023. invertNormalMapX: boolean;
  110024. private _invertNormalMapY;
  110025. /**
  110026. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110027. */
  110028. invertNormalMapY: boolean;
  110029. private _twoSidedLighting;
  110030. /**
  110031. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110032. */
  110033. twoSidedLighting: boolean;
  110034. /**
  110035. * Default configuration related to image processing available in the standard Material.
  110036. */
  110037. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110038. /**
  110039. * Gets the image processing configuration used either in this material.
  110040. */
  110041. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110042. /**
  110043. * Sets the Default image processing configuration used either in the this material.
  110044. *
  110045. * If sets to null, the scene one is in use.
  110046. */
  110047. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110048. /**
  110049. * Keep track of the image processing observer to allow dispose and replace.
  110050. */
  110051. private _imageProcessingObserver;
  110052. /**
  110053. * Attaches a new image processing configuration to the Standard Material.
  110054. * @param configuration
  110055. */
  110056. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110057. /**
  110058. * Gets wether the color curves effect is enabled.
  110059. */
  110060. get cameraColorCurvesEnabled(): boolean;
  110061. /**
  110062. * Sets wether the color curves effect is enabled.
  110063. */
  110064. set cameraColorCurvesEnabled(value: boolean);
  110065. /**
  110066. * Gets wether the color grading effect is enabled.
  110067. */
  110068. get cameraColorGradingEnabled(): boolean;
  110069. /**
  110070. * Gets wether the color grading effect is enabled.
  110071. */
  110072. set cameraColorGradingEnabled(value: boolean);
  110073. /**
  110074. * Gets wether tonemapping is enabled or not.
  110075. */
  110076. get cameraToneMappingEnabled(): boolean;
  110077. /**
  110078. * Sets wether tonemapping is enabled or not
  110079. */
  110080. set cameraToneMappingEnabled(value: boolean);
  110081. /**
  110082. * The camera exposure used on this material.
  110083. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110084. * This corresponds to a photographic exposure.
  110085. */
  110086. get cameraExposure(): number;
  110087. /**
  110088. * The camera exposure used on this material.
  110089. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110090. * This corresponds to a photographic exposure.
  110091. */
  110092. set cameraExposure(value: number);
  110093. /**
  110094. * Gets The camera contrast used on this material.
  110095. */
  110096. get cameraContrast(): number;
  110097. /**
  110098. * Sets The camera contrast used on this material.
  110099. */
  110100. set cameraContrast(value: number);
  110101. /**
  110102. * Gets the Color Grading 2D Lookup Texture.
  110103. */
  110104. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110105. /**
  110106. * Sets the Color Grading 2D Lookup Texture.
  110107. */
  110108. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110109. /**
  110110. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110111. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110112. * 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;
  110113. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110114. */
  110115. get cameraColorCurves(): Nullable<ColorCurves>;
  110116. /**
  110117. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110118. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110119. * 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;
  110120. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110121. */
  110122. set cameraColorCurves(value: Nullable<ColorCurves>);
  110123. /**
  110124. * Can this material render to several textures at once
  110125. */
  110126. get canRenderToMRT(): boolean;
  110127. /**
  110128. * Defines the detail map parameters for the material.
  110129. */
  110130. readonly detailMap: DetailMapConfiguration;
  110131. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110132. protected _worldViewProjectionMatrix: Matrix;
  110133. protected _globalAmbientColor: Color3;
  110134. protected _useLogarithmicDepth: boolean;
  110135. protected _rebuildInParallel: boolean;
  110136. /**
  110137. * Instantiates a new standard material.
  110138. * This is the default material used in Babylon. It is the best trade off between quality
  110139. * and performances.
  110140. * @see https://doc.babylonjs.com/babylon101/materials
  110141. * @param name Define the name of the material in the scene
  110142. * @param scene Define the scene the material belong to
  110143. */
  110144. constructor(name: string, scene: Scene);
  110145. /**
  110146. * Gets a boolean indicating that current material needs to register RTT
  110147. */
  110148. get hasRenderTargetTextures(): boolean;
  110149. /**
  110150. * Gets the current class name of the material e.g. "StandardMaterial"
  110151. * Mainly use in serialization.
  110152. * @returns the class name
  110153. */
  110154. getClassName(): string;
  110155. /**
  110156. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110157. * You can try switching to logarithmic depth.
  110158. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110159. */
  110160. get useLogarithmicDepth(): boolean;
  110161. set useLogarithmicDepth(value: boolean);
  110162. /**
  110163. * Specifies if the material will require alpha blending
  110164. * @returns a boolean specifying if alpha blending is needed
  110165. */
  110166. needAlphaBlending(): boolean;
  110167. /**
  110168. * Specifies if this material should be rendered in alpha test mode
  110169. * @returns a boolean specifying if an alpha test is needed.
  110170. */
  110171. needAlphaTesting(): boolean;
  110172. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110173. /**
  110174. * Get the texture used for alpha test purpose.
  110175. * @returns the diffuse texture in case of the standard material.
  110176. */
  110177. getAlphaTestTexture(): Nullable<BaseTexture>;
  110178. /**
  110179. * Get if the submesh is ready to be used and all its information available.
  110180. * Child classes can use it to update shaders
  110181. * @param mesh defines the mesh to check
  110182. * @param subMesh defines which submesh to check
  110183. * @param useInstances specifies that instances should be used
  110184. * @returns a boolean indicating that the submesh is ready or not
  110185. */
  110186. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110187. /**
  110188. * Builds the material UBO layouts.
  110189. * Used internally during the effect preparation.
  110190. */
  110191. buildUniformLayout(): void;
  110192. /**
  110193. * Unbinds the material from the mesh
  110194. */
  110195. unbind(): void;
  110196. /**
  110197. * Binds the submesh to this material by preparing the effect and shader to draw
  110198. * @param world defines the world transformation matrix
  110199. * @param mesh defines the mesh containing the submesh
  110200. * @param subMesh defines the submesh to bind the material to
  110201. */
  110202. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110203. /**
  110204. * Get the list of animatables in the material.
  110205. * @returns the list of animatables object used in the material
  110206. */
  110207. getAnimatables(): IAnimatable[];
  110208. /**
  110209. * Gets the active textures from the material
  110210. * @returns an array of textures
  110211. */
  110212. getActiveTextures(): BaseTexture[];
  110213. /**
  110214. * Specifies if the material uses a texture
  110215. * @param texture defines the texture to check against the material
  110216. * @returns a boolean specifying if the material uses the texture
  110217. */
  110218. hasTexture(texture: BaseTexture): boolean;
  110219. /**
  110220. * Disposes the material
  110221. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110222. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110223. */
  110224. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110225. /**
  110226. * Makes a duplicate of the material, and gives it a new name
  110227. * @param name defines the new name for the duplicated material
  110228. * @returns the cloned material
  110229. */
  110230. clone(name: string): StandardMaterial;
  110231. /**
  110232. * Serializes this material in a JSON representation
  110233. * @returns the serialized material object
  110234. */
  110235. serialize(): any;
  110236. /**
  110237. * Creates a standard material from parsed material data
  110238. * @param source defines the JSON representation of the material
  110239. * @param scene defines the hosting scene
  110240. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110241. * @returns a new standard material
  110242. */
  110243. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110244. /**
  110245. * Are diffuse textures enabled in the application.
  110246. */
  110247. static get DiffuseTextureEnabled(): boolean;
  110248. static set DiffuseTextureEnabled(value: boolean);
  110249. /**
  110250. * Are detail textures enabled in the application.
  110251. */
  110252. static get DetailTextureEnabled(): boolean;
  110253. static set DetailTextureEnabled(value: boolean);
  110254. /**
  110255. * Are ambient textures enabled in the application.
  110256. */
  110257. static get AmbientTextureEnabled(): boolean;
  110258. static set AmbientTextureEnabled(value: boolean);
  110259. /**
  110260. * Are opacity textures enabled in the application.
  110261. */
  110262. static get OpacityTextureEnabled(): boolean;
  110263. static set OpacityTextureEnabled(value: boolean);
  110264. /**
  110265. * Are reflection textures enabled in the application.
  110266. */
  110267. static get ReflectionTextureEnabled(): boolean;
  110268. static set ReflectionTextureEnabled(value: boolean);
  110269. /**
  110270. * Are emissive textures enabled in the application.
  110271. */
  110272. static get EmissiveTextureEnabled(): boolean;
  110273. static set EmissiveTextureEnabled(value: boolean);
  110274. /**
  110275. * Are specular textures enabled in the application.
  110276. */
  110277. static get SpecularTextureEnabled(): boolean;
  110278. static set SpecularTextureEnabled(value: boolean);
  110279. /**
  110280. * Are bump textures enabled in the application.
  110281. */
  110282. static get BumpTextureEnabled(): boolean;
  110283. static set BumpTextureEnabled(value: boolean);
  110284. /**
  110285. * Are lightmap textures enabled in the application.
  110286. */
  110287. static get LightmapTextureEnabled(): boolean;
  110288. static set LightmapTextureEnabled(value: boolean);
  110289. /**
  110290. * Are refraction textures enabled in the application.
  110291. */
  110292. static get RefractionTextureEnabled(): boolean;
  110293. static set RefractionTextureEnabled(value: boolean);
  110294. /**
  110295. * Are color grading textures enabled in the application.
  110296. */
  110297. static get ColorGradingTextureEnabled(): boolean;
  110298. static set ColorGradingTextureEnabled(value: boolean);
  110299. /**
  110300. * Are fresnels enabled in the application.
  110301. */
  110302. static get FresnelEnabled(): boolean;
  110303. static set FresnelEnabled(value: boolean);
  110304. }
  110305. }
  110306. declare module BABYLON {
  110307. /**
  110308. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110309. *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.
  110310. * The SPS is also a particle system. It provides some methods to manage the particles.
  110311. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110312. *
  110313. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110314. */
  110315. export class SolidParticleSystem implements IDisposable {
  110316. /**
  110317. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110318. * Example : var p = SPS.particles[i];
  110319. */
  110320. particles: SolidParticle[];
  110321. /**
  110322. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110323. */
  110324. nbParticles: number;
  110325. /**
  110326. * If the particles must ever face the camera (default false). Useful for planar particles.
  110327. */
  110328. billboard: boolean;
  110329. /**
  110330. * Recompute normals when adding a shape
  110331. */
  110332. recomputeNormals: boolean;
  110333. /**
  110334. * This a counter ofr your own usage. It's not set by any SPS functions.
  110335. */
  110336. counter: number;
  110337. /**
  110338. * The SPS name. This name is also given to the underlying mesh.
  110339. */
  110340. name: string;
  110341. /**
  110342. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110343. */
  110344. mesh: Mesh;
  110345. /**
  110346. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110347. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110348. */
  110349. vars: any;
  110350. /**
  110351. * This array is populated when the SPS is set as 'pickable'.
  110352. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110353. * Each element of this array is an object `{idx: int, faceId: int}`.
  110354. * `idx` is the picked particle index in the `SPS.particles` array
  110355. * `faceId` is the picked face index counted within this particle.
  110356. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110357. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110358. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110359. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110360. */
  110361. pickedParticles: {
  110362. idx: number;
  110363. faceId: number;
  110364. }[];
  110365. /**
  110366. * This array is populated when the SPS is set as 'pickable'
  110367. * Each key of this array is a submesh index.
  110368. * Each element of this array is a second array defined like this :
  110369. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110370. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110371. * `idx` is the picked particle index in the `SPS.particles` array
  110372. * `faceId` is the picked face index counted within this particle.
  110373. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110374. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110375. */
  110376. pickedBySubMesh: {
  110377. idx: number;
  110378. faceId: number;
  110379. }[][];
  110380. /**
  110381. * This array is populated when `enableDepthSort` is set to true.
  110382. * Each element of this array is an instance of the class DepthSortedParticle.
  110383. */
  110384. depthSortedParticles: DepthSortedParticle[];
  110385. /**
  110386. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110387. * @hidden
  110388. */
  110389. _bSphereOnly: boolean;
  110390. /**
  110391. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110392. * @hidden
  110393. */
  110394. _bSphereRadiusFactor: number;
  110395. private _scene;
  110396. private _positions;
  110397. private _indices;
  110398. private _normals;
  110399. private _colors;
  110400. private _uvs;
  110401. private _indices32;
  110402. private _positions32;
  110403. private _normals32;
  110404. private _fixedNormal32;
  110405. private _colors32;
  110406. private _uvs32;
  110407. private _index;
  110408. private _updatable;
  110409. private _pickable;
  110410. private _isVisibilityBoxLocked;
  110411. private _alwaysVisible;
  110412. private _depthSort;
  110413. private _expandable;
  110414. private _shapeCounter;
  110415. private _copy;
  110416. private _color;
  110417. private _computeParticleColor;
  110418. private _computeParticleTexture;
  110419. private _computeParticleRotation;
  110420. private _computeParticleVertex;
  110421. private _computeBoundingBox;
  110422. private _depthSortParticles;
  110423. private _camera;
  110424. private _mustUnrotateFixedNormals;
  110425. private _particlesIntersect;
  110426. private _needs32Bits;
  110427. private _isNotBuilt;
  110428. private _lastParticleId;
  110429. private _idxOfId;
  110430. private _multimaterialEnabled;
  110431. private _useModelMaterial;
  110432. private _indicesByMaterial;
  110433. private _materialIndexes;
  110434. private _depthSortFunction;
  110435. private _materialSortFunction;
  110436. private _materials;
  110437. private _multimaterial;
  110438. private _materialIndexesById;
  110439. private _defaultMaterial;
  110440. private _autoUpdateSubMeshes;
  110441. private _tmpVertex;
  110442. /**
  110443. * Creates a SPS (Solid Particle System) object.
  110444. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110445. * @param scene (Scene) is the scene in which the SPS is added.
  110446. * @param options defines the options of the sps e.g.
  110447. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110448. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110449. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110450. * * 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.
  110451. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110452. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110453. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110454. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110455. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110456. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110457. */
  110458. constructor(name: string, scene: Scene, options?: {
  110459. updatable?: boolean;
  110460. isPickable?: boolean;
  110461. enableDepthSort?: boolean;
  110462. particleIntersection?: boolean;
  110463. boundingSphereOnly?: boolean;
  110464. bSphereRadiusFactor?: number;
  110465. expandable?: boolean;
  110466. useModelMaterial?: boolean;
  110467. enableMultiMaterial?: boolean;
  110468. });
  110469. /**
  110470. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110471. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110472. * @returns the created mesh
  110473. */
  110474. buildMesh(): Mesh;
  110475. /**
  110476. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110477. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110478. * Thus the particles generated from `digest()` have their property `position` set yet.
  110479. * @param mesh ( Mesh ) is the mesh to be digested
  110480. * @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
  110481. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110482. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110483. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110484. * @returns the current SPS
  110485. */
  110486. digest(mesh: Mesh, options?: {
  110487. facetNb?: number;
  110488. number?: number;
  110489. delta?: number;
  110490. storage?: [];
  110491. }): SolidParticleSystem;
  110492. /**
  110493. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110494. * @hidden
  110495. */
  110496. private _unrotateFixedNormals;
  110497. /**
  110498. * Resets the temporary working copy particle
  110499. * @hidden
  110500. */
  110501. private _resetCopy;
  110502. /**
  110503. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110504. * @param p the current index in the positions array to be updated
  110505. * @param ind the current index in the indices array
  110506. * @param shape a Vector3 array, the shape geometry
  110507. * @param positions the positions array to be updated
  110508. * @param meshInd the shape indices array
  110509. * @param indices the indices array to be updated
  110510. * @param meshUV the shape uv array
  110511. * @param uvs the uv array to be updated
  110512. * @param meshCol the shape color array
  110513. * @param colors the color array to be updated
  110514. * @param meshNor the shape normals array
  110515. * @param normals the normals array to be updated
  110516. * @param idx the particle index
  110517. * @param idxInShape the particle index in its shape
  110518. * @param options the addShape() method passed options
  110519. * @model the particle model
  110520. * @hidden
  110521. */
  110522. private _meshBuilder;
  110523. /**
  110524. * Returns a shape Vector3 array from positions float array
  110525. * @param positions float array
  110526. * @returns a vector3 array
  110527. * @hidden
  110528. */
  110529. private _posToShape;
  110530. /**
  110531. * Returns a shapeUV array from a float uvs (array deep copy)
  110532. * @param uvs as a float array
  110533. * @returns a shapeUV array
  110534. * @hidden
  110535. */
  110536. private _uvsToShapeUV;
  110537. /**
  110538. * Adds a new particle object in the particles array
  110539. * @param idx particle index in particles array
  110540. * @param id particle id
  110541. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110542. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110543. * @param model particle ModelShape object
  110544. * @param shapeId model shape identifier
  110545. * @param idxInShape index of the particle in the current model
  110546. * @param bInfo model bounding info object
  110547. * @param storage target storage array, if any
  110548. * @hidden
  110549. */
  110550. private _addParticle;
  110551. /**
  110552. * Adds some particles to the SPS from the model shape. Returns the shape id.
  110553. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  110554. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  110555. * @param nb (positive integer) the number of particles to be created from this model
  110556. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  110557. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  110558. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110559. * @returns the number of shapes in the system
  110560. */
  110561. addShape(mesh: Mesh, nb: number, options?: {
  110562. positionFunction?: any;
  110563. vertexFunction?: any;
  110564. storage?: [];
  110565. }): number;
  110566. /**
  110567. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  110568. * @hidden
  110569. */
  110570. private _rebuildParticle;
  110571. /**
  110572. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  110573. * @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.
  110574. * @returns the SPS.
  110575. */
  110576. rebuildMesh(reset?: boolean): SolidParticleSystem;
  110577. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  110578. * Returns an array with the removed particles.
  110579. * 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.
  110580. * The SPS can't be empty so at least one particle needs to remain in place.
  110581. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  110582. * @param start index of the first particle to remove
  110583. * @param end index of the last particle to remove (included)
  110584. * @returns an array populated with the removed particles
  110585. */
  110586. removeParticles(start: number, end: number): SolidParticle[];
  110587. /**
  110588. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  110589. * @param solidParticleArray an array populated with Solid Particles objects
  110590. * @returns the SPS
  110591. */
  110592. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  110593. /**
  110594. * Creates a new particle and modifies the SPS mesh geometry :
  110595. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  110596. * - calls _addParticle() to populate the particle array
  110597. * factorized code from addShape() and insertParticlesFromArray()
  110598. * @param idx particle index in the particles array
  110599. * @param i particle index in its shape
  110600. * @param modelShape particle ModelShape object
  110601. * @param shape shape vertex array
  110602. * @param meshInd shape indices array
  110603. * @param meshUV shape uv array
  110604. * @param meshCol shape color array
  110605. * @param meshNor shape normals array
  110606. * @param bbInfo shape bounding info
  110607. * @param storage target particle storage
  110608. * @options addShape() passed options
  110609. * @hidden
  110610. */
  110611. private _insertNewParticle;
  110612. /**
  110613. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  110614. * This method calls `updateParticle()` for each particle of the SPS.
  110615. * For an animated SPS, it is usually called within the render loop.
  110616. * 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.
  110617. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  110618. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  110619. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  110620. * @returns the SPS.
  110621. */
  110622. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  110623. /**
  110624. * Disposes the SPS.
  110625. */
  110626. dispose(): void;
  110627. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  110628. * idx is the particle index in the SPS
  110629. * faceId is the picked face index counted within this particle.
  110630. * Returns null if the pickInfo can't identify a picked particle.
  110631. * @param pickingInfo (PickingInfo object)
  110632. * @returns {idx: number, faceId: number} or null
  110633. */
  110634. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  110635. idx: number;
  110636. faceId: number;
  110637. }>;
  110638. /**
  110639. * Returns a SolidParticle object from its identifier : particle.id
  110640. * @param id (integer) the particle Id
  110641. * @returns the searched particle or null if not found in the SPS.
  110642. */
  110643. getParticleById(id: number): Nullable<SolidParticle>;
  110644. /**
  110645. * Returns a new array populated with the particles having the passed shapeId.
  110646. * @param shapeId (integer) the shape identifier
  110647. * @returns a new solid particle array
  110648. */
  110649. getParticlesByShapeId(shapeId: number): SolidParticle[];
  110650. /**
  110651. * Populates the passed array "ref" with the particles having the passed shapeId.
  110652. * @param shapeId the shape identifier
  110653. * @returns the SPS
  110654. * @param ref
  110655. */
  110656. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  110657. /**
  110658. * Computes the required SubMeshes according the materials assigned to the particles.
  110659. * @returns the solid particle system.
  110660. * Does nothing if called before the SPS mesh is built.
  110661. */
  110662. computeSubMeshes(): SolidParticleSystem;
  110663. /**
  110664. * Sorts the solid particles by material when MultiMaterial is enabled.
  110665. * Updates the indices32 array.
  110666. * Updates the indicesByMaterial array.
  110667. * Updates the mesh indices array.
  110668. * @returns the SPS
  110669. * @hidden
  110670. */
  110671. private _sortParticlesByMaterial;
  110672. /**
  110673. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  110674. * @hidden
  110675. */
  110676. private _setMaterialIndexesById;
  110677. /**
  110678. * Returns an array with unique values of Materials from the passed array
  110679. * @param array the material array to be checked and filtered
  110680. * @hidden
  110681. */
  110682. private _filterUniqueMaterialId;
  110683. /**
  110684. * Sets a new Standard Material as _defaultMaterial if not already set.
  110685. * @hidden
  110686. */
  110687. private _setDefaultMaterial;
  110688. /**
  110689. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  110690. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110691. * @returns the SPS.
  110692. */
  110693. refreshVisibleSize(): SolidParticleSystem;
  110694. /**
  110695. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  110696. * @param size the size (float) of the visibility box
  110697. * note : this doesn't lock the SPS mesh bounding box.
  110698. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110699. */
  110700. setVisibilityBox(size: number): void;
  110701. /**
  110702. * Gets whether the SPS as always visible or not
  110703. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110704. */
  110705. get isAlwaysVisible(): boolean;
  110706. /**
  110707. * Sets the SPS as always visible or not
  110708. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110709. */
  110710. set isAlwaysVisible(val: boolean);
  110711. /**
  110712. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  110713. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110714. */
  110715. set isVisibilityBoxLocked(val: boolean);
  110716. /**
  110717. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  110718. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110719. */
  110720. get isVisibilityBoxLocked(): boolean;
  110721. /**
  110722. * Tells to `setParticles()` to compute the particle rotations or not.
  110723. * Default value : true. The SPS is faster when it's set to false.
  110724. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  110725. */
  110726. set computeParticleRotation(val: boolean);
  110727. /**
  110728. * Tells to `setParticles()` to compute the particle colors or not.
  110729. * Default value : true. The SPS is faster when it's set to false.
  110730. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  110731. */
  110732. set computeParticleColor(val: boolean);
  110733. set computeParticleTexture(val: boolean);
  110734. /**
  110735. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  110736. * Default value : false. The SPS is faster when it's set to false.
  110737. * Note : the particle custom vertex positions aren't stored values.
  110738. */
  110739. set computeParticleVertex(val: boolean);
  110740. /**
  110741. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  110742. */
  110743. set computeBoundingBox(val: boolean);
  110744. /**
  110745. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  110746. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  110747. * Default : `true`
  110748. */
  110749. set depthSortParticles(val: boolean);
  110750. /**
  110751. * Gets if `setParticles()` computes the particle rotations or not.
  110752. * Default value : true. The SPS is faster when it's set to false.
  110753. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  110754. */
  110755. get computeParticleRotation(): boolean;
  110756. /**
  110757. * Gets if `setParticles()` computes the particle colors or not.
  110758. * Default value : true. The SPS is faster when it's set to false.
  110759. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  110760. */
  110761. get computeParticleColor(): boolean;
  110762. /**
  110763. * Gets if `setParticles()` computes the particle textures or not.
  110764. * Default value : true. The SPS is faster when it's set to false.
  110765. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  110766. */
  110767. get computeParticleTexture(): boolean;
  110768. /**
  110769. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  110770. * Default value : false. The SPS is faster when it's set to false.
  110771. * Note : the particle custom vertex positions aren't stored values.
  110772. */
  110773. get computeParticleVertex(): boolean;
  110774. /**
  110775. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  110776. */
  110777. get computeBoundingBox(): boolean;
  110778. /**
  110779. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  110780. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  110781. * Default : `true`
  110782. */
  110783. get depthSortParticles(): boolean;
  110784. /**
  110785. * Gets if the SPS is created as expandable at construction time.
  110786. * Default : `false`
  110787. */
  110788. get expandable(): boolean;
  110789. /**
  110790. * Gets if the SPS supports the Multi Materials
  110791. */
  110792. get multimaterialEnabled(): boolean;
  110793. /**
  110794. * Gets if the SPS uses the model materials for its own multimaterial.
  110795. */
  110796. get useModelMaterial(): boolean;
  110797. /**
  110798. * The SPS used material array.
  110799. */
  110800. get materials(): Material[];
  110801. /**
  110802. * Sets the SPS MultiMaterial from the passed materials.
  110803. * Note : the passed array is internally copied and not used then by reference.
  110804. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  110805. */
  110806. setMultiMaterial(materials: Material[]): void;
  110807. /**
  110808. * The SPS computed multimaterial object
  110809. */
  110810. get multimaterial(): MultiMaterial;
  110811. set multimaterial(mm: MultiMaterial);
  110812. /**
  110813. * If the subMeshes must be updated on the next call to setParticles()
  110814. */
  110815. get autoUpdateSubMeshes(): boolean;
  110816. set autoUpdateSubMeshes(val: boolean);
  110817. /**
  110818. * This function does nothing. It may be overwritten to set all the particle first values.
  110819. * The SPS doesn't call this function, you may have to call it by your own.
  110820. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110821. */
  110822. initParticles(): void;
  110823. /**
  110824. * This function does nothing. It may be overwritten to recycle a particle.
  110825. * The SPS doesn't call this function, you may have to call it by your own.
  110826. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110827. * @param particle The particle to recycle
  110828. * @returns the recycled particle
  110829. */
  110830. recycleParticle(particle: SolidParticle): SolidParticle;
  110831. /**
  110832. * Updates a particle : this function should be overwritten by the user.
  110833. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  110834. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110835. * @example : just set a particle position or velocity and recycle conditions
  110836. * @param particle The particle to update
  110837. * @returns the updated particle
  110838. */
  110839. updateParticle(particle: SolidParticle): SolidParticle;
  110840. /**
  110841. * Updates a vertex of a particle : it can be overwritten by the user.
  110842. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  110843. * @param particle the current particle
  110844. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  110845. * @param pt the index of the current vertex in the particle shape
  110846. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  110847. * @example : just set a vertex particle position or color
  110848. * @returns the sps
  110849. */
  110850. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  110851. /**
  110852. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  110853. * This does nothing and may be overwritten by the user.
  110854. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110855. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110856. * @param update the boolean update value actually passed to setParticles()
  110857. */
  110858. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  110859. /**
  110860. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  110861. * This will be passed three parameters.
  110862. * This does nothing and may be overwritten by the user.
  110863. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110864. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110865. * @param update the boolean update value actually passed to setParticles()
  110866. */
  110867. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  110868. }
  110869. }
  110870. declare module BABYLON {
  110871. /**
  110872. * Represents one particle of a solid particle system.
  110873. */
  110874. export class SolidParticle {
  110875. /**
  110876. * particle global index
  110877. */
  110878. idx: number;
  110879. /**
  110880. * particle identifier
  110881. */
  110882. id: number;
  110883. /**
  110884. * The color of the particle
  110885. */
  110886. color: Nullable<Color4>;
  110887. /**
  110888. * The world space position of the particle.
  110889. */
  110890. position: Vector3;
  110891. /**
  110892. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  110893. */
  110894. rotation: Vector3;
  110895. /**
  110896. * The world space rotation quaternion of the particle.
  110897. */
  110898. rotationQuaternion: Nullable<Quaternion>;
  110899. /**
  110900. * The scaling of the particle.
  110901. */
  110902. scaling: Vector3;
  110903. /**
  110904. * The uvs of the particle.
  110905. */
  110906. uvs: Vector4;
  110907. /**
  110908. * The current speed of the particle.
  110909. */
  110910. velocity: Vector3;
  110911. /**
  110912. * The pivot point in the particle local space.
  110913. */
  110914. pivot: Vector3;
  110915. /**
  110916. * Must the particle be translated from its pivot point in its local space ?
  110917. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  110918. * Default : false
  110919. */
  110920. translateFromPivot: boolean;
  110921. /**
  110922. * Is the particle active or not ?
  110923. */
  110924. alive: boolean;
  110925. /**
  110926. * Is the particle visible or not ?
  110927. */
  110928. isVisible: boolean;
  110929. /**
  110930. * Index of this particle in the global "positions" array (Internal use)
  110931. * @hidden
  110932. */
  110933. _pos: number;
  110934. /**
  110935. * @hidden Index of this particle in the global "indices" array (Internal use)
  110936. */
  110937. _ind: number;
  110938. /**
  110939. * @hidden ModelShape of this particle (Internal use)
  110940. */
  110941. _model: ModelShape;
  110942. /**
  110943. * ModelShape id of this particle
  110944. */
  110945. shapeId: number;
  110946. /**
  110947. * Index of the particle in its shape id
  110948. */
  110949. idxInShape: number;
  110950. /**
  110951. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  110952. */
  110953. _modelBoundingInfo: BoundingInfo;
  110954. /**
  110955. * @hidden Particle BoundingInfo object (Internal use)
  110956. */
  110957. _boundingInfo: BoundingInfo;
  110958. /**
  110959. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  110960. */
  110961. _sps: SolidParticleSystem;
  110962. /**
  110963. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  110964. */
  110965. _stillInvisible: boolean;
  110966. /**
  110967. * @hidden Last computed particle rotation matrix
  110968. */
  110969. _rotationMatrix: number[];
  110970. /**
  110971. * Parent particle Id, if any.
  110972. * Default null.
  110973. */
  110974. parentId: Nullable<number>;
  110975. /**
  110976. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  110977. */
  110978. materialIndex: Nullable<number>;
  110979. /**
  110980. * Custom object or properties.
  110981. */
  110982. props: Nullable<any>;
  110983. /**
  110984. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  110985. * The possible values are :
  110986. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  110987. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  110988. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  110989. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  110990. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  110991. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  110992. * */
  110993. cullingStrategy: number;
  110994. /**
  110995. * @hidden Internal global position in the SPS.
  110996. */
  110997. _globalPosition: Vector3;
  110998. /**
  110999. * Creates a Solid Particle object.
  111000. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111001. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111002. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111003. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111004. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111005. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111006. * @param shapeId (integer) is the model shape identifier in the SPS.
  111007. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111008. * @param sps defines the sps it is associated to
  111009. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111010. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111011. */
  111012. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111013. /**
  111014. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111015. * @param target the particle target
  111016. * @returns the current particle
  111017. */
  111018. copyToRef(target: SolidParticle): SolidParticle;
  111019. /**
  111020. * Legacy support, changed scale to scaling
  111021. */
  111022. get scale(): Vector3;
  111023. /**
  111024. * Legacy support, changed scale to scaling
  111025. */
  111026. set scale(scale: Vector3);
  111027. /**
  111028. * Legacy support, changed quaternion to rotationQuaternion
  111029. */
  111030. get quaternion(): Nullable<Quaternion>;
  111031. /**
  111032. * Legacy support, changed quaternion to rotationQuaternion
  111033. */
  111034. set quaternion(q: Nullable<Quaternion>);
  111035. /**
  111036. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111037. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111038. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111039. * @returns true if it intersects
  111040. */
  111041. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111042. /**
  111043. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111044. * A particle is in the frustum if its bounding box intersects the frustum
  111045. * @param frustumPlanes defines the frustum to test
  111046. * @returns true if the particle is in the frustum planes
  111047. */
  111048. isInFrustum(frustumPlanes: Plane[]): boolean;
  111049. /**
  111050. * get the rotation matrix of the particle
  111051. * @hidden
  111052. */
  111053. getRotationMatrix(m: Matrix): void;
  111054. }
  111055. /**
  111056. * Represents the shape of the model used by one particle of a solid particle system.
  111057. * SPS internal tool, don't use it manually.
  111058. */
  111059. export class ModelShape {
  111060. /**
  111061. * The shape id
  111062. * @hidden
  111063. */
  111064. shapeID: number;
  111065. /**
  111066. * flat array of model positions (internal use)
  111067. * @hidden
  111068. */
  111069. _shape: Vector3[];
  111070. /**
  111071. * flat array of model UVs (internal use)
  111072. * @hidden
  111073. */
  111074. _shapeUV: number[];
  111075. /**
  111076. * color array of the model
  111077. * @hidden
  111078. */
  111079. _shapeColors: number[];
  111080. /**
  111081. * indices array of the model
  111082. * @hidden
  111083. */
  111084. _indices: number[];
  111085. /**
  111086. * normals array of the model
  111087. * @hidden
  111088. */
  111089. _normals: number[];
  111090. /**
  111091. * length of the shape in the model indices array (internal use)
  111092. * @hidden
  111093. */
  111094. _indicesLength: number;
  111095. /**
  111096. * Custom position function (internal use)
  111097. * @hidden
  111098. */
  111099. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111100. /**
  111101. * Custom vertex function (internal use)
  111102. * @hidden
  111103. */
  111104. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111105. /**
  111106. * Model material (internal use)
  111107. * @hidden
  111108. */
  111109. _material: Nullable<Material>;
  111110. /**
  111111. * 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.
  111112. * SPS internal tool, don't use it manually.
  111113. * @hidden
  111114. */
  111115. 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>);
  111116. }
  111117. /**
  111118. * Represents a Depth Sorted Particle in the solid particle system.
  111119. * @hidden
  111120. */
  111121. export class DepthSortedParticle {
  111122. /**
  111123. * Particle index
  111124. */
  111125. idx: number;
  111126. /**
  111127. * Index of the particle in the "indices" array
  111128. */
  111129. ind: number;
  111130. /**
  111131. * Length of the particle shape in the "indices" array
  111132. */
  111133. indicesLength: number;
  111134. /**
  111135. * Squared distance from the particle to the camera
  111136. */
  111137. sqDistance: number;
  111138. /**
  111139. * Material index when used with MultiMaterials
  111140. */
  111141. materialIndex: number;
  111142. /**
  111143. * Creates a new sorted particle
  111144. * @param materialIndex
  111145. */
  111146. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111147. }
  111148. /**
  111149. * Represents a solid particle vertex
  111150. */
  111151. export class SolidParticleVertex {
  111152. /**
  111153. * Vertex position
  111154. */
  111155. position: Vector3;
  111156. /**
  111157. * Vertex color
  111158. */
  111159. color: Color4;
  111160. /**
  111161. * Vertex UV
  111162. */
  111163. uv: Vector2;
  111164. /**
  111165. * Creates a new solid particle vertex
  111166. */
  111167. constructor();
  111168. /** Vertex x coordinate */
  111169. get x(): number;
  111170. set x(val: number);
  111171. /** Vertex y coordinate */
  111172. get y(): number;
  111173. set y(val: number);
  111174. /** Vertex z coordinate */
  111175. get z(): number;
  111176. set z(val: number);
  111177. }
  111178. }
  111179. declare module BABYLON {
  111180. /**
  111181. * @hidden
  111182. */
  111183. export class _MeshCollisionData {
  111184. _checkCollisions: boolean;
  111185. _collisionMask: number;
  111186. _collisionGroup: number;
  111187. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111188. _collider: Nullable<Collider>;
  111189. _oldPositionForCollisions: Vector3;
  111190. _diffPositionForCollisions: Vector3;
  111191. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111192. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111193. }
  111194. }
  111195. declare module BABYLON {
  111196. /** @hidden */
  111197. class _FacetDataStorage {
  111198. facetPositions: Vector3[];
  111199. facetNormals: Vector3[];
  111200. facetPartitioning: number[][];
  111201. facetNb: number;
  111202. partitioningSubdivisions: number;
  111203. partitioningBBoxRatio: number;
  111204. facetDataEnabled: boolean;
  111205. facetParameters: any;
  111206. bbSize: Vector3;
  111207. subDiv: {
  111208. max: number;
  111209. X: number;
  111210. Y: number;
  111211. Z: number;
  111212. };
  111213. facetDepthSort: boolean;
  111214. facetDepthSortEnabled: boolean;
  111215. depthSortedIndices: IndicesArray;
  111216. depthSortedFacets: {
  111217. ind: number;
  111218. sqDistance: number;
  111219. }[];
  111220. facetDepthSortFunction: (f1: {
  111221. ind: number;
  111222. sqDistance: number;
  111223. }, f2: {
  111224. ind: number;
  111225. sqDistance: number;
  111226. }) => number;
  111227. facetDepthSortFrom: Vector3;
  111228. facetDepthSortOrigin: Vector3;
  111229. invertedMatrix: Matrix;
  111230. }
  111231. /**
  111232. * @hidden
  111233. **/
  111234. class _InternalAbstractMeshDataInfo {
  111235. _hasVertexAlpha: boolean;
  111236. _useVertexColors: boolean;
  111237. _numBoneInfluencers: number;
  111238. _applyFog: boolean;
  111239. _receiveShadows: boolean;
  111240. _facetData: _FacetDataStorage;
  111241. _visibility: number;
  111242. _skeleton: Nullable<Skeleton>;
  111243. _layerMask: number;
  111244. _computeBonesUsingShaders: boolean;
  111245. _isActive: boolean;
  111246. _onlyForInstances: boolean;
  111247. _isActiveIntermediate: boolean;
  111248. _onlyForInstancesIntermediate: boolean;
  111249. _actAsRegularMesh: boolean;
  111250. }
  111251. /**
  111252. * Class used to store all common mesh properties
  111253. */
  111254. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111255. /** No occlusion */
  111256. static OCCLUSION_TYPE_NONE: number;
  111257. /** Occlusion set to optimisitic */
  111258. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111259. /** Occlusion set to strict */
  111260. static OCCLUSION_TYPE_STRICT: number;
  111261. /** Use an accurante occlusion algorithm */
  111262. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111263. /** Use a conservative occlusion algorithm */
  111264. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111265. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111266. * Test order :
  111267. * Is the bounding sphere outside the frustum ?
  111268. * If not, are the bounding box vertices outside the frustum ?
  111269. * It not, then the cullable object is in the frustum.
  111270. */
  111271. static readonly CULLINGSTRATEGY_STANDARD: number;
  111272. /** Culling strategy : Bounding Sphere Only.
  111273. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111274. * It's also less accurate than the standard because some not visible objects can still be selected.
  111275. * Test : is the bounding sphere outside the frustum ?
  111276. * If not, then the cullable object is in the frustum.
  111277. */
  111278. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111279. /** Culling strategy : Optimistic Inclusion.
  111280. * This in an inclusion test first, then the standard exclusion test.
  111281. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111282. * 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.
  111283. * Anyway, it's as accurate as the standard strategy.
  111284. * Test :
  111285. * Is the cullable object bounding sphere center in the frustum ?
  111286. * If not, apply the default culling strategy.
  111287. */
  111288. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111289. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111290. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111291. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111292. * 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.
  111293. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111294. * Test :
  111295. * Is the cullable object bounding sphere center in the frustum ?
  111296. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111297. */
  111298. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111299. /**
  111300. * No billboard
  111301. */
  111302. static get BILLBOARDMODE_NONE(): number;
  111303. /** Billboard on X axis */
  111304. static get BILLBOARDMODE_X(): number;
  111305. /** Billboard on Y axis */
  111306. static get BILLBOARDMODE_Y(): number;
  111307. /** Billboard on Z axis */
  111308. static get BILLBOARDMODE_Z(): number;
  111309. /** Billboard on all axes */
  111310. static get BILLBOARDMODE_ALL(): number;
  111311. /** Billboard on using position instead of orientation */
  111312. static get BILLBOARDMODE_USE_POSITION(): number;
  111313. /** @hidden */
  111314. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111315. /**
  111316. * The culling strategy to use to check whether the mesh must be rendered or not.
  111317. * This value can be changed at any time and will be used on the next render mesh selection.
  111318. * The possible values are :
  111319. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111320. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111321. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111322. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111323. * Please read each static variable documentation to get details about the culling process.
  111324. * */
  111325. cullingStrategy: number;
  111326. /**
  111327. * Gets the number of facets in the mesh
  111328. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111329. */
  111330. get facetNb(): number;
  111331. /**
  111332. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111333. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111334. */
  111335. get partitioningSubdivisions(): number;
  111336. set partitioningSubdivisions(nb: number);
  111337. /**
  111338. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111339. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111340. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111341. */
  111342. get partitioningBBoxRatio(): number;
  111343. set partitioningBBoxRatio(ratio: number);
  111344. /**
  111345. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111346. * Works only for updatable meshes.
  111347. * Doesn't work with multi-materials
  111348. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111349. */
  111350. get mustDepthSortFacets(): boolean;
  111351. set mustDepthSortFacets(sort: boolean);
  111352. /**
  111353. * The location (Vector3) where the facet depth sort must be computed from.
  111354. * By default, the active camera position.
  111355. * Used only when facet depth sort is enabled
  111356. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111357. */
  111358. get facetDepthSortFrom(): Vector3;
  111359. set facetDepthSortFrom(location: Vector3);
  111360. /**
  111361. * gets a boolean indicating if facetData is enabled
  111362. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111363. */
  111364. get isFacetDataEnabled(): boolean;
  111365. /** @hidden */
  111366. _updateNonUniformScalingState(value: boolean): boolean;
  111367. /**
  111368. * An event triggered when this mesh collides with another one
  111369. */
  111370. onCollideObservable: Observable<AbstractMesh>;
  111371. /** Set a function to call when this mesh collides with another one */
  111372. set onCollide(callback: () => void);
  111373. /**
  111374. * An event triggered when the collision's position changes
  111375. */
  111376. onCollisionPositionChangeObservable: Observable<Vector3>;
  111377. /** Set a function to call when the collision's position changes */
  111378. set onCollisionPositionChange(callback: () => void);
  111379. /**
  111380. * An event triggered when material is changed
  111381. */
  111382. onMaterialChangedObservable: Observable<AbstractMesh>;
  111383. /**
  111384. * Gets or sets the orientation for POV movement & rotation
  111385. */
  111386. definedFacingForward: boolean;
  111387. /** @hidden */
  111388. _occlusionQuery: Nullable<WebGLQuery>;
  111389. /** @hidden */
  111390. _renderingGroup: Nullable<RenderingGroup>;
  111391. /**
  111392. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111393. */
  111394. get visibility(): number;
  111395. /**
  111396. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111397. */
  111398. set visibility(value: number);
  111399. /** Gets or sets the alpha index used to sort transparent meshes
  111400. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111401. */
  111402. alphaIndex: number;
  111403. /**
  111404. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111405. */
  111406. isVisible: boolean;
  111407. /**
  111408. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111409. */
  111410. isPickable: boolean;
  111411. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111412. showSubMeshesBoundingBox: boolean;
  111413. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111414. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111415. */
  111416. isBlocker: boolean;
  111417. /**
  111418. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111419. */
  111420. enablePointerMoveEvents: boolean;
  111421. /**
  111422. * Specifies the rendering group id for this mesh (0 by default)
  111423. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111424. */
  111425. renderingGroupId: number;
  111426. private _material;
  111427. /** Gets or sets current material */
  111428. get material(): Nullable<Material>;
  111429. set material(value: Nullable<Material>);
  111430. /**
  111431. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111432. * @see https://doc.babylonjs.com/babylon101/shadows
  111433. */
  111434. get receiveShadows(): boolean;
  111435. set receiveShadows(value: boolean);
  111436. /** Defines color to use when rendering outline */
  111437. outlineColor: Color3;
  111438. /** Define width to use when rendering outline */
  111439. outlineWidth: number;
  111440. /** Defines color to use when rendering overlay */
  111441. overlayColor: Color3;
  111442. /** Defines alpha to use when rendering overlay */
  111443. overlayAlpha: number;
  111444. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111445. get hasVertexAlpha(): boolean;
  111446. set hasVertexAlpha(value: boolean);
  111447. /** 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) */
  111448. get useVertexColors(): boolean;
  111449. set useVertexColors(value: boolean);
  111450. /**
  111451. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111452. */
  111453. get computeBonesUsingShaders(): boolean;
  111454. set computeBonesUsingShaders(value: boolean);
  111455. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111456. get numBoneInfluencers(): number;
  111457. set numBoneInfluencers(value: number);
  111458. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111459. get applyFog(): boolean;
  111460. set applyFog(value: boolean);
  111461. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111462. useOctreeForRenderingSelection: boolean;
  111463. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111464. useOctreeForPicking: boolean;
  111465. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111466. useOctreeForCollisions: boolean;
  111467. /**
  111468. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111469. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111470. */
  111471. get layerMask(): number;
  111472. set layerMask(value: number);
  111473. /**
  111474. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111475. */
  111476. alwaysSelectAsActiveMesh: boolean;
  111477. /**
  111478. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111479. */
  111480. doNotSyncBoundingInfo: boolean;
  111481. /**
  111482. * Gets or sets the current action manager
  111483. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111484. */
  111485. actionManager: Nullable<AbstractActionManager>;
  111486. private _meshCollisionData;
  111487. /**
  111488. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111489. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111490. */
  111491. ellipsoid: Vector3;
  111492. /**
  111493. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111494. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111495. */
  111496. ellipsoidOffset: Vector3;
  111497. /**
  111498. * Gets or sets a collision mask used to mask collisions (default is -1).
  111499. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111500. */
  111501. get collisionMask(): number;
  111502. set collisionMask(mask: number);
  111503. /**
  111504. * Gets or sets the current collision group mask (-1 by default).
  111505. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111506. */
  111507. get collisionGroup(): number;
  111508. set collisionGroup(mask: number);
  111509. /**
  111510. * Gets or sets current surrounding meshes (null by default).
  111511. *
  111512. * By default collision detection is tested against every mesh in the scene.
  111513. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111514. * meshes will be tested for the collision.
  111515. *
  111516. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111517. */
  111518. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111519. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111520. /**
  111521. * Defines edge width used when edgesRenderer is enabled
  111522. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111523. */
  111524. edgesWidth: number;
  111525. /**
  111526. * Defines edge color used when edgesRenderer is enabled
  111527. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111528. */
  111529. edgesColor: Color4;
  111530. /** @hidden */
  111531. _edgesRenderer: Nullable<IEdgesRenderer>;
  111532. /** @hidden */
  111533. _masterMesh: Nullable<AbstractMesh>;
  111534. /** @hidden */
  111535. _boundingInfo: Nullable<BoundingInfo>;
  111536. /** @hidden */
  111537. _renderId: number;
  111538. /**
  111539. * Gets or sets the list of subMeshes
  111540. * @see https://doc.babylonjs.com/how_to/multi_materials
  111541. */
  111542. subMeshes: SubMesh[];
  111543. /** @hidden */
  111544. _intersectionsInProgress: AbstractMesh[];
  111545. /** @hidden */
  111546. _unIndexed: boolean;
  111547. /** @hidden */
  111548. _lightSources: Light[];
  111549. /** Gets the list of lights affecting that mesh */
  111550. get lightSources(): Light[];
  111551. /** @hidden */
  111552. get _positions(): Nullable<Vector3[]>;
  111553. /** @hidden */
  111554. _waitingData: {
  111555. lods: Nullable<any>;
  111556. actions: Nullable<any>;
  111557. freezeWorldMatrix: Nullable<boolean>;
  111558. };
  111559. /** @hidden */
  111560. _bonesTransformMatrices: Nullable<Float32Array>;
  111561. /** @hidden */
  111562. _transformMatrixTexture: Nullable<RawTexture>;
  111563. /**
  111564. * Gets or sets a skeleton to apply skining transformations
  111565. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  111566. */
  111567. set skeleton(value: Nullable<Skeleton>);
  111568. get skeleton(): Nullable<Skeleton>;
  111569. /**
  111570. * An event triggered when the mesh is rebuilt.
  111571. */
  111572. onRebuildObservable: Observable<AbstractMesh>;
  111573. /**
  111574. * Creates a new AbstractMesh
  111575. * @param name defines the name of the mesh
  111576. * @param scene defines the hosting scene
  111577. */
  111578. constructor(name: string, scene?: Nullable<Scene>);
  111579. /**
  111580. * Returns the string "AbstractMesh"
  111581. * @returns "AbstractMesh"
  111582. */
  111583. getClassName(): string;
  111584. /**
  111585. * Gets a string representation of the current mesh
  111586. * @param fullDetails defines a boolean indicating if full details must be included
  111587. * @returns a string representation of the current mesh
  111588. */
  111589. toString(fullDetails?: boolean): string;
  111590. /**
  111591. * @hidden
  111592. */
  111593. protected _getEffectiveParent(): Nullable<Node>;
  111594. /** @hidden */
  111595. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111596. /** @hidden */
  111597. _rebuild(): void;
  111598. /** @hidden */
  111599. _resyncLightSources(): void;
  111600. /** @hidden */
  111601. _resyncLightSource(light: Light): void;
  111602. /** @hidden */
  111603. _unBindEffect(): void;
  111604. /** @hidden */
  111605. _removeLightSource(light: Light, dispose: boolean): void;
  111606. private _markSubMeshesAsDirty;
  111607. /** @hidden */
  111608. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  111609. /** @hidden */
  111610. _markSubMeshesAsAttributesDirty(): void;
  111611. /** @hidden */
  111612. _markSubMeshesAsMiscDirty(): void;
  111613. /**
  111614. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  111615. */
  111616. get scaling(): Vector3;
  111617. set scaling(newScaling: Vector3);
  111618. /**
  111619. * Returns true if the mesh is blocked. Implemented by child classes
  111620. */
  111621. get isBlocked(): boolean;
  111622. /**
  111623. * Returns the mesh itself by default. Implemented by child classes
  111624. * @param camera defines the camera to use to pick the right LOD level
  111625. * @returns the currentAbstractMesh
  111626. */
  111627. getLOD(camera: Camera): Nullable<AbstractMesh>;
  111628. /**
  111629. * Returns 0 by default. Implemented by child classes
  111630. * @returns an integer
  111631. */
  111632. getTotalVertices(): number;
  111633. /**
  111634. * Returns a positive integer : the total number of indices in this mesh geometry.
  111635. * @returns the numner of indices or zero if the mesh has no geometry.
  111636. */
  111637. getTotalIndices(): number;
  111638. /**
  111639. * Returns null by default. Implemented by child classes
  111640. * @returns null
  111641. */
  111642. getIndices(): Nullable<IndicesArray>;
  111643. /**
  111644. * Returns the array of the requested vertex data kind. Implemented by child classes
  111645. * @param kind defines the vertex data kind to use
  111646. * @returns null
  111647. */
  111648. getVerticesData(kind: string): Nullable<FloatArray>;
  111649. /**
  111650. * Sets the vertex data of the mesh geometry for the requested `kind`.
  111651. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  111652. * Note that a new underlying VertexBuffer object is created each call.
  111653. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  111654. * @param kind defines vertex data kind:
  111655. * * VertexBuffer.PositionKind
  111656. * * VertexBuffer.UVKind
  111657. * * VertexBuffer.UV2Kind
  111658. * * VertexBuffer.UV3Kind
  111659. * * VertexBuffer.UV4Kind
  111660. * * VertexBuffer.UV5Kind
  111661. * * VertexBuffer.UV6Kind
  111662. * * VertexBuffer.ColorKind
  111663. * * VertexBuffer.MatricesIndicesKind
  111664. * * VertexBuffer.MatricesIndicesExtraKind
  111665. * * VertexBuffer.MatricesWeightsKind
  111666. * * VertexBuffer.MatricesWeightsExtraKind
  111667. * @param data defines the data source
  111668. * @param updatable defines if the data must be flagged as updatable (or static)
  111669. * @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
  111670. * @returns the current mesh
  111671. */
  111672. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  111673. /**
  111674. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  111675. * If the mesh has no geometry, it is simply returned as it is.
  111676. * @param kind defines vertex data kind:
  111677. * * VertexBuffer.PositionKind
  111678. * * VertexBuffer.UVKind
  111679. * * VertexBuffer.UV2Kind
  111680. * * VertexBuffer.UV3Kind
  111681. * * VertexBuffer.UV4Kind
  111682. * * VertexBuffer.UV5Kind
  111683. * * VertexBuffer.UV6Kind
  111684. * * VertexBuffer.ColorKind
  111685. * * VertexBuffer.MatricesIndicesKind
  111686. * * VertexBuffer.MatricesIndicesExtraKind
  111687. * * VertexBuffer.MatricesWeightsKind
  111688. * * VertexBuffer.MatricesWeightsExtraKind
  111689. * @param data defines the data source
  111690. * @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
  111691. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  111692. * @returns the current mesh
  111693. */
  111694. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  111695. /**
  111696. * Sets the mesh indices,
  111697. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  111698. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  111699. * @param totalVertices Defines the total number of vertices
  111700. * @returns the current mesh
  111701. */
  111702. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  111703. /**
  111704. * Gets a boolean indicating if specific vertex data is present
  111705. * @param kind defines the vertex data kind to use
  111706. * @returns true is data kind is present
  111707. */
  111708. isVerticesDataPresent(kind: string): boolean;
  111709. /**
  111710. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  111711. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  111712. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  111713. * @returns a BoundingInfo
  111714. */
  111715. getBoundingInfo(): BoundingInfo;
  111716. /**
  111717. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  111718. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  111719. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  111720. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  111721. * @returns the current mesh
  111722. */
  111723. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  111724. /**
  111725. * Overwrite the current bounding info
  111726. * @param boundingInfo defines the new bounding info
  111727. * @returns the current mesh
  111728. */
  111729. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  111730. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  111731. get useBones(): boolean;
  111732. /** @hidden */
  111733. _preActivate(): void;
  111734. /** @hidden */
  111735. _preActivateForIntermediateRendering(renderId: number): void;
  111736. /** @hidden */
  111737. _activate(renderId: number, intermediateRendering: boolean): boolean;
  111738. /** @hidden */
  111739. _postActivate(): void;
  111740. /** @hidden */
  111741. _freeze(): void;
  111742. /** @hidden */
  111743. _unFreeze(): void;
  111744. /**
  111745. * Gets the current world matrix
  111746. * @returns a Matrix
  111747. */
  111748. getWorldMatrix(): Matrix;
  111749. /** @hidden */
  111750. _getWorldMatrixDeterminant(): number;
  111751. /**
  111752. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  111753. */
  111754. get isAnInstance(): boolean;
  111755. /**
  111756. * Gets a boolean indicating if this mesh has instances
  111757. */
  111758. get hasInstances(): boolean;
  111759. /**
  111760. * Gets a boolean indicating if this mesh has thin instances
  111761. */
  111762. get hasThinInstances(): boolean;
  111763. /**
  111764. * Perform relative position change from the point of view of behind the front of the mesh.
  111765. * This is performed taking into account the meshes current rotation, so you do not have to care.
  111766. * Supports definition of mesh facing forward or backward
  111767. * @param amountRight defines the distance on the right axis
  111768. * @param amountUp defines the distance on the up axis
  111769. * @param amountForward defines the distance on the forward axis
  111770. * @returns the current mesh
  111771. */
  111772. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  111773. /**
  111774. * Calculate relative position change from the point of view of behind the front of the mesh.
  111775. * This is performed taking into account the meshes current rotation, so you do not have to care.
  111776. * Supports definition of mesh facing forward or backward
  111777. * @param amountRight defines the distance on the right axis
  111778. * @param amountUp defines the distance on the up axis
  111779. * @param amountForward defines the distance on the forward axis
  111780. * @returns the new displacement vector
  111781. */
  111782. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  111783. /**
  111784. * Perform relative rotation change from the point of view of behind the front of the mesh.
  111785. * Supports definition of mesh facing forward or backward
  111786. * @param flipBack defines the flip
  111787. * @param twirlClockwise defines the twirl
  111788. * @param tiltRight defines the tilt
  111789. * @returns the current mesh
  111790. */
  111791. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  111792. /**
  111793. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  111794. * Supports definition of mesh facing forward or backward.
  111795. * @param flipBack defines the flip
  111796. * @param twirlClockwise defines the twirl
  111797. * @param tiltRight defines the tilt
  111798. * @returns the new rotation vector
  111799. */
  111800. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  111801. /**
  111802. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  111803. * This means the mesh underlying bounding box and sphere are recomputed.
  111804. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  111805. * @returns the current mesh
  111806. */
  111807. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  111808. /** @hidden */
  111809. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  111810. /** @hidden */
  111811. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  111812. /** @hidden */
  111813. _updateBoundingInfo(): AbstractMesh;
  111814. /** @hidden */
  111815. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  111816. /** @hidden */
  111817. protected _afterComputeWorldMatrix(): void;
  111818. /** @hidden */
  111819. get _effectiveMesh(): AbstractMesh;
  111820. /**
  111821. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  111822. * A mesh is in the frustum if its bounding box intersects the frustum
  111823. * @param frustumPlanes defines the frustum to test
  111824. * @returns true if the mesh is in the frustum planes
  111825. */
  111826. isInFrustum(frustumPlanes: Plane[]): boolean;
  111827. /**
  111828. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  111829. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  111830. * @param frustumPlanes defines the frustum to test
  111831. * @returns true if the mesh is completely in the frustum planes
  111832. */
  111833. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  111834. /**
  111835. * True if the mesh intersects another mesh or a SolidParticle object
  111836. * @param mesh defines a target mesh or SolidParticle to test
  111837. * @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)
  111838. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  111839. * @returns true if there is an intersection
  111840. */
  111841. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  111842. /**
  111843. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  111844. * @param point defines the point to test
  111845. * @returns true if there is an intersection
  111846. */
  111847. intersectsPoint(point: Vector3): boolean;
  111848. /**
  111849. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  111850. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111851. */
  111852. get checkCollisions(): boolean;
  111853. set checkCollisions(collisionEnabled: boolean);
  111854. /**
  111855. * Gets Collider object used to compute collisions (not physics)
  111856. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111857. */
  111858. get collider(): Nullable<Collider>;
  111859. /**
  111860. * Move the mesh using collision engine
  111861. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111862. * @param displacement defines the requested displacement vector
  111863. * @returns the current mesh
  111864. */
  111865. moveWithCollisions(displacement: Vector3): AbstractMesh;
  111866. private _onCollisionPositionChange;
  111867. /** @hidden */
  111868. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  111869. /** @hidden */
  111870. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  111871. /** @hidden */
  111872. _checkCollision(collider: Collider): AbstractMesh;
  111873. /** @hidden */
  111874. _generatePointsArray(): boolean;
  111875. /**
  111876. * Checks if the passed Ray intersects with the mesh
  111877. * @param ray defines the ray to use
  111878. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  111879. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  111880. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  111881. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  111882. * @returns the picking info
  111883. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  111884. */
  111885. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  111886. /**
  111887. * Clones the current mesh
  111888. * @param name defines the mesh name
  111889. * @param newParent defines the new mesh parent
  111890. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  111891. * @returns the new mesh
  111892. */
  111893. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  111894. /**
  111895. * Disposes all the submeshes of the current meshnp
  111896. * @returns the current mesh
  111897. */
  111898. releaseSubMeshes(): AbstractMesh;
  111899. /**
  111900. * Releases resources associated with this abstract mesh.
  111901. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  111902. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  111903. */
  111904. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  111905. /**
  111906. * Adds the passed mesh as a child to the current mesh
  111907. * @param mesh defines the child mesh
  111908. * @returns the current mesh
  111909. */
  111910. addChild(mesh: AbstractMesh): AbstractMesh;
  111911. /**
  111912. * Removes the passed mesh from the current mesh children list
  111913. * @param mesh defines the child mesh
  111914. * @returns the current mesh
  111915. */
  111916. removeChild(mesh: AbstractMesh): AbstractMesh;
  111917. /** @hidden */
  111918. private _initFacetData;
  111919. /**
  111920. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  111921. * This method can be called within the render loop.
  111922. * 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
  111923. * @returns the current mesh
  111924. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111925. */
  111926. updateFacetData(): AbstractMesh;
  111927. /**
  111928. * Returns the facetLocalNormals array.
  111929. * The normals are expressed in the mesh local spac
  111930. * @returns an array of Vector3
  111931. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111932. */
  111933. getFacetLocalNormals(): Vector3[];
  111934. /**
  111935. * Returns the facetLocalPositions array.
  111936. * The facet positions are expressed in the mesh local space
  111937. * @returns an array of Vector3
  111938. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111939. */
  111940. getFacetLocalPositions(): Vector3[];
  111941. /**
  111942. * Returns the facetLocalPartioning array
  111943. * @returns an array of array of numbers
  111944. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111945. */
  111946. getFacetLocalPartitioning(): number[][];
  111947. /**
  111948. * Returns the i-th facet position in the world system.
  111949. * This method allocates a new Vector3 per call
  111950. * @param i defines the facet index
  111951. * @returns a new Vector3
  111952. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111953. */
  111954. getFacetPosition(i: number): Vector3;
  111955. /**
  111956. * Sets the reference Vector3 with the i-th facet position in the world system
  111957. * @param i defines the facet index
  111958. * @param ref defines the target vector
  111959. * @returns the current mesh
  111960. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111961. */
  111962. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  111963. /**
  111964. * Returns the i-th facet normal in the world system.
  111965. * This method allocates a new Vector3 per call
  111966. * @param i defines the facet index
  111967. * @returns a new Vector3
  111968. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111969. */
  111970. getFacetNormal(i: number): Vector3;
  111971. /**
  111972. * Sets the reference Vector3 with the i-th facet normal in the world system
  111973. * @param i defines the facet index
  111974. * @param ref defines the target vector
  111975. * @returns the current mesh
  111976. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111977. */
  111978. getFacetNormalToRef(i: number, ref: Vector3): this;
  111979. /**
  111980. * 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)
  111981. * @param x defines x coordinate
  111982. * @param y defines y coordinate
  111983. * @param z defines z coordinate
  111984. * @returns the array of facet indexes
  111985. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111986. */
  111987. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  111988. /**
  111989. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  111990. * @param projected sets as the (x,y,z) world projection on the facet
  111991. * @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
  111992. * @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
  111993. * @param x defines x coordinate
  111994. * @param y defines y coordinate
  111995. * @param z defines z coordinate
  111996. * @returns the face index if found (or null instead)
  111997. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111998. */
  111999. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112000. /**
  112001. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112002. * @param projected sets as the (x,y,z) local projection on the facet
  112003. * @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
  112004. * @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
  112005. * @param x defines x coordinate
  112006. * @param y defines y coordinate
  112007. * @param z defines z coordinate
  112008. * @returns the face index if found (or null instead)
  112009. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112010. */
  112011. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112012. /**
  112013. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112014. * @returns the parameters
  112015. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112016. */
  112017. getFacetDataParameters(): any;
  112018. /**
  112019. * Disables the feature FacetData and frees the related memory
  112020. * @returns the current mesh
  112021. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112022. */
  112023. disableFacetData(): AbstractMesh;
  112024. /**
  112025. * Updates the AbstractMesh indices array
  112026. * @param indices defines the data source
  112027. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112028. * @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)
  112029. * @returns the current mesh
  112030. */
  112031. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112032. /**
  112033. * Creates new normals data for the mesh
  112034. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112035. * @returns the current mesh
  112036. */
  112037. createNormals(updatable: boolean): AbstractMesh;
  112038. /**
  112039. * Align the mesh with a normal
  112040. * @param normal defines the normal to use
  112041. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112042. * @returns the current mesh
  112043. */
  112044. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112045. /** @hidden */
  112046. _checkOcclusionQuery(): boolean;
  112047. /**
  112048. * Disables the mesh edge rendering mode
  112049. * @returns the currentAbstractMesh
  112050. */
  112051. disableEdgesRendering(): AbstractMesh;
  112052. /**
  112053. * Enables the edge rendering mode on the mesh.
  112054. * This mode makes the mesh edges visible
  112055. * @param epsilon defines the maximal distance between two angles to detect a face
  112056. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112057. * @returns the currentAbstractMesh
  112058. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112059. */
  112060. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112061. /**
  112062. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112063. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112064. */
  112065. getConnectedParticleSystems(): IParticleSystem[];
  112066. }
  112067. }
  112068. declare module BABYLON {
  112069. /**
  112070. * Interface used to define ActionEvent
  112071. */
  112072. export interface IActionEvent {
  112073. /** The mesh or sprite that triggered the action */
  112074. source: any;
  112075. /** The X mouse cursor position at the time of the event */
  112076. pointerX: number;
  112077. /** The Y mouse cursor position at the time of the event */
  112078. pointerY: number;
  112079. /** The mesh that is currently pointed at (can be null) */
  112080. meshUnderPointer: Nullable<AbstractMesh>;
  112081. /** the original (browser) event that triggered the ActionEvent */
  112082. sourceEvent?: any;
  112083. /** additional data for the event */
  112084. additionalData?: any;
  112085. }
  112086. /**
  112087. * ActionEvent is the event being sent when an action is triggered.
  112088. */
  112089. export class ActionEvent implements IActionEvent {
  112090. /** The mesh or sprite that triggered the action */
  112091. source: any;
  112092. /** The X mouse cursor position at the time of the event */
  112093. pointerX: number;
  112094. /** The Y mouse cursor position at the time of the event */
  112095. pointerY: number;
  112096. /** The mesh that is currently pointed at (can be null) */
  112097. meshUnderPointer: Nullable<AbstractMesh>;
  112098. /** the original (browser) event that triggered the ActionEvent */
  112099. sourceEvent?: any;
  112100. /** additional data for the event */
  112101. additionalData?: any;
  112102. /**
  112103. * Creates a new ActionEvent
  112104. * @param source The mesh or sprite that triggered the action
  112105. * @param pointerX The X mouse cursor position at the time of the event
  112106. * @param pointerY The Y mouse cursor position at the time of the event
  112107. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112108. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112109. * @param additionalData additional data for the event
  112110. */
  112111. constructor(
  112112. /** The mesh or sprite that triggered the action */
  112113. source: any,
  112114. /** The X mouse cursor position at the time of the event */
  112115. pointerX: number,
  112116. /** The Y mouse cursor position at the time of the event */
  112117. pointerY: number,
  112118. /** The mesh that is currently pointed at (can be null) */
  112119. meshUnderPointer: Nullable<AbstractMesh>,
  112120. /** the original (browser) event that triggered the ActionEvent */
  112121. sourceEvent?: any,
  112122. /** additional data for the event */
  112123. additionalData?: any);
  112124. /**
  112125. * Helper function to auto-create an ActionEvent from a source mesh.
  112126. * @param source The source mesh that triggered the event
  112127. * @param evt The original (browser) event
  112128. * @param additionalData additional data for the event
  112129. * @returns the new ActionEvent
  112130. */
  112131. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112132. /**
  112133. * Helper function to auto-create an ActionEvent from a source sprite
  112134. * @param source The source sprite that triggered the event
  112135. * @param scene Scene associated with the sprite
  112136. * @param evt The original (browser) event
  112137. * @param additionalData additional data for the event
  112138. * @returns the new ActionEvent
  112139. */
  112140. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112141. /**
  112142. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112143. * @param scene the scene where the event occurred
  112144. * @param evt The original (browser) event
  112145. * @returns the new ActionEvent
  112146. */
  112147. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112148. /**
  112149. * Helper function to auto-create an ActionEvent from a primitive
  112150. * @param prim defines the target primitive
  112151. * @param pointerPos defines the pointer position
  112152. * @param evt The original (browser) event
  112153. * @param additionalData additional data for the event
  112154. * @returns the new ActionEvent
  112155. */
  112156. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112157. }
  112158. }
  112159. declare module BABYLON {
  112160. /**
  112161. * Abstract class used to decouple action Manager from scene and meshes.
  112162. * Do not instantiate.
  112163. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112164. */
  112165. export abstract class AbstractActionManager implements IDisposable {
  112166. /** Gets the list of active triggers */
  112167. static Triggers: {
  112168. [key: string]: number;
  112169. };
  112170. /** Gets the cursor to use when hovering items */
  112171. hoverCursor: string;
  112172. /** Gets the list of actions */
  112173. actions: IAction[];
  112174. /**
  112175. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112176. */
  112177. isRecursive: boolean;
  112178. /**
  112179. * Releases all associated resources
  112180. */
  112181. abstract dispose(): void;
  112182. /**
  112183. * Does this action manager has pointer triggers
  112184. */
  112185. abstract get hasPointerTriggers(): boolean;
  112186. /**
  112187. * Does this action manager has pick triggers
  112188. */
  112189. abstract get hasPickTriggers(): boolean;
  112190. /**
  112191. * Process a specific trigger
  112192. * @param trigger defines the trigger to process
  112193. * @param evt defines the event details to be processed
  112194. */
  112195. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112196. /**
  112197. * Does this action manager handles actions of any of the given triggers
  112198. * @param triggers defines the triggers to be tested
  112199. * @return a boolean indicating whether one (or more) of the triggers is handled
  112200. */
  112201. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112202. /**
  112203. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112204. * speed.
  112205. * @param triggerA defines the trigger to be tested
  112206. * @param triggerB defines the trigger to be tested
  112207. * @return a boolean indicating whether one (or more) of the triggers is handled
  112208. */
  112209. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112210. /**
  112211. * Does this action manager handles actions of a given trigger
  112212. * @param trigger defines the trigger to be tested
  112213. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112214. * @return whether the trigger is handled
  112215. */
  112216. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112217. /**
  112218. * Serialize this manager to a JSON object
  112219. * @param name defines the property name to store this manager
  112220. * @returns a JSON representation of this manager
  112221. */
  112222. abstract serialize(name: string): any;
  112223. /**
  112224. * Registers an action to this action manager
  112225. * @param action defines the action to be registered
  112226. * @return the action amended (prepared) after registration
  112227. */
  112228. abstract registerAction(action: IAction): Nullable<IAction>;
  112229. /**
  112230. * Unregisters an action to this action manager
  112231. * @param action defines the action to be unregistered
  112232. * @return a boolean indicating whether the action has been unregistered
  112233. */
  112234. abstract unregisterAction(action: IAction): Boolean;
  112235. /**
  112236. * Does exist one action manager with at least one trigger
  112237. **/
  112238. static get HasTriggers(): boolean;
  112239. /**
  112240. * Does exist one action manager with at least one pick trigger
  112241. **/
  112242. static get HasPickTriggers(): boolean;
  112243. /**
  112244. * Does exist one action manager that handles actions of a given trigger
  112245. * @param trigger defines the trigger to be tested
  112246. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112247. **/
  112248. static HasSpecificTrigger(trigger: number): boolean;
  112249. }
  112250. }
  112251. declare module BABYLON {
  112252. /**
  112253. * Defines how a node can be built from a string name.
  112254. */
  112255. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112256. /**
  112257. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112258. */
  112259. export class Node implements IBehaviorAware<Node> {
  112260. /** @hidden */
  112261. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112262. private static _NodeConstructors;
  112263. /**
  112264. * Add a new node constructor
  112265. * @param type defines the type name of the node to construct
  112266. * @param constructorFunc defines the constructor function
  112267. */
  112268. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112269. /**
  112270. * Returns a node constructor based on type name
  112271. * @param type defines the type name
  112272. * @param name defines the new node name
  112273. * @param scene defines the hosting scene
  112274. * @param options defines optional options to transmit to constructors
  112275. * @returns the new constructor or null
  112276. */
  112277. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112278. /**
  112279. * Gets or sets the name of the node
  112280. */
  112281. name: string;
  112282. /**
  112283. * Gets or sets the id of the node
  112284. */
  112285. id: string;
  112286. /**
  112287. * Gets or sets the unique id of the node
  112288. */
  112289. uniqueId: number;
  112290. /**
  112291. * Gets or sets a string used to store user defined state for the node
  112292. */
  112293. state: string;
  112294. /**
  112295. * Gets or sets an object used to store user defined information for the node
  112296. */
  112297. metadata: any;
  112298. /**
  112299. * For internal use only. Please do not use.
  112300. */
  112301. reservedDataStore: any;
  112302. /**
  112303. * List of inspectable custom properties (used by the Inspector)
  112304. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112305. */
  112306. inspectableCustomProperties: IInspectable[];
  112307. private _doNotSerialize;
  112308. /**
  112309. * Gets or sets a boolean used to define if the node must be serialized
  112310. */
  112311. get doNotSerialize(): boolean;
  112312. set doNotSerialize(value: boolean);
  112313. /** @hidden */
  112314. _isDisposed: boolean;
  112315. /**
  112316. * Gets a list of Animations associated with the node
  112317. */
  112318. animations: Animation[];
  112319. protected _ranges: {
  112320. [name: string]: Nullable<AnimationRange>;
  112321. };
  112322. /**
  112323. * Callback raised when the node is ready to be used
  112324. */
  112325. onReady: Nullable<(node: Node) => void>;
  112326. private _isEnabled;
  112327. private _isParentEnabled;
  112328. private _isReady;
  112329. /** @hidden */
  112330. _currentRenderId: number;
  112331. private _parentUpdateId;
  112332. /** @hidden */
  112333. _childUpdateId: number;
  112334. /** @hidden */
  112335. _waitingParentId: Nullable<string>;
  112336. /** @hidden */
  112337. _scene: Scene;
  112338. /** @hidden */
  112339. _cache: any;
  112340. private _parentNode;
  112341. private _children;
  112342. /** @hidden */
  112343. _worldMatrix: Matrix;
  112344. /** @hidden */
  112345. _worldMatrixDeterminant: number;
  112346. /** @hidden */
  112347. _worldMatrixDeterminantIsDirty: boolean;
  112348. /** @hidden */
  112349. private _sceneRootNodesIndex;
  112350. /**
  112351. * Gets a boolean indicating if the node has been disposed
  112352. * @returns true if the node was disposed
  112353. */
  112354. isDisposed(): boolean;
  112355. /**
  112356. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112357. * @see https://doc.babylonjs.com/how_to/parenting
  112358. */
  112359. set parent(parent: Nullable<Node>);
  112360. get parent(): Nullable<Node>;
  112361. /** @hidden */
  112362. _addToSceneRootNodes(): void;
  112363. /** @hidden */
  112364. _removeFromSceneRootNodes(): void;
  112365. private _animationPropertiesOverride;
  112366. /**
  112367. * Gets or sets the animation properties override
  112368. */
  112369. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112370. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112371. /**
  112372. * Gets a string identifying the name of the class
  112373. * @returns "Node" string
  112374. */
  112375. getClassName(): string;
  112376. /** @hidden */
  112377. readonly _isNode: boolean;
  112378. /**
  112379. * An event triggered when the mesh is disposed
  112380. */
  112381. onDisposeObservable: Observable<Node>;
  112382. private _onDisposeObserver;
  112383. /**
  112384. * Sets a callback that will be raised when the node will be disposed
  112385. */
  112386. set onDispose(callback: () => void);
  112387. /**
  112388. * Creates a new Node
  112389. * @param name the name and id to be given to this node
  112390. * @param scene the scene this node will be added to
  112391. */
  112392. constructor(name: string, scene?: Nullable<Scene>);
  112393. /**
  112394. * Gets the scene of the node
  112395. * @returns a scene
  112396. */
  112397. getScene(): Scene;
  112398. /**
  112399. * Gets the engine of the node
  112400. * @returns a Engine
  112401. */
  112402. getEngine(): Engine;
  112403. private _behaviors;
  112404. /**
  112405. * Attach a behavior to the node
  112406. * @see https://doc.babylonjs.com/features/behaviour
  112407. * @param behavior defines the behavior to attach
  112408. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112409. * @returns the current Node
  112410. */
  112411. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112412. /**
  112413. * Remove an attached behavior
  112414. * @see https://doc.babylonjs.com/features/behaviour
  112415. * @param behavior defines the behavior to attach
  112416. * @returns the current Node
  112417. */
  112418. removeBehavior(behavior: Behavior<Node>): Node;
  112419. /**
  112420. * Gets the list of attached behaviors
  112421. * @see https://doc.babylonjs.com/features/behaviour
  112422. */
  112423. get behaviors(): Behavior<Node>[];
  112424. /**
  112425. * Gets an attached behavior by name
  112426. * @param name defines the name of the behavior to look for
  112427. * @see https://doc.babylonjs.com/features/behaviour
  112428. * @returns null if behavior was not found else the requested behavior
  112429. */
  112430. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112431. /**
  112432. * Returns the latest update of the World matrix
  112433. * @returns a Matrix
  112434. */
  112435. getWorldMatrix(): Matrix;
  112436. /** @hidden */
  112437. _getWorldMatrixDeterminant(): number;
  112438. /**
  112439. * Returns directly the latest state of the mesh World matrix.
  112440. * A Matrix is returned.
  112441. */
  112442. get worldMatrixFromCache(): Matrix;
  112443. /** @hidden */
  112444. _initCache(): void;
  112445. /** @hidden */
  112446. updateCache(force?: boolean): void;
  112447. /** @hidden */
  112448. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112449. /** @hidden */
  112450. _updateCache(ignoreParentClass?: boolean): void;
  112451. /** @hidden */
  112452. _isSynchronized(): boolean;
  112453. /** @hidden */
  112454. _markSyncedWithParent(): void;
  112455. /** @hidden */
  112456. isSynchronizedWithParent(): boolean;
  112457. /** @hidden */
  112458. isSynchronized(): boolean;
  112459. /**
  112460. * Is this node ready to be used/rendered
  112461. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112462. * @return true if the node is ready
  112463. */
  112464. isReady(completeCheck?: boolean): boolean;
  112465. /**
  112466. * Is this node enabled?
  112467. * 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
  112468. * @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
  112469. * @return whether this node (and its parent) is enabled
  112470. */
  112471. isEnabled(checkAncestors?: boolean): boolean;
  112472. /** @hidden */
  112473. protected _syncParentEnabledState(): void;
  112474. /**
  112475. * Set the enabled state of this node
  112476. * @param value defines the new enabled state
  112477. */
  112478. setEnabled(value: boolean): void;
  112479. /**
  112480. * Is this node a descendant of the given node?
  112481. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112482. * @param ancestor defines the parent node to inspect
  112483. * @returns a boolean indicating if this node is a descendant of the given node
  112484. */
  112485. isDescendantOf(ancestor: Node): boolean;
  112486. /** @hidden */
  112487. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112488. /**
  112489. * Will return all nodes that have this node as ascendant
  112490. * @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
  112491. * @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
  112492. * @return all children nodes of all types
  112493. */
  112494. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112495. /**
  112496. * Get all child-meshes of this node
  112497. * @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)
  112498. * @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
  112499. * @returns an array of AbstractMesh
  112500. */
  112501. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112502. /**
  112503. * Get all direct children of this node
  112504. * @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
  112505. * @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)
  112506. * @returns an array of Node
  112507. */
  112508. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112509. /** @hidden */
  112510. _setReady(state: boolean): void;
  112511. /**
  112512. * Get an animation by name
  112513. * @param name defines the name of the animation to look for
  112514. * @returns null if not found else the requested animation
  112515. */
  112516. getAnimationByName(name: string): Nullable<Animation>;
  112517. /**
  112518. * Creates an animation range for this node
  112519. * @param name defines the name of the range
  112520. * @param from defines the starting key
  112521. * @param to defines the end key
  112522. */
  112523. createAnimationRange(name: string, from: number, to: number): void;
  112524. /**
  112525. * Delete a specific animation range
  112526. * @param name defines the name of the range to delete
  112527. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112528. */
  112529. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112530. /**
  112531. * Get an animation range by name
  112532. * @param name defines the name of the animation range to look for
  112533. * @returns null if not found else the requested animation range
  112534. */
  112535. getAnimationRange(name: string): Nullable<AnimationRange>;
  112536. /**
  112537. * Gets the list of all animation ranges defined on this node
  112538. * @returns an array
  112539. */
  112540. getAnimationRanges(): Nullable<AnimationRange>[];
  112541. /**
  112542. * Will start the animation sequence
  112543. * @param name defines the range frames for animation sequence
  112544. * @param loop defines if the animation should loop (false by default)
  112545. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  112546. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  112547. * @returns the object created for this animation. If range does not exist, it will return null
  112548. */
  112549. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  112550. /**
  112551. * Serialize animation ranges into a JSON compatible object
  112552. * @returns serialization object
  112553. */
  112554. serializeAnimationRanges(): any;
  112555. /**
  112556. * Computes the world matrix of the node
  112557. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  112558. * @returns the world matrix
  112559. */
  112560. computeWorldMatrix(force?: boolean): Matrix;
  112561. /**
  112562. * Releases resources associated with this node.
  112563. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112564. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112565. */
  112566. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112567. /**
  112568. * Parse animation range data from a serialization object and store them into a given node
  112569. * @param node defines where to store the animation ranges
  112570. * @param parsedNode defines the serialization object to read data from
  112571. * @param scene defines the hosting scene
  112572. */
  112573. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  112574. /**
  112575. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  112576. * @param includeDescendants Include bounding info from descendants as well (true by default)
  112577. * @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
  112578. * @returns the new bounding vectors
  112579. */
  112580. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  112581. min: Vector3;
  112582. max: Vector3;
  112583. };
  112584. }
  112585. }
  112586. declare module BABYLON {
  112587. /**
  112588. * @hidden
  112589. */
  112590. export class _IAnimationState {
  112591. key: number;
  112592. repeatCount: number;
  112593. workValue?: any;
  112594. loopMode?: number;
  112595. offsetValue?: any;
  112596. highLimitValue?: any;
  112597. }
  112598. /**
  112599. * Class used to store any kind of animation
  112600. */
  112601. export class Animation {
  112602. /**Name of the animation */
  112603. name: string;
  112604. /**Property to animate */
  112605. targetProperty: string;
  112606. /**The frames per second of the animation */
  112607. framePerSecond: number;
  112608. /**The data type of the animation */
  112609. dataType: number;
  112610. /**The loop mode of the animation */
  112611. loopMode?: number | undefined;
  112612. /**Specifies if blending should be enabled */
  112613. enableBlending?: boolean | undefined;
  112614. /**
  112615. * Use matrix interpolation instead of using direct key value when animating matrices
  112616. */
  112617. static AllowMatricesInterpolation: boolean;
  112618. /**
  112619. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  112620. */
  112621. static AllowMatrixDecomposeForInterpolation: boolean;
  112622. /** Define the Url to load snippets */
  112623. static SnippetUrl: string;
  112624. /** Snippet ID if the animation was created from the snippet server */
  112625. snippetId: string;
  112626. /**
  112627. * Stores the key frames of the animation
  112628. */
  112629. private _keys;
  112630. /**
  112631. * Stores the easing function of the animation
  112632. */
  112633. private _easingFunction;
  112634. /**
  112635. * @hidden Internal use only
  112636. */
  112637. _runtimeAnimations: RuntimeAnimation[];
  112638. /**
  112639. * The set of event that will be linked to this animation
  112640. */
  112641. private _events;
  112642. /**
  112643. * Stores an array of target property paths
  112644. */
  112645. targetPropertyPath: string[];
  112646. /**
  112647. * Stores the blending speed of the animation
  112648. */
  112649. blendingSpeed: number;
  112650. /**
  112651. * Stores the animation ranges for the animation
  112652. */
  112653. private _ranges;
  112654. /**
  112655. * @hidden Internal use
  112656. */
  112657. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  112658. /**
  112659. * Sets up an animation
  112660. * @param property The property to animate
  112661. * @param animationType The animation type to apply
  112662. * @param framePerSecond The frames per second of the animation
  112663. * @param easingFunction The easing function used in the animation
  112664. * @returns The created animation
  112665. */
  112666. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  112667. /**
  112668. * Create and start an animation on a node
  112669. * @param name defines the name of the global animation that will be run on all nodes
  112670. * @param node defines the root node where the animation will take place
  112671. * @param targetProperty defines property to animate
  112672. * @param framePerSecond defines the number of frame per second yo use
  112673. * @param totalFrame defines the number of frames in total
  112674. * @param from defines the initial value
  112675. * @param to defines the final value
  112676. * @param loopMode defines which loop mode you want to use (off by default)
  112677. * @param easingFunction defines the easing function to use (linear by default)
  112678. * @param onAnimationEnd defines the callback to call when animation end
  112679. * @returns the animatable created for this animation
  112680. */
  112681. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  112682. /**
  112683. * Create and start an animation on a node and its descendants
  112684. * @param name defines the name of the global animation that will be run on all nodes
  112685. * @param node defines the root node where the animation will take place
  112686. * @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
  112687. * @param targetProperty defines property to animate
  112688. * @param framePerSecond defines the number of frame per second to use
  112689. * @param totalFrame defines the number of frames in total
  112690. * @param from defines the initial value
  112691. * @param to defines the final value
  112692. * @param loopMode defines which loop mode you want to use (off by default)
  112693. * @param easingFunction defines the easing function to use (linear by default)
  112694. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  112695. * @returns the list of animatables created for all nodes
  112696. * @example https://www.babylonjs-playground.com/#MH0VLI
  112697. */
  112698. 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[]>;
  112699. /**
  112700. * Creates a new animation, merges it with the existing animations and starts it
  112701. * @param name Name of the animation
  112702. * @param node Node which contains the scene that begins the animations
  112703. * @param targetProperty Specifies which property to animate
  112704. * @param framePerSecond The frames per second of the animation
  112705. * @param totalFrame The total number of frames
  112706. * @param from The frame at the beginning of the animation
  112707. * @param to The frame at the end of the animation
  112708. * @param loopMode Specifies the loop mode of the animation
  112709. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  112710. * @param onAnimationEnd Callback to run once the animation is complete
  112711. * @returns Nullable animation
  112712. */
  112713. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  112714. /**
  112715. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  112716. * @param sourceAnimation defines the Animation containing keyframes to convert
  112717. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  112718. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  112719. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  112720. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  112721. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  112722. */
  112723. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  112724. /**
  112725. * Transition property of an host to the target Value
  112726. * @param property The property to transition
  112727. * @param targetValue The target Value of the property
  112728. * @param host The object where the property to animate belongs
  112729. * @param scene Scene used to run the animation
  112730. * @param frameRate Framerate (in frame/s) to use
  112731. * @param transition The transition type we want to use
  112732. * @param duration The duration of the animation, in milliseconds
  112733. * @param onAnimationEnd Callback trigger at the end of the animation
  112734. * @returns Nullable animation
  112735. */
  112736. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  112737. /**
  112738. * Return the array of runtime animations currently using this animation
  112739. */
  112740. get runtimeAnimations(): RuntimeAnimation[];
  112741. /**
  112742. * Specifies if any of the runtime animations are currently running
  112743. */
  112744. get hasRunningRuntimeAnimations(): boolean;
  112745. /**
  112746. * Initializes the animation
  112747. * @param name Name of the animation
  112748. * @param targetProperty Property to animate
  112749. * @param framePerSecond The frames per second of the animation
  112750. * @param dataType The data type of the animation
  112751. * @param loopMode The loop mode of the animation
  112752. * @param enableBlending Specifies if blending should be enabled
  112753. */
  112754. constructor(
  112755. /**Name of the animation */
  112756. name: string,
  112757. /**Property to animate */
  112758. targetProperty: string,
  112759. /**The frames per second of the animation */
  112760. framePerSecond: number,
  112761. /**The data type of the animation */
  112762. dataType: number,
  112763. /**The loop mode of the animation */
  112764. loopMode?: number | undefined,
  112765. /**Specifies if blending should be enabled */
  112766. enableBlending?: boolean | undefined);
  112767. /**
  112768. * Converts the animation to a string
  112769. * @param fullDetails support for multiple levels of logging within scene loading
  112770. * @returns String form of the animation
  112771. */
  112772. toString(fullDetails?: boolean): string;
  112773. /**
  112774. * Add an event to this animation
  112775. * @param event Event to add
  112776. */
  112777. addEvent(event: AnimationEvent): void;
  112778. /**
  112779. * Remove all events found at the given frame
  112780. * @param frame The frame to remove events from
  112781. */
  112782. removeEvents(frame: number): void;
  112783. /**
  112784. * Retrieves all the events from the animation
  112785. * @returns Events from the animation
  112786. */
  112787. getEvents(): AnimationEvent[];
  112788. /**
  112789. * Creates an animation range
  112790. * @param name Name of the animation range
  112791. * @param from Starting frame of the animation range
  112792. * @param to Ending frame of the animation
  112793. */
  112794. createRange(name: string, from: number, to: number): void;
  112795. /**
  112796. * Deletes an animation range by name
  112797. * @param name Name of the animation range to delete
  112798. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  112799. */
  112800. deleteRange(name: string, deleteFrames?: boolean): void;
  112801. /**
  112802. * Gets the animation range by name, or null if not defined
  112803. * @param name Name of the animation range
  112804. * @returns Nullable animation range
  112805. */
  112806. getRange(name: string): Nullable<AnimationRange>;
  112807. /**
  112808. * Gets the key frames from the animation
  112809. * @returns The key frames of the animation
  112810. */
  112811. getKeys(): Array<IAnimationKey>;
  112812. /**
  112813. * Gets the highest frame rate of the animation
  112814. * @returns Highest frame rate of the animation
  112815. */
  112816. getHighestFrame(): number;
  112817. /**
  112818. * Gets the easing function of the animation
  112819. * @returns Easing function of the animation
  112820. */
  112821. getEasingFunction(): IEasingFunction;
  112822. /**
  112823. * Sets the easing function of the animation
  112824. * @param easingFunction A custom mathematical formula for animation
  112825. */
  112826. setEasingFunction(easingFunction: EasingFunction): void;
  112827. /**
  112828. * Interpolates a scalar linearly
  112829. * @param startValue Start value of the animation curve
  112830. * @param endValue End value of the animation curve
  112831. * @param gradient Scalar amount to interpolate
  112832. * @returns Interpolated scalar value
  112833. */
  112834. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  112835. /**
  112836. * Interpolates a scalar cubically
  112837. * @param startValue Start value of the animation curve
  112838. * @param outTangent End tangent of the animation
  112839. * @param endValue End value of the animation curve
  112840. * @param inTangent Start tangent of the animation curve
  112841. * @param gradient Scalar amount to interpolate
  112842. * @returns Interpolated scalar value
  112843. */
  112844. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  112845. /**
  112846. * Interpolates a quaternion using a spherical linear interpolation
  112847. * @param startValue Start value of the animation curve
  112848. * @param endValue End value of the animation curve
  112849. * @param gradient Scalar amount to interpolate
  112850. * @returns Interpolated quaternion value
  112851. */
  112852. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  112853. /**
  112854. * Interpolates a quaternion cubically
  112855. * @param startValue Start value of the animation curve
  112856. * @param outTangent End tangent of the animation curve
  112857. * @param endValue End value of the animation curve
  112858. * @param inTangent Start tangent of the animation curve
  112859. * @param gradient Scalar amount to interpolate
  112860. * @returns Interpolated quaternion value
  112861. */
  112862. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  112863. /**
  112864. * Interpolates a Vector3 linearl
  112865. * @param startValue Start value of the animation curve
  112866. * @param endValue End value of the animation curve
  112867. * @param gradient Scalar amount to interpolate
  112868. * @returns Interpolated scalar value
  112869. */
  112870. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  112871. /**
  112872. * Interpolates a Vector3 cubically
  112873. * @param startValue Start value of the animation curve
  112874. * @param outTangent End tangent of the animation
  112875. * @param endValue End value of the animation curve
  112876. * @param inTangent Start tangent of the animation curve
  112877. * @param gradient Scalar amount to interpolate
  112878. * @returns InterpolatedVector3 value
  112879. */
  112880. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  112881. /**
  112882. * Interpolates a Vector2 linearly
  112883. * @param startValue Start value of the animation curve
  112884. * @param endValue End value of the animation curve
  112885. * @param gradient Scalar amount to interpolate
  112886. * @returns Interpolated Vector2 value
  112887. */
  112888. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  112889. /**
  112890. * Interpolates a Vector2 cubically
  112891. * @param startValue Start value of the animation curve
  112892. * @param outTangent End tangent of the animation
  112893. * @param endValue End value of the animation curve
  112894. * @param inTangent Start tangent of the animation curve
  112895. * @param gradient Scalar amount to interpolate
  112896. * @returns Interpolated Vector2 value
  112897. */
  112898. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  112899. /**
  112900. * Interpolates a size linearly
  112901. * @param startValue Start value of the animation curve
  112902. * @param endValue End value of the animation curve
  112903. * @param gradient Scalar amount to interpolate
  112904. * @returns Interpolated Size value
  112905. */
  112906. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  112907. /**
  112908. * Interpolates a Color3 linearly
  112909. * @param startValue Start value of the animation curve
  112910. * @param endValue End value of the animation curve
  112911. * @param gradient Scalar amount to interpolate
  112912. * @returns Interpolated Color3 value
  112913. */
  112914. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  112915. /**
  112916. * Interpolates a Color4 linearly
  112917. * @param startValue Start value of the animation curve
  112918. * @param endValue End value of the animation curve
  112919. * @param gradient Scalar amount to interpolate
  112920. * @returns Interpolated Color3 value
  112921. */
  112922. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  112923. /**
  112924. * @hidden Internal use only
  112925. */
  112926. _getKeyValue(value: any): any;
  112927. /**
  112928. * @hidden Internal use only
  112929. */
  112930. _interpolate(currentFrame: number, state: _IAnimationState): any;
  112931. /**
  112932. * Defines the function to use to interpolate matrices
  112933. * @param startValue defines the start matrix
  112934. * @param endValue defines the end matrix
  112935. * @param gradient defines the gradient between both matrices
  112936. * @param result defines an optional target matrix where to store the interpolation
  112937. * @returns the interpolated matrix
  112938. */
  112939. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  112940. /**
  112941. * Makes a copy of the animation
  112942. * @returns Cloned animation
  112943. */
  112944. clone(): Animation;
  112945. /**
  112946. * Sets the key frames of the animation
  112947. * @param values The animation key frames to set
  112948. */
  112949. setKeys(values: Array<IAnimationKey>): void;
  112950. /**
  112951. * Serializes the animation to an object
  112952. * @returns Serialized object
  112953. */
  112954. serialize(): any;
  112955. /**
  112956. * Float animation type
  112957. */
  112958. static readonly ANIMATIONTYPE_FLOAT: number;
  112959. /**
  112960. * Vector3 animation type
  112961. */
  112962. static readonly ANIMATIONTYPE_VECTOR3: number;
  112963. /**
  112964. * Quaternion animation type
  112965. */
  112966. static readonly ANIMATIONTYPE_QUATERNION: number;
  112967. /**
  112968. * Matrix animation type
  112969. */
  112970. static readonly ANIMATIONTYPE_MATRIX: number;
  112971. /**
  112972. * Color3 animation type
  112973. */
  112974. static readonly ANIMATIONTYPE_COLOR3: number;
  112975. /**
  112976. * Color3 animation type
  112977. */
  112978. static readonly ANIMATIONTYPE_COLOR4: number;
  112979. /**
  112980. * Vector2 animation type
  112981. */
  112982. static readonly ANIMATIONTYPE_VECTOR2: number;
  112983. /**
  112984. * Size animation type
  112985. */
  112986. static readonly ANIMATIONTYPE_SIZE: number;
  112987. /**
  112988. * Relative Loop Mode
  112989. */
  112990. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  112991. /**
  112992. * Cycle Loop Mode
  112993. */
  112994. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  112995. /**
  112996. * Constant Loop Mode
  112997. */
  112998. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  112999. /** @hidden */
  113000. static _UniversalLerp(left: any, right: any, amount: number): any;
  113001. /**
  113002. * Parses an animation object and creates an animation
  113003. * @param parsedAnimation Parsed animation object
  113004. * @returns Animation object
  113005. */
  113006. static Parse(parsedAnimation: any): Animation;
  113007. /**
  113008. * Appends the serialized animations from the source animations
  113009. * @param source Source containing the animations
  113010. * @param destination Target to store the animations
  113011. */
  113012. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113013. /**
  113014. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113015. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113016. * @param url defines the url to load from
  113017. * @returns a promise that will resolve to the new animation or an array of animations
  113018. */
  113019. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113020. /**
  113021. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113022. * @param snippetId defines the snippet to load
  113023. * @returns a promise that will resolve to the new animation or a new array of animations
  113024. */
  113025. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113026. }
  113027. }
  113028. declare module BABYLON {
  113029. /**
  113030. * Interface containing an array of animations
  113031. */
  113032. export interface IAnimatable {
  113033. /**
  113034. * Array of animations
  113035. */
  113036. animations: Nullable<Array<Animation>>;
  113037. }
  113038. }
  113039. declare module BABYLON {
  113040. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113041. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113042. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113043. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113044. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113045. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113046. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113047. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113048. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113049. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113050. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113051. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113052. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113053. /**
  113054. * Decorator used to define property that can be serialized as reference to a camera
  113055. * @param sourceName defines the name of the property to decorate
  113056. */
  113057. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113058. /**
  113059. * Class used to help serialization objects
  113060. */
  113061. export class SerializationHelper {
  113062. /** @hidden */
  113063. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113064. /** @hidden */
  113065. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113066. /** @hidden */
  113067. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113068. /** @hidden */
  113069. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113070. /**
  113071. * Appends the serialized animations from the source animations
  113072. * @param source Source containing the animations
  113073. * @param destination Target to store the animations
  113074. */
  113075. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113076. /**
  113077. * Static function used to serialized a specific entity
  113078. * @param entity defines the entity to serialize
  113079. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113080. * @returns a JSON compatible object representing the serialization of the entity
  113081. */
  113082. static Serialize<T>(entity: T, serializationObject?: any): any;
  113083. /**
  113084. * Creates a new entity from a serialization data object
  113085. * @param creationFunction defines a function used to instanciated the new entity
  113086. * @param source defines the source serialization data
  113087. * @param scene defines the hosting scene
  113088. * @param rootUrl defines the root url for resources
  113089. * @returns a new entity
  113090. */
  113091. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113092. /**
  113093. * Clones an object
  113094. * @param creationFunction defines the function used to instanciate the new object
  113095. * @param source defines the source object
  113096. * @returns the cloned object
  113097. */
  113098. static Clone<T>(creationFunction: () => T, source: T): T;
  113099. /**
  113100. * Instanciates a new object based on a source one (some data will be shared between both object)
  113101. * @param creationFunction defines the function used to instanciate the new object
  113102. * @param source defines the source object
  113103. * @returns the new object
  113104. */
  113105. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113106. }
  113107. }
  113108. declare module BABYLON {
  113109. /**
  113110. * Base class of all the textures in babylon.
  113111. * It groups all the common properties the materials, post process, lights... might need
  113112. * in order to make a correct use of the texture.
  113113. */
  113114. export class BaseTexture implements IAnimatable {
  113115. /**
  113116. * Default anisotropic filtering level for the application.
  113117. * It is set to 4 as a good tradeoff between perf and quality.
  113118. */
  113119. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113120. /**
  113121. * Gets or sets the unique id of the texture
  113122. */
  113123. uniqueId: number;
  113124. /**
  113125. * Define the name of the texture.
  113126. */
  113127. name: string;
  113128. /**
  113129. * Gets or sets an object used to store user defined information.
  113130. */
  113131. metadata: any;
  113132. /**
  113133. * For internal use only. Please do not use.
  113134. */
  113135. reservedDataStore: any;
  113136. private _hasAlpha;
  113137. /**
  113138. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113139. */
  113140. set hasAlpha(value: boolean);
  113141. get hasAlpha(): boolean;
  113142. /**
  113143. * Defines if the alpha value should be determined via the rgb values.
  113144. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113145. */
  113146. getAlphaFromRGB: boolean;
  113147. /**
  113148. * Intensity or strength of the texture.
  113149. * It is commonly used by materials to fine tune the intensity of the texture
  113150. */
  113151. level: number;
  113152. /**
  113153. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113154. * This is part of the texture as textures usually maps to one uv set.
  113155. */
  113156. coordinatesIndex: number;
  113157. private _coordinatesMode;
  113158. /**
  113159. * How a texture is mapped.
  113160. *
  113161. * | Value | Type | Description |
  113162. * | ----- | ----------------------------------- | ----------- |
  113163. * | 0 | EXPLICIT_MODE | |
  113164. * | 1 | SPHERICAL_MODE | |
  113165. * | 2 | PLANAR_MODE | |
  113166. * | 3 | CUBIC_MODE | |
  113167. * | 4 | PROJECTION_MODE | |
  113168. * | 5 | SKYBOX_MODE | |
  113169. * | 6 | INVCUBIC_MODE | |
  113170. * | 7 | EQUIRECTANGULAR_MODE | |
  113171. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113172. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113173. */
  113174. set coordinatesMode(value: number);
  113175. get coordinatesMode(): number;
  113176. /**
  113177. * | Value | Type | Description |
  113178. * | ----- | ------------------ | ----------- |
  113179. * | 0 | CLAMP_ADDRESSMODE | |
  113180. * | 1 | WRAP_ADDRESSMODE | |
  113181. * | 2 | MIRROR_ADDRESSMODE | |
  113182. */
  113183. wrapU: number;
  113184. /**
  113185. * | Value | Type | Description |
  113186. * | ----- | ------------------ | ----------- |
  113187. * | 0 | CLAMP_ADDRESSMODE | |
  113188. * | 1 | WRAP_ADDRESSMODE | |
  113189. * | 2 | MIRROR_ADDRESSMODE | |
  113190. */
  113191. wrapV: number;
  113192. /**
  113193. * | Value | Type | Description |
  113194. * | ----- | ------------------ | ----------- |
  113195. * | 0 | CLAMP_ADDRESSMODE | |
  113196. * | 1 | WRAP_ADDRESSMODE | |
  113197. * | 2 | MIRROR_ADDRESSMODE | |
  113198. */
  113199. wrapR: number;
  113200. /**
  113201. * With compliant hardware and browser (supporting anisotropic filtering)
  113202. * this defines the level of anisotropic filtering in the texture.
  113203. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113204. */
  113205. anisotropicFilteringLevel: number;
  113206. /**
  113207. * Define if the texture is a cube texture or if false a 2d texture.
  113208. */
  113209. get isCube(): boolean;
  113210. set isCube(value: boolean);
  113211. /**
  113212. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113213. */
  113214. get is3D(): boolean;
  113215. set is3D(value: boolean);
  113216. /**
  113217. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113218. */
  113219. get is2DArray(): boolean;
  113220. set is2DArray(value: boolean);
  113221. /**
  113222. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113223. * HDR texture are usually stored in linear space.
  113224. * This only impacts the PBR and Background materials
  113225. */
  113226. gammaSpace: boolean;
  113227. /**
  113228. * Gets or sets whether or not the texture contains RGBD data.
  113229. */
  113230. get isRGBD(): boolean;
  113231. set isRGBD(value: boolean);
  113232. /**
  113233. * Is Z inverted in the texture (useful in a cube texture).
  113234. */
  113235. invertZ: boolean;
  113236. /**
  113237. * Are mip maps generated for this texture or not.
  113238. */
  113239. get noMipmap(): boolean;
  113240. /**
  113241. * @hidden
  113242. */
  113243. lodLevelInAlpha: boolean;
  113244. /**
  113245. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113246. */
  113247. get lodGenerationOffset(): number;
  113248. set lodGenerationOffset(value: number);
  113249. /**
  113250. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113251. */
  113252. get lodGenerationScale(): number;
  113253. set lodGenerationScale(value: number);
  113254. /**
  113255. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113256. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113257. * average roughness values.
  113258. */
  113259. get linearSpecularLOD(): boolean;
  113260. set linearSpecularLOD(value: boolean);
  113261. /**
  113262. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113263. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113264. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113265. */
  113266. get irradianceTexture(): Nullable<BaseTexture>;
  113267. set irradianceTexture(value: Nullable<BaseTexture>);
  113268. /**
  113269. * Define if the texture is a render target.
  113270. */
  113271. isRenderTarget: boolean;
  113272. /**
  113273. * Define the unique id of the texture in the scene.
  113274. */
  113275. get uid(): string;
  113276. /** @hidden */
  113277. _prefiltered: boolean;
  113278. /**
  113279. * Return a string representation of the texture.
  113280. * @returns the texture as a string
  113281. */
  113282. toString(): string;
  113283. /**
  113284. * Get the class name of the texture.
  113285. * @returns "BaseTexture"
  113286. */
  113287. getClassName(): string;
  113288. /**
  113289. * Define the list of animation attached to the texture.
  113290. */
  113291. animations: Animation[];
  113292. /**
  113293. * An event triggered when the texture is disposed.
  113294. */
  113295. onDisposeObservable: Observable<BaseTexture>;
  113296. private _onDisposeObserver;
  113297. /**
  113298. * Callback triggered when the texture has been disposed.
  113299. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113300. */
  113301. set onDispose(callback: () => void);
  113302. /**
  113303. * Define the current state of the loading sequence when in delayed load mode.
  113304. */
  113305. delayLoadState: number;
  113306. protected _scene: Nullable<Scene>;
  113307. protected _engine: Nullable<ThinEngine>;
  113308. /** @hidden */
  113309. _texture: Nullable<InternalTexture>;
  113310. private _uid;
  113311. /**
  113312. * Define if the texture is preventinga material to render or not.
  113313. * If not and the texture is not ready, the engine will use a default black texture instead.
  113314. */
  113315. get isBlocking(): boolean;
  113316. /**
  113317. * Instantiates a new BaseTexture.
  113318. * Base class of all the textures in babylon.
  113319. * It groups all the common properties the materials, post process, lights... might need
  113320. * in order to make a correct use of the texture.
  113321. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113322. */
  113323. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113324. /**
  113325. * Get the scene the texture belongs to.
  113326. * @returns the scene or null if undefined
  113327. */
  113328. getScene(): Nullable<Scene>;
  113329. /** @hidden */
  113330. protected _getEngine(): Nullable<ThinEngine>;
  113331. /**
  113332. * Get the texture transform matrix used to offset tile the texture for istance.
  113333. * @returns the transformation matrix
  113334. */
  113335. getTextureMatrix(): Matrix;
  113336. /**
  113337. * Get the texture reflection matrix used to rotate/transform the reflection.
  113338. * @returns the reflection matrix
  113339. */
  113340. getReflectionTextureMatrix(): Matrix;
  113341. /**
  113342. * Get the underlying lower level texture from Babylon.
  113343. * @returns the insternal texture
  113344. */
  113345. getInternalTexture(): Nullable<InternalTexture>;
  113346. /**
  113347. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113348. * @returns true if ready or not blocking
  113349. */
  113350. isReadyOrNotBlocking(): boolean;
  113351. /**
  113352. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113353. * @returns true if fully ready
  113354. */
  113355. isReady(): boolean;
  113356. private _cachedSize;
  113357. /**
  113358. * Get the size of the texture.
  113359. * @returns the texture size.
  113360. */
  113361. getSize(): ISize;
  113362. /**
  113363. * Get the base size of the texture.
  113364. * It can be different from the size if the texture has been resized for POT for instance
  113365. * @returns the base size
  113366. */
  113367. getBaseSize(): ISize;
  113368. /**
  113369. * Update the sampling mode of the texture.
  113370. * Default is Trilinear mode.
  113371. *
  113372. * | Value | Type | Description |
  113373. * | ----- | ------------------ | ----------- |
  113374. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113375. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113376. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113377. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113378. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113379. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113380. * | 7 | NEAREST_LINEAR | |
  113381. * | 8 | NEAREST_NEAREST | |
  113382. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113383. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113384. * | 11 | LINEAR_LINEAR | |
  113385. * | 12 | LINEAR_NEAREST | |
  113386. *
  113387. * > _mag_: magnification filter (close to the viewer)
  113388. * > _min_: minification filter (far from the viewer)
  113389. * > _mip_: filter used between mip map levels
  113390. *@param samplingMode Define the new sampling mode of the texture
  113391. */
  113392. updateSamplingMode(samplingMode: number): void;
  113393. /**
  113394. * Scales the texture if is `canRescale()`
  113395. * @param ratio the resize factor we want to use to rescale
  113396. */
  113397. scale(ratio: number): void;
  113398. /**
  113399. * Get if the texture can rescale.
  113400. */
  113401. get canRescale(): boolean;
  113402. /** @hidden */
  113403. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113404. /** @hidden */
  113405. _rebuild(): void;
  113406. /**
  113407. * Triggers the load sequence in delayed load mode.
  113408. */
  113409. delayLoad(): void;
  113410. /**
  113411. * Clones the texture.
  113412. * @returns the cloned texture
  113413. */
  113414. clone(): Nullable<BaseTexture>;
  113415. /**
  113416. * Get the texture underlying type (INT, FLOAT...)
  113417. */
  113418. get textureType(): number;
  113419. /**
  113420. * Get the texture underlying format (RGB, RGBA...)
  113421. */
  113422. get textureFormat(): number;
  113423. /**
  113424. * Indicates that textures need to be re-calculated for all materials
  113425. */
  113426. protected _markAllSubMeshesAsTexturesDirty(): void;
  113427. /**
  113428. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113429. * This will returns an RGBA array buffer containing either in values (0-255) or
  113430. * float values (0-1) depending of the underlying buffer type.
  113431. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113432. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113433. * @param buffer defines a user defined buffer to fill with data (can be null)
  113434. * @returns The Array buffer containing the pixels data.
  113435. */
  113436. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113437. /**
  113438. * Release and destroy the underlying lower level texture aka internalTexture.
  113439. */
  113440. releaseInternalTexture(): void;
  113441. /** @hidden */
  113442. get _lodTextureHigh(): Nullable<BaseTexture>;
  113443. /** @hidden */
  113444. get _lodTextureMid(): Nullable<BaseTexture>;
  113445. /** @hidden */
  113446. get _lodTextureLow(): Nullable<BaseTexture>;
  113447. /**
  113448. * Dispose the texture and release its associated resources.
  113449. */
  113450. dispose(): void;
  113451. /**
  113452. * Serialize the texture into a JSON representation that can be parsed later on.
  113453. * @returns the JSON representation of the texture
  113454. */
  113455. serialize(): any;
  113456. /**
  113457. * Helper function to be called back once a list of texture contains only ready textures.
  113458. * @param textures Define the list of textures to wait for
  113459. * @param callback Define the callback triggered once the entire list will be ready
  113460. */
  113461. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113462. private static _isScene;
  113463. }
  113464. }
  113465. declare module BABYLON {
  113466. /**
  113467. * Options to be used when creating an effect.
  113468. */
  113469. export interface IEffectCreationOptions {
  113470. /**
  113471. * Atrributes that will be used in the shader.
  113472. */
  113473. attributes: string[];
  113474. /**
  113475. * Uniform varible names that will be set in the shader.
  113476. */
  113477. uniformsNames: string[];
  113478. /**
  113479. * Uniform buffer variable names that will be set in the shader.
  113480. */
  113481. uniformBuffersNames: string[];
  113482. /**
  113483. * Sampler texture variable names that will be set in the shader.
  113484. */
  113485. samplers: string[];
  113486. /**
  113487. * Define statements that will be set in the shader.
  113488. */
  113489. defines: any;
  113490. /**
  113491. * Possible fallbacks for this effect to improve performance when needed.
  113492. */
  113493. fallbacks: Nullable<IEffectFallbacks>;
  113494. /**
  113495. * Callback that will be called when the shader is compiled.
  113496. */
  113497. onCompiled: Nullable<(effect: Effect) => void>;
  113498. /**
  113499. * Callback that will be called if an error occurs during shader compilation.
  113500. */
  113501. onError: Nullable<(effect: Effect, errors: string) => void>;
  113502. /**
  113503. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113504. */
  113505. indexParameters?: any;
  113506. /**
  113507. * Max number of lights that can be used in the shader.
  113508. */
  113509. maxSimultaneousLights?: number;
  113510. /**
  113511. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113512. */
  113513. transformFeedbackVaryings?: Nullable<string[]>;
  113514. /**
  113515. * 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
  113516. */
  113517. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113518. /**
  113519. * Is this effect rendering to several color attachments ?
  113520. */
  113521. multiTarget?: boolean;
  113522. }
  113523. /**
  113524. * Effect containing vertex and fragment shader that can be executed on an object.
  113525. */
  113526. export class Effect implements IDisposable {
  113527. /**
  113528. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113529. */
  113530. static ShadersRepository: string;
  113531. /**
  113532. * Enable logging of the shader code when a compilation error occurs
  113533. */
  113534. static LogShaderCodeOnCompilationError: boolean;
  113535. /**
  113536. * Name of the effect.
  113537. */
  113538. name: any;
  113539. /**
  113540. * String container all the define statements that should be set on the shader.
  113541. */
  113542. defines: string;
  113543. /**
  113544. * Callback that will be called when the shader is compiled.
  113545. */
  113546. onCompiled: Nullable<(effect: Effect) => void>;
  113547. /**
  113548. * Callback that will be called if an error occurs during shader compilation.
  113549. */
  113550. onError: Nullable<(effect: Effect, errors: string) => void>;
  113551. /**
  113552. * Callback that will be called when effect is bound.
  113553. */
  113554. onBind: Nullable<(effect: Effect) => void>;
  113555. /**
  113556. * Unique ID of the effect.
  113557. */
  113558. uniqueId: number;
  113559. /**
  113560. * Observable that will be called when the shader is compiled.
  113561. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  113562. */
  113563. onCompileObservable: Observable<Effect>;
  113564. /**
  113565. * Observable that will be called if an error occurs during shader compilation.
  113566. */
  113567. onErrorObservable: Observable<Effect>;
  113568. /** @hidden */
  113569. _onBindObservable: Nullable<Observable<Effect>>;
  113570. /**
  113571. * @hidden
  113572. * Specifies if the effect was previously ready
  113573. */
  113574. _wasPreviouslyReady: boolean;
  113575. /**
  113576. * Observable that will be called when effect is bound.
  113577. */
  113578. get onBindObservable(): Observable<Effect>;
  113579. /** @hidden */
  113580. _bonesComputationForcedToCPU: boolean;
  113581. /** @hidden */
  113582. _multiTarget: boolean;
  113583. private static _uniqueIdSeed;
  113584. private _engine;
  113585. private _uniformBuffersNames;
  113586. private _uniformBuffersNamesList;
  113587. private _uniformsNames;
  113588. private _samplerList;
  113589. private _samplers;
  113590. private _isReady;
  113591. private _compilationError;
  113592. private _allFallbacksProcessed;
  113593. private _attributesNames;
  113594. private _attributes;
  113595. private _attributeLocationByName;
  113596. private _uniforms;
  113597. /**
  113598. * Key for the effect.
  113599. * @hidden
  113600. */
  113601. _key: string;
  113602. private _indexParameters;
  113603. private _fallbacks;
  113604. private _vertexSourceCode;
  113605. private _fragmentSourceCode;
  113606. private _vertexSourceCodeOverride;
  113607. private _fragmentSourceCodeOverride;
  113608. private _transformFeedbackVaryings;
  113609. /**
  113610. * Compiled shader to webGL program.
  113611. * @hidden
  113612. */
  113613. _pipelineContext: Nullable<IPipelineContext>;
  113614. private _valueCache;
  113615. private static _baseCache;
  113616. /**
  113617. * Instantiates an effect.
  113618. * An effect can be used to create/manage/execute vertex and fragment shaders.
  113619. * @param baseName Name of the effect.
  113620. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  113621. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  113622. * @param samplers List of sampler variables that will be passed to the shader.
  113623. * @param engine Engine to be used to render the effect
  113624. * @param defines Define statements to be added to the shader.
  113625. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  113626. * @param onCompiled Callback that will be called when the shader is compiled.
  113627. * @param onError Callback that will be called if an error occurs during shader compilation.
  113628. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113629. */
  113630. 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);
  113631. private _useFinalCode;
  113632. /**
  113633. * Unique key for this effect
  113634. */
  113635. get key(): string;
  113636. /**
  113637. * If the effect has been compiled and prepared.
  113638. * @returns if the effect is compiled and prepared.
  113639. */
  113640. isReady(): boolean;
  113641. private _isReadyInternal;
  113642. /**
  113643. * The engine the effect was initialized with.
  113644. * @returns the engine.
  113645. */
  113646. getEngine(): Engine;
  113647. /**
  113648. * The pipeline context for this effect
  113649. * @returns the associated pipeline context
  113650. */
  113651. getPipelineContext(): Nullable<IPipelineContext>;
  113652. /**
  113653. * The set of names of attribute variables for the shader.
  113654. * @returns An array of attribute names.
  113655. */
  113656. getAttributesNames(): string[];
  113657. /**
  113658. * Returns the attribute at the given index.
  113659. * @param index The index of the attribute.
  113660. * @returns The location of the attribute.
  113661. */
  113662. getAttributeLocation(index: number): number;
  113663. /**
  113664. * Returns the attribute based on the name of the variable.
  113665. * @param name of the attribute to look up.
  113666. * @returns the attribute location.
  113667. */
  113668. getAttributeLocationByName(name: string): number;
  113669. /**
  113670. * The number of attributes.
  113671. * @returns the numnber of attributes.
  113672. */
  113673. getAttributesCount(): number;
  113674. /**
  113675. * Gets the index of a uniform variable.
  113676. * @param uniformName of the uniform to look up.
  113677. * @returns the index.
  113678. */
  113679. getUniformIndex(uniformName: string): number;
  113680. /**
  113681. * Returns the attribute based on the name of the variable.
  113682. * @param uniformName of the uniform to look up.
  113683. * @returns the location of the uniform.
  113684. */
  113685. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  113686. /**
  113687. * Returns an array of sampler variable names
  113688. * @returns The array of sampler variable names.
  113689. */
  113690. getSamplers(): string[];
  113691. /**
  113692. * Returns an array of uniform variable names
  113693. * @returns The array of uniform variable names.
  113694. */
  113695. getUniformNames(): string[];
  113696. /**
  113697. * Returns an array of uniform buffer variable names
  113698. * @returns The array of uniform buffer variable names.
  113699. */
  113700. getUniformBuffersNames(): string[];
  113701. /**
  113702. * Returns the index parameters used to create the effect
  113703. * @returns The index parameters object
  113704. */
  113705. getIndexParameters(): any;
  113706. /**
  113707. * The error from the last compilation.
  113708. * @returns the error string.
  113709. */
  113710. getCompilationError(): string;
  113711. /**
  113712. * Gets a boolean indicating that all fallbacks were used during compilation
  113713. * @returns true if all fallbacks were used
  113714. */
  113715. allFallbacksProcessed(): boolean;
  113716. /**
  113717. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  113718. * @param func The callback to be used.
  113719. */
  113720. executeWhenCompiled(func: (effect: Effect) => void): void;
  113721. private _checkIsReady;
  113722. private _loadShader;
  113723. /**
  113724. * Gets the vertex shader source code of this effect
  113725. */
  113726. get vertexSourceCode(): string;
  113727. /**
  113728. * Gets the fragment shader source code of this effect
  113729. */
  113730. get fragmentSourceCode(): string;
  113731. /**
  113732. * Recompiles the webGL program
  113733. * @param vertexSourceCode The source code for the vertex shader.
  113734. * @param fragmentSourceCode The source code for the fragment shader.
  113735. * @param onCompiled Callback called when completed.
  113736. * @param onError Callback called on error.
  113737. * @hidden
  113738. */
  113739. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  113740. /**
  113741. * Prepares the effect
  113742. * @hidden
  113743. */
  113744. _prepareEffect(): void;
  113745. private _getShaderCodeAndErrorLine;
  113746. private _processCompilationErrors;
  113747. /**
  113748. * Checks if the effect is supported. (Must be called after compilation)
  113749. */
  113750. get isSupported(): boolean;
  113751. /**
  113752. * Binds a texture to the engine to be used as output of the shader.
  113753. * @param channel Name of the output variable.
  113754. * @param texture Texture to bind.
  113755. * @hidden
  113756. */
  113757. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  113758. /**
  113759. * Sets a texture on the engine to be used in the shader.
  113760. * @param channel Name of the sampler variable.
  113761. * @param texture Texture to set.
  113762. */
  113763. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  113764. /**
  113765. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  113766. * @param channel Name of the sampler variable.
  113767. * @param texture Texture to set.
  113768. */
  113769. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  113770. /**
  113771. * Sets an array of textures on the engine to be used in the shader.
  113772. * @param channel Name of the variable.
  113773. * @param textures Textures to set.
  113774. */
  113775. setTextureArray(channel: string, textures: BaseTexture[]): void;
  113776. /**
  113777. * 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)
  113778. * @param channel Name of the sampler variable.
  113779. * @param postProcess Post process to get the input texture from.
  113780. */
  113781. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  113782. /**
  113783. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  113784. * 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)
  113785. * @param channel Name of the sampler variable.
  113786. * @param postProcess Post process to get the output texture from.
  113787. */
  113788. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  113789. /** @hidden */
  113790. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  113791. /** @hidden */
  113792. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  113793. /** @hidden */
  113794. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  113795. /** @hidden */
  113796. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  113797. /**
  113798. * Binds a buffer to a uniform.
  113799. * @param buffer Buffer to bind.
  113800. * @param name Name of the uniform variable to bind to.
  113801. */
  113802. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  113803. /**
  113804. * Binds block to a uniform.
  113805. * @param blockName Name of the block to bind.
  113806. * @param index Index to bind.
  113807. */
  113808. bindUniformBlock(blockName: string, index: number): void;
  113809. /**
  113810. * Sets an interger value on a uniform variable.
  113811. * @param uniformName Name of the variable.
  113812. * @param value Value to be set.
  113813. * @returns this effect.
  113814. */
  113815. setInt(uniformName: string, value: number): Effect;
  113816. /**
  113817. * Sets an int array on a uniform variable.
  113818. * @param uniformName Name of the variable.
  113819. * @param array array to be set.
  113820. * @returns this effect.
  113821. */
  113822. setIntArray(uniformName: string, array: Int32Array): Effect;
  113823. /**
  113824. * 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)
  113825. * @param uniformName Name of the variable.
  113826. * @param array array to be set.
  113827. * @returns this effect.
  113828. */
  113829. setIntArray2(uniformName: string, array: Int32Array): Effect;
  113830. /**
  113831. * 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)
  113832. * @param uniformName Name of the variable.
  113833. * @param array array to be set.
  113834. * @returns this effect.
  113835. */
  113836. setIntArray3(uniformName: string, array: Int32Array): Effect;
  113837. /**
  113838. * 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)
  113839. * @param uniformName Name of the variable.
  113840. * @param array array to be set.
  113841. * @returns this effect.
  113842. */
  113843. setIntArray4(uniformName: string, array: Int32Array): Effect;
  113844. /**
  113845. * Sets an float array on a uniform variable.
  113846. * @param uniformName Name of the variable.
  113847. * @param array array to be set.
  113848. * @returns this effect.
  113849. */
  113850. setFloatArray(uniformName: string, array: Float32Array): Effect;
  113851. /**
  113852. * 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)
  113853. * @param uniformName Name of the variable.
  113854. * @param array array to be set.
  113855. * @returns this effect.
  113856. */
  113857. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  113858. /**
  113859. * 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)
  113860. * @param uniformName Name of the variable.
  113861. * @param array array to be set.
  113862. * @returns this effect.
  113863. */
  113864. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  113865. /**
  113866. * 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)
  113867. * @param uniformName Name of the variable.
  113868. * @param array array to be set.
  113869. * @returns this effect.
  113870. */
  113871. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  113872. /**
  113873. * Sets an array on a uniform variable.
  113874. * @param uniformName Name of the variable.
  113875. * @param array array to be set.
  113876. * @returns this effect.
  113877. */
  113878. setArray(uniformName: string, array: number[]): Effect;
  113879. /**
  113880. * 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)
  113881. * @param uniformName Name of the variable.
  113882. * @param array array to be set.
  113883. * @returns this effect.
  113884. */
  113885. setArray2(uniformName: string, array: number[]): Effect;
  113886. /**
  113887. * 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)
  113888. * @param uniformName Name of the variable.
  113889. * @param array array to be set.
  113890. * @returns this effect.
  113891. */
  113892. setArray3(uniformName: string, array: number[]): Effect;
  113893. /**
  113894. * 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)
  113895. * @param uniformName Name of the variable.
  113896. * @param array array to be set.
  113897. * @returns this effect.
  113898. */
  113899. setArray4(uniformName: string, array: number[]): Effect;
  113900. /**
  113901. * Sets matrices on a uniform variable.
  113902. * @param uniformName Name of the variable.
  113903. * @param matrices matrices to be set.
  113904. * @returns this effect.
  113905. */
  113906. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  113907. /**
  113908. * Sets matrix on a uniform variable.
  113909. * @param uniformName Name of the variable.
  113910. * @param matrix matrix to be set.
  113911. * @returns this effect.
  113912. */
  113913. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  113914. /**
  113915. * 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)
  113916. * @param uniformName Name of the variable.
  113917. * @param matrix matrix to be set.
  113918. * @returns this effect.
  113919. */
  113920. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  113921. /**
  113922. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  113923. * @param uniformName Name of the variable.
  113924. * @param matrix matrix to be set.
  113925. * @returns this effect.
  113926. */
  113927. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  113928. /**
  113929. * Sets a float on a uniform variable.
  113930. * @param uniformName Name of the variable.
  113931. * @param value value to be set.
  113932. * @returns this effect.
  113933. */
  113934. setFloat(uniformName: string, value: number): Effect;
  113935. /**
  113936. * Sets a boolean on a uniform variable.
  113937. * @param uniformName Name of the variable.
  113938. * @param bool value to be set.
  113939. * @returns this effect.
  113940. */
  113941. setBool(uniformName: string, bool: boolean): Effect;
  113942. /**
  113943. * Sets a Vector2 on a uniform variable.
  113944. * @param uniformName Name of the variable.
  113945. * @param vector2 vector2 to be set.
  113946. * @returns this effect.
  113947. */
  113948. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  113949. /**
  113950. * Sets a float2 on a uniform variable.
  113951. * @param uniformName Name of the variable.
  113952. * @param x First float in float2.
  113953. * @param y Second float in float2.
  113954. * @returns this effect.
  113955. */
  113956. setFloat2(uniformName: string, x: number, y: number): Effect;
  113957. /**
  113958. * Sets a Vector3 on a uniform variable.
  113959. * @param uniformName Name of the variable.
  113960. * @param vector3 Value to be set.
  113961. * @returns this effect.
  113962. */
  113963. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  113964. /**
  113965. * Sets a float3 on a uniform variable.
  113966. * @param uniformName Name of the variable.
  113967. * @param x First float in float3.
  113968. * @param y Second float in float3.
  113969. * @param z Third float in float3.
  113970. * @returns this effect.
  113971. */
  113972. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  113973. /**
  113974. * Sets a Vector4 on a uniform variable.
  113975. * @param uniformName Name of the variable.
  113976. * @param vector4 Value to be set.
  113977. * @returns this effect.
  113978. */
  113979. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  113980. /**
  113981. * Sets a float4 on a uniform variable.
  113982. * @param uniformName Name of the variable.
  113983. * @param x First float in float4.
  113984. * @param y Second float in float4.
  113985. * @param z Third float in float4.
  113986. * @param w Fourth float in float4.
  113987. * @returns this effect.
  113988. */
  113989. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  113990. /**
  113991. * Sets a Color3 on a uniform variable.
  113992. * @param uniformName Name of the variable.
  113993. * @param color3 Value to be set.
  113994. * @returns this effect.
  113995. */
  113996. setColor3(uniformName: string, color3: IColor3Like): Effect;
  113997. /**
  113998. * Sets a Color4 on a uniform variable.
  113999. * @param uniformName Name of the variable.
  114000. * @param color3 Value to be set.
  114001. * @param alpha Alpha value to be set.
  114002. * @returns this effect.
  114003. */
  114004. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114005. /**
  114006. * Sets a Color4 on a uniform variable
  114007. * @param uniformName defines the name of the variable
  114008. * @param color4 defines the value to be set
  114009. * @returns this effect.
  114010. */
  114011. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114012. /** Release all associated resources */
  114013. dispose(): void;
  114014. /**
  114015. * This function will add a new shader to the shader store
  114016. * @param name the name of the shader
  114017. * @param pixelShader optional pixel shader content
  114018. * @param vertexShader optional vertex shader content
  114019. */
  114020. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114021. /**
  114022. * Store of each shader (The can be looked up using effect.key)
  114023. */
  114024. static ShadersStore: {
  114025. [key: string]: string;
  114026. };
  114027. /**
  114028. * Store of each included file for a shader (The can be looked up using effect.key)
  114029. */
  114030. static IncludesShadersStore: {
  114031. [key: string]: string;
  114032. };
  114033. /**
  114034. * Resets the cache of effects.
  114035. */
  114036. static ResetCache(): void;
  114037. }
  114038. }
  114039. declare module BABYLON {
  114040. /**
  114041. * Interface used to describe the capabilities of the engine relatively to the current browser
  114042. */
  114043. export interface EngineCapabilities {
  114044. /** Maximum textures units per fragment shader */
  114045. maxTexturesImageUnits: number;
  114046. /** Maximum texture units per vertex shader */
  114047. maxVertexTextureImageUnits: number;
  114048. /** Maximum textures units in the entire pipeline */
  114049. maxCombinedTexturesImageUnits: number;
  114050. /** Maximum texture size */
  114051. maxTextureSize: number;
  114052. /** Maximum texture samples */
  114053. maxSamples?: number;
  114054. /** Maximum cube texture size */
  114055. maxCubemapTextureSize: number;
  114056. /** Maximum render texture size */
  114057. maxRenderTextureSize: number;
  114058. /** Maximum number of vertex attributes */
  114059. maxVertexAttribs: number;
  114060. /** Maximum number of varyings */
  114061. maxVaryingVectors: number;
  114062. /** Maximum number of uniforms per vertex shader */
  114063. maxVertexUniformVectors: number;
  114064. /** Maximum number of uniforms per fragment shader */
  114065. maxFragmentUniformVectors: number;
  114066. /** Defines if standard derivates (dx/dy) are supported */
  114067. standardDerivatives: boolean;
  114068. /** Defines if s3tc texture compression is supported */
  114069. s3tc?: WEBGL_compressed_texture_s3tc;
  114070. /** Defines if pvrtc texture compression is supported */
  114071. pvrtc: any;
  114072. /** Defines if etc1 texture compression is supported */
  114073. etc1: any;
  114074. /** Defines if etc2 texture compression is supported */
  114075. etc2: any;
  114076. /** Defines if astc texture compression is supported */
  114077. astc: any;
  114078. /** Defines if float textures are supported */
  114079. textureFloat: boolean;
  114080. /** Defines if vertex array objects are supported */
  114081. vertexArrayObject: boolean;
  114082. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114083. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114084. /** Gets the maximum level of anisotropy supported */
  114085. maxAnisotropy: number;
  114086. /** Defines if instancing is supported */
  114087. instancedArrays: boolean;
  114088. /** Defines if 32 bits indices are supported */
  114089. uintIndices: boolean;
  114090. /** Defines if high precision shaders are supported */
  114091. highPrecisionShaderSupported: boolean;
  114092. /** Defines if depth reading in the fragment shader is supported */
  114093. fragmentDepthSupported: boolean;
  114094. /** Defines if float texture linear filtering is supported*/
  114095. textureFloatLinearFiltering: boolean;
  114096. /** Defines if rendering to float textures is supported */
  114097. textureFloatRender: boolean;
  114098. /** Defines if half float textures are supported*/
  114099. textureHalfFloat: boolean;
  114100. /** Defines if half float texture linear filtering is supported*/
  114101. textureHalfFloatLinearFiltering: boolean;
  114102. /** Defines if rendering to half float textures is supported */
  114103. textureHalfFloatRender: boolean;
  114104. /** Defines if textureLOD shader command is supported */
  114105. textureLOD: boolean;
  114106. /** Defines if draw buffers extension is supported */
  114107. drawBuffersExtension: boolean;
  114108. /** Defines if depth textures are supported */
  114109. depthTextureExtension: boolean;
  114110. /** Defines if float color buffer are supported */
  114111. colorBufferFloat: boolean;
  114112. /** Gets disjoint timer query extension (null if not supported) */
  114113. timerQuery?: EXT_disjoint_timer_query;
  114114. /** Defines if timestamp can be used with timer query */
  114115. canUseTimestampForTimerQuery: boolean;
  114116. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114117. multiview?: any;
  114118. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114119. oculusMultiview?: any;
  114120. /** Function used to let the system compiles shaders in background */
  114121. parallelShaderCompile?: {
  114122. COMPLETION_STATUS_KHR: number;
  114123. };
  114124. /** Max number of texture samples for MSAA */
  114125. maxMSAASamples: number;
  114126. /** Defines if the blend min max extension is supported */
  114127. blendMinMax: boolean;
  114128. }
  114129. }
  114130. declare module BABYLON {
  114131. /**
  114132. * @hidden
  114133. **/
  114134. export class DepthCullingState {
  114135. private _isDepthTestDirty;
  114136. private _isDepthMaskDirty;
  114137. private _isDepthFuncDirty;
  114138. private _isCullFaceDirty;
  114139. private _isCullDirty;
  114140. private _isZOffsetDirty;
  114141. private _isFrontFaceDirty;
  114142. private _depthTest;
  114143. private _depthMask;
  114144. private _depthFunc;
  114145. private _cull;
  114146. private _cullFace;
  114147. private _zOffset;
  114148. private _frontFace;
  114149. /**
  114150. * Initializes the state.
  114151. */
  114152. constructor();
  114153. get isDirty(): boolean;
  114154. get zOffset(): number;
  114155. set zOffset(value: number);
  114156. get cullFace(): Nullable<number>;
  114157. set cullFace(value: Nullable<number>);
  114158. get cull(): Nullable<boolean>;
  114159. set cull(value: Nullable<boolean>);
  114160. get depthFunc(): Nullable<number>;
  114161. set depthFunc(value: Nullable<number>);
  114162. get depthMask(): boolean;
  114163. set depthMask(value: boolean);
  114164. get depthTest(): boolean;
  114165. set depthTest(value: boolean);
  114166. get frontFace(): Nullable<number>;
  114167. set frontFace(value: Nullable<number>);
  114168. reset(): void;
  114169. apply(gl: WebGLRenderingContext): void;
  114170. }
  114171. }
  114172. declare module BABYLON {
  114173. /**
  114174. * @hidden
  114175. **/
  114176. export class StencilState {
  114177. /** 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 */
  114178. static readonly ALWAYS: number;
  114179. /** Passed to stencilOperation to specify that stencil value must be kept */
  114180. static readonly KEEP: number;
  114181. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114182. static readonly REPLACE: number;
  114183. private _isStencilTestDirty;
  114184. private _isStencilMaskDirty;
  114185. private _isStencilFuncDirty;
  114186. private _isStencilOpDirty;
  114187. private _stencilTest;
  114188. private _stencilMask;
  114189. private _stencilFunc;
  114190. private _stencilFuncRef;
  114191. private _stencilFuncMask;
  114192. private _stencilOpStencilFail;
  114193. private _stencilOpDepthFail;
  114194. private _stencilOpStencilDepthPass;
  114195. get isDirty(): boolean;
  114196. get stencilFunc(): number;
  114197. set stencilFunc(value: number);
  114198. get stencilFuncRef(): number;
  114199. set stencilFuncRef(value: number);
  114200. get stencilFuncMask(): number;
  114201. set stencilFuncMask(value: number);
  114202. get stencilOpStencilFail(): number;
  114203. set stencilOpStencilFail(value: number);
  114204. get stencilOpDepthFail(): number;
  114205. set stencilOpDepthFail(value: number);
  114206. get stencilOpStencilDepthPass(): number;
  114207. set stencilOpStencilDepthPass(value: number);
  114208. get stencilMask(): number;
  114209. set stencilMask(value: number);
  114210. get stencilTest(): boolean;
  114211. set stencilTest(value: boolean);
  114212. constructor();
  114213. reset(): void;
  114214. apply(gl: WebGLRenderingContext): void;
  114215. }
  114216. }
  114217. declare module BABYLON {
  114218. /**
  114219. * @hidden
  114220. **/
  114221. export class AlphaState {
  114222. private _isAlphaBlendDirty;
  114223. private _isBlendFunctionParametersDirty;
  114224. private _isBlendEquationParametersDirty;
  114225. private _isBlendConstantsDirty;
  114226. private _alphaBlend;
  114227. private _blendFunctionParameters;
  114228. private _blendEquationParameters;
  114229. private _blendConstants;
  114230. /**
  114231. * Initializes the state.
  114232. */
  114233. constructor();
  114234. get isDirty(): boolean;
  114235. get alphaBlend(): boolean;
  114236. set alphaBlend(value: boolean);
  114237. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114238. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114239. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114240. reset(): void;
  114241. apply(gl: WebGLRenderingContext): void;
  114242. }
  114243. }
  114244. declare module BABYLON {
  114245. /** @hidden */
  114246. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114247. attributeProcessor(attribute: string): string;
  114248. varyingProcessor(varying: string, isFragment: boolean): string;
  114249. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114250. }
  114251. }
  114252. declare module BABYLON {
  114253. /**
  114254. * Interface for attribute information associated with buffer instanciation
  114255. */
  114256. export interface InstancingAttributeInfo {
  114257. /**
  114258. * Name of the GLSL attribute
  114259. * if attribute index is not specified, this is used to retrieve the index from the effect
  114260. */
  114261. attributeName: string;
  114262. /**
  114263. * Index/offset of the attribute in the vertex shader
  114264. * if not specified, this will be computes from the name.
  114265. */
  114266. index?: number;
  114267. /**
  114268. * size of the attribute, 1, 2, 3 or 4
  114269. */
  114270. attributeSize: number;
  114271. /**
  114272. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114273. */
  114274. offset: number;
  114275. /**
  114276. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114277. * default to 1
  114278. */
  114279. divisor?: number;
  114280. /**
  114281. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114282. * default is FLOAT
  114283. */
  114284. attributeType?: number;
  114285. /**
  114286. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114287. */
  114288. normalized?: boolean;
  114289. }
  114290. }
  114291. declare module BABYLON {
  114292. interface ThinEngine {
  114293. /**
  114294. * Update a video texture
  114295. * @param texture defines the texture to update
  114296. * @param video defines the video element to use
  114297. * @param invertY defines if data must be stored with Y axis inverted
  114298. */
  114299. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114300. }
  114301. }
  114302. declare module BABYLON {
  114303. interface ThinEngine {
  114304. /**
  114305. * Creates a dynamic texture
  114306. * @param width defines the width of the texture
  114307. * @param height defines the height of the texture
  114308. * @param generateMipMaps defines if the engine should generate the mip levels
  114309. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114310. * @returns the dynamic texture inside an InternalTexture
  114311. */
  114312. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114313. /**
  114314. * Update the content of a dynamic texture
  114315. * @param texture defines the texture to update
  114316. * @param canvas defines the canvas containing the source
  114317. * @param invertY defines if data must be stored with Y axis inverted
  114318. * @param premulAlpha defines if alpha is stored as premultiplied
  114319. * @param format defines the format of the data
  114320. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114321. */
  114322. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114323. }
  114324. }
  114325. declare module BABYLON {
  114326. /**
  114327. * Settings for finer control over video usage
  114328. */
  114329. export interface VideoTextureSettings {
  114330. /**
  114331. * Applies `autoplay` to video, if specified
  114332. */
  114333. autoPlay?: boolean;
  114334. /**
  114335. * Applies `loop` to video, if specified
  114336. */
  114337. loop?: boolean;
  114338. /**
  114339. * Automatically updates internal texture from video at every frame in the render loop
  114340. */
  114341. autoUpdateTexture: boolean;
  114342. /**
  114343. * Image src displayed during the video loading or until the user interacts with the video.
  114344. */
  114345. poster?: string;
  114346. }
  114347. /**
  114348. * If you want to display a video in your scene, this is the special texture for that.
  114349. * This special texture works similar to other textures, with the exception of a few parameters.
  114350. * @see https://doc.babylonjs.com/how_to/video_texture
  114351. */
  114352. export class VideoTexture extends Texture {
  114353. /**
  114354. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114355. */
  114356. readonly autoUpdateTexture: boolean;
  114357. /**
  114358. * The video instance used by the texture internally
  114359. */
  114360. readonly video: HTMLVideoElement;
  114361. private _onUserActionRequestedObservable;
  114362. /**
  114363. * Event triggerd when a dom action is required by the user to play the video.
  114364. * This happens due to recent changes in browser policies preventing video to auto start.
  114365. */
  114366. get onUserActionRequestedObservable(): Observable<Texture>;
  114367. private _generateMipMaps;
  114368. private _stillImageCaptured;
  114369. private _displayingPosterTexture;
  114370. private _settings;
  114371. private _createInternalTextureOnEvent;
  114372. private _frameId;
  114373. private _currentSrc;
  114374. /**
  114375. * Creates a video texture.
  114376. * If you want to display a video in your scene, this is the special texture for that.
  114377. * This special texture works similar to other textures, with the exception of a few parameters.
  114378. * @see https://doc.babylonjs.com/how_to/video_texture
  114379. * @param name optional name, will detect from video source, if not defined
  114380. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114381. * @param scene is obviously the current scene.
  114382. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114383. * @param invertY is false by default but can be used to invert video on Y axis
  114384. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114385. * @param settings allows finer control over video usage
  114386. */
  114387. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114388. private _getName;
  114389. private _getVideo;
  114390. private _createInternalTexture;
  114391. private reset;
  114392. /**
  114393. * @hidden Internal method to initiate `update`.
  114394. */
  114395. _rebuild(): void;
  114396. /**
  114397. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114398. */
  114399. update(): void;
  114400. /**
  114401. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114402. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114403. */
  114404. updateTexture(isVisible: boolean): void;
  114405. protected _updateInternalTexture: () => void;
  114406. /**
  114407. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114408. * @param url New url.
  114409. */
  114410. updateURL(url: string): void;
  114411. /**
  114412. * Clones the texture.
  114413. * @returns the cloned texture
  114414. */
  114415. clone(): VideoTexture;
  114416. /**
  114417. * Dispose the texture and release its associated resources.
  114418. */
  114419. dispose(): void;
  114420. /**
  114421. * Creates a video texture straight from a stream.
  114422. * @param scene Define the scene the texture should be created in
  114423. * @param stream Define the stream the texture should be created from
  114424. * @returns The created video texture as a promise
  114425. */
  114426. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114427. /**
  114428. * Creates a video texture straight from your WebCam video feed.
  114429. * @param scene Define the scene the texture should be created in
  114430. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114431. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114432. * @returns The created video texture as a promise
  114433. */
  114434. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114435. minWidth: number;
  114436. maxWidth: number;
  114437. minHeight: number;
  114438. maxHeight: number;
  114439. deviceId: string;
  114440. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114441. /**
  114442. * Creates a video texture straight from your WebCam video feed.
  114443. * @param scene Define the scene the texture should be created in
  114444. * @param onReady Define a callback to triggered once the texture will be ready
  114445. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114446. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114447. */
  114448. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114449. minWidth: number;
  114450. maxWidth: number;
  114451. minHeight: number;
  114452. maxHeight: number;
  114453. deviceId: string;
  114454. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114455. }
  114456. }
  114457. declare module BABYLON {
  114458. /**
  114459. * Defines the interface used by objects working like Scene
  114460. * @hidden
  114461. */
  114462. export interface ISceneLike {
  114463. _addPendingData(data: any): void;
  114464. _removePendingData(data: any): void;
  114465. offlineProvider: IOfflineProvider;
  114466. }
  114467. /**
  114468. * Information about the current host
  114469. */
  114470. export interface HostInformation {
  114471. /**
  114472. * Defines if the current host is a mobile
  114473. */
  114474. isMobile: boolean;
  114475. }
  114476. /** Interface defining initialization parameters for Engine class */
  114477. export interface EngineOptions extends WebGLContextAttributes {
  114478. /**
  114479. * Defines if the engine should no exceed a specified device ratio
  114480. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114481. */
  114482. limitDeviceRatio?: number;
  114483. /**
  114484. * Defines if webvr should be enabled automatically
  114485. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114486. */
  114487. autoEnableWebVR?: boolean;
  114488. /**
  114489. * Defines if webgl2 should be turned off even if supported
  114490. * @see https://doc.babylonjs.com/features/webgl2
  114491. */
  114492. disableWebGL2Support?: boolean;
  114493. /**
  114494. * Defines if webaudio should be initialized as well
  114495. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114496. */
  114497. audioEngine?: boolean;
  114498. /**
  114499. * Defines if animations should run using a deterministic lock step
  114500. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114501. */
  114502. deterministicLockstep?: boolean;
  114503. /** Defines the maximum steps to use with deterministic lock step mode */
  114504. lockstepMaxSteps?: number;
  114505. /** Defines the seconds between each deterministic lock step */
  114506. timeStep?: number;
  114507. /**
  114508. * Defines that engine should ignore context lost events
  114509. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114510. */
  114511. doNotHandleContextLost?: boolean;
  114512. /**
  114513. * Defines that engine should ignore modifying touch action attribute and style
  114514. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114515. */
  114516. doNotHandleTouchAction?: boolean;
  114517. /**
  114518. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114519. */
  114520. useHighPrecisionFloats?: boolean;
  114521. /**
  114522. * Make the canvas XR Compatible for XR sessions
  114523. */
  114524. xrCompatible?: boolean;
  114525. /**
  114526. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114527. */
  114528. useHighPrecisionMatrix?: boolean;
  114529. }
  114530. /**
  114531. * The base engine class (root of all engines)
  114532. */
  114533. export class ThinEngine {
  114534. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114535. static ExceptionList: ({
  114536. key: string;
  114537. capture: string;
  114538. captureConstraint: number;
  114539. targets: string[];
  114540. } | {
  114541. key: string;
  114542. capture: null;
  114543. captureConstraint: null;
  114544. targets: string[];
  114545. })[];
  114546. /** @hidden */
  114547. static _TextureLoaders: IInternalTextureLoader[];
  114548. /**
  114549. * Returns the current npm package of the sdk
  114550. */
  114551. static get NpmPackage(): string;
  114552. /**
  114553. * Returns the current version of the framework
  114554. */
  114555. static get Version(): string;
  114556. /**
  114557. * Returns a string describing the current engine
  114558. */
  114559. get description(): string;
  114560. /**
  114561. * Gets or sets the epsilon value used by collision engine
  114562. */
  114563. static CollisionsEpsilon: number;
  114564. /**
  114565. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114566. */
  114567. static get ShadersRepository(): string;
  114568. static set ShadersRepository(value: string);
  114569. /** @hidden */
  114570. _shaderProcessor: IShaderProcessor;
  114571. /**
  114572. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  114573. */
  114574. forcePOTTextures: boolean;
  114575. /**
  114576. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  114577. */
  114578. isFullscreen: boolean;
  114579. /**
  114580. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  114581. */
  114582. cullBackFaces: boolean;
  114583. /**
  114584. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  114585. */
  114586. renderEvenInBackground: boolean;
  114587. /**
  114588. * Gets or sets a boolean indicating that cache can be kept between frames
  114589. */
  114590. preventCacheWipeBetweenFrames: boolean;
  114591. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  114592. validateShaderPrograms: boolean;
  114593. /**
  114594. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  114595. * This can provide greater z depth for distant objects.
  114596. */
  114597. useReverseDepthBuffer: boolean;
  114598. /**
  114599. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  114600. */
  114601. disableUniformBuffers: boolean;
  114602. /** @hidden */
  114603. _uniformBuffers: UniformBuffer[];
  114604. /**
  114605. * Gets a boolean indicating that the engine supports uniform buffers
  114606. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  114607. */
  114608. get supportsUniformBuffers(): boolean;
  114609. /** @hidden */
  114610. _gl: WebGLRenderingContext;
  114611. /** @hidden */
  114612. _webGLVersion: number;
  114613. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  114614. protected _windowIsBackground: boolean;
  114615. protected _creationOptions: EngineOptions;
  114616. protected _highPrecisionShadersAllowed: boolean;
  114617. /** @hidden */
  114618. get _shouldUseHighPrecisionShader(): boolean;
  114619. /**
  114620. * Gets a boolean indicating that only power of 2 textures are supported
  114621. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  114622. */
  114623. get needPOTTextures(): boolean;
  114624. /** @hidden */
  114625. _badOS: boolean;
  114626. /** @hidden */
  114627. _badDesktopOS: boolean;
  114628. private _hardwareScalingLevel;
  114629. /** @hidden */
  114630. _caps: EngineCapabilities;
  114631. private _isStencilEnable;
  114632. private _glVersion;
  114633. private _glRenderer;
  114634. private _glVendor;
  114635. /** @hidden */
  114636. _videoTextureSupported: boolean;
  114637. protected _renderingQueueLaunched: boolean;
  114638. protected _activeRenderLoops: (() => void)[];
  114639. /**
  114640. * Observable signaled when a context lost event is raised
  114641. */
  114642. onContextLostObservable: Observable<ThinEngine>;
  114643. /**
  114644. * Observable signaled when a context restored event is raised
  114645. */
  114646. onContextRestoredObservable: Observable<ThinEngine>;
  114647. private _onContextLost;
  114648. private _onContextRestored;
  114649. protected _contextWasLost: boolean;
  114650. /** @hidden */
  114651. _doNotHandleContextLost: boolean;
  114652. /**
  114653. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  114654. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  114655. */
  114656. get doNotHandleContextLost(): boolean;
  114657. set doNotHandleContextLost(value: boolean);
  114658. /**
  114659. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  114660. */
  114661. disableVertexArrayObjects: boolean;
  114662. /** @hidden */
  114663. protected _colorWrite: boolean;
  114664. /** @hidden */
  114665. protected _colorWriteChanged: boolean;
  114666. /** @hidden */
  114667. protected _depthCullingState: DepthCullingState;
  114668. /** @hidden */
  114669. protected _stencilState: StencilState;
  114670. /** @hidden */
  114671. _alphaState: AlphaState;
  114672. /** @hidden */
  114673. _alphaMode: number;
  114674. /** @hidden */
  114675. _alphaEquation: number;
  114676. /** @hidden */
  114677. _internalTexturesCache: InternalTexture[];
  114678. /** @hidden */
  114679. protected _activeChannel: number;
  114680. private _currentTextureChannel;
  114681. /** @hidden */
  114682. protected _boundTexturesCache: {
  114683. [key: string]: Nullable<InternalTexture>;
  114684. };
  114685. /** @hidden */
  114686. protected _currentEffect: Nullable<Effect>;
  114687. /** @hidden */
  114688. protected _currentProgram: Nullable<WebGLProgram>;
  114689. private _compiledEffects;
  114690. private _vertexAttribArraysEnabled;
  114691. /** @hidden */
  114692. protected _cachedViewport: Nullable<IViewportLike>;
  114693. private _cachedVertexArrayObject;
  114694. /** @hidden */
  114695. protected _cachedVertexBuffers: any;
  114696. /** @hidden */
  114697. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  114698. /** @hidden */
  114699. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  114700. /** @hidden */
  114701. _currentRenderTarget: Nullable<InternalTexture>;
  114702. private _uintIndicesCurrentlySet;
  114703. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  114704. /** @hidden */
  114705. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  114706. /** @hidden */
  114707. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  114708. private _currentBufferPointers;
  114709. private _currentInstanceLocations;
  114710. private _currentInstanceBuffers;
  114711. private _textureUnits;
  114712. /** @hidden */
  114713. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  114714. /** @hidden */
  114715. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  114716. /** @hidden */
  114717. _boundRenderFunction: any;
  114718. private _vaoRecordInProgress;
  114719. private _mustWipeVertexAttributes;
  114720. private _emptyTexture;
  114721. private _emptyCubeTexture;
  114722. private _emptyTexture3D;
  114723. private _emptyTexture2DArray;
  114724. /** @hidden */
  114725. _frameHandler: number;
  114726. private _nextFreeTextureSlots;
  114727. private _maxSimultaneousTextures;
  114728. private _activeRequests;
  114729. /** @hidden */
  114730. _transformTextureUrl: Nullable<(url: string) => string>;
  114731. /**
  114732. * Gets information about the current host
  114733. */
  114734. hostInformation: HostInformation;
  114735. protected get _supportsHardwareTextureRescaling(): boolean;
  114736. private _framebufferDimensionsObject;
  114737. /**
  114738. * sets the object from which width and height will be taken from when getting render width and height
  114739. * Will fallback to the gl object
  114740. * @param dimensions the framebuffer width and height that will be used.
  114741. */
  114742. set framebufferDimensionsObject(dimensions: Nullable<{
  114743. framebufferWidth: number;
  114744. framebufferHeight: number;
  114745. }>);
  114746. /**
  114747. * Gets the current viewport
  114748. */
  114749. get currentViewport(): Nullable<IViewportLike>;
  114750. /**
  114751. * Gets the default empty texture
  114752. */
  114753. get emptyTexture(): InternalTexture;
  114754. /**
  114755. * Gets the default empty 3D texture
  114756. */
  114757. get emptyTexture3D(): InternalTexture;
  114758. /**
  114759. * Gets the default empty 2D array texture
  114760. */
  114761. get emptyTexture2DArray(): InternalTexture;
  114762. /**
  114763. * Gets the default empty cube texture
  114764. */
  114765. get emptyCubeTexture(): InternalTexture;
  114766. /**
  114767. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  114768. */
  114769. readonly premultipliedAlpha: boolean;
  114770. /**
  114771. * Observable event triggered before each texture is initialized
  114772. */
  114773. onBeforeTextureInitObservable: Observable<Texture>;
  114774. /**
  114775. * Creates a new engine
  114776. * @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
  114777. * @param antialias defines enable antialiasing (default: false)
  114778. * @param options defines further options to be sent to the getContext() function
  114779. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  114780. */
  114781. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  114782. private _rebuildInternalTextures;
  114783. private _rebuildEffects;
  114784. /**
  114785. * Gets a boolean indicating if all created effects are ready
  114786. * @returns true if all effects are ready
  114787. */
  114788. areAllEffectsReady(): boolean;
  114789. protected _rebuildBuffers(): void;
  114790. protected _initGLContext(): void;
  114791. /**
  114792. * Gets version of the current webGL context
  114793. */
  114794. get webGLVersion(): number;
  114795. /**
  114796. * Gets a string identifying the name of the class
  114797. * @returns "Engine" string
  114798. */
  114799. getClassName(): string;
  114800. /**
  114801. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  114802. */
  114803. get isStencilEnable(): boolean;
  114804. /** @hidden */
  114805. _prepareWorkingCanvas(): void;
  114806. /**
  114807. * Reset the texture cache to empty state
  114808. */
  114809. resetTextureCache(): void;
  114810. /**
  114811. * Gets an object containing information about the current webGL context
  114812. * @returns an object containing the vender, the renderer and the version of the current webGL context
  114813. */
  114814. getGlInfo(): {
  114815. vendor: string;
  114816. renderer: string;
  114817. version: string;
  114818. };
  114819. /**
  114820. * Defines the hardware scaling level.
  114821. * By default the hardware scaling level is computed from the window device ratio.
  114822. * 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.
  114823. * @param level defines the level to use
  114824. */
  114825. setHardwareScalingLevel(level: number): void;
  114826. /**
  114827. * Gets the current hardware scaling level.
  114828. * By default the hardware scaling level is computed from the window device ratio.
  114829. * 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.
  114830. * @returns a number indicating the current hardware scaling level
  114831. */
  114832. getHardwareScalingLevel(): number;
  114833. /**
  114834. * Gets the list of loaded textures
  114835. * @returns an array containing all loaded textures
  114836. */
  114837. getLoadedTexturesCache(): InternalTexture[];
  114838. /**
  114839. * Gets the object containing all engine capabilities
  114840. * @returns the EngineCapabilities object
  114841. */
  114842. getCaps(): EngineCapabilities;
  114843. /**
  114844. * stop executing a render loop function and remove it from the execution array
  114845. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  114846. */
  114847. stopRenderLoop(renderFunction?: () => void): void;
  114848. /** @hidden */
  114849. _renderLoop(): void;
  114850. /**
  114851. * Gets the HTML canvas attached with the current webGL context
  114852. * @returns a HTML canvas
  114853. */
  114854. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  114855. /**
  114856. * Gets host window
  114857. * @returns the host window object
  114858. */
  114859. getHostWindow(): Nullable<Window>;
  114860. /**
  114861. * Gets the current render width
  114862. * @param useScreen defines if screen size must be used (or the current render target if any)
  114863. * @returns a number defining the current render width
  114864. */
  114865. getRenderWidth(useScreen?: boolean): number;
  114866. /**
  114867. * Gets the current render height
  114868. * @param useScreen defines if screen size must be used (or the current render target if any)
  114869. * @returns a number defining the current render height
  114870. */
  114871. getRenderHeight(useScreen?: boolean): number;
  114872. /**
  114873. * Can be used to override the current requestAnimationFrame requester.
  114874. * @hidden
  114875. */
  114876. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  114877. /**
  114878. * Register and execute a render loop. The engine can have more than one render function
  114879. * @param renderFunction defines the function to continuously execute
  114880. */
  114881. runRenderLoop(renderFunction: () => void): void;
  114882. /**
  114883. * Clear the current render buffer or the current render target (if any is set up)
  114884. * @param color defines the color to use
  114885. * @param backBuffer defines if the back buffer must be cleared
  114886. * @param depth defines if the depth buffer must be cleared
  114887. * @param stencil defines if the stencil buffer must be cleared
  114888. */
  114889. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  114890. private _viewportCached;
  114891. /** @hidden */
  114892. _viewport(x: number, y: number, width: number, height: number): void;
  114893. /**
  114894. * Set the WebGL's viewport
  114895. * @param viewport defines the viewport element to be used
  114896. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  114897. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  114898. */
  114899. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  114900. /**
  114901. * Begin a new frame
  114902. */
  114903. beginFrame(): void;
  114904. /**
  114905. * Enf the current frame
  114906. */
  114907. endFrame(): void;
  114908. /**
  114909. * Resize the view according to the canvas' size
  114910. */
  114911. resize(): void;
  114912. /**
  114913. * Force a specific size of the canvas
  114914. * @param width defines the new canvas' width
  114915. * @param height defines the new canvas' height
  114916. * @returns true if the size was changed
  114917. */
  114918. setSize(width: number, height: number): boolean;
  114919. /**
  114920. * Binds the frame buffer to the specified texture.
  114921. * @param texture The texture to render to or null for the default canvas
  114922. * @param faceIndex The face of the texture to render to in case of cube texture
  114923. * @param requiredWidth The width of the target to render to
  114924. * @param requiredHeight The height of the target to render to
  114925. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  114926. * @param lodLevel defines the lod level to bind to the frame buffer
  114927. * @param layer defines the 2d array index to bind to frame buffer to
  114928. */
  114929. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  114930. /** @hidden */
  114931. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  114932. /**
  114933. * Unbind the current render target texture from the webGL context
  114934. * @param texture defines the render target texture to unbind
  114935. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  114936. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  114937. */
  114938. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  114939. /**
  114940. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  114941. */
  114942. flushFramebuffer(): void;
  114943. /**
  114944. * Unbind the current render target and bind the default framebuffer
  114945. */
  114946. restoreDefaultFramebuffer(): void;
  114947. /** @hidden */
  114948. protected _resetVertexBufferBinding(): void;
  114949. /**
  114950. * Creates a vertex buffer
  114951. * @param data the data for the vertex buffer
  114952. * @returns the new WebGL static buffer
  114953. */
  114954. createVertexBuffer(data: DataArray): DataBuffer;
  114955. private _createVertexBuffer;
  114956. /**
  114957. * Creates a dynamic vertex buffer
  114958. * @param data the data for the dynamic vertex buffer
  114959. * @returns the new WebGL dynamic buffer
  114960. */
  114961. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  114962. protected _resetIndexBufferBinding(): void;
  114963. /**
  114964. * Creates a new index buffer
  114965. * @param indices defines the content of the index buffer
  114966. * @param updatable defines if the index buffer must be updatable
  114967. * @returns a new webGL buffer
  114968. */
  114969. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  114970. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  114971. /**
  114972. * Bind a webGL buffer to the webGL context
  114973. * @param buffer defines the buffer to bind
  114974. */
  114975. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  114976. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  114977. private bindBuffer;
  114978. /**
  114979. * update the bound buffer with the given data
  114980. * @param data defines the data to update
  114981. */
  114982. updateArrayBuffer(data: Float32Array): void;
  114983. private _vertexAttribPointer;
  114984. /** @hidden */
  114985. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  114986. private _bindVertexBuffersAttributes;
  114987. /**
  114988. * Records a vertex array object
  114989. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  114990. * @param vertexBuffers defines the list of vertex buffers to store
  114991. * @param indexBuffer defines the index buffer to store
  114992. * @param effect defines the effect to store
  114993. * @returns the new vertex array object
  114994. */
  114995. recordVertexArrayObject(vertexBuffers: {
  114996. [key: string]: VertexBuffer;
  114997. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  114998. /**
  114999. * Bind a specific vertex array object
  115000. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115001. * @param vertexArrayObject defines the vertex array object to bind
  115002. * @param indexBuffer defines the index buffer to bind
  115003. */
  115004. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115005. /**
  115006. * Bind webGl buffers directly to the webGL context
  115007. * @param vertexBuffer defines the vertex buffer to bind
  115008. * @param indexBuffer defines the index buffer to bind
  115009. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115010. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115011. * @param effect defines the effect associated with the vertex buffer
  115012. */
  115013. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115014. private _unbindVertexArrayObject;
  115015. /**
  115016. * Bind a list of vertex buffers to the webGL context
  115017. * @param vertexBuffers defines the list of vertex buffers to bind
  115018. * @param indexBuffer defines the index buffer to bind
  115019. * @param effect defines the effect associated with the vertex buffers
  115020. */
  115021. bindBuffers(vertexBuffers: {
  115022. [key: string]: Nullable<VertexBuffer>;
  115023. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115024. /**
  115025. * Unbind all instance attributes
  115026. */
  115027. unbindInstanceAttributes(): void;
  115028. /**
  115029. * Release and free the memory of a vertex array object
  115030. * @param vao defines the vertex array object to delete
  115031. */
  115032. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115033. /** @hidden */
  115034. _releaseBuffer(buffer: DataBuffer): boolean;
  115035. protected _deleteBuffer(buffer: DataBuffer): void;
  115036. /**
  115037. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115038. * @param instancesBuffer defines the webGL buffer to update and bind
  115039. * @param data defines the data to store in the buffer
  115040. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115041. */
  115042. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115043. /**
  115044. * Bind the content of a webGL buffer used with instantiation
  115045. * @param instancesBuffer defines the webGL buffer to bind
  115046. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115047. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115048. */
  115049. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115050. /**
  115051. * Disable the instance attribute corresponding to the name in parameter
  115052. * @param name defines the name of the attribute to disable
  115053. */
  115054. disableInstanceAttributeByName(name: string): void;
  115055. /**
  115056. * Disable the instance attribute corresponding to the location in parameter
  115057. * @param attributeLocation defines the attribute location of the attribute to disable
  115058. */
  115059. disableInstanceAttribute(attributeLocation: number): void;
  115060. /**
  115061. * Disable the attribute corresponding to the location in parameter
  115062. * @param attributeLocation defines the attribute location of the attribute to disable
  115063. */
  115064. disableAttributeByIndex(attributeLocation: number): void;
  115065. /**
  115066. * Send a draw order
  115067. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115068. * @param indexStart defines the starting index
  115069. * @param indexCount defines the number of index to draw
  115070. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115071. */
  115072. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115073. /**
  115074. * Draw a list of points
  115075. * @param verticesStart defines the index of first vertex to draw
  115076. * @param verticesCount defines the count of vertices to draw
  115077. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115078. */
  115079. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115080. /**
  115081. * Draw a list of unindexed primitives
  115082. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115083. * @param verticesStart defines the index of first vertex to draw
  115084. * @param verticesCount defines the count of vertices to draw
  115085. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115086. */
  115087. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115088. /**
  115089. * Draw a list of indexed primitives
  115090. * @param fillMode defines the primitive to use
  115091. * @param indexStart defines the starting index
  115092. * @param indexCount defines the number of index to draw
  115093. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115094. */
  115095. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115096. /**
  115097. * Draw a list of unindexed primitives
  115098. * @param fillMode defines the primitive to use
  115099. * @param verticesStart defines the index of first vertex to draw
  115100. * @param verticesCount defines the count of vertices to draw
  115101. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115102. */
  115103. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115104. private _drawMode;
  115105. /** @hidden */
  115106. protected _reportDrawCall(): void;
  115107. /** @hidden */
  115108. _releaseEffect(effect: Effect): void;
  115109. /** @hidden */
  115110. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115111. /**
  115112. * Create a new effect (used to store vertex/fragment shaders)
  115113. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115114. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115115. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115116. * @param samplers defines an array of string used to represent textures
  115117. * @param defines defines the string containing the defines to use to compile the shaders
  115118. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115119. * @param onCompiled defines a function to call when the effect creation is successful
  115120. * @param onError defines a function to call when the effect creation has failed
  115121. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115122. * @returns the new Effect
  115123. */
  115124. 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;
  115125. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115126. private _compileShader;
  115127. private _compileRawShader;
  115128. /** @hidden */
  115129. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115130. /**
  115131. * Directly creates a webGL program
  115132. * @param pipelineContext defines the pipeline context to attach to
  115133. * @param vertexCode defines the vertex shader code to use
  115134. * @param fragmentCode defines the fragment shader code to use
  115135. * @param context defines the webGL context to use (if not set, the current one will be used)
  115136. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115137. * @returns the new webGL program
  115138. */
  115139. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115140. /**
  115141. * Creates a webGL program
  115142. * @param pipelineContext defines the pipeline context to attach to
  115143. * @param vertexCode defines the vertex shader code to use
  115144. * @param fragmentCode defines the fragment shader code to use
  115145. * @param defines defines the string containing the defines to use to compile the shaders
  115146. * @param context defines the webGL context to use (if not set, the current one will be used)
  115147. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115148. * @returns the new webGL program
  115149. */
  115150. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115151. /**
  115152. * Creates a new pipeline context
  115153. * @returns the new pipeline
  115154. */
  115155. createPipelineContext(): IPipelineContext;
  115156. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115157. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115158. /** @hidden */
  115159. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115160. /** @hidden */
  115161. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115162. /** @hidden */
  115163. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115164. /**
  115165. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115166. * @param pipelineContext defines the pipeline context to use
  115167. * @param uniformsNames defines the list of uniform names
  115168. * @returns an array of webGL uniform locations
  115169. */
  115170. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115171. /**
  115172. * Gets the lsit of active attributes for a given webGL program
  115173. * @param pipelineContext defines the pipeline context to use
  115174. * @param attributesNames defines the list of attribute names to get
  115175. * @returns an array of indices indicating the offset of each attribute
  115176. */
  115177. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115178. /**
  115179. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115180. * @param effect defines the effect to activate
  115181. */
  115182. enableEffect(effect: Nullable<Effect>): void;
  115183. /**
  115184. * Set the value of an uniform to a number (int)
  115185. * @param uniform defines the webGL uniform location where to store the value
  115186. * @param value defines the int number to store
  115187. */
  115188. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115189. /**
  115190. * Set the value of an uniform to an array of int32
  115191. * @param uniform defines the webGL uniform location where to store the value
  115192. * @param array defines the array of int32 to store
  115193. */
  115194. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115195. /**
  115196. * Set the value of an uniform to an array of int32 (stored as vec2)
  115197. * @param uniform defines the webGL uniform location where to store the value
  115198. * @param array defines the array of int32 to store
  115199. */
  115200. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115201. /**
  115202. * Set the value of an uniform to an array of int32 (stored as vec3)
  115203. * @param uniform defines the webGL uniform location where to store the value
  115204. * @param array defines the array of int32 to store
  115205. */
  115206. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115207. /**
  115208. * Set the value of an uniform to an array of int32 (stored as vec4)
  115209. * @param uniform defines the webGL uniform location where to store the value
  115210. * @param array defines the array of int32 to store
  115211. */
  115212. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115213. /**
  115214. * Set the value of an uniform to an array of number
  115215. * @param uniform defines the webGL uniform location where to store the value
  115216. * @param array defines the array of number to store
  115217. */
  115218. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115219. /**
  115220. * Set the value of an uniform to an array of number (stored as vec2)
  115221. * @param uniform defines the webGL uniform location where to store the value
  115222. * @param array defines the array of number to store
  115223. */
  115224. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115225. /**
  115226. * Set the value of an uniform to an array of number (stored as vec3)
  115227. * @param uniform defines the webGL uniform location where to store the value
  115228. * @param array defines the array of number to store
  115229. */
  115230. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115231. /**
  115232. * Set the value of an uniform to an array of number (stored as vec4)
  115233. * @param uniform defines the webGL uniform location where to store the value
  115234. * @param array defines the array of number to store
  115235. */
  115236. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115237. /**
  115238. * Set the value of an uniform to an array of float32 (stored as matrices)
  115239. * @param uniform defines the webGL uniform location where to store the value
  115240. * @param matrices defines the array of float32 to store
  115241. */
  115242. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115243. /**
  115244. * Set the value of an uniform to a matrix (3x3)
  115245. * @param uniform defines the webGL uniform location where to store the value
  115246. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115247. */
  115248. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115249. /**
  115250. * Set the value of an uniform to a matrix (2x2)
  115251. * @param uniform defines the webGL uniform location where to store the value
  115252. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115253. */
  115254. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115255. /**
  115256. * Set the value of an uniform to a number (float)
  115257. * @param uniform defines the webGL uniform location where to store the value
  115258. * @param value defines the float number to store
  115259. */
  115260. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115261. /**
  115262. * Set the value of an uniform to a vec2
  115263. * @param uniform defines the webGL uniform location where to store the value
  115264. * @param x defines the 1st component of the value
  115265. * @param y defines the 2nd component of the value
  115266. */
  115267. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115268. /**
  115269. * Set the value of an uniform to a vec3
  115270. * @param uniform defines the webGL uniform location where to store the value
  115271. * @param x defines the 1st component of the value
  115272. * @param y defines the 2nd component of the value
  115273. * @param z defines the 3rd component of the value
  115274. */
  115275. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115276. /**
  115277. * Set the value of an uniform to a vec4
  115278. * @param uniform defines the webGL uniform location where to store the value
  115279. * @param x defines the 1st component of the value
  115280. * @param y defines the 2nd component of the value
  115281. * @param z defines the 3rd component of the value
  115282. * @param w defines the 4th component of the value
  115283. */
  115284. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115285. /**
  115286. * Apply all cached states (depth, culling, stencil and alpha)
  115287. */
  115288. applyStates(): void;
  115289. /**
  115290. * Enable or disable color writing
  115291. * @param enable defines the state to set
  115292. */
  115293. setColorWrite(enable: boolean): void;
  115294. /**
  115295. * Gets a boolean indicating if color writing is enabled
  115296. * @returns the current color writing state
  115297. */
  115298. getColorWrite(): boolean;
  115299. /**
  115300. * Gets the depth culling state manager
  115301. */
  115302. get depthCullingState(): DepthCullingState;
  115303. /**
  115304. * Gets the alpha state manager
  115305. */
  115306. get alphaState(): AlphaState;
  115307. /**
  115308. * Gets the stencil state manager
  115309. */
  115310. get stencilState(): StencilState;
  115311. /**
  115312. * Clears the list of texture accessible through engine.
  115313. * This can help preventing texture load conflict due to name collision.
  115314. */
  115315. clearInternalTexturesCache(): void;
  115316. /**
  115317. * Force the entire cache to be cleared
  115318. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115319. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115320. */
  115321. wipeCaches(bruteForce?: boolean): void;
  115322. /** @hidden */
  115323. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115324. min: number;
  115325. mag: number;
  115326. };
  115327. /** @hidden */
  115328. _createTexture(): WebGLTexture;
  115329. /**
  115330. * Usually called from Texture.ts.
  115331. * Passed information to create a WebGLTexture
  115332. * @param url defines a value which contains one of the following:
  115333. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115334. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115335. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115336. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115337. * @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)
  115338. * @param scene needed for loading to the correct scene
  115339. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115340. * @param onLoad optional callback to be called upon successful completion
  115341. * @param onError optional callback to be called upon failure
  115342. * @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
  115343. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115344. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115345. * @param forcedExtension defines the extension to use to pick the right loader
  115346. * @param mimeType defines an optional mime type
  115347. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115348. */
  115349. 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;
  115350. /**
  115351. * Loads an image as an HTMLImageElement.
  115352. * @param input url string, ArrayBuffer, or Blob to load
  115353. * @param onLoad callback called when the image successfully loads
  115354. * @param onError callback called when the image fails to load
  115355. * @param offlineProvider offline provider for caching
  115356. * @param mimeType optional mime type
  115357. * @returns the HTMLImageElement of the loaded image
  115358. * @hidden
  115359. */
  115360. 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>;
  115361. /**
  115362. * @hidden
  115363. */
  115364. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115365. private _unpackFlipYCached;
  115366. /**
  115367. * In case you are sharing the context with other applications, it might
  115368. * be interested to not cache the unpack flip y state to ensure a consistent
  115369. * value would be set.
  115370. */
  115371. enableUnpackFlipYCached: boolean;
  115372. /** @hidden */
  115373. _unpackFlipY(value: boolean): void;
  115374. /** @hidden */
  115375. _getUnpackAlignement(): number;
  115376. private _getTextureTarget;
  115377. /**
  115378. * Update the sampling mode of a given texture
  115379. * @param samplingMode defines the required sampling mode
  115380. * @param texture defines the texture to update
  115381. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115382. */
  115383. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115384. /**
  115385. * Update the sampling mode of a given texture
  115386. * @param texture defines the texture to update
  115387. * @param wrapU defines the texture wrap mode of the u coordinates
  115388. * @param wrapV defines the texture wrap mode of the v coordinates
  115389. * @param wrapR defines the texture wrap mode of the r coordinates
  115390. */
  115391. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115392. /** @hidden */
  115393. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115394. width: number;
  115395. height: number;
  115396. layers?: number;
  115397. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115398. /** @hidden */
  115399. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115400. /** @hidden */
  115401. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115402. /**
  115403. * Update a portion of an internal texture
  115404. * @param texture defines the texture to update
  115405. * @param imageData defines the data to store into the texture
  115406. * @param xOffset defines the x coordinates of the update rectangle
  115407. * @param yOffset defines the y coordinates of the update rectangle
  115408. * @param width defines the width of the update rectangle
  115409. * @param height defines the height of the update rectangle
  115410. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115411. * @param lod defines the lod level to update (0 by default)
  115412. */
  115413. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115414. /** @hidden */
  115415. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115416. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115417. private _prepareWebGLTexture;
  115418. /** @hidden */
  115419. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115420. private _getDepthStencilBuffer;
  115421. /** @hidden */
  115422. _releaseFramebufferObjects(texture: InternalTexture): void;
  115423. /** @hidden */
  115424. _releaseTexture(texture: InternalTexture): void;
  115425. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115426. protected _setProgram(program: WebGLProgram): void;
  115427. protected _boundUniforms: {
  115428. [key: number]: WebGLUniformLocation;
  115429. };
  115430. /**
  115431. * Binds an effect to the webGL context
  115432. * @param effect defines the effect to bind
  115433. */
  115434. bindSamplers(effect: Effect): void;
  115435. private _activateCurrentTexture;
  115436. /** @hidden */
  115437. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115438. /** @hidden */
  115439. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115440. /**
  115441. * Unbind all textures from the webGL context
  115442. */
  115443. unbindAllTextures(): void;
  115444. /**
  115445. * Sets a texture to the according uniform.
  115446. * @param channel The texture channel
  115447. * @param uniform The uniform to set
  115448. * @param texture The texture to apply
  115449. */
  115450. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115451. private _bindSamplerUniformToChannel;
  115452. private _getTextureWrapMode;
  115453. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115454. /**
  115455. * Sets an array of texture to the webGL context
  115456. * @param channel defines the channel where the texture array must be set
  115457. * @param uniform defines the associated uniform location
  115458. * @param textures defines the array of textures to bind
  115459. */
  115460. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115461. /** @hidden */
  115462. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115463. private _setTextureParameterFloat;
  115464. private _setTextureParameterInteger;
  115465. /**
  115466. * Unbind all vertex attributes from the webGL context
  115467. */
  115468. unbindAllAttributes(): void;
  115469. /**
  115470. * 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
  115471. */
  115472. releaseEffects(): void;
  115473. /**
  115474. * Dispose and release all associated resources
  115475. */
  115476. dispose(): void;
  115477. /**
  115478. * Attach a new callback raised when context lost event is fired
  115479. * @param callback defines the callback to call
  115480. */
  115481. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115482. /**
  115483. * Attach a new callback raised when context restored event is fired
  115484. * @param callback defines the callback to call
  115485. */
  115486. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115487. /**
  115488. * Get the current error code of the webGL context
  115489. * @returns the error code
  115490. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115491. */
  115492. getError(): number;
  115493. private _canRenderToFloatFramebuffer;
  115494. private _canRenderToHalfFloatFramebuffer;
  115495. private _canRenderToFramebuffer;
  115496. /** @hidden */
  115497. _getWebGLTextureType(type: number): number;
  115498. /** @hidden */
  115499. _getInternalFormat(format: number): number;
  115500. /** @hidden */
  115501. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115502. /** @hidden */
  115503. _getRGBAMultiSampleBufferFormat(type: number): number;
  115504. /** @hidden */
  115505. _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;
  115506. /**
  115507. * Loads a file from a url
  115508. * @param url url to load
  115509. * @param onSuccess callback called when the file successfully loads
  115510. * @param onProgress callback called while file is loading (if the server supports this mode)
  115511. * @param offlineProvider defines the offline provider for caching
  115512. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115513. * @param onError callback called when the file fails to load
  115514. * @returns a file request object
  115515. * @hidden
  115516. */
  115517. 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;
  115518. /**
  115519. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115520. * @param x defines the x coordinate of the rectangle where pixels must be read
  115521. * @param y defines the y coordinate of the rectangle where pixels must be read
  115522. * @param width defines the width of the rectangle where pixels must be read
  115523. * @param height defines the height of the rectangle where pixels must be read
  115524. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115525. * @returns a Uint8Array containing RGBA colors
  115526. */
  115527. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115528. private static _isSupported;
  115529. /**
  115530. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115531. * @returns true if the engine can be created
  115532. * @ignorenaming
  115533. */
  115534. static isSupported(): boolean;
  115535. /**
  115536. * Find the next highest power of two.
  115537. * @param x Number to start search from.
  115538. * @return Next highest power of two.
  115539. */
  115540. static CeilingPOT(x: number): number;
  115541. /**
  115542. * Find the next lowest power of two.
  115543. * @param x Number to start search from.
  115544. * @return Next lowest power of two.
  115545. */
  115546. static FloorPOT(x: number): number;
  115547. /**
  115548. * Find the nearest power of two.
  115549. * @param x Number to start search from.
  115550. * @return Next nearest power of two.
  115551. */
  115552. static NearestPOT(x: number): number;
  115553. /**
  115554. * Get the closest exponent of two
  115555. * @param value defines the value to approximate
  115556. * @param max defines the maximum value to return
  115557. * @param mode defines how to define the closest value
  115558. * @returns closest exponent of two of the given value
  115559. */
  115560. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  115561. /**
  115562. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  115563. * @param func - the function to be called
  115564. * @param requester - the object that will request the next frame. Falls back to window.
  115565. * @returns frame number
  115566. */
  115567. static QueueNewFrame(func: () => void, requester?: any): number;
  115568. /**
  115569. * Gets host document
  115570. * @returns the host document object
  115571. */
  115572. getHostDocument(): Nullable<Document>;
  115573. }
  115574. }
  115575. declare module BABYLON {
  115576. /**
  115577. * Class representing spherical harmonics coefficients to the 3rd degree
  115578. */
  115579. export class SphericalHarmonics {
  115580. /**
  115581. * Defines whether or not the harmonics have been prescaled for rendering.
  115582. */
  115583. preScaled: boolean;
  115584. /**
  115585. * The l0,0 coefficients of the spherical harmonics
  115586. */
  115587. l00: Vector3;
  115588. /**
  115589. * The l1,-1 coefficients of the spherical harmonics
  115590. */
  115591. l1_1: Vector3;
  115592. /**
  115593. * The l1,0 coefficients of the spherical harmonics
  115594. */
  115595. l10: Vector3;
  115596. /**
  115597. * The l1,1 coefficients of the spherical harmonics
  115598. */
  115599. l11: Vector3;
  115600. /**
  115601. * The l2,-2 coefficients of the spherical harmonics
  115602. */
  115603. l2_2: Vector3;
  115604. /**
  115605. * The l2,-1 coefficients of the spherical harmonics
  115606. */
  115607. l2_1: Vector3;
  115608. /**
  115609. * The l2,0 coefficients of the spherical harmonics
  115610. */
  115611. l20: Vector3;
  115612. /**
  115613. * The l2,1 coefficients of the spherical harmonics
  115614. */
  115615. l21: Vector3;
  115616. /**
  115617. * The l2,2 coefficients of the spherical harmonics
  115618. */
  115619. l22: Vector3;
  115620. /**
  115621. * Adds a light to the spherical harmonics
  115622. * @param direction the direction of the light
  115623. * @param color the color of the light
  115624. * @param deltaSolidAngle the delta solid angle of the light
  115625. */
  115626. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  115627. /**
  115628. * Scales the spherical harmonics by the given amount
  115629. * @param scale the amount to scale
  115630. */
  115631. scaleInPlace(scale: number): void;
  115632. /**
  115633. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  115634. *
  115635. * ```
  115636. * E_lm = A_l * L_lm
  115637. * ```
  115638. *
  115639. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  115640. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  115641. * the scaling factors are given in equation 9.
  115642. */
  115643. convertIncidentRadianceToIrradiance(): void;
  115644. /**
  115645. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  115646. *
  115647. * ```
  115648. * L = (1/pi) * E * rho
  115649. * ```
  115650. *
  115651. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  115652. */
  115653. convertIrradianceToLambertianRadiance(): void;
  115654. /**
  115655. * Integrates the reconstruction coefficients directly in to the SH preventing further
  115656. * required operations at run time.
  115657. *
  115658. * This is simply done by scaling back the SH with Ylm constants parameter.
  115659. * The trigonometric part being applied by the shader at run time.
  115660. */
  115661. preScaleForRendering(): void;
  115662. /**
  115663. * Constructs a spherical harmonics from an array.
  115664. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  115665. * @returns the spherical harmonics
  115666. */
  115667. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  115668. /**
  115669. * Gets the spherical harmonics from polynomial
  115670. * @param polynomial the spherical polynomial
  115671. * @returns the spherical harmonics
  115672. */
  115673. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  115674. }
  115675. /**
  115676. * Class representing spherical polynomial coefficients to the 3rd degree
  115677. */
  115678. export class SphericalPolynomial {
  115679. private _harmonics;
  115680. /**
  115681. * The spherical harmonics used to create the polynomials.
  115682. */
  115683. get preScaledHarmonics(): SphericalHarmonics;
  115684. /**
  115685. * The x coefficients of the spherical polynomial
  115686. */
  115687. x: Vector3;
  115688. /**
  115689. * The y coefficients of the spherical polynomial
  115690. */
  115691. y: Vector3;
  115692. /**
  115693. * The z coefficients of the spherical polynomial
  115694. */
  115695. z: Vector3;
  115696. /**
  115697. * The xx coefficients of the spherical polynomial
  115698. */
  115699. xx: Vector3;
  115700. /**
  115701. * The yy coefficients of the spherical polynomial
  115702. */
  115703. yy: Vector3;
  115704. /**
  115705. * The zz coefficients of the spherical polynomial
  115706. */
  115707. zz: Vector3;
  115708. /**
  115709. * The xy coefficients of the spherical polynomial
  115710. */
  115711. xy: Vector3;
  115712. /**
  115713. * The yz coefficients of the spherical polynomial
  115714. */
  115715. yz: Vector3;
  115716. /**
  115717. * The zx coefficients of the spherical polynomial
  115718. */
  115719. zx: Vector3;
  115720. /**
  115721. * Adds an ambient color to the spherical polynomial
  115722. * @param color the color to add
  115723. */
  115724. addAmbient(color: Color3): void;
  115725. /**
  115726. * Scales the spherical polynomial by the given amount
  115727. * @param scale the amount to scale
  115728. */
  115729. scaleInPlace(scale: number): void;
  115730. /**
  115731. * Gets the spherical polynomial from harmonics
  115732. * @param harmonics the spherical harmonics
  115733. * @returns the spherical polynomial
  115734. */
  115735. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  115736. /**
  115737. * Constructs a spherical polynomial from an array.
  115738. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  115739. * @returns the spherical polynomial
  115740. */
  115741. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  115742. }
  115743. }
  115744. declare module BABYLON {
  115745. /**
  115746. * Defines the source of the internal texture
  115747. */
  115748. export enum InternalTextureSource {
  115749. /**
  115750. * The source of the texture data is unknown
  115751. */
  115752. Unknown = 0,
  115753. /**
  115754. * Texture data comes from an URL
  115755. */
  115756. Url = 1,
  115757. /**
  115758. * Texture data is only used for temporary storage
  115759. */
  115760. Temp = 2,
  115761. /**
  115762. * Texture data comes from raw data (ArrayBuffer)
  115763. */
  115764. Raw = 3,
  115765. /**
  115766. * Texture content is dynamic (video or dynamic texture)
  115767. */
  115768. Dynamic = 4,
  115769. /**
  115770. * Texture content is generated by rendering to it
  115771. */
  115772. RenderTarget = 5,
  115773. /**
  115774. * Texture content is part of a multi render target process
  115775. */
  115776. MultiRenderTarget = 6,
  115777. /**
  115778. * Texture data comes from a cube data file
  115779. */
  115780. Cube = 7,
  115781. /**
  115782. * Texture data comes from a raw cube data
  115783. */
  115784. CubeRaw = 8,
  115785. /**
  115786. * Texture data come from a prefiltered cube data file
  115787. */
  115788. CubePrefiltered = 9,
  115789. /**
  115790. * Texture content is raw 3D data
  115791. */
  115792. Raw3D = 10,
  115793. /**
  115794. * Texture content is raw 2D array data
  115795. */
  115796. Raw2DArray = 11,
  115797. /**
  115798. * Texture content is a depth texture
  115799. */
  115800. Depth = 12,
  115801. /**
  115802. * Texture data comes from a raw cube data encoded with RGBD
  115803. */
  115804. CubeRawRGBD = 13
  115805. }
  115806. /**
  115807. * Class used to store data associated with WebGL texture data for the engine
  115808. * This class should not be used directly
  115809. */
  115810. export class InternalTexture {
  115811. /** @hidden */
  115812. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  115813. /**
  115814. * Defines if the texture is ready
  115815. */
  115816. isReady: boolean;
  115817. /**
  115818. * Defines if the texture is a cube texture
  115819. */
  115820. isCube: boolean;
  115821. /**
  115822. * Defines if the texture contains 3D data
  115823. */
  115824. is3D: boolean;
  115825. /**
  115826. * Defines if the texture contains 2D array data
  115827. */
  115828. is2DArray: boolean;
  115829. /**
  115830. * Defines if the texture contains multiview data
  115831. */
  115832. isMultiview: boolean;
  115833. /**
  115834. * Gets the URL used to load this texture
  115835. */
  115836. url: string;
  115837. /**
  115838. * Gets the sampling mode of the texture
  115839. */
  115840. samplingMode: number;
  115841. /**
  115842. * Gets a boolean indicating if the texture needs mipmaps generation
  115843. */
  115844. generateMipMaps: boolean;
  115845. /**
  115846. * Gets the number of samples used by the texture (WebGL2+ only)
  115847. */
  115848. samples: number;
  115849. /**
  115850. * Gets the type of the texture (int, float...)
  115851. */
  115852. type: number;
  115853. /**
  115854. * Gets the format of the texture (RGB, RGBA...)
  115855. */
  115856. format: number;
  115857. /**
  115858. * Observable called when the texture is loaded
  115859. */
  115860. onLoadedObservable: Observable<InternalTexture>;
  115861. /**
  115862. * Gets the width of the texture
  115863. */
  115864. width: number;
  115865. /**
  115866. * Gets the height of the texture
  115867. */
  115868. height: number;
  115869. /**
  115870. * Gets the depth of the texture
  115871. */
  115872. depth: number;
  115873. /**
  115874. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  115875. */
  115876. baseWidth: number;
  115877. /**
  115878. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  115879. */
  115880. baseHeight: number;
  115881. /**
  115882. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  115883. */
  115884. baseDepth: number;
  115885. /**
  115886. * Gets a boolean indicating if the texture is inverted on Y axis
  115887. */
  115888. invertY: boolean;
  115889. /** @hidden */
  115890. _invertVScale: boolean;
  115891. /** @hidden */
  115892. _associatedChannel: number;
  115893. /** @hidden */
  115894. _source: InternalTextureSource;
  115895. /** @hidden */
  115896. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  115897. /** @hidden */
  115898. _bufferView: Nullable<ArrayBufferView>;
  115899. /** @hidden */
  115900. _bufferViewArray: Nullable<ArrayBufferView[]>;
  115901. /** @hidden */
  115902. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  115903. /** @hidden */
  115904. _size: number;
  115905. /** @hidden */
  115906. _extension: string;
  115907. /** @hidden */
  115908. _files: Nullable<string[]>;
  115909. /** @hidden */
  115910. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115911. /** @hidden */
  115912. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115913. /** @hidden */
  115914. _framebuffer: Nullable<WebGLFramebuffer>;
  115915. /** @hidden */
  115916. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  115917. /** @hidden */
  115918. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  115919. /** @hidden */
  115920. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  115921. /** @hidden */
  115922. _attachments: Nullable<number[]>;
  115923. /** @hidden */
  115924. _textureArray: Nullable<InternalTexture[]>;
  115925. /** @hidden */
  115926. _cachedCoordinatesMode: Nullable<number>;
  115927. /** @hidden */
  115928. _cachedWrapU: Nullable<number>;
  115929. /** @hidden */
  115930. _cachedWrapV: Nullable<number>;
  115931. /** @hidden */
  115932. _cachedWrapR: Nullable<number>;
  115933. /** @hidden */
  115934. _cachedAnisotropicFilteringLevel: Nullable<number>;
  115935. /** @hidden */
  115936. _isDisabled: boolean;
  115937. /** @hidden */
  115938. _compression: Nullable<string>;
  115939. /** @hidden */
  115940. _generateStencilBuffer: boolean;
  115941. /** @hidden */
  115942. _generateDepthBuffer: boolean;
  115943. /** @hidden */
  115944. _comparisonFunction: number;
  115945. /** @hidden */
  115946. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  115947. /** @hidden */
  115948. _lodGenerationScale: number;
  115949. /** @hidden */
  115950. _lodGenerationOffset: number;
  115951. /** @hidden */
  115952. _depthStencilTexture: Nullable<InternalTexture>;
  115953. /** @hidden */
  115954. _colorTextureArray: Nullable<WebGLTexture>;
  115955. /** @hidden */
  115956. _depthStencilTextureArray: Nullable<WebGLTexture>;
  115957. /** @hidden */
  115958. _lodTextureHigh: Nullable<BaseTexture>;
  115959. /** @hidden */
  115960. _lodTextureMid: Nullable<BaseTexture>;
  115961. /** @hidden */
  115962. _lodTextureLow: Nullable<BaseTexture>;
  115963. /** @hidden */
  115964. _isRGBD: boolean;
  115965. /** @hidden */
  115966. _linearSpecularLOD: boolean;
  115967. /** @hidden */
  115968. _irradianceTexture: Nullable<BaseTexture>;
  115969. /** @hidden */
  115970. _webGLTexture: Nullable<WebGLTexture>;
  115971. /** @hidden */
  115972. _references: number;
  115973. private _engine;
  115974. /**
  115975. * Gets the Engine the texture belongs to.
  115976. * @returns The babylon engine
  115977. */
  115978. getEngine(): ThinEngine;
  115979. /**
  115980. * Gets the data source type of the texture
  115981. */
  115982. get source(): InternalTextureSource;
  115983. /**
  115984. * Creates a new InternalTexture
  115985. * @param engine defines the engine to use
  115986. * @param source defines the type of data that will be used
  115987. * @param delayAllocation if the texture allocation should be delayed (default: false)
  115988. */
  115989. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  115990. /**
  115991. * Increments the number of references (ie. the number of Texture that point to it)
  115992. */
  115993. incrementReferences(): void;
  115994. /**
  115995. * Change the size of the texture (not the size of the content)
  115996. * @param width defines the new width
  115997. * @param height defines the new height
  115998. * @param depth defines the new depth (1 by default)
  115999. */
  116000. updateSize(width: int, height: int, depth?: int): void;
  116001. /** @hidden */
  116002. _rebuild(): void;
  116003. /** @hidden */
  116004. _swapAndDie(target: InternalTexture): void;
  116005. /**
  116006. * Dispose the current allocated resources
  116007. */
  116008. dispose(): void;
  116009. }
  116010. }
  116011. declare module BABYLON {
  116012. /**
  116013. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116014. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116015. */
  116016. export class Analyser {
  116017. /**
  116018. * Gets or sets the smoothing
  116019. * @ignorenaming
  116020. */
  116021. SMOOTHING: number;
  116022. /**
  116023. * Gets or sets the FFT table size
  116024. * @ignorenaming
  116025. */
  116026. FFT_SIZE: number;
  116027. /**
  116028. * Gets or sets the bar graph amplitude
  116029. * @ignorenaming
  116030. */
  116031. BARGRAPHAMPLITUDE: number;
  116032. /**
  116033. * Gets or sets the position of the debug canvas
  116034. * @ignorenaming
  116035. */
  116036. DEBUGCANVASPOS: {
  116037. x: number;
  116038. y: number;
  116039. };
  116040. /**
  116041. * Gets or sets the debug canvas size
  116042. * @ignorenaming
  116043. */
  116044. DEBUGCANVASSIZE: {
  116045. width: number;
  116046. height: number;
  116047. };
  116048. private _byteFreqs;
  116049. private _byteTime;
  116050. private _floatFreqs;
  116051. private _webAudioAnalyser;
  116052. private _debugCanvas;
  116053. private _debugCanvasContext;
  116054. private _scene;
  116055. private _registerFunc;
  116056. private _audioEngine;
  116057. /**
  116058. * Creates a new analyser
  116059. * @param scene defines hosting scene
  116060. */
  116061. constructor(scene: Scene);
  116062. /**
  116063. * Get the number of data values you will have to play with for the visualization
  116064. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116065. * @returns a number
  116066. */
  116067. getFrequencyBinCount(): number;
  116068. /**
  116069. * Gets the current frequency data as a byte array
  116070. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116071. * @returns a Uint8Array
  116072. */
  116073. getByteFrequencyData(): Uint8Array;
  116074. /**
  116075. * Gets the current waveform as a byte array
  116076. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116077. * @returns a Uint8Array
  116078. */
  116079. getByteTimeDomainData(): Uint8Array;
  116080. /**
  116081. * Gets the current frequency data as a float array
  116082. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116083. * @returns a Float32Array
  116084. */
  116085. getFloatFrequencyData(): Float32Array;
  116086. /**
  116087. * Renders the debug canvas
  116088. */
  116089. drawDebugCanvas(): void;
  116090. /**
  116091. * Stops rendering the debug canvas and removes it
  116092. */
  116093. stopDebugCanvas(): void;
  116094. /**
  116095. * Connects two audio nodes
  116096. * @param inputAudioNode defines first node to connect
  116097. * @param outputAudioNode defines second node to connect
  116098. */
  116099. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116100. /**
  116101. * Releases all associated resources
  116102. */
  116103. dispose(): void;
  116104. }
  116105. }
  116106. declare module BABYLON {
  116107. /**
  116108. * This represents an audio engine and it is responsible
  116109. * to play, synchronize and analyse sounds throughout the application.
  116110. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116111. */
  116112. export interface IAudioEngine extends IDisposable {
  116113. /**
  116114. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116115. */
  116116. readonly canUseWebAudio: boolean;
  116117. /**
  116118. * Gets the current AudioContext if available.
  116119. */
  116120. readonly audioContext: Nullable<AudioContext>;
  116121. /**
  116122. * The master gain node defines the global audio volume of your audio engine.
  116123. */
  116124. readonly masterGain: GainNode;
  116125. /**
  116126. * Gets whether or not mp3 are supported by your browser.
  116127. */
  116128. readonly isMP3supported: boolean;
  116129. /**
  116130. * Gets whether or not ogg are supported by your browser.
  116131. */
  116132. readonly isOGGsupported: boolean;
  116133. /**
  116134. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116135. * @ignoreNaming
  116136. */
  116137. WarnedWebAudioUnsupported: boolean;
  116138. /**
  116139. * Defines if the audio engine relies on a custom unlocked button.
  116140. * In this case, the embedded button will not be displayed.
  116141. */
  116142. useCustomUnlockedButton: boolean;
  116143. /**
  116144. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116145. */
  116146. readonly unlocked: boolean;
  116147. /**
  116148. * Event raised when audio has been unlocked on the browser.
  116149. */
  116150. onAudioUnlockedObservable: Observable<AudioEngine>;
  116151. /**
  116152. * Event raised when audio has been locked on the browser.
  116153. */
  116154. onAudioLockedObservable: Observable<AudioEngine>;
  116155. /**
  116156. * Flags the audio engine in Locked state.
  116157. * This happens due to new browser policies preventing audio to autoplay.
  116158. */
  116159. lock(): void;
  116160. /**
  116161. * Unlocks the audio engine once a user action has been done on the dom.
  116162. * This is helpful to resume play once browser policies have been satisfied.
  116163. */
  116164. unlock(): void;
  116165. /**
  116166. * Gets the global volume sets on the master gain.
  116167. * @returns the global volume if set or -1 otherwise
  116168. */
  116169. getGlobalVolume(): number;
  116170. /**
  116171. * Sets the global volume of your experience (sets on the master gain).
  116172. * @param newVolume Defines the new global volume of the application
  116173. */
  116174. setGlobalVolume(newVolume: number): void;
  116175. /**
  116176. * Connect the audio engine to an audio analyser allowing some amazing
  116177. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116178. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116179. * @param analyser The analyser to connect to the engine
  116180. */
  116181. connectToAnalyser(analyser: Analyser): void;
  116182. }
  116183. /**
  116184. * This represents the default audio engine used in babylon.
  116185. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116186. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116187. */
  116188. export class AudioEngine implements IAudioEngine {
  116189. private _audioContext;
  116190. private _audioContextInitialized;
  116191. private _muteButton;
  116192. private _hostElement;
  116193. /**
  116194. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116195. */
  116196. canUseWebAudio: boolean;
  116197. /**
  116198. * The master gain node defines the global audio volume of your audio engine.
  116199. */
  116200. masterGain: GainNode;
  116201. /**
  116202. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116203. * @ignoreNaming
  116204. */
  116205. WarnedWebAudioUnsupported: boolean;
  116206. /**
  116207. * Gets whether or not mp3 are supported by your browser.
  116208. */
  116209. isMP3supported: boolean;
  116210. /**
  116211. * Gets whether or not ogg are supported by your browser.
  116212. */
  116213. isOGGsupported: boolean;
  116214. /**
  116215. * Gets whether audio has been unlocked on the device.
  116216. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116217. * a user interaction has happened.
  116218. */
  116219. unlocked: boolean;
  116220. /**
  116221. * Defines if the audio engine relies on a custom unlocked button.
  116222. * In this case, the embedded button will not be displayed.
  116223. */
  116224. useCustomUnlockedButton: boolean;
  116225. /**
  116226. * Event raised when audio has been unlocked on the browser.
  116227. */
  116228. onAudioUnlockedObservable: Observable<AudioEngine>;
  116229. /**
  116230. * Event raised when audio has been locked on the browser.
  116231. */
  116232. onAudioLockedObservable: Observable<AudioEngine>;
  116233. /**
  116234. * Gets the current AudioContext if available.
  116235. */
  116236. get audioContext(): Nullable<AudioContext>;
  116237. private _connectedAnalyser;
  116238. /**
  116239. * Instantiates a new audio engine.
  116240. *
  116241. * There should be only one per page as some browsers restrict the number
  116242. * of audio contexts you can create.
  116243. * @param hostElement defines the host element where to display the mute icon if necessary
  116244. */
  116245. constructor(hostElement?: Nullable<HTMLElement>);
  116246. /**
  116247. * Flags the audio engine in Locked state.
  116248. * This happens due to new browser policies preventing audio to autoplay.
  116249. */
  116250. lock(): void;
  116251. /**
  116252. * Unlocks the audio engine once a user action has been done on the dom.
  116253. * This is helpful to resume play once browser policies have been satisfied.
  116254. */
  116255. unlock(): void;
  116256. private _resumeAudioContext;
  116257. private _initializeAudioContext;
  116258. private _tryToRun;
  116259. private _triggerRunningState;
  116260. private _triggerSuspendedState;
  116261. private _displayMuteButton;
  116262. private _moveButtonToTopLeft;
  116263. private _onResize;
  116264. private _hideMuteButton;
  116265. /**
  116266. * Destroy and release the resources associated with the audio ccontext.
  116267. */
  116268. dispose(): void;
  116269. /**
  116270. * Gets the global volume sets on the master gain.
  116271. * @returns the global volume if set or -1 otherwise
  116272. */
  116273. getGlobalVolume(): number;
  116274. /**
  116275. * Sets the global volume of your experience (sets on the master gain).
  116276. * @param newVolume Defines the new global volume of the application
  116277. */
  116278. setGlobalVolume(newVolume: number): void;
  116279. /**
  116280. * Connect the audio engine to an audio analyser allowing some amazing
  116281. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116282. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116283. * @param analyser The analyser to connect to the engine
  116284. */
  116285. connectToAnalyser(analyser: Analyser): void;
  116286. }
  116287. }
  116288. declare module BABYLON {
  116289. /**
  116290. * Interface used to present a loading screen while loading a scene
  116291. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116292. */
  116293. export interface ILoadingScreen {
  116294. /**
  116295. * Function called to display the loading screen
  116296. */
  116297. displayLoadingUI: () => void;
  116298. /**
  116299. * Function called to hide the loading screen
  116300. */
  116301. hideLoadingUI: () => void;
  116302. /**
  116303. * Gets or sets the color to use for the background
  116304. */
  116305. loadingUIBackgroundColor: string;
  116306. /**
  116307. * Gets or sets the text to display while loading
  116308. */
  116309. loadingUIText: string;
  116310. }
  116311. /**
  116312. * Class used for the default loading screen
  116313. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116314. */
  116315. export class DefaultLoadingScreen implements ILoadingScreen {
  116316. private _renderingCanvas;
  116317. private _loadingText;
  116318. private _loadingDivBackgroundColor;
  116319. private _loadingDiv;
  116320. private _loadingTextDiv;
  116321. /** Gets or sets the logo url to use for the default loading screen */
  116322. static DefaultLogoUrl: string;
  116323. /** Gets or sets the spinner url to use for the default loading screen */
  116324. static DefaultSpinnerUrl: string;
  116325. /**
  116326. * Creates a new default loading screen
  116327. * @param _renderingCanvas defines the canvas used to render the scene
  116328. * @param _loadingText defines the default text to display
  116329. * @param _loadingDivBackgroundColor defines the default background color
  116330. */
  116331. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116332. /**
  116333. * Function called to display the loading screen
  116334. */
  116335. displayLoadingUI(): void;
  116336. /**
  116337. * Function called to hide the loading screen
  116338. */
  116339. hideLoadingUI(): void;
  116340. /**
  116341. * Gets or sets the text to display while loading
  116342. */
  116343. set loadingUIText(text: string);
  116344. get loadingUIText(): string;
  116345. /**
  116346. * Gets or sets the color to use for the background
  116347. */
  116348. get loadingUIBackgroundColor(): string;
  116349. set loadingUIBackgroundColor(color: string);
  116350. private _resizeLoadingUI;
  116351. }
  116352. }
  116353. declare module BABYLON {
  116354. /**
  116355. * Interface for any object that can request an animation frame
  116356. */
  116357. export interface ICustomAnimationFrameRequester {
  116358. /**
  116359. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116360. */
  116361. renderFunction?: Function;
  116362. /**
  116363. * Called to request the next frame to render to
  116364. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116365. */
  116366. requestAnimationFrame: Function;
  116367. /**
  116368. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116369. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116370. */
  116371. requestID?: number;
  116372. }
  116373. }
  116374. declare module BABYLON {
  116375. /**
  116376. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116377. */
  116378. export class PerformanceMonitor {
  116379. private _enabled;
  116380. private _rollingFrameTime;
  116381. private _lastFrameTimeMs;
  116382. /**
  116383. * constructor
  116384. * @param frameSampleSize The number of samples required to saturate the sliding window
  116385. */
  116386. constructor(frameSampleSize?: number);
  116387. /**
  116388. * Samples current frame
  116389. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116390. */
  116391. sampleFrame(timeMs?: number): void;
  116392. /**
  116393. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116394. */
  116395. get averageFrameTime(): number;
  116396. /**
  116397. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116398. */
  116399. get averageFrameTimeVariance(): number;
  116400. /**
  116401. * Returns the frame time of the most recent frame
  116402. */
  116403. get instantaneousFrameTime(): number;
  116404. /**
  116405. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116406. */
  116407. get averageFPS(): number;
  116408. /**
  116409. * Returns the average framerate in frames per second using the most recent frame time
  116410. */
  116411. get instantaneousFPS(): number;
  116412. /**
  116413. * Returns true if enough samples have been taken to completely fill the sliding window
  116414. */
  116415. get isSaturated(): boolean;
  116416. /**
  116417. * Enables contributions to the sliding window sample set
  116418. */
  116419. enable(): void;
  116420. /**
  116421. * Disables contributions to the sliding window sample set
  116422. * Samples will not be interpolated over the disabled period
  116423. */
  116424. disable(): void;
  116425. /**
  116426. * Returns true if sampling is enabled
  116427. */
  116428. get isEnabled(): boolean;
  116429. /**
  116430. * Resets performance monitor
  116431. */
  116432. reset(): void;
  116433. }
  116434. /**
  116435. * RollingAverage
  116436. *
  116437. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116438. */
  116439. export class RollingAverage {
  116440. /**
  116441. * Current average
  116442. */
  116443. average: number;
  116444. /**
  116445. * Current variance
  116446. */
  116447. variance: number;
  116448. protected _samples: Array<number>;
  116449. protected _sampleCount: number;
  116450. protected _pos: number;
  116451. protected _m2: number;
  116452. /**
  116453. * constructor
  116454. * @param length The number of samples required to saturate the sliding window
  116455. */
  116456. constructor(length: number);
  116457. /**
  116458. * Adds a sample to the sample set
  116459. * @param v The sample value
  116460. */
  116461. add(v: number): void;
  116462. /**
  116463. * Returns previously added values or null if outside of history or outside the sliding window domain
  116464. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116465. * @return Value previously recorded with add() or null if outside of range
  116466. */
  116467. history(i: number): number;
  116468. /**
  116469. * Returns true if enough samples have been taken to completely fill the sliding window
  116470. * @return true if sample-set saturated
  116471. */
  116472. isSaturated(): boolean;
  116473. /**
  116474. * Resets the rolling average (equivalent to 0 samples taken so far)
  116475. */
  116476. reset(): void;
  116477. /**
  116478. * Wraps a value around the sample range boundaries
  116479. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116480. * @return Wrapped position in sample range
  116481. */
  116482. protected _wrapPosition(i: number): number;
  116483. }
  116484. }
  116485. declare module BABYLON {
  116486. /**
  116487. * This class is used to track a performance counter which is number based.
  116488. * The user has access to many properties which give statistics of different nature.
  116489. *
  116490. * The implementer can track two kinds of Performance Counter: time and count.
  116491. * 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.
  116492. * 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.
  116493. */
  116494. export class PerfCounter {
  116495. /**
  116496. * Gets or sets a global boolean to turn on and off all the counters
  116497. */
  116498. static Enabled: boolean;
  116499. /**
  116500. * Returns the smallest value ever
  116501. */
  116502. get min(): number;
  116503. /**
  116504. * Returns the biggest value ever
  116505. */
  116506. get max(): number;
  116507. /**
  116508. * Returns the average value since the performance counter is running
  116509. */
  116510. get average(): number;
  116511. /**
  116512. * Returns the average value of the last second the counter was monitored
  116513. */
  116514. get lastSecAverage(): number;
  116515. /**
  116516. * Returns the current value
  116517. */
  116518. get current(): number;
  116519. /**
  116520. * Gets the accumulated total
  116521. */
  116522. get total(): number;
  116523. /**
  116524. * Gets the total value count
  116525. */
  116526. get count(): number;
  116527. /**
  116528. * Creates a new counter
  116529. */
  116530. constructor();
  116531. /**
  116532. * Call this method to start monitoring a new frame.
  116533. * 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.
  116534. */
  116535. fetchNewFrame(): void;
  116536. /**
  116537. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  116538. * @param newCount the count value to add to the monitored count
  116539. * @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.
  116540. */
  116541. addCount(newCount: number, fetchResult: boolean): void;
  116542. /**
  116543. * Start monitoring this performance counter
  116544. */
  116545. beginMonitoring(): void;
  116546. /**
  116547. * Compute the time lapsed since the previous beginMonitoring() call.
  116548. * @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
  116549. */
  116550. endMonitoring(newFrame?: boolean): void;
  116551. private _fetchResult;
  116552. private _startMonitoringTime;
  116553. private _min;
  116554. private _max;
  116555. private _average;
  116556. private _current;
  116557. private _totalValueCount;
  116558. private _totalAccumulated;
  116559. private _lastSecAverage;
  116560. private _lastSecAccumulated;
  116561. private _lastSecTime;
  116562. private _lastSecValueCount;
  116563. }
  116564. }
  116565. declare module BABYLON {
  116566. interface ThinEngine {
  116567. /** @hidden */
  116568. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  116569. }
  116570. }
  116571. declare module BABYLON {
  116572. /**
  116573. * Defines the interface used by display changed events
  116574. */
  116575. export interface IDisplayChangedEventArgs {
  116576. /** Gets the vrDisplay object (if any) */
  116577. vrDisplay: Nullable<any>;
  116578. /** Gets a boolean indicating if webVR is supported */
  116579. vrSupported: boolean;
  116580. }
  116581. /**
  116582. * Defines the interface used by objects containing a viewport (like a camera)
  116583. */
  116584. interface IViewportOwnerLike {
  116585. /**
  116586. * Gets or sets the viewport
  116587. */
  116588. viewport: IViewportLike;
  116589. }
  116590. /**
  116591. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  116592. */
  116593. export class Engine extends ThinEngine {
  116594. /** Defines that alpha blending is disabled */
  116595. static readonly ALPHA_DISABLE: number;
  116596. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  116597. static readonly ALPHA_ADD: number;
  116598. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  116599. static readonly ALPHA_COMBINE: number;
  116600. /** Defines that alpha blending to DEST - SRC * DEST */
  116601. static readonly ALPHA_SUBTRACT: number;
  116602. /** Defines that alpha blending to SRC * DEST */
  116603. static readonly ALPHA_MULTIPLY: number;
  116604. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  116605. static readonly ALPHA_MAXIMIZED: number;
  116606. /** Defines that alpha blending to SRC + DEST */
  116607. static readonly ALPHA_ONEONE: number;
  116608. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  116609. static readonly ALPHA_PREMULTIPLIED: number;
  116610. /**
  116611. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  116612. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  116613. */
  116614. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  116615. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  116616. static readonly ALPHA_INTERPOLATE: number;
  116617. /**
  116618. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  116619. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  116620. */
  116621. static readonly ALPHA_SCREENMODE: number;
  116622. /** Defines that the ressource is not delayed*/
  116623. static readonly DELAYLOADSTATE_NONE: number;
  116624. /** Defines that the ressource was successfully delay loaded */
  116625. static readonly DELAYLOADSTATE_LOADED: number;
  116626. /** Defines that the ressource is currently delay loading */
  116627. static readonly DELAYLOADSTATE_LOADING: number;
  116628. /** Defines that the ressource is delayed and has not started loading */
  116629. static readonly DELAYLOADSTATE_NOTLOADED: number;
  116630. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  116631. static readonly NEVER: number;
  116632. /** 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 */
  116633. static readonly ALWAYS: number;
  116634. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  116635. static readonly LESS: number;
  116636. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  116637. static readonly EQUAL: number;
  116638. /** 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 */
  116639. static readonly LEQUAL: number;
  116640. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  116641. static readonly GREATER: number;
  116642. /** 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 */
  116643. static readonly GEQUAL: number;
  116644. /** 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 */
  116645. static readonly NOTEQUAL: number;
  116646. /** Passed to stencilOperation to specify that stencil value must be kept */
  116647. static readonly KEEP: number;
  116648. /** Passed to stencilOperation to specify that stencil value must be replaced */
  116649. static readonly REPLACE: number;
  116650. /** Passed to stencilOperation to specify that stencil value must be incremented */
  116651. static readonly INCR: number;
  116652. /** Passed to stencilOperation to specify that stencil value must be decremented */
  116653. static readonly DECR: number;
  116654. /** Passed to stencilOperation to specify that stencil value must be inverted */
  116655. static readonly INVERT: number;
  116656. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  116657. static readonly INCR_WRAP: number;
  116658. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  116659. static readonly DECR_WRAP: number;
  116660. /** Texture is not repeating outside of 0..1 UVs */
  116661. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  116662. /** Texture is repeating outside of 0..1 UVs */
  116663. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  116664. /** Texture is repeating and mirrored */
  116665. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  116666. /** ALPHA */
  116667. static readonly TEXTUREFORMAT_ALPHA: number;
  116668. /** LUMINANCE */
  116669. static readonly TEXTUREFORMAT_LUMINANCE: number;
  116670. /** LUMINANCE_ALPHA */
  116671. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  116672. /** RGB */
  116673. static readonly TEXTUREFORMAT_RGB: number;
  116674. /** RGBA */
  116675. static readonly TEXTUREFORMAT_RGBA: number;
  116676. /** RED */
  116677. static readonly TEXTUREFORMAT_RED: number;
  116678. /** RED (2nd reference) */
  116679. static readonly TEXTUREFORMAT_R: number;
  116680. /** RG */
  116681. static readonly TEXTUREFORMAT_RG: number;
  116682. /** RED_INTEGER */
  116683. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  116684. /** RED_INTEGER (2nd reference) */
  116685. static readonly TEXTUREFORMAT_R_INTEGER: number;
  116686. /** RG_INTEGER */
  116687. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  116688. /** RGB_INTEGER */
  116689. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  116690. /** RGBA_INTEGER */
  116691. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  116692. /** UNSIGNED_BYTE */
  116693. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  116694. /** UNSIGNED_BYTE (2nd reference) */
  116695. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  116696. /** FLOAT */
  116697. static readonly TEXTURETYPE_FLOAT: number;
  116698. /** HALF_FLOAT */
  116699. static readonly TEXTURETYPE_HALF_FLOAT: number;
  116700. /** BYTE */
  116701. static readonly TEXTURETYPE_BYTE: number;
  116702. /** SHORT */
  116703. static readonly TEXTURETYPE_SHORT: number;
  116704. /** UNSIGNED_SHORT */
  116705. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  116706. /** INT */
  116707. static readonly TEXTURETYPE_INT: number;
  116708. /** UNSIGNED_INT */
  116709. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  116710. /** UNSIGNED_SHORT_4_4_4_4 */
  116711. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  116712. /** UNSIGNED_SHORT_5_5_5_1 */
  116713. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  116714. /** UNSIGNED_SHORT_5_6_5 */
  116715. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  116716. /** UNSIGNED_INT_2_10_10_10_REV */
  116717. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  116718. /** UNSIGNED_INT_24_8 */
  116719. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  116720. /** UNSIGNED_INT_10F_11F_11F_REV */
  116721. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  116722. /** UNSIGNED_INT_5_9_9_9_REV */
  116723. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  116724. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  116725. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  116726. /** nearest is mag = nearest and min = nearest and mip = linear */
  116727. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  116728. /** Bilinear is mag = linear and min = linear and mip = nearest */
  116729. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  116730. /** Trilinear is mag = linear and min = linear and mip = linear */
  116731. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  116732. /** nearest is mag = nearest and min = nearest and mip = linear */
  116733. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  116734. /** Bilinear is mag = linear and min = linear and mip = nearest */
  116735. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  116736. /** Trilinear is mag = linear and min = linear and mip = linear */
  116737. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  116738. /** mag = nearest and min = nearest and mip = nearest */
  116739. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  116740. /** mag = nearest and min = linear and mip = nearest */
  116741. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  116742. /** mag = nearest and min = linear and mip = linear */
  116743. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  116744. /** mag = nearest and min = linear and mip = none */
  116745. static readonly TEXTURE_NEAREST_LINEAR: number;
  116746. /** mag = nearest and min = nearest and mip = none */
  116747. static readonly TEXTURE_NEAREST_NEAREST: number;
  116748. /** mag = linear and min = nearest and mip = nearest */
  116749. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  116750. /** mag = linear and min = nearest and mip = linear */
  116751. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  116752. /** mag = linear and min = linear and mip = none */
  116753. static readonly TEXTURE_LINEAR_LINEAR: number;
  116754. /** mag = linear and min = nearest and mip = none */
  116755. static readonly TEXTURE_LINEAR_NEAREST: number;
  116756. /** Explicit coordinates mode */
  116757. static readonly TEXTURE_EXPLICIT_MODE: number;
  116758. /** Spherical coordinates mode */
  116759. static readonly TEXTURE_SPHERICAL_MODE: number;
  116760. /** Planar coordinates mode */
  116761. static readonly TEXTURE_PLANAR_MODE: number;
  116762. /** Cubic coordinates mode */
  116763. static readonly TEXTURE_CUBIC_MODE: number;
  116764. /** Projection coordinates mode */
  116765. static readonly TEXTURE_PROJECTION_MODE: number;
  116766. /** Skybox coordinates mode */
  116767. static readonly TEXTURE_SKYBOX_MODE: number;
  116768. /** Inverse Cubic coordinates mode */
  116769. static readonly TEXTURE_INVCUBIC_MODE: number;
  116770. /** Equirectangular coordinates mode */
  116771. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  116772. /** Equirectangular Fixed coordinates mode */
  116773. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  116774. /** Equirectangular Fixed Mirrored coordinates mode */
  116775. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  116776. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  116777. static readonly SCALEMODE_FLOOR: number;
  116778. /** Defines that texture rescaling will look for the nearest power of 2 size */
  116779. static readonly SCALEMODE_NEAREST: number;
  116780. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  116781. static readonly SCALEMODE_CEILING: number;
  116782. /**
  116783. * Returns the current npm package of the sdk
  116784. */
  116785. static get NpmPackage(): string;
  116786. /**
  116787. * Returns the current version of the framework
  116788. */
  116789. static get Version(): string;
  116790. /** Gets the list of created engines */
  116791. static get Instances(): Engine[];
  116792. /**
  116793. * Gets the latest created engine
  116794. */
  116795. static get LastCreatedEngine(): Nullable<Engine>;
  116796. /**
  116797. * Gets the latest created scene
  116798. */
  116799. static get LastCreatedScene(): Nullable<Scene>;
  116800. /**
  116801. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  116802. * @param flag defines which part of the materials must be marked as dirty
  116803. * @param predicate defines a predicate used to filter which materials should be affected
  116804. */
  116805. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  116806. /**
  116807. * Method called to create the default loading screen.
  116808. * This can be overriden in your own app.
  116809. * @param canvas The rendering canvas element
  116810. * @returns The loading screen
  116811. */
  116812. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  116813. /**
  116814. * Method called to create the default rescale post process on each engine.
  116815. */
  116816. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  116817. /**
  116818. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  116819. **/
  116820. enableOfflineSupport: boolean;
  116821. /**
  116822. * 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)
  116823. **/
  116824. disableManifestCheck: boolean;
  116825. /**
  116826. * Gets the list of created scenes
  116827. */
  116828. scenes: Scene[];
  116829. /**
  116830. * Event raised when a new scene is created
  116831. */
  116832. onNewSceneAddedObservable: Observable<Scene>;
  116833. /**
  116834. * Gets the list of created postprocesses
  116835. */
  116836. postProcesses: PostProcess[];
  116837. /**
  116838. * Gets a boolean indicating if the pointer is currently locked
  116839. */
  116840. isPointerLock: boolean;
  116841. /**
  116842. * Observable event triggered each time the rendering canvas is resized
  116843. */
  116844. onResizeObservable: Observable<Engine>;
  116845. /**
  116846. * Observable event triggered each time the canvas loses focus
  116847. */
  116848. onCanvasBlurObservable: Observable<Engine>;
  116849. /**
  116850. * Observable event triggered each time the canvas gains focus
  116851. */
  116852. onCanvasFocusObservable: Observable<Engine>;
  116853. /**
  116854. * Observable event triggered each time the canvas receives pointerout event
  116855. */
  116856. onCanvasPointerOutObservable: Observable<PointerEvent>;
  116857. /**
  116858. * Observable raised when the engine begins a new frame
  116859. */
  116860. onBeginFrameObservable: Observable<Engine>;
  116861. /**
  116862. * If set, will be used to request the next animation frame for the render loop
  116863. */
  116864. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  116865. /**
  116866. * Observable raised when the engine ends the current frame
  116867. */
  116868. onEndFrameObservable: Observable<Engine>;
  116869. /**
  116870. * Observable raised when the engine is about to compile a shader
  116871. */
  116872. onBeforeShaderCompilationObservable: Observable<Engine>;
  116873. /**
  116874. * Observable raised when the engine has jsut compiled a shader
  116875. */
  116876. onAfterShaderCompilationObservable: Observable<Engine>;
  116877. /**
  116878. * Gets the audio engine
  116879. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116880. * @ignorenaming
  116881. */
  116882. static audioEngine: IAudioEngine;
  116883. /**
  116884. * Default AudioEngine factory responsible of creating the Audio Engine.
  116885. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  116886. */
  116887. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  116888. /**
  116889. * Default offline support factory responsible of creating a tool used to store data locally.
  116890. * By default, this will create a Database object if the workload has been embedded.
  116891. */
  116892. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  116893. private _loadingScreen;
  116894. private _pointerLockRequested;
  116895. private _rescalePostProcess;
  116896. private _deterministicLockstep;
  116897. private _lockstepMaxSteps;
  116898. private _timeStep;
  116899. protected get _supportsHardwareTextureRescaling(): boolean;
  116900. private _fps;
  116901. private _deltaTime;
  116902. /** @hidden */
  116903. _drawCalls: PerfCounter;
  116904. /** 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 */
  116905. canvasTabIndex: number;
  116906. /**
  116907. * Turn this value on if you want to pause FPS computation when in background
  116908. */
  116909. disablePerformanceMonitorInBackground: boolean;
  116910. private _performanceMonitor;
  116911. /**
  116912. * Gets the performance monitor attached to this engine
  116913. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  116914. */
  116915. get performanceMonitor(): PerformanceMonitor;
  116916. private _onFocus;
  116917. private _onBlur;
  116918. private _onCanvasPointerOut;
  116919. private _onCanvasBlur;
  116920. private _onCanvasFocus;
  116921. private _onFullscreenChange;
  116922. private _onPointerLockChange;
  116923. /**
  116924. * Gets the HTML element used to attach event listeners
  116925. * @returns a HTML element
  116926. */
  116927. getInputElement(): Nullable<HTMLElement>;
  116928. /**
  116929. * Creates a new engine
  116930. * @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
  116931. * @param antialias defines enable antialiasing (default: false)
  116932. * @param options defines further options to be sent to the getContext() function
  116933. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  116934. */
  116935. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  116936. /**
  116937. * Gets current aspect ratio
  116938. * @param viewportOwner defines the camera to use to get the aspect ratio
  116939. * @param useScreen defines if screen size must be used (or the current render target if any)
  116940. * @returns a number defining the aspect ratio
  116941. */
  116942. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  116943. /**
  116944. * Gets current screen aspect ratio
  116945. * @returns a number defining the aspect ratio
  116946. */
  116947. getScreenAspectRatio(): number;
  116948. /**
  116949. * Gets the client rect of the HTML canvas attached with the current webGL context
  116950. * @returns a client rectanglee
  116951. */
  116952. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  116953. /**
  116954. * Gets the client rect of the HTML element used for events
  116955. * @returns a client rectanglee
  116956. */
  116957. getInputElementClientRect(): Nullable<ClientRect>;
  116958. /**
  116959. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  116960. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116961. * @returns true if engine is in deterministic lock step mode
  116962. */
  116963. isDeterministicLockStep(): boolean;
  116964. /**
  116965. * Gets the max steps when engine is running in deterministic lock step
  116966. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116967. * @returns the max steps
  116968. */
  116969. getLockstepMaxSteps(): number;
  116970. /**
  116971. * Returns the time in ms between steps when using deterministic lock step.
  116972. * @returns time step in (ms)
  116973. */
  116974. getTimeStep(): number;
  116975. /**
  116976. * Force the mipmap generation for the given render target texture
  116977. * @param texture defines the render target texture to use
  116978. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  116979. */
  116980. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  116981. /** States */
  116982. /**
  116983. * Set various states to the webGL context
  116984. * @param culling defines backface culling state
  116985. * @param zOffset defines the value to apply to zOffset (0 by default)
  116986. * @param force defines if states must be applied even if cache is up to date
  116987. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  116988. */
  116989. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  116990. /**
  116991. * Set the z offset to apply to current rendering
  116992. * @param value defines the offset to apply
  116993. */
  116994. setZOffset(value: number): void;
  116995. /**
  116996. * Gets the current value of the zOffset
  116997. * @returns the current zOffset state
  116998. */
  116999. getZOffset(): number;
  117000. /**
  117001. * Enable or disable depth buffering
  117002. * @param enable defines the state to set
  117003. */
  117004. setDepthBuffer(enable: boolean): void;
  117005. /**
  117006. * Gets a boolean indicating if depth writing is enabled
  117007. * @returns the current depth writing state
  117008. */
  117009. getDepthWrite(): boolean;
  117010. /**
  117011. * Enable or disable depth writing
  117012. * @param enable defines the state to set
  117013. */
  117014. setDepthWrite(enable: boolean): void;
  117015. /**
  117016. * Gets a boolean indicating if stencil buffer is enabled
  117017. * @returns the current stencil buffer state
  117018. */
  117019. getStencilBuffer(): boolean;
  117020. /**
  117021. * Enable or disable the stencil buffer
  117022. * @param enable defines if the stencil buffer must be enabled or disabled
  117023. */
  117024. setStencilBuffer(enable: boolean): void;
  117025. /**
  117026. * Gets the current stencil mask
  117027. * @returns a number defining the new stencil mask to use
  117028. */
  117029. getStencilMask(): number;
  117030. /**
  117031. * Sets the current stencil mask
  117032. * @param mask defines the new stencil mask to use
  117033. */
  117034. setStencilMask(mask: number): void;
  117035. /**
  117036. * Gets the current stencil function
  117037. * @returns a number defining the stencil function to use
  117038. */
  117039. getStencilFunction(): number;
  117040. /**
  117041. * Gets the current stencil reference value
  117042. * @returns a number defining the stencil reference value to use
  117043. */
  117044. getStencilFunctionReference(): number;
  117045. /**
  117046. * Gets the current stencil mask
  117047. * @returns a number defining the stencil mask to use
  117048. */
  117049. getStencilFunctionMask(): number;
  117050. /**
  117051. * Sets the current stencil function
  117052. * @param stencilFunc defines the new stencil function to use
  117053. */
  117054. setStencilFunction(stencilFunc: number): void;
  117055. /**
  117056. * Sets the current stencil reference
  117057. * @param reference defines the new stencil reference to use
  117058. */
  117059. setStencilFunctionReference(reference: number): void;
  117060. /**
  117061. * Sets the current stencil mask
  117062. * @param mask defines the new stencil mask to use
  117063. */
  117064. setStencilFunctionMask(mask: number): void;
  117065. /**
  117066. * Gets the current stencil operation when stencil fails
  117067. * @returns a number defining stencil operation to use when stencil fails
  117068. */
  117069. getStencilOperationFail(): number;
  117070. /**
  117071. * Gets the current stencil operation when depth fails
  117072. * @returns a number defining stencil operation to use when depth fails
  117073. */
  117074. getStencilOperationDepthFail(): number;
  117075. /**
  117076. * Gets the current stencil operation when stencil passes
  117077. * @returns a number defining stencil operation to use when stencil passes
  117078. */
  117079. getStencilOperationPass(): number;
  117080. /**
  117081. * Sets the stencil operation to use when stencil fails
  117082. * @param operation defines the stencil operation to use when stencil fails
  117083. */
  117084. setStencilOperationFail(operation: number): void;
  117085. /**
  117086. * Sets the stencil operation to use when depth fails
  117087. * @param operation defines the stencil operation to use when depth fails
  117088. */
  117089. setStencilOperationDepthFail(operation: number): void;
  117090. /**
  117091. * Sets the stencil operation to use when stencil passes
  117092. * @param operation defines the stencil operation to use when stencil passes
  117093. */
  117094. setStencilOperationPass(operation: number): void;
  117095. /**
  117096. * Sets a boolean indicating if the dithering state is enabled or disabled
  117097. * @param value defines the dithering state
  117098. */
  117099. setDitheringState(value: boolean): void;
  117100. /**
  117101. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117102. * @param value defines the rasterizer state
  117103. */
  117104. setRasterizerState(value: boolean): void;
  117105. /**
  117106. * Gets the current depth function
  117107. * @returns a number defining the depth function
  117108. */
  117109. getDepthFunction(): Nullable<number>;
  117110. /**
  117111. * Sets the current depth function
  117112. * @param depthFunc defines the function to use
  117113. */
  117114. setDepthFunction(depthFunc: number): void;
  117115. /**
  117116. * Sets the current depth function to GREATER
  117117. */
  117118. setDepthFunctionToGreater(): void;
  117119. /**
  117120. * Sets the current depth function to GEQUAL
  117121. */
  117122. setDepthFunctionToGreaterOrEqual(): void;
  117123. /**
  117124. * Sets the current depth function to LESS
  117125. */
  117126. setDepthFunctionToLess(): void;
  117127. /**
  117128. * Sets the current depth function to LEQUAL
  117129. */
  117130. setDepthFunctionToLessOrEqual(): void;
  117131. private _cachedStencilBuffer;
  117132. private _cachedStencilFunction;
  117133. private _cachedStencilMask;
  117134. private _cachedStencilOperationPass;
  117135. private _cachedStencilOperationFail;
  117136. private _cachedStencilOperationDepthFail;
  117137. private _cachedStencilReference;
  117138. /**
  117139. * Caches the the state of the stencil buffer
  117140. */
  117141. cacheStencilState(): void;
  117142. /**
  117143. * Restores the state of the stencil buffer
  117144. */
  117145. restoreStencilState(): void;
  117146. /**
  117147. * Directly set the WebGL Viewport
  117148. * @param x defines the x coordinate of the viewport (in screen space)
  117149. * @param y defines the y coordinate of the viewport (in screen space)
  117150. * @param width defines the width of the viewport (in screen space)
  117151. * @param height defines the height of the viewport (in screen space)
  117152. * @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
  117153. */
  117154. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117155. /**
  117156. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117157. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117158. * @param y defines the y-coordinate of the corner of the clear rectangle
  117159. * @param width defines the width of the clear rectangle
  117160. * @param height defines the height of the clear rectangle
  117161. * @param clearColor defines the clear color
  117162. */
  117163. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117164. /**
  117165. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117166. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117167. * @param y defines the y-coordinate of the corner of the clear rectangle
  117168. * @param width defines the width of the clear rectangle
  117169. * @param height defines the height of the clear rectangle
  117170. */
  117171. enableScissor(x: number, y: number, width: number, height: number): void;
  117172. /**
  117173. * Disable previously set scissor test rectangle
  117174. */
  117175. disableScissor(): void;
  117176. protected _reportDrawCall(): void;
  117177. /**
  117178. * Initializes a webVR display and starts listening to display change events
  117179. * The onVRDisplayChangedObservable will be notified upon these changes
  117180. * @returns The onVRDisplayChangedObservable
  117181. */
  117182. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117183. /** @hidden */
  117184. _prepareVRComponent(): void;
  117185. /** @hidden */
  117186. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117187. /** @hidden */
  117188. _submitVRFrame(): void;
  117189. /**
  117190. * Call this function to leave webVR mode
  117191. * Will do nothing if webVR is not supported or if there is no webVR device
  117192. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117193. */
  117194. disableVR(): void;
  117195. /**
  117196. * Gets a boolean indicating that the system is in VR mode and is presenting
  117197. * @returns true if VR mode is engaged
  117198. */
  117199. isVRPresenting(): boolean;
  117200. /** @hidden */
  117201. _requestVRFrame(): void;
  117202. /** @hidden */
  117203. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117204. /**
  117205. * Gets the source code of the vertex shader associated with a specific webGL program
  117206. * @param program defines the program to use
  117207. * @returns a string containing the source code of the vertex shader associated with the program
  117208. */
  117209. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117210. /**
  117211. * Gets the source code of the fragment shader associated with a specific webGL program
  117212. * @param program defines the program to use
  117213. * @returns a string containing the source code of the fragment shader associated with the program
  117214. */
  117215. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117216. /**
  117217. * Sets a depth stencil texture from a render target to the according uniform.
  117218. * @param channel The texture channel
  117219. * @param uniform The uniform to set
  117220. * @param texture The render target texture containing the depth stencil texture to apply
  117221. */
  117222. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117223. /**
  117224. * Sets a texture to the webGL context from a postprocess
  117225. * @param channel defines the channel to use
  117226. * @param postProcess defines the source postprocess
  117227. */
  117228. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117229. /**
  117230. * Binds the output of the passed in post process to the texture channel specified
  117231. * @param channel The channel the texture should be bound to
  117232. * @param postProcess The post process which's output should be bound
  117233. */
  117234. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117235. protected _rebuildBuffers(): void;
  117236. /** @hidden */
  117237. _renderFrame(): void;
  117238. _renderLoop(): void;
  117239. /** @hidden */
  117240. _renderViews(): boolean;
  117241. /**
  117242. * Toggle full screen mode
  117243. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117244. */
  117245. switchFullscreen(requestPointerLock: boolean): void;
  117246. /**
  117247. * Enters full screen mode
  117248. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117249. */
  117250. enterFullscreen(requestPointerLock: boolean): void;
  117251. /**
  117252. * Exits full screen mode
  117253. */
  117254. exitFullscreen(): void;
  117255. /**
  117256. * Enters Pointerlock mode
  117257. */
  117258. enterPointerlock(): void;
  117259. /**
  117260. * Exits Pointerlock mode
  117261. */
  117262. exitPointerlock(): void;
  117263. /**
  117264. * Begin a new frame
  117265. */
  117266. beginFrame(): void;
  117267. /**
  117268. * Enf the current frame
  117269. */
  117270. endFrame(): void;
  117271. resize(): void;
  117272. /**
  117273. * Force a specific size of the canvas
  117274. * @param width defines the new canvas' width
  117275. * @param height defines the new canvas' height
  117276. * @returns true if the size was changed
  117277. */
  117278. setSize(width: number, height: number): boolean;
  117279. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117280. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117281. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117282. _releaseTexture(texture: InternalTexture): void;
  117283. /**
  117284. * @hidden
  117285. * Rescales a texture
  117286. * @param source input texutre
  117287. * @param destination destination texture
  117288. * @param scene scene to use to render the resize
  117289. * @param internalFormat format to use when resizing
  117290. * @param onComplete callback to be called when resize has completed
  117291. */
  117292. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117293. /**
  117294. * Gets the current framerate
  117295. * @returns a number representing the framerate
  117296. */
  117297. getFps(): number;
  117298. /**
  117299. * Gets the time spent between current and previous frame
  117300. * @returns a number representing the delta time in ms
  117301. */
  117302. getDeltaTime(): number;
  117303. private _measureFps;
  117304. /** @hidden */
  117305. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117306. /**
  117307. * Updates the sample count of a render target texture
  117308. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117309. * @param texture defines the texture to update
  117310. * @param samples defines the sample count to set
  117311. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117312. */
  117313. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117314. /**
  117315. * Updates a depth texture Comparison Mode and Function.
  117316. * If the comparison Function is equal to 0, the mode will be set to none.
  117317. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117318. * @param texture The texture to set the comparison function for
  117319. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117320. */
  117321. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117322. /**
  117323. * Creates a webGL buffer to use with instanciation
  117324. * @param capacity defines the size of the buffer
  117325. * @returns the webGL buffer
  117326. */
  117327. createInstancesBuffer(capacity: number): DataBuffer;
  117328. /**
  117329. * Delete a webGL buffer used with instanciation
  117330. * @param buffer defines the webGL buffer to delete
  117331. */
  117332. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117333. private _clientWaitAsync;
  117334. /** @hidden */
  117335. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117336. dispose(): void;
  117337. private _disableTouchAction;
  117338. /**
  117339. * Display the loading screen
  117340. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117341. */
  117342. displayLoadingUI(): void;
  117343. /**
  117344. * Hide the loading screen
  117345. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117346. */
  117347. hideLoadingUI(): void;
  117348. /**
  117349. * Gets the current loading screen object
  117350. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117351. */
  117352. get loadingScreen(): ILoadingScreen;
  117353. /**
  117354. * Sets the current loading screen object
  117355. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117356. */
  117357. set loadingScreen(loadingScreen: ILoadingScreen);
  117358. /**
  117359. * Sets the current loading screen text
  117360. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117361. */
  117362. set loadingUIText(text: string);
  117363. /**
  117364. * Sets the current loading screen background color
  117365. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117366. */
  117367. set loadingUIBackgroundColor(color: string);
  117368. /** Pointerlock and fullscreen */
  117369. /**
  117370. * Ask the browser to promote the current element to pointerlock mode
  117371. * @param element defines the DOM element to promote
  117372. */
  117373. static _RequestPointerlock(element: HTMLElement): void;
  117374. /**
  117375. * Asks the browser to exit pointerlock mode
  117376. */
  117377. static _ExitPointerlock(): void;
  117378. /**
  117379. * Ask the browser to promote the current element to fullscreen rendering mode
  117380. * @param element defines the DOM element to promote
  117381. */
  117382. static _RequestFullscreen(element: HTMLElement): void;
  117383. /**
  117384. * Asks the browser to exit fullscreen mode
  117385. */
  117386. static _ExitFullscreen(): void;
  117387. }
  117388. }
  117389. declare module BABYLON {
  117390. /**
  117391. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117392. * during the life time of the application.
  117393. */
  117394. export class EngineStore {
  117395. /** Gets the list of created engines */
  117396. static Instances: Engine[];
  117397. /** @hidden */
  117398. static _LastCreatedScene: Nullable<Scene>;
  117399. /**
  117400. * Gets the latest created engine
  117401. */
  117402. static get LastCreatedEngine(): Nullable<Engine>;
  117403. /**
  117404. * Gets the latest created scene
  117405. */
  117406. static get LastCreatedScene(): Nullable<Scene>;
  117407. /**
  117408. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117409. * @ignorenaming
  117410. */
  117411. static UseFallbackTexture: boolean;
  117412. /**
  117413. * Texture content used if a texture cannot loaded
  117414. * @ignorenaming
  117415. */
  117416. static FallbackTexture: string;
  117417. }
  117418. }
  117419. declare module BABYLON {
  117420. /**
  117421. * Helper class that provides a small promise polyfill
  117422. */
  117423. export class PromisePolyfill {
  117424. /**
  117425. * Static function used to check if the polyfill is required
  117426. * If this is the case then the function will inject the polyfill to window.Promise
  117427. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117428. */
  117429. static Apply(force?: boolean): void;
  117430. }
  117431. }
  117432. declare module BABYLON {
  117433. /**
  117434. * Interface for screenshot methods with describe argument called `size` as object with options
  117435. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117436. */
  117437. export interface IScreenshotSize {
  117438. /**
  117439. * number in pixels for canvas height
  117440. */
  117441. height?: number;
  117442. /**
  117443. * multiplier allowing render at a higher or lower resolution
  117444. * If value is defined then height and width will be ignored and taken from camera
  117445. */
  117446. precision?: number;
  117447. /**
  117448. * number in pixels for canvas width
  117449. */
  117450. width?: number;
  117451. }
  117452. }
  117453. declare module BABYLON {
  117454. interface IColor4Like {
  117455. r: float;
  117456. g: float;
  117457. b: float;
  117458. a: float;
  117459. }
  117460. /**
  117461. * Class containing a set of static utilities functions
  117462. */
  117463. export class Tools {
  117464. /**
  117465. * Gets or sets the base URL to use to load assets
  117466. */
  117467. static get BaseUrl(): string;
  117468. static set BaseUrl(value: string);
  117469. /**
  117470. * Enable/Disable Custom HTTP Request Headers globally.
  117471. * default = false
  117472. * @see CustomRequestHeaders
  117473. */
  117474. static UseCustomRequestHeaders: boolean;
  117475. /**
  117476. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117477. * i.e. when loading files, where the server/service expects an Authorization header
  117478. */
  117479. static CustomRequestHeaders: {
  117480. [key: string]: string;
  117481. };
  117482. /**
  117483. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117484. */
  117485. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117486. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117487. /**
  117488. * Default behaviour for cors in the application.
  117489. * It can be a string if the expected behavior is identical in the entire app.
  117490. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117491. */
  117492. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117493. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117494. /**
  117495. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117496. * @ignorenaming
  117497. */
  117498. static get UseFallbackTexture(): boolean;
  117499. static set UseFallbackTexture(value: boolean);
  117500. /**
  117501. * Use this object to register external classes like custom textures or material
  117502. * to allow the laoders to instantiate them
  117503. */
  117504. static get RegisteredExternalClasses(): {
  117505. [key: string]: Object;
  117506. };
  117507. static set RegisteredExternalClasses(classes: {
  117508. [key: string]: Object;
  117509. });
  117510. /**
  117511. * Texture content used if a texture cannot loaded
  117512. * @ignorenaming
  117513. */
  117514. static get fallbackTexture(): string;
  117515. static set fallbackTexture(value: string);
  117516. /**
  117517. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117518. * @param u defines the coordinate on X axis
  117519. * @param v defines the coordinate on Y axis
  117520. * @param width defines the width of the source data
  117521. * @param height defines the height of the source data
  117522. * @param pixels defines the source byte array
  117523. * @param color defines the output color
  117524. */
  117525. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117526. /**
  117527. * Interpolates between a and b via alpha
  117528. * @param a The lower value (returned when alpha = 0)
  117529. * @param b The upper value (returned when alpha = 1)
  117530. * @param alpha The interpolation-factor
  117531. * @return The mixed value
  117532. */
  117533. static Mix(a: number, b: number, alpha: number): number;
  117534. /**
  117535. * Tries to instantiate a new object from a given class name
  117536. * @param className defines the class name to instantiate
  117537. * @returns the new object or null if the system was not able to do the instantiation
  117538. */
  117539. static Instantiate(className: string): any;
  117540. /**
  117541. * Provides a slice function that will work even on IE
  117542. * @param data defines the array to slice
  117543. * @param start defines the start of the data (optional)
  117544. * @param end defines the end of the data (optional)
  117545. * @returns the new sliced array
  117546. */
  117547. static Slice<T>(data: T, start?: number, end?: number): T;
  117548. /**
  117549. * Polyfill for setImmediate
  117550. * @param action defines the action to execute after the current execution block
  117551. */
  117552. static SetImmediate(action: () => void): void;
  117553. /**
  117554. * Function indicating if a number is an exponent of 2
  117555. * @param value defines the value to test
  117556. * @returns true if the value is an exponent of 2
  117557. */
  117558. static IsExponentOfTwo(value: number): boolean;
  117559. private static _tmpFloatArray;
  117560. /**
  117561. * Returns the nearest 32-bit single precision float representation of a Number
  117562. * @param value A Number. If the parameter is of a different type, it will get converted
  117563. * to a number or to NaN if it cannot be converted
  117564. * @returns number
  117565. */
  117566. static FloatRound(value: number): number;
  117567. /**
  117568. * Extracts the filename from a path
  117569. * @param path defines the path to use
  117570. * @returns the filename
  117571. */
  117572. static GetFilename(path: string): string;
  117573. /**
  117574. * Extracts the "folder" part of a path (everything before the filename).
  117575. * @param uri The URI to extract the info from
  117576. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  117577. * @returns The "folder" part of the path
  117578. */
  117579. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  117580. /**
  117581. * Extracts text content from a DOM element hierarchy
  117582. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  117583. */
  117584. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  117585. /**
  117586. * Convert an angle in radians to degrees
  117587. * @param angle defines the angle to convert
  117588. * @returns the angle in degrees
  117589. */
  117590. static ToDegrees(angle: number): number;
  117591. /**
  117592. * Convert an angle in degrees to radians
  117593. * @param angle defines the angle to convert
  117594. * @returns the angle in radians
  117595. */
  117596. static ToRadians(angle: number): number;
  117597. /**
  117598. * Returns an array if obj is not an array
  117599. * @param obj defines the object to evaluate as an array
  117600. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  117601. * @returns either obj directly if obj is an array or a new array containing obj
  117602. */
  117603. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  117604. /**
  117605. * Gets the pointer prefix to use
  117606. * @param engine defines the engine we are finding the prefix for
  117607. * @returns "pointer" if touch is enabled. Else returns "mouse"
  117608. */
  117609. static GetPointerPrefix(engine: Engine): string;
  117610. /**
  117611. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  117612. * @param url define the url we are trying
  117613. * @param element define the dom element where to configure the cors policy
  117614. */
  117615. static SetCorsBehavior(url: string | string[], element: {
  117616. crossOrigin: string | null;
  117617. }): void;
  117618. /**
  117619. * Removes unwanted characters from an url
  117620. * @param url defines the url to clean
  117621. * @returns the cleaned url
  117622. */
  117623. static CleanUrl(url: string): string;
  117624. /**
  117625. * Gets or sets a function used to pre-process url before using them to load assets
  117626. */
  117627. static get PreprocessUrl(): (url: string) => string;
  117628. static set PreprocessUrl(processor: (url: string) => string);
  117629. /**
  117630. * Loads an image as an HTMLImageElement.
  117631. * @param input url string, ArrayBuffer, or Blob to load
  117632. * @param onLoad callback called when the image successfully loads
  117633. * @param onError callback called when the image fails to load
  117634. * @param offlineProvider offline provider for caching
  117635. * @param mimeType optional mime type
  117636. * @returns the HTMLImageElement of the loaded image
  117637. */
  117638. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  117639. /**
  117640. * Loads a file from a url
  117641. * @param url url string, ArrayBuffer, or Blob to load
  117642. * @param onSuccess callback called when the file successfully loads
  117643. * @param onProgress callback called while file is loading (if the server supports this mode)
  117644. * @param offlineProvider defines the offline provider for caching
  117645. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  117646. * @param onError callback called when the file fails to load
  117647. * @returns a file request object
  117648. */
  117649. 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;
  117650. /**
  117651. * Loads a file from a url
  117652. * @param url the file url to load
  117653. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  117654. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  117655. */
  117656. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  117657. /**
  117658. * Load a script (identified by an url). When the url returns, the
  117659. * content of this file is added into a new script element, attached to the DOM (body element)
  117660. * @param scriptUrl defines the url of the script to laod
  117661. * @param onSuccess defines the callback called when the script is loaded
  117662. * @param onError defines the callback to call if an error occurs
  117663. * @param scriptId defines the id of the script element
  117664. */
  117665. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  117666. /**
  117667. * Load an asynchronous script (identified by an url). When the url returns, the
  117668. * content of this file is added into a new script element, attached to the DOM (body element)
  117669. * @param scriptUrl defines the url of the script to laod
  117670. * @param scriptId defines the id of the script element
  117671. * @returns a promise request object
  117672. */
  117673. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  117674. /**
  117675. * Loads a file from a blob
  117676. * @param fileToLoad defines the blob to use
  117677. * @param callback defines the callback to call when data is loaded
  117678. * @param progressCallback defines the callback to call during loading process
  117679. * @returns a file request object
  117680. */
  117681. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  117682. /**
  117683. * Reads a file from a File object
  117684. * @param file defines the file to load
  117685. * @param onSuccess defines the callback to call when data is loaded
  117686. * @param onProgress defines the callback to call during loading process
  117687. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  117688. * @param onError defines the callback to call when an error occurs
  117689. * @returns a file request object
  117690. */
  117691. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  117692. /**
  117693. * Creates a data url from a given string content
  117694. * @param content defines the content to convert
  117695. * @returns the new data url link
  117696. */
  117697. static FileAsURL(content: string): string;
  117698. /**
  117699. * Format the given number to a specific decimal format
  117700. * @param value defines the number to format
  117701. * @param decimals defines the number of decimals to use
  117702. * @returns the formatted string
  117703. */
  117704. static Format(value: number, decimals?: number): string;
  117705. /**
  117706. * Tries to copy an object by duplicating every property
  117707. * @param source defines the source object
  117708. * @param destination defines the target object
  117709. * @param doNotCopyList defines a list of properties to avoid
  117710. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  117711. */
  117712. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  117713. /**
  117714. * Gets a boolean indicating if the given object has no own property
  117715. * @param obj defines the object to test
  117716. * @returns true if object has no own property
  117717. */
  117718. static IsEmpty(obj: any): boolean;
  117719. /**
  117720. * Function used to register events at window level
  117721. * @param windowElement defines the Window object to use
  117722. * @param events defines the events to register
  117723. */
  117724. static RegisterTopRootEvents(windowElement: Window, events: {
  117725. name: string;
  117726. handler: Nullable<(e: FocusEvent) => any>;
  117727. }[]): void;
  117728. /**
  117729. * Function used to unregister events from window level
  117730. * @param windowElement defines the Window object to use
  117731. * @param events defines the events to unregister
  117732. */
  117733. static UnregisterTopRootEvents(windowElement: Window, events: {
  117734. name: string;
  117735. handler: Nullable<(e: FocusEvent) => any>;
  117736. }[]): void;
  117737. /**
  117738. * @ignore
  117739. */
  117740. static _ScreenshotCanvas: HTMLCanvasElement;
  117741. /**
  117742. * Dumps the current bound framebuffer
  117743. * @param width defines the rendering width
  117744. * @param height defines the rendering height
  117745. * @param engine defines the hosting engine
  117746. * @param successCallback defines the callback triggered once the data are available
  117747. * @param mimeType defines the mime type of the result
  117748. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  117749. */
  117750. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  117751. /**
  117752. * Converts the canvas data to blob.
  117753. * This acts as a polyfill for browsers not supporting the to blob function.
  117754. * @param canvas Defines the canvas to extract the data from
  117755. * @param successCallback Defines the callback triggered once the data are available
  117756. * @param mimeType Defines the mime type of the result
  117757. */
  117758. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  117759. /**
  117760. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  117761. * @param successCallback defines the callback triggered once the data are available
  117762. * @param mimeType defines the mime type of the result
  117763. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  117764. */
  117765. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  117766. /**
  117767. * Downloads a blob in the browser
  117768. * @param blob defines the blob to download
  117769. * @param fileName defines the name of the downloaded file
  117770. */
  117771. static Download(blob: Blob, fileName: string): void;
  117772. /**
  117773. * Captures a screenshot of the current rendering
  117774. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117775. * @param engine defines the rendering engine
  117776. * @param camera defines the source camera
  117777. * @param size This parameter can be set to a single number or to an object with the
  117778. * following (optional) properties: precision, width, height. If a single number is passed,
  117779. * it will be used for both width and height. If an object is passed, the screenshot size
  117780. * will be derived from the parameters. The precision property is a multiplier allowing
  117781. * rendering at a higher or lower resolution
  117782. * @param successCallback defines the callback receives a single parameter which contains the
  117783. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  117784. * src parameter of an <img> to display it
  117785. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  117786. * Check your browser for supported MIME types
  117787. */
  117788. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  117789. /**
  117790. * Captures a screenshot of the current rendering
  117791. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117792. * @param engine defines the rendering engine
  117793. * @param camera defines the source camera
  117794. * @param size This parameter can be set to a single number or to an object with the
  117795. * following (optional) properties: precision, width, height. If a single number is passed,
  117796. * it will be used for both width and height. If an object is passed, the screenshot size
  117797. * will be derived from the parameters. The precision property is a multiplier allowing
  117798. * rendering at a higher or lower resolution
  117799. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  117800. * Check your browser for supported MIME types
  117801. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  117802. * to the src parameter of an <img> to display it
  117803. */
  117804. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  117805. /**
  117806. * Generates an image screenshot from the specified camera.
  117807. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117808. * @param engine The engine to use for rendering
  117809. * @param camera The camera to use for rendering
  117810. * @param size This parameter can be set to a single number or to an object with the
  117811. * following (optional) properties: precision, width, height. If a single number is passed,
  117812. * it will be used for both width and height. If an object is passed, the screenshot size
  117813. * will be derived from the parameters. The precision property is a multiplier allowing
  117814. * rendering at a higher or lower resolution
  117815. * @param successCallback The callback receives a single parameter which contains the
  117816. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  117817. * src parameter of an <img> to display it
  117818. * @param mimeType The MIME type of the screenshot image (default: image/png).
  117819. * Check your browser for supported MIME types
  117820. * @param samples Texture samples (default: 1)
  117821. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  117822. * @param fileName A name for for the downloaded file.
  117823. */
  117824. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  117825. /**
  117826. * Generates an image screenshot from the specified camera.
  117827. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117828. * @param engine The engine to use for rendering
  117829. * @param camera The camera to use for rendering
  117830. * @param size This parameter can be set to a single number or to an object with the
  117831. * following (optional) properties: precision, width, height. If a single number is passed,
  117832. * it will be used for both width and height. If an object is passed, the screenshot size
  117833. * will be derived from the parameters. The precision property is a multiplier allowing
  117834. * rendering at a higher or lower resolution
  117835. * @param mimeType The MIME type of the screenshot image (default: image/png).
  117836. * Check your browser for supported MIME types
  117837. * @param samples Texture samples (default: 1)
  117838. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  117839. * @param fileName A name for for the downloaded file.
  117840. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  117841. * to the src parameter of an <img> to display it
  117842. */
  117843. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  117844. /**
  117845. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  117846. * Be aware Math.random() could cause collisions, but:
  117847. * "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"
  117848. * @returns a pseudo random id
  117849. */
  117850. static RandomId(): string;
  117851. /**
  117852. * Test if the given uri is a base64 string
  117853. * @param uri The uri to test
  117854. * @return True if the uri is a base64 string or false otherwise
  117855. */
  117856. static IsBase64(uri: string): boolean;
  117857. /**
  117858. * Decode the given base64 uri.
  117859. * @param uri The uri to decode
  117860. * @return The decoded base64 data.
  117861. */
  117862. static DecodeBase64(uri: string): ArrayBuffer;
  117863. /**
  117864. * Gets the absolute url.
  117865. * @param url the input url
  117866. * @return the absolute url
  117867. */
  117868. static GetAbsoluteUrl(url: string): string;
  117869. /**
  117870. * No log
  117871. */
  117872. static readonly NoneLogLevel: number;
  117873. /**
  117874. * Only message logs
  117875. */
  117876. static readonly MessageLogLevel: number;
  117877. /**
  117878. * Only warning logs
  117879. */
  117880. static readonly WarningLogLevel: number;
  117881. /**
  117882. * Only error logs
  117883. */
  117884. static readonly ErrorLogLevel: number;
  117885. /**
  117886. * All logs
  117887. */
  117888. static readonly AllLogLevel: number;
  117889. /**
  117890. * Gets a value indicating the number of loading errors
  117891. * @ignorenaming
  117892. */
  117893. static get errorsCount(): number;
  117894. /**
  117895. * Callback called when a new log is added
  117896. */
  117897. static OnNewCacheEntry: (entry: string) => void;
  117898. /**
  117899. * Log a message to the console
  117900. * @param message defines the message to log
  117901. */
  117902. static Log(message: string): void;
  117903. /**
  117904. * Write a warning message to the console
  117905. * @param message defines the message to log
  117906. */
  117907. static Warn(message: string): void;
  117908. /**
  117909. * Write an error message to the console
  117910. * @param message defines the message to log
  117911. */
  117912. static Error(message: string): void;
  117913. /**
  117914. * Gets current log cache (list of logs)
  117915. */
  117916. static get LogCache(): string;
  117917. /**
  117918. * Clears the log cache
  117919. */
  117920. static ClearLogCache(): void;
  117921. /**
  117922. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  117923. */
  117924. static set LogLevels(level: number);
  117925. /**
  117926. * Checks if the window object exists
  117927. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  117928. */
  117929. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  117930. /**
  117931. * No performance log
  117932. */
  117933. static readonly PerformanceNoneLogLevel: number;
  117934. /**
  117935. * Use user marks to log performance
  117936. */
  117937. static readonly PerformanceUserMarkLogLevel: number;
  117938. /**
  117939. * Log performance to the console
  117940. */
  117941. static readonly PerformanceConsoleLogLevel: number;
  117942. private static _performance;
  117943. /**
  117944. * Sets the current performance log level
  117945. */
  117946. static set PerformanceLogLevel(level: number);
  117947. private static _StartPerformanceCounterDisabled;
  117948. private static _EndPerformanceCounterDisabled;
  117949. private static _StartUserMark;
  117950. private static _EndUserMark;
  117951. private static _StartPerformanceConsole;
  117952. private static _EndPerformanceConsole;
  117953. /**
  117954. * Starts a performance counter
  117955. */
  117956. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  117957. /**
  117958. * Ends a specific performance coutner
  117959. */
  117960. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  117961. /**
  117962. * Gets either window.performance.now() if supported or Date.now() else
  117963. */
  117964. static get Now(): number;
  117965. /**
  117966. * This method will return the name of the class used to create the instance of the given object.
  117967. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  117968. * @param object the object to get the class name from
  117969. * @param isType defines if the object is actually a type
  117970. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  117971. */
  117972. static GetClassName(object: any, isType?: boolean): string;
  117973. /**
  117974. * Gets the first element of an array satisfying a given predicate
  117975. * @param array defines the array to browse
  117976. * @param predicate defines the predicate to use
  117977. * @returns null if not found or the element
  117978. */
  117979. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  117980. /**
  117981. * This method will return the name of the full name of the class, including its owning module (if any).
  117982. * 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).
  117983. * @param object the object to get the class name from
  117984. * @param isType defines if the object is actually a type
  117985. * @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.
  117986. * @ignorenaming
  117987. */
  117988. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  117989. /**
  117990. * Returns a promise that resolves after the given amount of time.
  117991. * @param delay Number of milliseconds to delay
  117992. * @returns Promise that resolves after the given amount of time
  117993. */
  117994. static DelayAsync(delay: number): Promise<void>;
  117995. /**
  117996. * Utility function to detect if the current user agent is Safari
  117997. * @returns whether or not the current user agent is safari
  117998. */
  117999. static IsSafari(): boolean;
  118000. }
  118001. /**
  118002. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118003. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118004. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118005. * @param name The name of the class, case should be preserved
  118006. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118007. */
  118008. export function className(name: string, module?: string): (target: Object) => void;
  118009. /**
  118010. * An implementation of a loop for asynchronous functions.
  118011. */
  118012. export class AsyncLoop {
  118013. /**
  118014. * Defines the number of iterations for the loop
  118015. */
  118016. iterations: number;
  118017. /**
  118018. * Defines the current index of the loop.
  118019. */
  118020. index: number;
  118021. private _done;
  118022. private _fn;
  118023. private _successCallback;
  118024. /**
  118025. * Constructor.
  118026. * @param iterations the number of iterations.
  118027. * @param func the function to run each iteration
  118028. * @param successCallback the callback that will be called upon succesful execution
  118029. * @param offset starting offset.
  118030. */
  118031. constructor(
  118032. /**
  118033. * Defines the number of iterations for the loop
  118034. */
  118035. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118036. /**
  118037. * Execute the next iteration. Must be called after the last iteration was finished.
  118038. */
  118039. executeNext(): void;
  118040. /**
  118041. * Break the loop and run the success callback.
  118042. */
  118043. breakLoop(): void;
  118044. /**
  118045. * Create and run an async loop.
  118046. * @param iterations the number of iterations.
  118047. * @param fn the function to run each iteration
  118048. * @param successCallback the callback that will be called upon succesful execution
  118049. * @param offset starting offset.
  118050. * @returns the created async loop object
  118051. */
  118052. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118053. /**
  118054. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118055. * @param iterations total number of iterations
  118056. * @param syncedIterations number of synchronous iterations in each async iteration.
  118057. * @param fn the function to call each iteration.
  118058. * @param callback a success call back that will be called when iterating stops.
  118059. * @param breakFunction a break condition (optional)
  118060. * @param timeout timeout settings for the setTimeout function. default - 0.
  118061. * @returns the created async loop object
  118062. */
  118063. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118064. }
  118065. }
  118066. declare module BABYLON {
  118067. /**
  118068. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118069. * The underlying implementation relies on an associative array to ensure the best performances.
  118070. * The value can be anything including 'null' but except 'undefined'
  118071. */
  118072. export class StringDictionary<T> {
  118073. /**
  118074. * This will clear this dictionary and copy the content from the 'source' one.
  118075. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118076. * @param source the dictionary to take the content from and copy to this dictionary
  118077. */
  118078. copyFrom(source: StringDictionary<T>): void;
  118079. /**
  118080. * Get a value based from its key
  118081. * @param key the given key to get the matching value from
  118082. * @return the value if found, otherwise undefined is returned
  118083. */
  118084. get(key: string): T | undefined;
  118085. /**
  118086. * Get a value from its key or add it if it doesn't exist.
  118087. * This method will ensure you that a given key/data will be present in the dictionary.
  118088. * @param key the given key to get the matching value from
  118089. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118090. * The factory will only be invoked if there's no data for the given key.
  118091. * @return the value corresponding to the key.
  118092. */
  118093. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118094. /**
  118095. * Get a value from its key if present in the dictionary otherwise add it
  118096. * @param key the key to get the value from
  118097. * @param val if there's no such key/value pair in the dictionary add it with this value
  118098. * @return the value corresponding to the key
  118099. */
  118100. getOrAdd(key: string, val: T): T;
  118101. /**
  118102. * Check if there's a given key in the dictionary
  118103. * @param key the key to check for
  118104. * @return true if the key is present, false otherwise
  118105. */
  118106. contains(key: string): boolean;
  118107. /**
  118108. * Add a new key and its corresponding value
  118109. * @param key the key to add
  118110. * @param value the value corresponding to the key
  118111. * @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
  118112. */
  118113. add(key: string, value: T): boolean;
  118114. /**
  118115. * Update a specific value associated to a key
  118116. * @param key defines the key to use
  118117. * @param value defines the value to store
  118118. * @returns true if the value was updated (or false if the key was not found)
  118119. */
  118120. set(key: string, value: T): boolean;
  118121. /**
  118122. * Get the element of the given key and remove it from the dictionary
  118123. * @param key defines the key to search
  118124. * @returns the value associated with the key or null if not found
  118125. */
  118126. getAndRemove(key: string): Nullable<T>;
  118127. /**
  118128. * Remove a key/value from the dictionary.
  118129. * @param key the key to remove
  118130. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118131. */
  118132. remove(key: string): boolean;
  118133. /**
  118134. * Clear the whole content of the dictionary
  118135. */
  118136. clear(): void;
  118137. /**
  118138. * Gets the current count
  118139. */
  118140. get count(): number;
  118141. /**
  118142. * Execute a callback on each key/val of the dictionary.
  118143. * Note that you can remove any element in this dictionary in the callback implementation
  118144. * @param callback the callback to execute on a given key/value pair
  118145. */
  118146. forEach(callback: (key: string, val: T) => void): void;
  118147. /**
  118148. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118149. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118150. * Note that you can remove any element in this dictionary in the callback implementation
  118151. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118152. * @returns the first item
  118153. */
  118154. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118155. private _count;
  118156. private _data;
  118157. }
  118158. }
  118159. declare module BABYLON {
  118160. /** @hidden */
  118161. export interface ICollisionCoordinator {
  118162. createCollider(): Collider;
  118163. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118164. init(scene: Scene): void;
  118165. }
  118166. /** @hidden */
  118167. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118168. private _scene;
  118169. private _scaledPosition;
  118170. private _scaledVelocity;
  118171. private _finalPosition;
  118172. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118173. createCollider(): Collider;
  118174. init(scene: Scene): void;
  118175. private _collideWithWorld;
  118176. }
  118177. }
  118178. declare module BABYLON {
  118179. /**
  118180. * Class used to manage all inputs for the scene.
  118181. */
  118182. export class InputManager {
  118183. /** The distance in pixel that you have to move to prevent some events */
  118184. static DragMovementThreshold: number;
  118185. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118186. static LongPressDelay: number;
  118187. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118188. static DoubleClickDelay: number;
  118189. /** If you need to check double click without raising a single click at first click, enable this flag */
  118190. static ExclusiveDoubleClickMode: boolean;
  118191. /** 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. */
  118192. private _alreadyAttached;
  118193. private _wheelEventName;
  118194. private _onPointerMove;
  118195. private _onPointerDown;
  118196. private _onPointerUp;
  118197. private _initClickEvent;
  118198. private _initActionManager;
  118199. private _delayedSimpleClick;
  118200. private _delayedSimpleClickTimeout;
  118201. private _previousDelayedSimpleClickTimeout;
  118202. private _meshPickProceed;
  118203. private _previousButtonPressed;
  118204. private _currentPickResult;
  118205. private _previousPickResult;
  118206. private _totalPointersPressed;
  118207. private _doubleClickOccured;
  118208. private _pointerOverMesh;
  118209. private _pickedDownMesh;
  118210. private _pickedUpMesh;
  118211. private _pointerX;
  118212. private _pointerY;
  118213. private _unTranslatedPointerX;
  118214. private _unTranslatedPointerY;
  118215. private _startingPointerPosition;
  118216. private _previousStartingPointerPosition;
  118217. private _startingPointerTime;
  118218. private _previousStartingPointerTime;
  118219. private _pointerCaptures;
  118220. private _onKeyDown;
  118221. private _onKeyUp;
  118222. private _onCanvasFocusObserver;
  118223. private _onCanvasBlurObserver;
  118224. private _scene;
  118225. /**
  118226. * Creates a new InputManager
  118227. * @param scene defines the hosting scene
  118228. */
  118229. constructor(scene: Scene);
  118230. /**
  118231. * Gets the mesh that is currently under the pointer
  118232. */
  118233. get meshUnderPointer(): Nullable<AbstractMesh>;
  118234. /**
  118235. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118236. */
  118237. get unTranslatedPointer(): Vector2;
  118238. /**
  118239. * Gets or sets the current on-screen X position of the pointer
  118240. */
  118241. get pointerX(): number;
  118242. set pointerX(value: number);
  118243. /**
  118244. * Gets or sets the current on-screen Y position of the pointer
  118245. */
  118246. get pointerY(): number;
  118247. set pointerY(value: number);
  118248. private _updatePointerPosition;
  118249. private _processPointerMove;
  118250. private _setRayOnPointerInfo;
  118251. private _checkPrePointerObservable;
  118252. /**
  118253. * Use this method to simulate a pointer move on a mesh
  118254. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118255. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118256. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118257. */
  118258. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118259. /**
  118260. * Use this method to simulate a pointer down on a mesh
  118261. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118262. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118263. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118264. */
  118265. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118266. private _processPointerDown;
  118267. /** @hidden */
  118268. _isPointerSwiping(): boolean;
  118269. /**
  118270. * Use this method to simulate a pointer up on a mesh
  118271. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118272. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118273. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118274. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118275. */
  118276. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118277. private _processPointerUp;
  118278. /**
  118279. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118280. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118281. * @returns true if the pointer was captured
  118282. */
  118283. isPointerCaptured(pointerId?: number): boolean;
  118284. /**
  118285. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118286. * @param attachUp defines if you want to attach events to pointerup
  118287. * @param attachDown defines if you want to attach events to pointerdown
  118288. * @param attachMove defines if you want to attach events to pointermove
  118289. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118290. */
  118291. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118292. /**
  118293. * Detaches all event handlers
  118294. */
  118295. detachControl(): void;
  118296. /**
  118297. * Force the value of meshUnderPointer
  118298. * @param mesh defines the mesh to use
  118299. */
  118300. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  118301. /**
  118302. * Gets the mesh under the pointer
  118303. * @returns a Mesh or null if no mesh is under the pointer
  118304. */
  118305. getPointerOverMesh(): Nullable<AbstractMesh>;
  118306. }
  118307. }
  118308. declare module BABYLON {
  118309. /**
  118310. * This class defines the direct association between an animation and a target
  118311. */
  118312. export class TargetedAnimation {
  118313. /**
  118314. * Animation to perform
  118315. */
  118316. animation: Animation;
  118317. /**
  118318. * Target to animate
  118319. */
  118320. target: any;
  118321. /**
  118322. * Returns the string "TargetedAnimation"
  118323. * @returns "TargetedAnimation"
  118324. */
  118325. getClassName(): string;
  118326. /**
  118327. * Serialize the object
  118328. * @returns the JSON object representing the current entity
  118329. */
  118330. serialize(): any;
  118331. }
  118332. /**
  118333. * Use this class to create coordinated animations on multiple targets
  118334. */
  118335. export class AnimationGroup implements IDisposable {
  118336. /** The name of the animation group */
  118337. name: string;
  118338. private _scene;
  118339. private _targetedAnimations;
  118340. private _animatables;
  118341. private _from;
  118342. private _to;
  118343. private _isStarted;
  118344. private _isPaused;
  118345. private _speedRatio;
  118346. private _loopAnimation;
  118347. private _isAdditive;
  118348. /**
  118349. * Gets or sets the unique id of the node
  118350. */
  118351. uniqueId: number;
  118352. /**
  118353. * This observable will notify when one animation have ended
  118354. */
  118355. onAnimationEndObservable: Observable<TargetedAnimation>;
  118356. /**
  118357. * Observer raised when one animation loops
  118358. */
  118359. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118360. /**
  118361. * Observer raised when all animations have looped
  118362. */
  118363. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118364. /**
  118365. * This observable will notify when all animations have ended.
  118366. */
  118367. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118368. /**
  118369. * This observable will notify when all animations have paused.
  118370. */
  118371. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118372. /**
  118373. * This observable will notify when all animations are playing.
  118374. */
  118375. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118376. /**
  118377. * Gets the first frame
  118378. */
  118379. get from(): number;
  118380. /**
  118381. * Gets the last frame
  118382. */
  118383. get to(): number;
  118384. /**
  118385. * Define if the animations are started
  118386. */
  118387. get isStarted(): boolean;
  118388. /**
  118389. * Gets a value indicating that the current group is playing
  118390. */
  118391. get isPlaying(): boolean;
  118392. /**
  118393. * Gets or sets the speed ratio to use for all animations
  118394. */
  118395. get speedRatio(): number;
  118396. /**
  118397. * Gets or sets the speed ratio to use for all animations
  118398. */
  118399. set speedRatio(value: number);
  118400. /**
  118401. * Gets or sets if all animations should loop or not
  118402. */
  118403. get loopAnimation(): boolean;
  118404. set loopAnimation(value: boolean);
  118405. /**
  118406. * Gets or sets if all animations should be evaluated additively
  118407. */
  118408. get isAdditive(): boolean;
  118409. set isAdditive(value: boolean);
  118410. /**
  118411. * Gets the targeted animations for this animation group
  118412. */
  118413. get targetedAnimations(): Array<TargetedAnimation>;
  118414. /**
  118415. * returning the list of animatables controlled by this animation group.
  118416. */
  118417. get animatables(): Array<Animatable>;
  118418. /**
  118419. * Gets the list of target animations
  118420. */
  118421. get children(): TargetedAnimation[];
  118422. /**
  118423. * Instantiates a new Animation Group.
  118424. * This helps managing several animations at once.
  118425. * @see https://doc.babylonjs.com/how_to/group
  118426. * @param name Defines the name of the group
  118427. * @param scene Defines the scene the group belongs to
  118428. */
  118429. constructor(
  118430. /** The name of the animation group */
  118431. name: string, scene?: Nullable<Scene>);
  118432. /**
  118433. * Add an animation (with its target) in the group
  118434. * @param animation defines the animation we want to add
  118435. * @param target defines the target of the animation
  118436. * @returns the TargetedAnimation object
  118437. */
  118438. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118439. /**
  118440. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118441. * It can add constant keys at begin or end
  118442. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118443. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118444. * @returns the animation group
  118445. */
  118446. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118447. private _animationLoopCount;
  118448. private _animationLoopFlags;
  118449. private _processLoop;
  118450. /**
  118451. * Start all animations on given targets
  118452. * @param loop defines if animations must loop
  118453. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118454. * @param from defines the from key (optional)
  118455. * @param to defines the to key (optional)
  118456. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118457. * @returns the current animation group
  118458. */
  118459. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118460. /**
  118461. * Pause all animations
  118462. * @returns the animation group
  118463. */
  118464. pause(): AnimationGroup;
  118465. /**
  118466. * Play all animations to initial state
  118467. * This function will start() the animations if they were not started or will restart() them if they were paused
  118468. * @param loop defines if animations must loop
  118469. * @returns the animation group
  118470. */
  118471. play(loop?: boolean): AnimationGroup;
  118472. /**
  118473. * Reset all animations to initial state
  118474. * @returns the animation group
  118475. */
  118476. reset(): AnimationGroup;
  118477. /**
  118478. * Restart animations from key 0
  118479. * @returns the animation group
  118480. */
  118481. restart(): AnimationGroup;
  118482. /**
  118483. * Stop all animations
  118484. * @returns the animation group
  118485. */
  118486. stop(): AnimationGroup;
  118487. /**
  118488. * Set animation weight for all animatables
  118489. * @param weight defines the weight to use
  118490. * @return the animationGroup
  118491. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118492. */
  118493. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118494. /**
  118495. * Synchronize and normalize all animatables with a source animatable
  118496. * @param root defines the root animatable to synchronize with
  118497. * @return the animationGroup
  118498. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118499. */
  118500. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118501. /**
  118502. * Goes to a specific frame in this animation group
  118503. * @param frame the frame number to go to
  118504. * @return the animationGroup
  118505. */
  118506. goToFrame(frame: number): AnimationGroup;
  118507. /**
  118508. * Dispose all associated resources
  118509. */
  118510. dispose(): void;
  118511. private _checkAnimationGroupEnded;
  118512. /**
  118513. * Clone the current animation group and returns a copy
  118514. * @param newName defines the name of the new group
  118515. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118516. * @returns the new aniamtion group
  118517. */
  118518. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118519. /**
  118520. * Serializes the animationGroup to an object
  118521. * @returns Serialized object
  118522. */
  118523. serialize(): any;
  118524. /**
  118525. * Returns a new AnimationGroup object parsed from the source provided.
  118526. * @param parsedAnimationGroup defines the source
  118527. * @param scene defines the scene that will receive the animationGroup
  118528. * @returns a new AnimationGroup
  118529. */
  118530. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  118531. /**
  118532. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  118533. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  118534. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  118535. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  118536. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  118537. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  118538. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  118539. */
  118540. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  118541. /**
  118542. * Returns the string "AnimationGroup"
  118543. * @returns "AnimationGroup"
  118544. */
  118545. getClassName(): string;
  118546. /**
  118547. * Creates a detailled string about the object
  118548. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  118549. * @returns a string representing the object
  118550. */
  118551. toString(fullDetails?: boolean): string;
  118552. }
  118553. }
  118554. declare module BABYLON {
  118555. /**
  118556. * Define an interface for all classes that will hold resources
  118557. */
  118558. export interface IDisposable {
  118559. /**
  118560. * Releases all held resources
  118561. */
  118562. dispose(): void;
  118563. }
  118564. /** Interface defining initialization parameters for Scene class */
  118565. export interface SceneOptions {
  118566. /**
  118567. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  118568. * It will improve performance when the number of geometries becomes important.
  118569. */
  118570. useGeometryUniqueIdsMap?: boolean;
  118571. /**
  118572. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  118573. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118574. */
  118575. useMaterialMeshMap?: boolean;
  118576. /**
  118577. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  118578. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118579. */
  118580. useClonedMeshMap?: boolean;
  118581. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  118582. virtual?: boolean;
  118583. }
  118584. /**
  118585. * Represents a scene to be rendered by the engine.
  118586. * @see https://doc.babylonjs.com/features/scene
  118587. */
  118588. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  118589. /** The fog is deactivated */
  118590. static readonly FOGMODE_NONE: number;
  118591. /** The fog density is following an exponential function */
  118592. static readonly FOGMODE_EXP: number;
  118593. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  118594. static readonly FOGMODE_EXP2: number;
  118595. /** The fog density is following a linear function. */
  118596. static readonly FOGMODE_LINEAR: number;
  118597. /**
  118598. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  118599. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118600. */
  118601. static MinDeltaTime: number;
  118602. /**
  118603. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  118604. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118605. */
  118606. static MaxDeltaTime: number;
  118607. /**
  118608. * Factory used to create the default material.
  118609. * @param name The name of the material to create
  118610. * @param scene The scene to create the material for
  118611. * @returns The default material
  118612. */
  118613. static DefaultMaterialFactory(scene: Scene): Material;
  118614. /**
  118615. * Factory used to create the a collision coordinator.
  118616. * @returns The collision coordinator
  118617. */
  118618. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  118619. /** @hidden */
  118620. _inputManager: InputManager;
  118621. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  118622. cameraToUseForPointers: Nullable<Camera>;
  118623. /** @hidden */
  118624. readonly _isScene: boolean;
  118625. /** @hidden */
  118626. _blockEntityCollection: boolean;
  118627. /**
  118628. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  118629. */
  118630. autoClear: boolean;
  118631. /**
  118632. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  118633. */
  118634. autoClearDepthAndStencil: boolean;
  118635. /**
  118636. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  118637. */
  118638. clearColor: Color4;
  118639. /**
  118640. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  118641. */
  118642. ambientColor: Color3;
  118643. /**
  118644. * This is use to store the default BRDF lookup for PBR materials in your scene.
  118645. * It should only be one of the following (if not the default embedded one):
  118646. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  118647. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  118648. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  118649. * The material properties need to be setup according to the type of texture in use.
  118650. */
  118651. environmentBRDFTexture: BaseTexture;
  118652. /** @hidden */
  118653. protected _environmentTexture: Nullable<BaseTexture>;
  118654. /**
  118655. * Texture used in all pbr material as the reflection texture.
  118656. * As in the majority of the scene they are the same (exception for multi room and so on),
  118657. * this is easier to reference from here than from all the materials.
  118658. */
  118659. get environmentTexture(): Nullable<BaseTexture>;
  118660. /**
  118661. * Texture used in all pbr material as the reflection texture.
  118662. * As in the majority of the scene they are the same (exception for multi room and so on),
  118663. * this is easier to set here than in all the materials.
  118664. */
  118665. set environmentTexture(value: Nullable<BaseTexture>);
  118666. /** @hidden */
  118667. protected _environmentIntensity: number;
  118668. /**
  118669. * Intensity of the environment in all pbr material.
  118670. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  118671. * As in the majority of the scene they are the same (exception for multi room and so on),
  118672. * this is easier to reference from here than from all the materials.
  118673. */
  118674. get environmentIntensity(): number;
  118675. /**
  118676. * Intensity of the environment in all pbr material.
  118677. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  118678. * As in the majority of the scene they are the same (exception for multi room and so on),
  118679. * this is easier to set here than in all the materials.
  118680. */
  118681. set environmentIntensity(value: number);
  118682. /** @hidden */
  118683. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  118684. /**
  118685. * Default image processing configuration used either in the rendering
  118686. * Forward main pass or through the imageProcessingPostProcess if present.
  118687. * As in the majority of the scene they are the same (exception for multi camera),
  118688. * this is easier to reference from here than from all the materials and post process.
  118689. *
  118690. * No setter as we it is a shared configuration, you can set the values instead.
  118691. */
  118692. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  118693. private _forceWireframe;
  118694. /**
  118695. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  118696. */
  118697. set forceWireframe(value: boolean);
  118698. get forceWireframe(): boolean;
  118699. private _skipFrustumClipping;
  118700. /**
  118701. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  118702. */
  118703. set skipFrustumClipping(value: boolean);
  118704. get skipFrustumClipping(): boolean;
  118705. private _forcePointsCloud;
  118706. /**
  118707. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  118708. */
  118709. set forcePointsCloud(value: boolean);
  118710. get forcePointsCloud(): boolean;
  118711. /**
  118712. * Gets or sets the active clipplane 1
  118713. */
  118714. clipPlane: Nullable<Plane>;
  118715. /**
  118716. * Gets or sets the active clipplane 2
  118717. */
  118718. clipPlane2: Nullable<Plane>;
  118719. /**
  118720. * Gets or sets the active clipplane 3
  118721. */
  118722. clipPlane3: Nullable<Plane>;
  118723. /**
  118724. * Gets or sets the active clipplane 4
  118725. */
  118726. clipPlane4: Nullable<Plane>;
  118727. /**
  118728. * Gets or sets the active clipplane 5
  118729. */
  118730. clipPlane5: Nullable<Plane>;
  118731. /**
  118732. * Gets or sets the active clipplane 6
  118733. */
  118734. clipPlane6: Nullable<Plane>;
  118735. /**
  118736. * Gets or sets a boolean indicating if animations are enabled
  118737. */
  118738. animationsEnabled: boolean;
  118739. private _animationPropertiesOverride;
  118740. /**
  118741. * Gets or sets the animation properties override
  118742. */
  118743. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  118744. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  118745. /**
  118746. * Gets or sets a boolean indicating if a constant deltatime has to be used
  118747. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  118748. */
  118749. useConstantAnimationDeltaTime: boolean;
  118750. /**
  118751. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  118752. * Please note that it requires to run a ray cast through the scene on every frame
  118753. */
  118754. constantlyUpdateMeshUnderPointer: boolean;
  118755. /**
  118756. * Defines the HTML cursor to use when hovering over interactive elements
  118757. */
  118758. hoverCursor: string;
  118759. /**
  118760. * Defines the HTML default cursor to use (empty by default)
  118761. */
  118762. defaultCursor: string;
  118763. /**
  118764. * Defines whether cursors are handled by the scene.
  118765. */
  118766. doNotHandleCursors: boolean;
  118767. /**
  118768. * This is used to call preventDefault() on pointer down
  118769. * in order to block unwanted artifacts like system double clicks
  118770. */
  118771. preventDefaultOnPointerDown: boolean;
  118772. /**
  118773. * This is used to call preventDefault() on pointer up
  118774. * in order to block unwanted artifacts like system double clicks
  118775. */
  118776. preventDefaultOnPointerUp: boolean;
  118777. /**
  118778. * Gets or sets user defined metadata
  118779. */
  118780. metadata: any;
  118781. /**
  118782. * For internal use only. Please do not use.
  118783. */
  118784. reservedDataStore: any;
  118785. /**
  118786. * Gets the name of the plugin used to load this scene (null by default)
  118787. */
  118788. loadingPluginName: string;
  118789. /**
  118790. * Use this array to add regular expressions used to disable offline support for specific urls
  118791. */
  118792. disableOfflineSupportExceptionRules: RegExp[];
  118793. /**
  118794. * An event triggered when the scene is disposed.
  118795. */
  118796. onDisposeObservable: Observable<Scene>;
  118797. private _onDisposeObserver;
  118798. /** Sets a function to be executed when this scene is disposed. */
  118799. set onDispose(callback: () => void);
  118800. /**
  118801. * An event triggered before rendering the scene (right after animations and physics)
  118802. */
  118803. onBeforeRenderObservable: Observable<Scene>;
  118804. private _onBeforeRenderObserver;
  118805. /** Sets a function to be executed before rendering this scene */
  118806. set beforeRender(callback: Nullable<() => void>);
  118807. /**
  118808. * An event triggered after rendering the scene
  118809. */
  118810. onAfterRenderObservable: Observable<Scene>;
  118811. /**
  118812. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  118813. */
  118814. onAfterRenderCameraObservable: Observable<Camera>;
  118815. private _onAfterRenderObserver;
  118816. /** Sets a function to be executed after rendering this scene */
  118817. set afterRender(callback: Nullable<() => void>);
  118818. /**
  118819. * An event triggered before animating the scene
  118820. */
  118821. onBeforeAnimationsObservable: Observable<Scene>;
  118822. /**
  118823. * An event triggered after animations processing
  118824. */
  118825. onAfterAnimationsObservable: Observable<Scene>;
  118826. /**
  118827. * An event triggered before draw calls are ready to be sent
  118828. */
  118829. onBeforeDrawPhaseObservable: Observable<Scene>;
  118830. /**
  118831. * An event triggered after draw calls have been sent
  118832. */
  118833. onAfterDrawPhaseObservable: Observable<Scene>;
  118834. /**
  118835. * An event triggered when the scene is ready
  118836. */
  118837. onReadyObservable: Observable<Scene>;
  118838. /**
  118839. * An event triggered before rendering a camera
  118840. */
  118841. onBeforeCameraRenderObservable: Observable<Camera>;
  118842. private _onBeforeCameraRenderObserver;
  118843. /** Sets a function to be executed before rendering a camera*/
  118844. set beforeCameraRender(callback: () => void);
  118845. /**
  118846. * An event triggered after rendering a camera
  118847. */
  118848. onAfterCameraRenderObservable: Observable<Camera>;
  118849. private _onAfterCameraRenderObserver;
  118850. /** Sets a function to be executed after rendering a camera*/
  118851. set afterCameraRender(callback: () => void);
  118852. /**
  118853. * An event triggered when active meshes evaluation is about to start
  118854. */
  118855. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  118856. /**
  118857. * An event triggered when active meshes evaluation is done
  118858. */
  118859. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  118860. /**
  118861. * An event triggered when particles rendering is about to start
  118862. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  118863. */
  118864. onBeforeParticlesRenderingObservable: Observable<Scene>;
  118865. /**
  118866. * An event triggered when particles rendering is done
  118867. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  118868. */
  118869. onAfterParticlesRenderingObservable: Observable<Scene>;
  118870. /**
  118871. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  118872. */
  118873. onDataLoadedObservable: Observable<Scene>;
  118874. /**
  118875. * An event triggered when a camera is created
  118876. */
  118877. onNewCameraAddedObservable: Observable<Camera>;
  118878. /**
  118879. * An event triggered when a camera is removed
  118880. */
  118881. onCameraRemovedObservable: Observable<Camera>;
  118882. /**
  118883. * An event triggered when a light is created
  118884. */
  118885. onNewLightAddedObservable: Observable<Light>;
  118886. /**
  118887. * An event triggered when a light is removed
  118888. */
  118889. onLightRemovedObservable: Observable<Light>;
  118890. /**
  118891. * An event triggered when a geometry is created
  118892. */
  118893. onNewGeometryAddedObservable: Observable<Geometry>;
  118894. /**
  118895. * An event triggered when a geometry is removed
  118896. */
  118897. onGeometryRemovedObservable: Observable<Geometry>;
  118898. /**
  118899. * An event triggered when a transform node is created
  118900. */
  118901. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  118902. /**
  118903. * An event triggered when a transform node is removed
  118904. */
  118905. onTransformNodeRemovedObservable: Observable<TransformNode>;
  118906. /**
  118907. * An event triggered when a mesh is created
  118908. */
  118909. onNewMeshAddedObservable: Observable<AbstractMesh>;
  118910. /**
  118911. * An event triggered when a mesh is removed
  118912. */
  118913. onMeshRemovedObservable: Observable<AbstractMesh>;
  118914. /**
  118915. * An event triggered when a skeleton is created
  118916. */
  118917. onNewSkeletonAddedObservable: Observable<Skeleton>;
  118918. /**
  118919. * An event triggered when a skeleton is removed
  118920. */
  118921. onSkeletonRemovedObservable: Observable<Skeleton>;
  118922. /**
  118923. * An event triggered when a material is created
  118924. */
  118925. onNewMaterialAddedObservable: Observable<Material>;
  118926. /**
  118927. * An event triggered when a material is removed
  118928. */
  118929. onMaterialRemovedObservable: Observable<Material>;
  118930. /**
  118931. * An event triggered when a texture is created
  118932. */
  118933. onNewTextureAddedObservable: Observable<BaseTexture>;
  118934. /**
  118935. * An event triggered when a texture is removed
  118936. */
  118937. onTextureRemovedObservable: Observable<BaseTexture>;
  118938. /**
  118939. * An event triggered when render targets are about to be rendered
  118940. * Can happen multiple times per frame.
  118941. */
  118942. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  118943. /**
  118944. * An event triggered when render targets were rendered.
  118945. * Can happen multiple times per frame.
  118946. */
  118947. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  118948. /**
  118949. * An event triggered before calculating deterministic simulation step
  118950. */
  118951. onBeforeStepObservable: Observable<Scene>;
  118952. /**
  118953. * An event triggered after calculating deterministic simulation step
  118954. */
  118955. onAfterStepObservable: Observable<Scene>;
  118956. /**
  118957. * An event triggered when the activeCamera property is updated
  118958. */
  118959. onActiveCameraChanged: Observable<Scene>;
  118960. /**
  118961. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  118962. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  118963. * 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)
  118964. */
  118965. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  118966. /**
  118967. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  118968. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  118969. * 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)
  118970. */
  118971. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  118972. /**
  118973. * This Observable will when a mesh has been imported into the scene.
  118974. */
  118975. onMeshImportedObservable: Observable<AbstractMesh>;
  118976. /**
  118977. * This Observable will when an animation file has been imported into the scene.
  118978. */
  118979. onAnimationFileImportedObservable: Observable<Scene>;
  118980. /**
  118981. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  118982. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  118983. */
  118984. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  118985. /** @hidden */
  118986. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  118987. /**
  118988. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  118989. */
  118990. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  118991. /**
  118992. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  118993. */
  118994. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  118995. /**
  118996. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  118997. */
  118998. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  118999. /** Callback called when a pointer move is detected */
  119000. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119001. /** Callback called when a pointer down is detected */
  119002. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119003. /** Callback called when a pointer up is detected */
  119004. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119005. /** Callback called when a pointer pick is detected */
  119006. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119007. /**
  119008. * 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).
  119009. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119010. */
  119011. onPrePointerObservable: Observable<PointerInfoPre>;
  119012. /**
  119013. * Observable event triggered each time an input event is received from the rendering canvas
  119014. */
  119015. onPointerObservable: Observable<PointerInfo>;
  119016. /**
  119017. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119018. */
  119019. get unTranslatedPointer(): Vector2;
  119020. /**
  119021. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119022. */
  119023. static get DragMovementThreshold(): number;
  119024. static set DragMovementThreshold(value: number);
  119025. /**
  119026. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119027. */
  119028. static get LongPressDelay(): number;
  119029. static set LongPressDelay(value: number);
  119030. /**
  119031. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119032. */
  119033. static get DoubleClickDelay(): number;
  119034. static set DoubleClickDelay(value: number);
  119035. /** If you need to check double click without raising a single click at first click, enable this flag */
  119036. static get ExclusiveDoubleClickMode(): boolean;
  119037. static set ExclusiveDoubleClickMode(value: boolean);
  119038. /** @hidden */
  119039. _mirroredCameraPosition: Nullable<Vector3>;
  119040. /**
  119041. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119042. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119043. */
  119044. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119045. /**
  119046. * Observable event triggered each time an keyboard event is received from the hosting window
  119047. */
  119048. onKeyboardObservable: Observable<KeyboardInfo>;
  119049. private _useRightHandedSystem;
  119050. /**
  119051. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119052. */
  119053. set useRightHandedSystem(value: boolean);
  119054. get useRightHandedSystem(): boolean;
  119055. private _timeAccumulator;
  119056. private _currentStepId;
  119057. private _currentInternalStep;
  119058. /**
  119059. * Sets the step Id used by deterministic lock step
  119060. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119061. * @param newStepId defines the step Id
  119062. */
  119063. setStepId(newStepId: number): void;
  119064. /**
  119065. * Gets the step Id used by deterministic lock step
  119066. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119067. * @returns the step Id
  119068. */
  119069. getStepId(): number;
  119070. /**
  119071. * Gets the internal step used by deterministic lock step
  119072. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119073. * @returns the internal step
  119074. */
  119075. getInternalStep(): number;
  119076. private _fogEnabled;
  119077. /**
  119078. * Gets or sets a boolean indicating if fog is enabled on this scene
  119079. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119080. * (Default is true)
  119081. */
  119082. set fogEnabled(value: boolean);
  119083. get fogEnabled(): boolean;
  119084. private _fogMode;
  119085. /**
  119086. * Gets or sets the fog mode to use
  119087. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119088. * | mode | value |
  119089. * | --- | --- |
  119090. * | FOGMODE_NONE | 0 |
  119091. * | FOGMODE_EXP | 1 |
  119092. * | FOGMODE_EXP2 | 2 |
  119093. * | FOGMODE_LINEAR | 3 |
  119094. */
  119095. set fogMode(value: number);
  119096. get fogMode(): number;
  119097. /**
  119098. * Gets or sets the fog color to use
  119099. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119100. * (Default is Color3(0.2, 0.2, 0.3))
  119101. */
  119102. fogColor: Color3;
  119103. /**
  119104. * Gets or sets the fog density to use
  119105. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119106. * (Default is 0.1)
  119107. */
  119108. fogDensity: number;
  119109. /**
  119110. * Gets or sets the fog start distance to use
  119111. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119112. * (Default is 0)
  119113. */
  119114. fogStart: number;
  119115. /**
  119116. * Gets or sets the fog end distance to use
  119117. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119118. * (Default is 1000)
  119119. */
  119120. fogEnd: number;
  119121. /**
  119122. * Flag indicating that the frame buffer binding is handled by another component
  119123. */
  119124. prePass: boolean;
  119125. private _shadowsEnabled;
  119126. /**
  119127. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119128. */
  119129. set shadowsEnabled(value: boolean);
  119130. get shadowsEnabled(): boolean;
  119131. private _lightsEnabled;
  119132. /**
  119133. * Gets or sets a boolean indicating if lights are enabled on this scene
  119134. */
  119135. set lightsEnabled(value: boolean);
  119136. get lightsEnabled(): boolean;
  119137. /** All of the active cameras added to this scene. */
  119138. activeCameras: Camera[];
  119139. /** @hidden */
  119140. _activeCamera: Nullable<Camera>;
  119141. /** Gets or sets the current active camera */
  119142. get activeCamera(): Nullable<Camera>;
  119143. set activeCamera(value: Nullable<Camera>);
  119144. private _defaultMaterial;
  119145. /** The default material used on meshes when no material is affected */
  119146. get defaultMaterial(): Material;
  119147. /** The default material used on meshes when no material is affected */
  119148. set defaultMaterial(value: Material);
  119149. private _texturesEnabled;
  119150. /**
  119151. * Gets or sets a boolean indicating if textures are enabled on this scene
  119152. */
  119153. set texturesEnabled(value: boolean);
  119154. get texturesEnabled(): boolean;
  119155. /**
  119156. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119157. */
  119158. physicsEnabled: boolean;
  119159. /**
  119160. * Gets or sets a boolean indicating if particles are enabled on this scene
  119161. */
  119162. particlesEnabled: boolean;
  119163. /**
  119164. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119165. */
  119166. spritesEnabled: boolean;
  119167. private _skeletonsEnabled;
  119168. /**
  119169. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119170. */
  119171. set skeletonsEnabled(value: boolean);
  119172. get skeletonsEnabled(): boolean;
  119173. /**
  119174. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119175. */
  119176. lensFlaresEnabled: boolean;
  119177. /**
  119178. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119179. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119180. */
  119181. collisionsEnabled: boolean;
  119182. private _collisionCoordinator;
  119183. /** @hidden */
  119184. get collisionCoordinator(): ICollisionCoordinator;
  119185. /**
  119186. * Defines the gravity applied to this scene (used only for collisions)
  119187. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119188. */
  119189. gravity: Vector3;
  119190. /**
  119191. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119192. */
  119193. postProcessesEnabled: boolean;
  119194. /**
  119195. * Gets the current postprocess manager
  119196. */
  119197. postProcessManager: PostProcessManager;
  119198. /**
  119199. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119200. */
  119201. renderTargetsEnabled: boolean;
  119202. /**
  119203. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119204. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119205. */
  119206. dumpNextRenderTargets: boolean;
  119207. /**
  119208. * The list of user defined render targets added to the scene
  119209. */
  119210. customRenderTargets: RenderTargetTexture[];
  119211. /**
  119212. * Defines if texture loading must be delayed
  119213. * If true, textures will only be loaded when they need to be rendered
  119214. */
  119215. useDelayedTextureLoading: boolean;
  119216. /**
  119217. * Gets the list of meshes imported to the scene through SceneLoader
  119218. */
  119219. importedMeshesFiles: String[];
  119220. /**
  119221. * Gets or sets a boolean indicating if probes are enabled on this scene
  119222. */
  119223. probesEnabled: boolean;
  119224. /**
  119225. * Gets or sets the current offline provider to use to store scene data
  119226. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119227. */
  119228. offlineProvider: IOfflineProvider;
  119229. /**
  119230. * Gets or sets the action manager associated with the scene
  119231. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119232. */
  119233. actionManager: AbstractActionManager;
  119234. private _meshesForIntersections;
  119235. /**
  119236. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119237. */
  119238. proceduralTexturesEnabled: boolean;
  119239. private _engine;
  119240. private _totalVertices;
  119241. /** @hidden */
  119242. _activeIndices: PerfCounter;
  119243. /** @hidden */
  119244. _activeParticles: PerfCounter;
  119245. /** @hidden */
  119246. _activeBones: PerfCounter;
  119247. private _animationRatio;
  119248. /** @hidden */
  119249. _animationTimeLast: number;
  119250. /** @hidden */
  119251. _animationTime: number;
  119252. /**
  119253. * Gets or sets a general scale for animation speed
  119254. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119255. */
  119256. animationTimeScale: number;
  119257. /** @hidden */
  119258. _cachedMaterial: Nullable<Material>;
  119259. /** @hidden */
  119260. _cachedEffect: Nullable<Effect>;
  119261. /** @hidden */
  119262. _cachedVisibility: Nullable<number>;
  119263. private _renderId;
  119264. private _frameId;
  119265. private _executeWhenReadyTimeoutId;
  119266. private _intermediateRendering;
  119267. private _viewUpdateFlag;
  119268. private _projectionUpdateFlag;
  119269. /** @hidden */
  119270. _toBeDisposed: Nullable<IDisposable>[];
  119271. private _activeRequests;
  119272. /** @hidden */
  119273. _pendingData: any[];
  119274. private _isDisposed;
  119275. /**
  119276. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119277. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119278. */
  119279. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119280. private _activeMeshes;
  119281. private _processedMaterials;
  119282. private _renderTargets;
  119283. /** @hidden */
  119284. _activeParticleSystems: SmartArray<IParticleSystem>;
  119285. private _activeSkeletons;
  119286. private _softwareSkinnedMeshes;
  119287. private _renderingManager;
  119288. /** @hidden */
  119289. _activeAnimatables: Animatable[];
  119290. private _transformMatrix;
  119291. private _sceneUbo;
  119292. /** @hidden */
  119293. _viewMatrix: Matrix;
  119294. private _projectionMatrix;
  119295. /** @hidden */
  119296. _forcedViewPosition: Nullable<Vector3>;
  119297. /** @hidden */
  119298. _frustumPlanes: Plane[];
  119299. /**
  119300. * Gets the list of frustum planes (built from the active camera)
  119301. */
  119302. get frustumPlanes(): Plane[];
  119303. /**
  119304. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119305. * This is useful if there are more lights that the maximum simulteanous authorized
  119306. */
  119307. requireLightSorting: boolean;
  119308. /** @hidden */
  119309. readonly useMaterialMeshMap: boolean;
  119310. /** @hidden */
  119311. readonly useClonedMeshMap: boolean;
  119312. private _externalData;
  119313. private _uid;
  119314. /**
  119315. * @hidden
  119316. * Backing store of defined scene components.
  119317. */
  119318. _components: ISceneComponent[];
  119319. /**
  119320. * @hidden
  119321. * Backing store of defined scene components.
  119322. */
  119323. _serializableComponents: ISceneSerializableComponent[];
  119324. /**
  119325. * List of components to register on the next registration step.
  119326. */
  119327. private _transientComponents;
  119328. /**
  119329. * Registers the transient components if needed.
  119330. */
  119331. private _registerTransientComponents;
  119332. /**
  119333. * @hidden
  119334. * Add a component to the scene.
  119335. * Note that the ccomponent could be registered on th next frame if this is called after
  119336. * the register component stage.
  119337. * @param component Defines the component to add to the scene
  119338. */
  119339. _addComponent(component: ISceneComponent): void;
  119340. /**
  119341. * @hidden
  119342. * Gets a component from the scene.
  119343. * @param name defines the name of the component to retrieve
  119344. * @returns the component or null if not present
  119345. */
  119346. _getComponent(name: string): Nullable<ISceneComponent>;
  119347. /**
  119348. * @hidden
  119349. * Defines the actions happening before camera updates.
  119350. */
  119351. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119352. /**
  119353. * @hidden
  119354. * Defines the actions happening before clear the canvas.
  119355. */
  119356. _beforeClearStage: Stage<SimpleStageAction>;
  119357. /**
  119358. * @hidden
  119359. * Defines the actions when collecting render targets for the frame.
  119360. */
  119361. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119362. /**
  119363. * @hidden
  119364. * Defines the actions happening for one camera in the frame.
  119365. */
  119366. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119367. /**
  119368. * @hidden
  119369. * Defines the actions happening during the per mesh ready checks.
  119370. */
  119371. _isReadyForMeshStage: Stage<MeshStageAction>;
  119372. /**
  119373. * @hidden
  119374. * Defines the actions happening before evaluate active mesh checks.
  119375. */
  119376. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119377. /**
  119378. * @hidden
  119379. * Defines the actions happening during the evaluate sub mesh checks.
  119380. */
  119381. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119382. /**
  119383. * @hidden
  119384. * Defines the actions happening during the active mesh stage.
  119385. */
  119386. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119387. /**
  119388. * @hidden
  119389. * Defines the actions happening during the per camera render target step.
  119390. */
  119391. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119392. /**
  119393. * @hidden
  119394. * Defines the actions happening just before the active camera is drawing.
  119395. */
  119396. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119397. /**
  119398. * @hidden
  119399. * Defines the actions happening just before a render target is drawing.
  119400. */
  119401. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119402. /**
  119403. * @hidden
  119404. * Defines the actions happening just before a rendering group is drawing.
  119405. */
  119406. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119407. /**
  119408. * @hidden
  119409. * Defines the actions happening just before a mesh is drawing.
  119410. */
  119411. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119412. /**
  119413. * @hidden
  119414. * Defines the actions happening just after a mesh has been drawn.
  119415. */
  119416. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119417. /**
  119418. * @hidden
  119419. * Defines the actions happening just after a rendering group has been drawn.
  119420. */
  119421. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119422. /**
  119423. * @hidden
  119424. * Defines the actions happening just after the active camera has been drawn.
  119425. */
  119426. _afterCameraDrawStage: Stage<CameraStageAction>;
  119427. /**
  119428. * @hidden
  119429. * Defines the actions happening just after a render target has been drawn.
  119430. */
  119431. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119432. /**
  119433. * @hidden
  119434. * Defines the actions happening just after rendering all cameras and computing intersections.
  119435. */
  119436. _afterRenderStage: Stage<SimpleStageAction>;
  119437. /**
  119438. * @hidden
  119439. * Defines the actions happening when a pointer move event happens.
  119440. */
  119441. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119442. /**
  119443. * @hidden
  119444. * Defines the actions happening when a pointer down event happens.
  119445. */
  119446. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119447. /**
  119448. * @hidden
  119449. * Defines the actions happening when a pointer up event happens.
  119450. */
  119451. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119452. /**
  119453. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119454. */
  119455. private geometriesByUniqueId;
  119456. /**
  119457. * Creates a new Scene
  119458. * @param engine defines the engine to use to render this scene
  119459. * @param options defines the scene options
  119460. */
  119461. constructor(engine: Engine, options?: SceneOptions);
  119462. /**
  119463. * Gets a string identifying the name of the class
  119464. * @returns "Scene" string
  119465. */
  119466. getClassName(): string;
  119467. private _defaultMeshCandidates;
  119468. /**
  119469. * @hidden
  119470. */
  119471. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119472. private _defaultSubMeshCandidates;
  119473. /**
  119474. * @hidden
  119475. */
  119476. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119477. /**
  119478. * Sets the default candidate providers for the scene.
  119479. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119480. * and getCollidingSubMeshCandidates to their default function
  119481. */
  119482. setDefaultCandidateProviders(): void;
  119483. /**
  119484. * Gets the mesh that is currently under the pointer
  119485. */
  119486. get meshUnderPointer(): Nullable<AbstractMesh>;
  119487. /**
  119488. * Gets or sets the current on-screen X position of the pointer
  119489. */
  119490. get pointerX(): number;
  119491. set pointerX(value: number);
  119492. /**
  119493. * Gets or sets the current on-screen Y position of the pointer
  119494. */
  119495. get pointerY(): number;
  119496. set pointerY(value: number);
  119497. /**
  119498. * Gets the cached material (ie. the latest rendered one)
  119499. * @returns the cached material
  119500. */
  119501. getCachedMaterial(): Nullable<Material>;
  119502. /**
  119503. * Gets the cached effect (ie. the latest rendered one)
  119504. * @returns the cached effect
  119505. */
  119506. getCachedEffect(): Nullable<Effect>;
  119507. /**
  119508. * Gets the cached visibility state (ie. the latest rendered one)
  119509. * @returns the cached visibility state
  119510. */
  119511. getCachedVisibility(): Nullable<number>;
  119512. /**
  119513. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119514. * @param material defines the current material
  119515. * @param effect defines the current effect
  119516. * @param visibility defines the current visibility state
  119517. * @returns true if one parameter is not cached
  119518. */
  119519. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119520. /**
  119521. * Gets the engine associated with the scene
  119522. * @returns an Engine
  119523. */
  119524. getEngine(): Engine;
  119525. /**
  119526. * Gets the total number of vertices rendered per frame
  119527. * @returns the total number of vertices rendered per frame
  119528. */
  119529. getTotalVertices(): number;
  119530. /**
  119531. * Gets the performance counter for total vertices
  119532. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119533. */
  119534. get totalVerticesPerfCounter(): PerfCounter;
  119535. /**
  119536. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  119537. * @returns the total number of active indices rendered per frame
  119538. */
  119539. getActiveIndices(): number;
  119540. /**
  119541. * Gets the performance counter for active indices
  119542. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119543. */
  119544. get totalActiveIndicesPerfCounter(): PerfCounter;
  119545. /**
  119546. * Gets the total number of active particles rendered per frame
  119547. * @returns the total number of active particles rendered per frame
  119548. */
  119549. getActiveParticles(): number;
  119550. /**
  119551. * Gets the performance counter for active particles
  119552. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119553. */
  119554. get activeParticlesPerfCounter(): PerfCounter;
  119555. /**
  119556. * Gets the total number of active bones rendered per frame
  119557. * @returns the total number of active bones rendered per frame
  119558. */
  119559. getActiveBones(): number;
  119560. /**
  119561. * Gets the performance counter for active bones
  119562. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119563. */
  119564. get activeBonesPerfCounter(): PerfCounter;
  119565. /**
  119566. * Gets the array of active meshes
  119567. * @returns an array of AbstractMesh
  119568. */
  119569. getActiveMeshes(): SmartArray<AbstractMesh>;
  119570. /**
  119571. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  119572. * @returns a number
  119573. */
  119574. getAnimationRatio(): number;
  119575. /**
  119576. * Gets an unique Id for the current render phase
  119577. * @returns a number
  119578. */
  119579. getRenderId(): number;
  119580. /**
  119581. * Gets an unique Id for the current frame
  119582. * @returns a number
  119583. */
  119584. getFrameId(): number;
  119585. /** Call this function if you want to manually increment the render Id*/
  119586. incrementRenderId(): void;
  119587. private _createUbo;
  119588. /**
  119589. * Use this method to simulate a pointer move on a mesh
  119590. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119591. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119592. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119593. * @returns the current scene
  119594. */
  119595. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119596. /**
  119597. * Use this method to simulate a pointer down on a mesh
  119598. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119599. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119600. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119601. * @returns the current scene
  119602. */
  119603. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119604. /**
  119605. * Use this method to simulate a pointer up on a mesh
  119606. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119607. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119608. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119609. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119610. * @returns the current scene
  119611. */
  119612. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  119613. /**
  119614. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119615. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119616. * @returns true if the pointer was captured
  119617. */
  119618. isPointerCaptured(pointerId?: number): boolean;
  119619. /**
  119620. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  119621. * @param attachUp defines if you want to attach events to pointerup
  119622. * @param attachDown defines if you want to attach events to pointerdown
  119623. * @param attachMove defines if you want to attach events to pointermove
  119624. */
  119625. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  119626. /** Detaches all event handlers*/
  119627. detachControl(): void;
  119628. /**
  119629. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  119630. * Delay loaded resources are not taking in account
  119631. * @return true if all required resources are ready
  119632. */
  119633. isReady(): boolean;
  119634. /** Resets all cached information relative to material (including effect and visibility) */
  119635. resetCachedMaterial(): void;
  119636. /**
  119637. * Registers a function to be called before every frame render
  119638. * @param func defines the function to register
  119639. */
  119640. registerBeforeRender(func: () => void): void;
  119641. /**
  119642. * Unregisters a function called before every frame render
  119643. * @param func defines the function to unregister
  119644. */
  119645. unregisterBeforeRender(func: () => void): void;
  119646. /**
  119647. * Registers a function to be called after every frame render
  119648. * @param func defines the function to register
  119649. */
  119650. registerAfterRender(func: () => void): void;
  119651. /**
  119652. * Unregisters a function called after every frame render
  119653. * @param func defines the function to unregister
  119654. */
  119655. unregisterAfterRender(func: () => void): void;
  119656. private _executeOnceBeforeRender;
  119657. /**
  119658. * The provided function will run before render once and will be disposed afterwards.
  119659. * A timeout delay can be provided so that the function will be executed in N ms.
  119660. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  119661. * @param func The function to be executed.
  119662. * @param timeout optional delay in ms
  119663. */
  119664. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  119665. /** @hidden */
  119666. _addPendingData(data: any): void;
  119667. /** @hidden */
  119668. _removePendingData(data: any): void;
  119669. /**
  119670. * Returns the number of items waiting to be loaded
  119671. * @returns the number of items waiting to be loaded
  119672. */
  119673. getWaitingItemsCount(): number;
  119674. /**
  119675. * Returns a boolean indicating if the scene is still loading data
  119676. */
  119677. get isLoading(): boolean;
  119678. /**
  119679. * Registers a function to be executed when the scene is ready
  119680. * @param {Function} func - the function to be executed
  119681. */
  119682. executeWhenReady(func: () => void): void;
  119683. /**
  119684. * Returns a promise that resolves when the scene is ready
  119685. * @returns A promise that resolves when the scene is ready
  119686. */
  119687. whenReadyAsync(): Promise<void>;
  119688. /** @hidden */
  119689. _checkIsReady(): void;
  119690. /**
  119691. * Gets all animatable attached to the scene
  119692. */
  119693. get animatables(): Animatable[];
  119694. /**
  119695. * Resets the last animation time frame.
  119696. * Useful to override when animations start running when loading a scene for the first time.
  119697. */
  119698. resetLastAnimationTimeFrame(): void;
  119699. /**
  119700. * Gets the current view matrix
  119701. * @returns a Matrix
  119702. */
  119703. getViewMatrix(): Matrix;
  119704. /**
  119705. * Gets the current projection matrix
  119706. * @returns a Matrix
  119707. */
  119708. getProjectionMatrix(): Matrix;
  119709. /**
  119710. * Gets the current transform matrix
  119711. * @returns a Matrix made of View * Projection
  119712. */
  119713. getTransformMatrix(): Matrix;
  119714. /**
  119715. * Sets the current transform matrix
  119716. * @param viewL defines the View matrix to use
  119717. * @param projectionL defines the Projection matrix to use
  119718. * @param viewR defines the right View matrix to use (if provided)
  119719. * @param projectionR defines the right Projection matrix to use (if provided)
  119720. */
  119721. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  119722. /**
  119723. * Gets the uniform buffer used to store scene data
  119724. * @returns a UniformBuffer
  119725. */
  119726. getSceneUniformBuffer(): UniformBuffer;
  119727. /**
  119728. * Gets an unique (relatively to the current scene) Id
  119729. * @returns an unique number for the scene
  119730. */
  119731. getUniqueId(): number;
  119732. /**
  119733. * Add a mesh to the list of scene's meshes
  119734. * @param newMesh defines the mesh to add
  119735. * @param recursive if all child meshes should also be added to the scene
  119736. */
  119737. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  119738. /**
  119739. * Remove a mesh for the list of scene's meshes
  119740. * @param toRemove defines the mesh to remove
  119741. * @param recursive if all child meshes should also be removed from the scene
  119742. * @returns the index where the mesh was in the mesh list
  119743. */
  119744. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  119745. /**
  119746. * Add a transform node to the list of scene's transform nodes
  119747. * @param newTransformNode defines the transform node to add
  119748. */
  119749. addTransformNode(newTransformNode: TransformNode): void;
  119750. /**
  119751. * Remove a transform node for the list of scene's transform nodes
  119752. * @param toRemove defines the transform node to remove
  119753. * @returns the index where the transform node was in the transform node list
  119754. */
  119755. removeTransformNode(toRemove: TransformNode): number;
  119756. /**
  119757. * Remove a skeleton for the list of scene's skeletons
  119758. * @param toRemove defines the skeleton to remove
  119759. * @returns the index where the skeleton was in the skeleton list
  119760. */
  119761. removeSkeleton(toRemove: Skeleton): number;
  119762. /**
  119763. * Remove a morph target for the list of scene's morph targets
  119764. * @param toRemove defines the morph target to remove
  119765. * @returns the index where the morph target was in the morph target list
  119766. */
  119767. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  119768. /**
  119769. * Remove a light for the list of scene's lights
  119770. * @param toRemove defines the light to remove
  119771. * @returns the index where the light was in the light list
  119772. */
  119773. removeLight(toRemove: Light): number;
  119774. /**
  119775. * Remove a camera for the list of scene's cameras
  119776. * @param toRemove defines the camera to remove
  119777. * @returns the index where the camera was in the camera list
  119778. */
  119779. removeCamera(toRemove: Camera): number;
  119780. /**
  119781. * Remove a particle system for the list of scene's particle systems
  119782. * @param toRemove defines the particle system to remove
  119783. * @returns the index where the particle system was in the particle system list
  119784. */
  119785. removeParticleSystem(toRemove: IParticleSystem): number;
  119786. /**
  119787. * Remove a animation for the list of scene's animations
  119788. * @param toRemove defines the animation to remove
  119789. * @returns the index where the animation was in the animation list
  119790. */
  119791. removeAnimation(toRemove: Animation): number;
  119792. /**
  119793. * Will stop the animation of the given target
  119794. * @param target - the target
  119795. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  119796. * @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)
  119797. */
  119798. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  119799. /**
  119800. * Removes the given animation group from this scene.
  119801. * @param toRemove The animation group to remove
  119802. * @returns The index of the removed animation group
  119803. */
  119804. removeAnimationGroup(toRemove: AnimationGroup): number;
  119805. /**
  119806. * Removes the given multi-material from this scene.
  119807. * @param toRemove The multi-material to remove
  119808. * @returns The index of the removed multi-material
  119809. */
  119810. removeMultiMaterial(toRemove: MultiMaterial): number;
  119811. /**
  119812. * Removes the given material from this scene.
  119813. * @param toRemove The material to remove
  119814. * @returns The index of the removed material
  119815. */
  119816. removeMaterial(toRemove: Material): number;
  119817. /**
  119818. * Removes the given action manager from this scene.
  119819. * @param toRemove The action manager to remove
  119820. * @returns The index of the removed action manager
  119821. */
  119822. removeActionManager(toRemove: AbstractActionManager): number;
  119823. /**
  119824. * Removes the given texture from this scene.
  119825. * @param toRemove The texture to remove
  119826. * @returns The index of the removed texture
  119827. */
  119828. removeTexture(toRemove: BaseTexture): number;
  119829. /**
  119830. * Adds the given light to this scene
  119831. * @param newLight The light to add
  119832. */
  119833. addLight(newLight: Light): void;
  119834. /**
  119835. * Sorts the list list based on light priorities
  119836. */
  119837. sortLightsByPriority(): void;
  119838. /**
  119839. * Adds the given camera to this scene
  119840. * @param newCamera The camera to add
  119841. */
  119842. addCamera(newCamera: Camera): void;
  119843. /**
  119844. * Adds the given skeleton to this scene
  119845. * @param newSkeleton The skeleton to add
  119846. */
  119847. addSkeleton(newSkeleton: Skeleton): void;
  119848. /**
  119849. * Adds the given particle system to this scene
  119850. * @param newParticleSystem The particle system to add
  119851. */
  119852. addParticleSystem(newParticleSystem: IParticleSystem): void;
  119853. /**
  119854. * Adds the given animation to this scene
  119855. * @param newAnimation The animation to add
  119856. */
  119857. addAnimation(newAnimation: Animation): void;
  119858. /**
  119859. * Adds the given animation group to this scene.
  119860. * @param newAnimationGroup The animation group to add
  119861. */
  119862. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  119863. /**
  119864. * Adds the given multi-material to this scene
  119865. * @param newMultiMaterial The multi-material to add
  119866. */
  119867. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  119868. /**
  119869. * Adds the given material to this scene
  119870. * @param newMaterial The material to add
  119871. */
  119872. addMaterial(newMaterial: Material): void;
  119873. /**
  119874. * Adds the given morph target to this scene
  119875. * @param newMorphTargetManager The morph target to add
  119876. */
  119877. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  119878. /**
  119879. * Adds the given geometry to this scene
  119880. * @param newGeometry The geometry to add
  119881. */
  119882. addGeometry(newGeometry: Geometry): void;
  119883. /**
  119884. * Adds the given action manager to this scene
  119885. * @param newActionManager The action manager to add
  119886. */
  119887. addActionManager(newActionManager: AbstractActionManager): void;
  119888. /**
  119889. * Adds the given texture to this scene.
  119890. * @param newTexture The texture to add
  119891. */
  119892. addTexture(newTexture: BaseTexture): void;
  119893. /**
  119894. * Switch active camera
  119895. * @param newCamera defines the new active camera
  119896. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  119897. */
  119898. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  119899. /**
  119900. * sets the active camera of the scene using its ID
  119901. * @param id defines the camera's ID
  119902. * @return the new active camera or null if none found.
  119903. */
  119904. setActiveCameraByID(id: string): Nullable<Camera>;
  119905. /**
  119906. * sets the active camera of the scene using its name
  119907. * @param name defines the camera's name
  119908. * @returns the new active camera or null if none found.
  119909. */
  119910. setActiveCameraByName(name: string): Nullable<Camera>;
  119911. /**
  119912. * get an animation group using its name
  119913. * @param name defines the material's name
  119914. * @return the animation group or null if none found.
  119915. */
  119916. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  119917. /**
  119918. * Get a material using its unique id
  119919. * @param uniqueId defines the material's unique id
  119920. * @return the material or null if none found.
  119921. */
  119922. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  119923. /**
  119924. * get a material using its id
  119925. * @param id defines the material's ID
  119926. * @return the material or null if none found.
  119927. */
  119928. getMaterialByID(id: string): Nullable<Material>;
  119929. /**
  119930. * Gets a the last added material using a given id
  119931. * @param id defines the material's ID
  119932. * @return the last material with the given id or null if none found.
  119933. */
  119934. getLastMaterialByID(id: string): Nullable<Material>;
  119935. /**
  119936. * Gets a material using its name
  119937. * @param name defines the material's name
  119938. * @return the material or null if none found.
  119939. */
  119940. getMaterialByName(name: string): Nullable<Material>;
  119941. /**
  119942. * Get a texture using its unique id
  119943. * @param uniqueId defines the texture's unique id
  119944. * @return the texture or null if none found.
  119945. */
  119946. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  119947. /**
  119948. * Gets a camera using its id
  119949. * @param id defines the id to look for
  119950. * @returns the camera or null if not found
  119951. */
  119952. getCameraByID(id: string): Nullable<Camera>;
  119953. /**
  119954. * Gets a camera using its unique id
  119955. * @param uniqueId defines the unique id to look for
  119956. * @returns the camera or null if not found
  119957. */
  119958. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  119959. /**
  119960. * Gets a camera using its name
  119961. * @param name defines the camera's name
  119962. * @return the camera or null if none found.
  119963. */
  119964. getCameraByName(name: string): Nullable<Camera>;
  119965. /**
  119966. * Gets a bone using its id
  119967. * @param id defines the bone's id
  119968. * @return the bone or null if not found
  119969. */
  119970. getBoneByID(id: string): Nullable<Bone>;
  119971. /**
  119972. * Gets a bone using its id
  119973. * @param name defines the bone's name
  119974. * @return the bone or null if not found
  119975. */
  119976. getBoneByName(name: string): Nullable<Bone>;
  119977. /**
  119978. * Gets a light node using its name
  119979. * @param name defines the the light's name
  119980. * @return the light or null if none found.
  119981. */
  119982. getLightByName(name: string): Nullable<Light>;
  119983. /**
  119984. * Gets a light node using its id
  119985. * @param id defines the light's id
  119986. * @return the light or null if none found.
  119987. */
  119988. getLightByID(id: string): Nullable<Light>;
  119989. /**
  119990. * Gets a light node using its scene-generated unique ID
  119991. * @param uniqueId defines the light's unique id
  119992. * @return the light or null if none found.
  119993. */
  119994. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  119995. /**
  119996. * Gets a particle system by id
  119997. * @param id defines the particle system id
  119998. * @return the corresponding system or null if none found
  119999. */
  120000. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120001. /**
  120002. * Gets a geometry using its ID
  120003. * @param id defines the geometry's id
  120004. * @return the geometry or null if none found.
  120005. */
  120006. getGeometryByID(id: string): Nullable<Geometry>;
  120007. private _getGeometryByUniqueID;
  120008. /**
  120009. * Add a new geometry to this scene
  120010. * @param geometry defines the geometry to be added to the scene.
  120011. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120012. * @return a boolean defining if the geometry was added or not
  120013. */
  120014. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120015. /**
  120016. * Removes an existing geometry
  120017. * @param geometry defines the geometry to be removed from the scene
  120018. * @return a boolean defining if the geometry was removed or not
  120019. */
  120020. removeGeometry(geometry: Geometry): boolean;
  120021. /**
  120022. * Gets the list of geometries attached to the scene
  120023. * @returns an array of Geometry
  120024. */
  120025. getGeometries(): Geometry[];
  120026. /**
  120027. * Gets the first added mesh found of a given ID
  120028. * @param id defines the id to search for
  120029. * @return the mesh found or null if not found at all
  120030. */
  120031. getMeshByID(id: string): Nullable<AbstractMesh>;
  120032. /**
  120033. * Gets a list of meshes using their id
  120034. * @param id defines the id to search for
  120035. * @returns a list of meshes
  120036. */
  120037. getMeshesByID(id: string): Array<AbstractMesh>;
  120038. /**
  120039. * Gets the first added transform node found of a given ID
  120040. * @param id defines the id to search for
  120041. * @return the found transform node or null if not found at all.
  120042. */
  120043. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120044. /**
  120045. * Gets a transform node with its auto-generated unique id
  120046. * @param uniqueId efines the unique id to search for
  120047. * @return the found transform node or null if not found at all.
  120048. */
  120049. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120050. /**
  120051. * Gets a list of transform nodes using their id
  120052. * @param id defines the id to search for
  120053. * @returns a list of transform nodes
  120054. */
  120055. getTransformNodesByID(id: string): Array<TransformNode>;
  120056. /**
  120057. * Gets a mesh with its auto-generated unique id
  120058. * @param uniqueId defines the unique id to search for
  120059. * @return the found mesh or null if not found at all.
  120060. */
  120061. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120062. /**
  120063. * Gets a the last added mesh using a given id
  120064. * @param id defines the id to search for
  120065. * @return the found mesh or null if not found at all.
  120066. */
  120067. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120068. /**
  120069. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120070. * @param id defines the id to search for
  120071. * @return the found node or null if not found at all
  120072. */
  120073. getLastEntryByID(id: string): Nullable<Node>;
  120074. /**
  120075. * Gets a node (Mesh, Camera, Light) using a given id
  120076. * @param id defines the id to search for
  120077. * @return the found node or null if not found at all
  120078. */
  120079. getNodeByID(id: string): Nullable<Node>;
  120080. /**
  120081. * Gets a node (Mesh, Camera, Light) using a given name
  120082. * @param name defines the name to search for
  120083. * @return the found node or null if not found at all.
  120084. */
  120085. getNodeByName(name: string): Nullable<Node>;
  120086. /**
  120087. * Gets a mesh using a given name
  120088. * @param name defines the name to search for
  120089. * @return the found mesh or null if not found at all.
  120090. */
  120091. getMeshByName(name: string): Nullable<AbstractMesh>;
  120092. /**
  120093. * Gets a transform node using a given name
  120094. * @param name defines the name to search for
  120095. * @return the found transform node or null if not found at all.
  120096. */
  120097. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120098. /**
  120099. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120100. * @param id defines the id to search for
  120101. * @return the found skeleton or null if not found at all.
  120102. */
  120103. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120104. /**
  120105. * Gets a skeleton using a given auto generated unique id
  120106. * @param uniqueId defines the unique id to search for
  120107. * @return the found skeleton or null if not found at all.
  120108. */
  120109. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120110. /**
  120111. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120112. * @param id defines the id to search for
  120113. * @return the found skeleton or null if not found at all.
  120114. */
  120115. getSkeletonById(id: string): Nullable<Skeleton>;
  120116. /**
  120117. * Gets a skeleton using a given name
  120118. * @param name defines the name to search for
  120119. * @return the found skeleton or null if not found at all.
  120120. */
  120121. getSkeletonByName(name: string): Nullable<Skeleton>;
  120122. /**
  120123. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120124. * @param id defines the id to search for
  120125. * @return the found morph target manager or null if not found at all.
  120126. */
  120127. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120128. /**
  120129. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120130. * @param id defines the id to search for
  120131. * @return the found morph target or null if not found at all.
  120132. */
  120133. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120134. /**
  120135. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120136. * @param name defines the name to search for
  120137. * @return the found morph target or null if not found at all.
  120138. */
  120139. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120140. /**
  120141. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120142. * @param name defines the name to search for
  120143. * @return the found post process or null if not found at all.
  120144. */
  120145. getPostProcessByName(name: string): Nullable<PostProcess>;
  120146. /**
  120147. * Gets a boolean indicating if the given mesh is active
  120148. * @param mesh defines the mesh to look for
  120149. * @returns true if the mesh is in the active list
  120150. */
  120151. isActiveMesh(mesh: AbstractMesh): boolean;
  120152. /**
  120153. * Return a unique id as a string which can serve as an identifier for the scene
  120154. */
  120155. get uid(): string;
  120156. /**
  120157. * Add an externaly attached data from its key.
  120158. * This method call will fail and return false, if such key already exists.
  120159. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120160. * @param key the unique key that identifies the data
  120161. * @param data the data object to associate to the key for this Engine instance
  120162. * @return true if no such key were already present and the data was added successfully, false otherwise
  120163. */
  120164. addExternalData<T>(key: string, data: T): boolean;
  120165. /**
  120166. * Get an externaly attached data from its key
  120167. * @param key the unique key that identifies the data
  120168. * @return the associated data, if present (can be null), or undefined if not present
  120169. */
  120170. getExternalData<T>(key: string): Nullable<T>;
  120171. /**
  120172. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120173. * @param key the unique key that identifies the data
  120174. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120175. * @return the associated data, can be null if the factory returned null.
  120176. */
  120177. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120178. /**
  120179. * Remove an externaly attached data from the Engine instance
  120180. * @param key the unique key that identifies the data
  120181. * @return true if the data was successfully removed, false if it doesn't exist
  120182. */
  120183. removeExternalData(key: string): boolean;
  120184. private _evaluateSubMesh;
  120185. /**
  120186. * Clear the processed materials smart array preventing retention point in material dispose.
  120187. */
  120188. freeProcessedMaterials(): void;
  120189. private _preventFreeActiveMeshesAndRenderingGroups;
  120190. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120191. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120192. * when disposing several meshes in a row or a hierarchy of meshes.
  120193. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120194. */
  120195. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120196. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120197. /**
  120198. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120199. */
  120200. freeActiveMeshes(): void;
  120201. /**
  120202. * Clear the info related to rendering groups preventing retention points during dispose.
  120203. */
  120204. freeRenderingGroups(): void;
  120205. /** @hidden */
  120206. _isInIntermediateRendering(): boolean;
  120207. /**
  120208. * Lambda returning the list of potentially active meshes.
  120209. */
  120210. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120211. /**
  120212. * Lambda returning the list of potentially active sub meshes.
  120213. */
  120214. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120215. /**
  120216. * Lambda returning the list of potentially intersecting sub meshes.
  120217. */
  120218. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120219. /**
  120220. * Lambda returning the list of potentially colliding sub meshes.
  120221. */
  120222. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120223. private _activeMeshesFrozen;
  120224. private _skipEvaluateActiveMeshesCompletely;
  120225. /**
  120226. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120227. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120228. * @returns the current scene
  120229. */
  120230. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120231. /**
  120232. * Use this function to restart evaluating active meshes on every frame
  120233. * @returns the current scene
  120234. */
  120235. unfreezeActiveMeshes(): Scene;
  120236. private _evaluateActiveMeshes;
  120237. private _activeMesh;
  120238. /**
  120239. * Update the transform matrix to update from the current active camera
  120240. * @param force defines a boolean used to force the update even if cache is up to date
  120241. */
  120242. updateTransformMatrix(force?: boolean): void;
  120243. private _bindFrameBuffer;
  120244. /** @hidden */
  120245. _allowPostProcessClearColor: boolean;
  120246. /** @hidden */
  120247. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120248. private _processSubCameras;
  120249. private _checkIntersections;
  120250. /** @hidden */
  120251. _advancePhysicsEngineStep(step: number): void;
  120252. /**
  120253. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120254. */
  120255. getDeterministicFrameTime: () => number;
  120256. /** @hidden */
  120257. _animate(): void;
  120258. /** Execute all animations (for a frame) */
  120259. animate(): void;
  120260. /**
  120261. * Render the scene
  120262. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120263. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120264. */
  120265. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120266. /**
  120267. * Freeze all materials
  120268. * A frozen material will not be updatable but should be faster to render
  120269. */
  120270. freezeMaterials(): void;
  120271. /**
  120272. * Unfreeze all materials
  120273. * A frozen material will not be updatable but should be faster to render
  120274. */
  120275. unfreezeMaterials(): void;
  120276. /**
  120277. * Releases all held ressources
  120278. */
  120279. dispose(): void;
  120280. /**
  120281. * Gets if the scene is already disposed
  120282. */
  120283. get isDisposed(): boolean;
  120284. /**
  120285. * Call this function to reduce memory footprint of the scene.
  120286. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120287. */
  120288. clearCachedVertexData(): void;
  120289. /**
  120290. * This function will remove the local cached buffer data from texture.
  120291. * It will save memory but will prevent the texture from being rebuilt
  120292. */
  120293. cleanCachedTextureBuffer(): void;
  120294. /**
  120295. * Get the world extend vectors with an optional filter
  120296. *
  120297. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120298. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120299. */
  120300. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120301. min: Vector3;
  120302. max: Vector3;
  120303. };
  120304. /**
  120305. * Creates a ray that can be used to pick in the scene
  120306. * @param x defines the x coordinate of the origin (on-screen)
  120307. * @param y defines the y coordinate of the origin (on-screen)
  120308. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120309. * @param camera defines the camera to use for the picking
  120310. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120311. * @returns a Ray
  120312. */
  120313. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120314. /**
  120315. * Creates a ray that can be used to pick in the scene
  120316. * @param x defines the x coordinate of the origin (on-screen)
  120317. * @param y defines the y coordinate of the origin (on-screen)
  120318. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120319. * @param result defines the ray where to store the picking ray
  120320. * @param camera defines the camera to use for the picking
  120321. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120322. * @returns the current scene
  120323. */
  120324. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120325. /**
  120326. * Creates a ray that can be used to pick in the scene
  120327. * @param x defines the x coordinate of the origin (on-screen)
  120328. * @param y defines the y coordinate of the origin (on-screen)
  120329. * @param camera defines the camera to use for the picking
  120330. * @returns a Ray
  120331. */
  120332. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120333. /**
  120334. * Creates a ray that can be used to pick in the scene
  120335. * @param x defines the x coordinate of the origin (on-screen)
  120336. * @param y defines the y coordinate of the origin (on-screen)
  120337. * @param result defines the ray where to store the picking ray
  120338. * @param camera defines the camera to use for the picking
  120339. * @returns the current scene
  120340. */
  120341. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120342. /** Launch a ray to try to pick a mesh in the scene
  120343. * @param x position on screen
  120344. * @param y position on screen
  120345. * @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
  120346. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120347. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120348. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120349. * @returns a PickingInfo
  120350. */
  120351. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120352. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120353. * @param x position on screen
  120354. * @param y position on screen
  120355. * @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
  120356. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120357. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120358. * @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)
  120359. */
  120360. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120361. /** Use the given ray to pick a mesh in the scene
  120362. * @param ray The ray to use to pick meshes
  120363. * @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
  120364. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120365. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120366. * @returns a PickingInfo
  120367. */
  120368. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120369. /**
  120370. * Launch a ray to try to pick a mesh in the scene
  120371. * @param x X position on screen
  120372. * @param y Y position on screen
  120373. * @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
  120374. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120375. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120376. * @returns an array of PickingInfo
  120377. */
  120378. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120379. /**
  120380. * Launch a ray to try to pick a mesh in the scene
  120381. * @param ray Ray to use
  120382. * @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
  120383. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120384. * @returns an array of PickingInfo
  120385. */
  120386. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120387. /**
  120388. * Force the value of meshUnderPointer
  120389. * @param mesh defines the mesh to use
  120390. */
  120391. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  120392. /**
  120393. * Gets the mesh under the pointer
  120394. * @returns a Mesh or null if no mesh is under the pointer
  120395. */
  120396. getPointerOverMesh(): Nullable<AbstractMesh>;
  120397. /** @hidden */
  120398. _rebuildGeometries(): void;
  120399. /** @hidden */
  120400. _rebuildTextures(): void;
  120401. private _getByTags;
  120402. /**
  120403. * Get a list of meshes by tags
  120404. * @param tagsQuery defines the tags query to use
  120405. * @param forEach defines a predicate used to filter results
  120406. * @returns an array of Mesh
  120407. */
  120408. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120409. /**
  120410. * Get a list of cameras by tags
  120411. * @param tagsQuery defines the tags query to use
  120412. * @param forEach defines a predicate used to filter results
  120413. * @returns an array of Camera
  120414. */
  120415. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120416. /**
  120417. * Get a list of lights by tags
  120418. * @param tagsQuery defines the tags query to use
  120419. * @param forEach defines a predicate used to filter results
  120420. * @returns an array of Light
  120421. */
  120422. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120423. /**
  120424. * Get a list of materials by tags
  120425. * @param tagsQuery defines the tags query to use
  120426. * @param forEach defines a predicate used to filter results
  120427. * @returns an array of Material
  120428. */
  120429. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120430. /**
  120431. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120432. * This allowed control for front to back rendering or reversly depending of the special needs.
  120433. *
  120434. * @param renderingGroupId The rendering group id corresponding to its index
  120435. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120436. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120437. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120438. */
  120439. 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;
  120440. /**
  120441. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120442. *
  120443. * @param renderingGroupId The rendering group id corresponding to its index
  120444. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120445. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120446. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120447. */
  120448. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120449. /**
  120450. * Gets the current auto clear configuration for one rendering group of the rendering
  120451. * manager.
  120452. * @param index the rendering group index to get the information for
  120453. * @returns The auto clear setup for the requested rendering group
  120454. */
  120455. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120456. private _blockMaterialDirtyMechanism;
  120457. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120458. get blockMaterialDirtyMechanism(): boolean;
  120459. set blockMaterialDirtyMechanism(value: boolean);
  120460. /**
  120461. * Will flag all materials as dirty to trigger new shader compilation
  120462. * @param flag defines the flag used to specify which material part must be marked as dirty
  120463. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120464. */
  120465. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120466. /** @hidden */
  120467. _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;
  120468. /** @hidden */
  120469. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120470. /** @hidden */
  120471. _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;
  120472. /** @hidden */
  120473. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120474. /** @hidden */
  120475. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120476. /** @hidden */
  120477. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120478. }
  120479. }
  120480. declare module BABYLON {
  120481. /**
  120482. * Set of assets to keep when moving a scene into an asset container.
  120483. */
  120484. export class KeepAssets extends AbstractScene {
  120485. }
  120486. /**
  120487. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120488. */
  120489. export class InstantiatedEntries {
  120490. /**
  120491. * List of new root nodes (eg. nodes with no parent)
  120492. */
  120493. rootNodes: TransformNode[];
  120494. /**
  120495. * List of new skeletons
  120496. */
  120497. skeletons: Skeleton[];
  120498. /**
  120499. * List of new animation groups
  120500. */
  120501. animationGroups: AnimationGroup[];
  120502. }
  120503. /**
  120504. * Container with a set of assets that can be added or removed from a scene.
  120505. */
  120506. export class AssetContainer extends AbstractScene {
  120507. private _wasAddedToScene;
  120508. /**
  120509. * The scene the AssetContainer belongs to.
  120510. */
  120511. scene: Scene;
  120512. /**
  120513. * Instantiates an AssetContainer.
  120514. * @param scene The scene the AssetContainer belongs to.
  120515. */
  120516. constructor(scene: Scene);
  120517. /**
  120518. * Instantiate or clone all meshes and add the new ones to the scene.
  120519. * Skeletons and animation groups will all be cloned
  120520. * @param nameFunction defines an optional function used to get new names for clones
  120521. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120522. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120523. */
  120524. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  120525. /**
  120526. * Adds all the assets from the container to the scene.
  120527. */
  120528. addAllToScene(): void;
  120529. /**
  120530. * Removes all the assets in the container from the scene
  120531. */
  120532. removeAllFromScene(): void;
  120533. /**
  120534. * Disposes all the assets in the container
  120535. */
  120536. dispose(): void;
  120537. private _moveAssets;
  120538. /**
  120539. * Removes all the assets contained in the scene and adds them to the container.
  120540. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  120541. */
  120542. moveAllFromScene(keepAssets?: KeepAssets): void;
  120543. /**
  120544. * 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.
  120545. * @returns the root mesh
  120546. */
  120547. createRootMesh(): Mesh;
  120548. /**
  120549. * Merge animations (direct and animation groups) from this asset container into a scene
  120550. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  120551. * @param animatables set of animatables to retarget to a node from the scene
  120552. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  120553. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  120554. */
  120555. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  120556. }
  120557. }
  120558. declare module BABYLON {
  120559. /**
  120560. * Defines how the parser contract is defined.
  120561. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  120562. */
  120563. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  120564. /**
  120565. * Defines how the individual parser contract is defined.
  120566. * These parser can parse an individual asset
  120567. */
  120568. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  120569. /**
  120570. * Base class of the scene acting as a container for the different elements composing a scene.
  120571. * This class is dynamically extended by the different components of the scene increasing
  120572. * flexibility and reducing coupling
  120573. */
  120574. export abstract class AbstractScene {
  120575. /**
  120576. * Stores the list of available parsers in the application.
  120577. */
  120578. private static _BabylonFileParsers;
  120579. /**
  120580. * Stores the list of available individual parsers in the application.
  120581. */
  120582. private static _IndividualBabylonFileParsers;
  120583. /**
  120584. * Adds a parser in the list of available ones
  120585. * @param name Defines the name of the parser
  120586. * @param parser Defines the parser to add
  120587. */
  120588. static AddParser(name: string, parser: BabylonFileParser): void;
  120589. /**
  120590. * Gets a general parser from the list of avaialble ones
  120591. * @param name Defines the name of the parser
  120592. * @returns the requested parser or null
  120593. */
  120594. static GetParser(name: string): Nullable<BabylonFileParser>;
  120595. /**
  120596. * Adds n individual parser in the list of available ones
  120597. * @param name Defines the name of the parser
  120598. * @param parser Defines the parser to add
  120599. */
  120600. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  120601. /**
  120602. * Gets an individual parser from the list of avaialble ones
  120603. * @param name Defines the name of the parser
  120604. * @returns the requested parser or null
  120605. */
  120606. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  120607. /**
  120608. * Parser json data and populate both a scene and its associated container object
  120609. * @param jsonData Defines the data to parse
  120610. * @param scene Defines the scene to parse the data for
  120611. * @param container Defines the container attached to the parsing sequence
  120612. * @param rootUrl Defines the root url of the data
  120613. */
  120614. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  120615. /**
  120616. * Gets the list of root nodes (ie. nodes with no parent)
  120617. */
  120618. rootNodes: Node[];
  120619. /** All of the cameras added to this scene
  120620. * @see https://doc.babylonjs.com/babylon101/cameras
  120621. */
  120622. cameras: Camera[];
  120623. /**
  120624. * All of the lights added to this scene
  120625. * @see https://doc.babylonjs.com/babylon101/lights
  120626. */
  120627. lights: Light[];
  120628. /**
  120629. * All of the (abstract) meshes added to this scene
  120630. */
  120631. meshes: AbstractMesh[];
  120632. /**
  120633. * The list of skeletons added to the scene
  120634. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  120635. */
  120636. skeletons: Skeleton[];
  120637. /**
  120638. * All of the particle systems added to this scene
  120639. * @see https://doc.babylonjs.com/babylon101/particles
  120640. */
  120641. particleSystems: IParticleSystem[];
  120642. /**
  120643. * Gets a list of Animations associated with the scene
  120644. */
  120645. animations: Animation[];
  120646. /**
  120647. * All of the animation groups added to this scene
  120648. * @see https://doc.babylonjs.com/how_to/group
  120649. */
  120650. animationGroups: AnimationGroup[];
  120651. /**
  120652. * All of the multi-materials added to this scene
  120653. * @see https://doc.babylonjs.com/how_to/multi_materials
  120654. */
  120655. multiMaterials: MultiMaterial[];
  120656. /**
  120657. * All of the materials added to this scene
  120658. * In the context of a Scene, it is not supposed to be modified manually.
  120659. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  120660. * Note also that the order of the Material within the array is not significant and might change.
  120661. * @see https://doc.babylonjs.com/babylon101/materials
  120662. */
  120663. materials: Material[];
  120664. /**
  120665. * The list of morph target managers added to the scene
  120666. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  120667. */
  120668. morphTargetManagers: MorphTargetManager[];
  120669. /**
  120670. * The list of geometries used in the scene.
  120671. */
  120672. geometries: Geometry[];
  120673. /**
  120674. * All of the tranform nodes added to this scene
  120675. * In the context of a Scene, it is not supposed to be modified manually.
  120676. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  120677. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  120678. * @see https://doc.babylonjs.com/how_to/transformnode
  120679. */
  120680. transformNodes: TransformNode[];
  120681. /**
  120682. * ActionManagers available on the scene.
  120683. */
  120684. actionManagers: AbstractActionManager[];
  120685. /**
  120686. * Textures to keep.
  120687. */
  120688. textures: BaseTexture[];
  120689. /**
  120690. * Environment texture for the scene
  120691. */
  120692. environmentTexture: Nullable<BaseTexture>;
  120693. /**
  120694. * The list of postprocesses added to the scene
  120695. */
  120696. postProcesses: PostProcess[];
  120697. /**
  120698. * @returns all meshes, lights, cameras, transformNodes and bones
  120699. */
  120700. getNodes(): Array<Node>;
  120701. }
  120702. }
  120703. declare module BABYLON {
  120704. /**
  120705. * Interface used to define options for Sound class
  120706. */
  120707. export interface ISoundOptions {
  120708. /**
  120709. * Does the sound autoplay once loaded.
  120710. */
  120711. autoplay?: boolean;
  120712. /**
  120713. * Does the sound loop after it finishes playing once.
  120714. */
  120715. loop?: boolean;
  120716. /**
  120717. * Sound's volume
  120718. */
  120719. volume?: number;
  120720. /**
  120721. * Is it a spatial sound?
  120722. */
  120723. spatialSound?: boolean;
  120724. /**
  120725. * Maximum distance to hear that sound
  120726. */
  120727. maxDistance?: number;
  120728. /**
  120729. * Uses user defined attenuation function
  120730. */
  120731. useCustomAttenuation?: boolean;
  120732. /**
  120733. * Define the roll off factor of spatial sounds.
  120734. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120735. */
  120736. rolloffFactor?: number;
  120737. /**
  120738. * Define the reference distance the sound should be heard perfectly.
  120739. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120740. */
  120741. refDistance?: number;
  120742. /**
  120743. * Define the distance attenuation model the sound will follow.
  120744. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120745. */
  120746. distanceModel?: string;
  120747. /**
  120748. * Defines the playback speed (1 by default)
  120749. */
  120750. playbackRate?: number;
  120751. /**
  120752. * Defines if the sound is from a streaming source
  120753. */
  120754. streaming?: boolean;
  120755. /**
  120756. * Defines an optional length (in seconds) inside the sound file
  120757. */
  120758. length?: number;
  120759. /**
  120760. * Defines an optional offset (in seconds) inside the sound file
  120761. */
  120762. offset?: number;
  120763. /**
  120764. * If true, URLs will not be required to state the audio file codec to use.
  120765. */
  120766. skipCodecCheck?: boolean;
  120767. }
  120768. /**
  120769. * Defines a sound that can be played in the application.
  120770. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  120771. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120772. */
  120773. export class Sound {
  120774. /**
  120775. * The name of the sound in the scene.
  120776. */
  120777. name: string;
  120778. /**
  120779. * Does the sound autoplay once loaded.
  120780. */
  120781. autoplay: boolean;
  120782. /**
  120783. * Does the sound loop after it finishes playing once.
  120784. */
  120785. loop: boolean;
  120786. /**
  120787. * Does the sound use a custom attenuation curve to simulate the falloff
  120788. * happening when the source gets further away from the camera.
  120789. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  120790. */
  120791. useCustomAttenuation: boolean;
  120792. /**
  120793. * The sound track id this sound belongs to.
  120794. */
  120795. soundTrackId: number;
  120796. /**
  120797. * Is this sound currently played.
  120798. */
  120799. isPlaying: boolean;
  120800. /**
  120801. * Is this sound currently paused.
  120802. */
  120803. isPaused: boolean;
  120804. /**
  120805. * Does this sound enables spatial sound.
  120806. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120807. */
  120808. spatialSound: boolean;
  120809. /**
  120810. * Define the reference distance the sound should be heard perfectly.
  120811. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120812. */
  120813. refDistance: number;
  120814. /**
  120815. * Define the roll off factor of spatial sounds.
  120816. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120817. */
  120818. rolloffFactor: number;
  120819. /**
  120820. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  120821. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120822. */
  120823. maxDistance: number;
  120824. /**
  120825. * Define the distance attenuation model the sound will follow.
  120826. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120827. */
  120828. distanceModel: string;
  120829. /**
  120830. * @hidden
  120831. * Back Compat
  120832. **/
  120833. onended: () => any;
  120834. /**
  120835. * Gets or sets an object used to store user defined information for the sound.
  120836. */
  120837. metadata: any;
  120838. /**
  120839. * Observable event when the current playing sound finishes.
  120840. */
  120841. onEndedObservable: Observable<Sound>;
  120842. private _panningModel;
  120843. private _playbackRate;
  120844. private _streaming;
  120845. private _startTime;
  120846. private _startOffset;
  120847. private _position;
  120848. /** @hidden */
  120849. _positionInEmitterSpace: boolean;
  120850. private _localDirection;
  120851. private _volume;
  120852. private _isReadyToPlay;
  120853. private _isDirectional;
  120854. private _readyToPlayCallback;
  120855. private _audioBuffer;
  120856. private _soundSource;
  120857. private _streamingSource;
  120858. private _soundPanner;
  120859. private _soundGain;
  120860. private _inputAudioNode;
  120861. private _outputAudioNode;
  120862. private _coneInnerAngle;
  120863. private _coneOuterAngle;
  120864. private _coneOuterGain;
  120865. private _scene;
  120866. private _connectedTransformNode;
  120867. private _customAttenuationFunction;
  120868. private _registerFunc;
  120869. private _isOutputConnected;
  120870. private _htmlAudioElement;
  120871. private _urlType;
  120872. private _length?;
  120873. private _offset?;
  120874. /** @hidden */
  120875. static _SceneComponentInitialization: (scene: Scene) => void;
  120876. /**
  120877. * Create a sound and attach it to a scene
  120878. * @param name Name of your sound
  120879. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  120880. * @param scene defines the scene the sound belongs to
  120881. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  120882. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  120883. */
  120884. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  120885. /**
  120886. * Release the sound and its associated resources
  120887. */
  120888. dispose(): void;
  120889. /**
  120890. * Gets if the sounds is ready to be played or not.
  120891. * @returns true if ready, otherwise false
  120892. */
  120893. isReady(): boolean;
  120894. private _soundLoaded;
  120895. /**
  120896. * Sets the data of the sound from an audiobuffer
  120897. * @param audioBuffer The audioBuffer containing the data
  120898. */
  120899. setAudioBuffer(audioBuffer: AudioBuffer): void;
  120900. /**
  120901. * Updates the current sounds options such as maxdistance, loop...
  120902. * @param options A JSON object containing values named as the object properties
  120903. */
  120904. updateOptions(options: ISoundOptions): void;
  120905. private _createSpatialParameters;
  120906. private _updateSpatialParameters;
  120907. /**
  120908. * Switch the panning model to HRTF:
  120909. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  120910. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120911. */
  120912. switchPanningModelToHRTF(): void;
  120913. /**
  120914. * Switch the panning model to Equal Power:
  120915. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  120916. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120917. */
  120918. switchPanningModelToEqualPower(): void;
  120919. private _switchPanningModel;
  120920. /**
  120921. * Connect this sound to a sound track audio node like gain...
  120922. * @param soundTrackAudioNode the sound track audio node to connect to
  120923. */
  120924. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  120925. /**
  120926. * Transform this sound into a directional source
  120927. * @param coneInnerAngle Size of the inner cone in degree
  120928. * @param coneOuterAngle Size of the outer cone in degree
  120929. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  120930. */
  120931. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  120932. /**
  120933. * Gets or sets the inner angle for the directional cone.
  120934. */
  120935. get directionalConeInnerAngle(): number;
  120936. /**
  120937. * Gets or sets the inner angle for the directional cone.
  120938. */
  120939. set directionalConeInnerAngle(value: number);
  120940. /**
  120941. * Gets or sets the outer angle for the directional cone.
  120942. */
  120943. get directionalConeOuterAngle(): number;
  120944. /**
  120945. * Gets or sets the outer angle for the directional cone.
  120946. */
  120947. set directionalConeOuterAngle(value: number);
  120948. /**
  120949. * Sets the position of the emitter if spatial sound is enabled
  120950. * @param newPosition Defines the new posisiton
  120951. */
  120952. setPosition(newPosition: Vector3): void;
  120953. /**
  120954. * Sets the local direction of the emitter if spatial sound is enabled
  120955. * @param newLocalDirection Defines the new local direction
  120956. */
  120957. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  120958. private _updateDirection;
  120959. /** @hidden */
  120960. updateDistanceFromListener(): void;
  120961. /**
  120962. * Sets a new custom attenuation function for the sound.
  120963. * @param callback Defines the function used for the attenuation
  120964. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  120965. */
  120966. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  120967. /**
  120968. * Play the sound
  120969. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  120970. * @param offset (optional) Start the sound at a specific time in seconds
  120971. * @param length (optional) Sound duration (in seconds)
  120972. */
  120973. play(time?: number, offset?: number, length?: number): void;
  120974. private _onended;
  120975. /**
  120976. * Stop the sound
  120977. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  120978. */
  120979. stop(time?: number): void;
  120980. /**
  120981. * Put the sound in pause
  120982. */
  120983. pause(): void;
  120984. /**
  120985. * Sets a dedicated volume for this sounds
  120986. * @param newVolume Define the new volume of the sound
  120987. * @param time Define time for gradual change to new volume
  120988. */
  120989. setVolume(newVolume: number, time?: number): void;
  120990. /**
  120991. * Set the sound play back rate
  120992. * @param newPlaybackRate Define the playback rate the sound should be played at
  120993. */
  120994. setPlaybackRate(newPlaybackRate: number): void;
  120995. /**
  120996. * Gets the volume of the sound.
  120997. * @returns the volume of the sound
  120998. */
  120999. getVolume(): number;
  121000. /**
  121001. * Attach the sound to a dedicated mesh
  121002. * @param transformNode The transform node to connect the sound with
  121003. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121004. */
  121005. attachToMesh(transformNode: TransformNode): void;
  121006. /**
  121007. * Detach the sound from the previously attached mesh
  121008. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121009. */
  121010. detachFromMesh(): void;
  121011. private _onRegisterAfterWorldMatrixUpdate;
  121012. /**
  121013. * Clone the current sound in the scene.
  121014. * @returns the new sound clone
  121015. */
  121016. clone(): Nullable<Sound>;
  121017. /**
  121018. * Gets the current underlying audio buffer containing the data
  121019. * @returns the audio buffer
  121020. */
  121021. getAudioBuffer(): Nullable<AudioBuffer>;
  121022. /**
  121023. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121024. * @returns the source node
  121025. */
  121026. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121027. /**
  121028. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121029. * @returns the gain node
  121030. */
  121031. getSoundGain(): Nullable<GainNode>;
  121032. /**
  121033. * Serializes the Sound in a JSON representation
  121034. * @returns the JSON representation of the sound
  121035. */
  121036. serialize(): any;
  121037. /**
  121038. * Parse a JSON representation of a sound to innstantiate in a given scene
  121039. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121040. * @param scene Define the scene the new parsed sound should be created in
  121041. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121042. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121043. * @returns the newly parsed sound
  121044. */
  121045. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121046. }
  121047. }
  121048. declare module BABYLON {
  121049. /**
  121050. * This defines an action helpful to play a defined sound on a triggered action.
  121051. */
  121052. export class PlaySoundAction extends Action {
  121053. private _sound;
  121054. /**
  121055. * Instantiate the action
  121056. * @param triggerOptions defines the trigger options
  121057. * @param sound defines the sound to play
  121058. * @param condition defines the trigger related conditions
  121059. */
  121060. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121061. /** @hidden */
  121062. _prepare(): void;
  121063. /**
  121064. * Execute the action and play the sound.
  121065. */
  121066. execute(): void;
  121067. /**
  121068. * Serializes the actions and its related information.
  121069. * @param parent defines the object to serialize in
  121070. * @returns the serialized object
  121071. */
  121072. serialize(parent: any): any;
  121073. }
  121074. /**
  121075. * This defines an action helpful to stop a defined sound on a triggered action.
  121076. */
  121077. export class StopSoundAction extends Action {
  121078. private _sound;
  121079. /**
  121080. * Instantiate the action
  121081. * @param triggerOptions defines the trigger options
  121082. * @param sound defines the sound to stop
  121083. * @param condition defines the trigger related conditions
  121084. */
  121085. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121086. /** @hidden */
  121087. _prepare(): void;
  121088. /**
  121089. * Execute the action and stop the sound.
  121090. */
  121091. execute(): void;
  121092. /**
  121093. * Serializes the actions and its related information.
  121094. * @param parent defines the object to serialize in
  121095. * @returns the serialized object
  121096. */
  121097. serialize(parent: any): any;
  121098. }
  121099. }
  121100. declare module BABYLON {
  121101. /**
  121102. * This defines an action responsible to change the value of a property
  121103. * by interpolating between its current value and the newly set one once triggered.
  121104. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121105. */
  121106. export class InterpolateValueAction extends Action {
  121107. /**
  121108. * Defines the path of the property where the value should be interpolated
  121109. */
  121110. propertyPath: string;
  121111. /**
  121112. * Defines the target value at the end of the interpolation.
  121113. */
  121114. value: any;
  121115. /**
  121116. * Defines the time it will take for the property to interpolate to the value.
  121117. */
  121118. duration: number;
  121119. /**
  121120. * Defines if the other scene animations should be stopped when the action has been triggered
  121121. */
  121122. stopOtherAnimations?: boolean;
  121123. /**
  121124. * Defines a callback raised once the interpolation animation has been done.
  121125. */
  121126. onInterpolationDone?: () => void;
  121127. /**
  121128. * Observable triggered once the interpolation animation has been done.
  121129. */
  121130. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121131. private _target;
  121132. private _effectiveTarget;
  121133. private _property;
  121134. /**
  121135. * Instantiate the action
  121136. * @param triggerOptions defines the trigger options
  121137. * @param target defines the object containing the value to interpolate
  121138. * @param propertyPath defines the path to the property in the target object
  121139. * @param value defines the target value at the end of the interpolation
  121140. * @param duration deines the time it will take for the property to interpolate to the value.
  121141. * @param condition defines the trigger related conditions
  121142. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121143. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121144. */
  121145. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121146. /** @hidden */
  121147. _prepare(): void;
  121148. /**
  121149. * Execute the action starts the value interpolation.
  121150. */
  121151. execute(): void;
  121152. /**
  121153. * Serializes the actions and its related information.
  121154. * @param parent defines the object to serialize in
  121155. * @returns the serialized object
  121156. */
  121157. serialize(parent: any): any;
  121158. }
  121159. }
  121160. declare module BABYLON {
  121161. /**
  121162. * Options allowed during the creation of a sound track.
  121163. */
  121164. export interface ISoundTrackOptions {
  121165. /**
  121166. * The volume the sound track should take during creation
  121167. */
  121168. volume?: number;
  121169. /**
  121170. * Define if the sound track is the main sound track of the scene
  121171. */
  121172. mainTrack?: boolean;
  121173. }
  121174. /**
  121175. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121176. * It will be also used in a future release to apply effects on a specific track.
  121177. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121178. */
  121179. export class SoundTrack {
  121180. /**
  121181. * The unique identifier of the sound track in the scene.
  121182. */
  121183. id: number;
  121184. /**
  121185. * The list of sounds included in the sound track.
  121186. */
  121187. soundCollection: Array<Sound>;
  121188. private _outputAudioNode;
  121189. private _scene;
  121190. private _connectedAnalyser;
  121191. private _options;
  121192. private _isInitialized;
  121193. /**
  121194. * Creates a new sound track.
  121195. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121196. * @param scene Define the scene the sound track belongs to
  121197. * @param options
  121198. */
  121199. constructor(scene: Scene, options?: ISoundTrackOptions);
  121200. private _initializeSoundTrackAudioGraph;
  121201. /**
  121202. * Release the sound track and its associated resources
  121203. */
  121204. dispose(): void;
  121205. /**
  121206. * Adds a sound to this sound track
  121207. * @param sound define the cound to add
  121208. * @ignoreNaming
  121209. */
  121210. AddSound(sound: Sound): void;
  121211. /**
  121212. * Removes a sound to this sound track
  121213. * @param sound define the cound to remove
  121214. * @ignoreNaming
  121215. */
  121216. RemoveSound(sound: Sound): void;
  121217. /**
  121218. * Set a global volume for the full sound track.
  121219. * @param newVolume Define the new volume of the sound track
  121220. */
  121221. setVolume(newVolume: number): void;
  121222. /**
  121223. * Switch the panning model to HRTF:
  121224. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121225. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121226. */
  121227. switchPanningModelToHRTF(): void;
  121228. /**
  121229. * Switch the panning model to Equal Power:
  121230. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121231. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121232. */
  121233. switchPanningModelToEqualPower(): void;
  121234. /**
  121235. * Connect the sound track to an audio analyser allowing some amazing
  121236. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121237. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121238. * @param analyser The analyser to connect to the engine
  121239. */
  121240. connectToAnalyser(analyser: Analyser): void;
  121241. }
  121242. }
  121243. declare module BABYLON {
  121244. interface AbstractScene {
  121245. /**
  121246. * The list of sounds used in the scene.
  121247. */
  121248. sounds: Nullable<Array<Sound>>;
  121249. }
  121250. interface Scene {
  121251. /**
  121252. * @hidden
  121253. * Backing field
  121254. */
  121255. _mainSoundTrack: SoundTrack;
  121256. /**
  121257. * The main sound track played by the scene.
  121258. * It cotains your primary collection of sounds.
  121259. */
  121260. mainSoundTrack: SoundTrack;
  121261. /**
  121262. * The list of sound tracks added to the scene
  121263. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121264. */
  121265. soundTracks: Nullable<Array<SoundTrack>>;
  121266. /**
  121267. * Gets a sound using a given name
  121268. * @param name defines the name to search for
  121269. * @return the found sound or null if not found at all.
  121270. */
  121271. getSoundByName(name: string): Nullable<Sound>;
  121272. /**
  121273. * Gets or sets if audio support is enabled
  121274. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121275. */
  121276. audioEnabled: boolean;
  121277. /**
  121278. * Gets or sets if audio will be output to headphones
  121279. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121280. */
  121281. headphone: boolean;
  121282. /**
  121283. * Gets or sets custom audio listener position provider
  121284. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121285. */
  121286. audioListenerPositionProvider: Nullable<() => Vector3>;
  121287. /**
  121288. * Gets or sets a refresh rate when using 3D audio positioning
  121289. */
  121290. audioPositioningRefreshRate: number;
  121291. }
  121292. /**
  121293. * Defines the sound scene component responsible to manage any sounds
  121294. * in a given scene.
  121295. */
  121296. export class AudioSceneComponent implements ISceneSerializableComponent {
  121297. /**
  121298. * The component name helpfull to identify the component in the list of scene components.
  121299. */
  121300. readonly name: string;
  121301. /**
  121302. * The scene the component belongs to.
  121303. */
  121304. scene: Scene;
  121305. private _audioEnabled;
  121306. /**
  121307. * Gets whether audio is enabled or not.
  121308. * Please use related enable/disable method to switch state.
  121309. */
  121310. get audioEnabled(): boolean;
  121311. private _headphone;
  121312. /**
  121313. * Gets whether audio is outputing to headphone or not.
  121314. * Please use the according Switch methods to change output.
  121315. */
  121316. get headphone(): boolean;
  121317. /**
  121318. * Gets or sets a refresh rate when using 3D audio positioning
  121319. */
  121320. audioPositioningRefreshRate: number;
  121321. private _audioListenerPositionProvider;
  121322. /**
  121323. * Gets the current audio listener position provider
  121324. */
  121325. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121326. /**
  121327. * Sets a custom listener position for all sounds in the scene
  121328. * By default, this is the position of the first active camera
  121329. */
  121330. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121331. /**
  121332. * Creates a new instance of the component for the given scene
  121333. * @param scene Defines the scene to register the component in
  121334. */
  121335. constructor(scene: Scene);
  121336. /**
  121337. * Registers the component in a given scene
  121338. */
  121339. register(): void;
  121340. /**
  121341. * Rebuilds the elements related to this component in case of
  121342. * context lost for instance.
  121343. */
  121344. rebuild(): void;
  121345. /**
  121346. * Serializes the component data to the specified json object
  121347. * @param serializationObject The object to serialize to
  121348. */
  121349. serialize(serializationObject: any): void;
  121350. /**
  121351. * Adds all the elements from the container to the scene
  121352. * @param container the container holding the elements
  121353. */
  121354. addFromContainer(container: AbstractScene): void;
  121355. /**
  121356. * Removes all the elements in the container from the scene
  121357. * @param container contains the elements to remove
  121358. * @param dispose if the removed element should be disposed (default: false)
  121359. */
  121360. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121361. /**
  121362. * Disposes the component and the associated ressources.
  121363. */
  121364. dispose(): void;
  121365. /**
  121366. * Disables audio in the associated scene.
  121367. */
  121368. disableAudio(): void;
  121369. /**
  121370. * Enables audio in the associated scene.
  121371. */
  121372. enableAudio(): void;
  121373. /**
  121374. * Switch audio to headphone output.
  121375. */
  121376. switchAudioModeForHeadphones(): void;
  121377. /**
  121378. * Switch audio to normal speakers.
  121379. */
  121380. switchAudioModeForNormalSpeakers(): void;
  121381. private _cachedCameraDirection;
  121382. private _cachedCameraPosition;
  121383. private _lastCheck;
  121384. private _afterRender;
  121385. }
  121386. }
  121387. declare module BABYLON {
  121388. /**
  121389. * Wraps one or more Sound objects and selects one with random weight for playback.
  121390. */
  121391. export class WeightedSound {
  121392. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121393. loop: boolean;
  121394. private _coneInnerAngle;
  121395. private _coneOuterAngle;
  121396. private _volume;
  121397. /** A Sound is currently playing. */
  121398. isPlaying: boolean;
  121399. /** A Sound is currently paused. */
  121400. isPaused: boolean;
  121401. private _sounds;
  121402. private _weights;
  121403. private _currentIndex?;
  121404. /**
  121405. * Creates a new WeightedSound from the list of sounds given.
  121406. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121407. * @param sounds Array of Sounds that will be selected from.
  121408. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121409. */
  121410. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121411. /**
  121412. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121413. */
  121414. get directionalConeInnerAngle(): number;
  121415. /**
  121416. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121417. */
  121418. set directionalConeInnerAngle(value: number);
  121419. /**
  121420. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121421. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121422. */
  121423. get directionalConeOuterAngle(): number;
  121424. /**
  121425. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121426. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121427. */
  121428. set directionalConeOuterAngle(value: number);
  121429. /**
  121430. * Playback volume.
  121431. */
  121432. get volume(): number;
  121433. /**
  121434. * Playback volume.
  121435. */
  121436. set volume(value: number);
  121437. private _onended;
  121438. /**
  121439. * Suspend playback
  121440. */
  121441. pause(): void;
  121442. /**
  121443. * Stop playback
  121444. */
  121445. stop(): void;
  121446. /**
  121447. * Start playback.
  121448. * @param startOffset Position the clip head at a specific time in seconds.
  121449. */
  121450. play(startOffset?: number): void;
  121451. }
  121452. }
  121453. declare module BABYLON {
  121454. /**
  121455. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121456. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121457. */
  121458. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121459. /**
  121460. * Gets the name of the behavior.
  121461. */
  121462. get name(): string;
  121463. /**
  121464. * The easing function used by animations
  121465. */
  121466. static EasingFunction: BackEase;
  121467. /**
  121468. * The easing mode used by animations
  121469. */
  121470. static EasingMode: number;
  121471. /**
  121472. * The duration of the animation, in milliseconds
  121473. */
  121474. transitionDuration: number;
  121475. /**
  121476. * Length of the distance animated by the transition when lower radius is reached
  121477. */
  121478. lowerRadiusTransitionRange: number;
  121479. /**
  121480. * Length of the distance animated by the transition when upper radius is reached
  121481. */
  121482. upperRadiusTransitionRange: number;
  121483. private _autoTransitionRange;
  121484. /**
  121485. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121486. */
  121487. get autoTransitionRange(): boolean;
  121488. /**
  121489. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121490. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121491. */
  121492. set autoTransitionRange(value: boolean);
  121493. private _attachedCamera;
  121494. private _onAfterCheckInputsObserver;
  121495. private _onMeshTargetChangedObserver;
  121496. /**
  121497. * Initializes the behavior.
  121498. */
  121499. init(): void;
  121500. /**
  121501. * Attaches the behavior to its arc rotate camera.
  121502. * @param camera Defines the camera to attach the behavior to
  121503. */
  121504. attach(camera: ArcRotateCamera): void;
  121505. /**
  121506. * Detaches the behavior from its current arc rotate camera.
  121507. */
  121508. detach(): void;
  121509. private _radiusIsAnimating;
  121510. private _radiusBounceTransition;
  121511. private _animatables;
  121512. private _cachedWheelPrecision;
  121513. /**
  121514. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121515. * @param radiusLimit The limit to check against.
  121516. * @return Bool to indicate if at limit.
  121517. */
  121518. private _isRadiusAtLimit;
  121519. /**
  121520. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  121521. * @param radiusDelta The delta by which to animate to. Can be negative.
  121522. */
  121523. private _applyBoundRadiusAnimation;
  121524. /**
  121525. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  121526. */
  121527. protected _clearAnimationLocks(): void;
  121528. /**
  121529. * Stops and removes all animations that have been applied to the camera
  121530. */
  121531. stopAllAnimations(): void;
  121532. }
  121533. }
  121534. declare module BABYLON {
  121535. /**
  121536. * 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.
  121537. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121538. */
  121539. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  121540. /**
  121541. * Gets the name of the behavior.
  121542. */
  121543. get name(): string;
  121544. private _mode;
  121545. private _radiusScale;
  121546. private _positionScale;
  121547. private _defaultElevation;
  121548. private _elevationReturnTime;
  121549. private _elevationReturnWaitTime;
  121550. private _zoomStopsAnimation;
  121551. private _framingTime;
  121552. /**
  121553. * The easing function used by animations
  121554. */
  121555. static EasingFunction: ExponentialEase;
  121556. /**
  121557. * The easing mode used by animations
  121558. */
  121559. static EasingMode: number;
  121560. /**
  121561. * Sets the current mode used by the behavior
  121562. */
  121563. set mode(mode: number);
  121564. /**
  121565. * Gets current mode used by the behavior.
  121566. */
  121567. get mode(): number;
  121568. /**
  121569. * Sets the scale applied to the radius (1 by default)
  121570. */
  121571. set radiusScale(radius: number);
  121572. /**
  121573. * Gets the scale applied to the radius
  121574. */
  121575. get radiusScale(): number;
  121576. /**
  121577. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121578. */
  121579. set positionScale(scale: number);
  121580. /**
  121581. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121582. */
  121583. get positionScale(): number;
  121584. /**
  121585. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121586. * behaviour is triggered, in radians.
  121587. */
  121588. set defaultElevation(elevation: number);
  121589. /**
  121590. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121591. * behaviour is triggered, in radians.
  121592. */
  121593. get defaultElevation(): number;
  121594. /**
  121595. * Sets the time (in milliseconds) taken to return to the default beta position.
  121596. * Negative value indicates camera should not return to default.
  121597. */
  121598. set elevationReturnTime(speed: number);
  121599. /**
  121600. * Gets the time (in milliseconds) taken to return to the default beta position.
  121601. * Negative value indicates camera should not return to default.
  121602. */
  121603. get elevationReturnTime(): number;
  121604. /**
  121605. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121606. */
  121607. set elevationReturnWaitTime(time: number);
  121608. /**
  121609. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121610. */
  121611. get elevationReturnWaitTime(): number;
  121612. /**
  121613. * Sets the flag that indicates if user zooming should stop animation.
  121614. */
  121615. set zoomStopsAnimation(flag: boolean);
  121616. /**
  121617. * Gets the flag that indicates if user zooming should stop animation.
  121618. */
  121619. get zoomStopsAnimation(): boolean;
  121620. /**
  121621. * Sets the transition time when framing the mesh, in milliseconds
  121622. */
  121623. set framingTime(time: number);
  121624. /**
  121625. * Gets the transition time when framing the mesh, in milliseconds
  121626. */
  121627. get framingTime(): number;
  121628. /**
  121629. * Define if the behavior should automatically change the configured
  121630. * camera limits and sensibilities.
  121631. */
  121632. autoCorrectCameraLimitsAndSensibility: boolean;
  121633. private _onPrePointerObservableObserver;
  121634. private _onAfterCheckInputsObserver;
  121635. private _onMeshTargetChangedObserver;
  121636. private _attachedCamera;
  121637. private _isPointerDown;
  121638. private _lastInteractionTime;
  121639. /**
  121640. * Initializes the behavior.
  121641. */
  121642. init(): void;
  121643. /**
  121644. * Attaches the behavior to its arc rotate camera.
  121645. * @param camera Defines the camera to attach the behavior to
  121646. */
  121647. attach(camera: ArcRotateCamera): void;
  121648. /**
  121649. * Detaches the behavior from its current arc rotate camera.
  121650. */
  121651. detach(): void;
  121652. private _animatables;
  121653. private _betaIsAnimating;
  121654. private _betaTransition;
  121655. private _radiusTransition;
  121656. private _vectorTransition;
  121657. /**
  121658. * Targets the given mesh and updates zoom level accordingly.
  121659. * @param mesh The mesh to target.
  121660. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121661. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121662. */
  121663. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121664. /**
  121665. * Targets the given mesh with its children and updates zoom level accordingly.
  121666. * @param mesh The mesh to target.
  121667. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121668. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121669. */
  121670. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121671. /**
  121672. * Targets the given meshes with their children and updates zoom level accordingly.
  121673. * @param meshes The mesh to target.
  121674. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121675. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121676. */
  121677. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121678. /**
  121679. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  121680. * @param minimumWorld Determines the smaller position of the bounding box extend
  121681. * @param maximumWorld Determines the bigger position of the bounding box extend
  121682. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121683. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121684. */
  121685. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121686. /**
  121687. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  121688. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  121689. * frustum width.
  121690. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  121691. * to fully enclose the mesh in the viewing frustum.
  121692. */
  121693. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  121694. /**
  121695. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  121696. * is automatically returned to its default position (expected to be above ground plane).
  121697. */
  121698. private _maintainCameraAboveGround;
  121699. /**
  121700. * Returns the frustum slope based on the canvas ratio and camera FOV
  121701. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  121702. */
  121703. private _getFrustumSlope;
  121704. /**
  121705. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  121706. */
  121707. private _clearAnimationLocks;
  121708. /**
  121709. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  121710. */
  121711. private _applyUserInteraction;
  121712. /**
  121713. * Stops and removes all animations that have been applied to the camera
  121714. */
  121715. stopAllAnimations(): void;
  121716. /**
  121717. * Gets a value indicating if the user is moving the camera
  121718. */
  121719. get isUserIsMoving(): boolean;
  121720. /**
  121721. * The camera can move all the way towards the mesh.
  121722. */
  121723. static IgnoreBoundsSizeMode: number;
  121724. /**
  121725. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  121726. */
  121727. static FitFrustumSidesMode: number;
  121728. }
  121729. }
  121730. declare module BABYLON {
  121731. /**
  121732. * Base class for Camera Pointer Inputs.
  121733. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  121734. * for example usage.
  121735. */
  121736. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  121737. /**
  121738. * Defines the camera the input is attached to.
  121739. */
  121740. abstract camera: Camera;
  121741. /**
  121742. * Whether keyboard modifier keys are pressed at time of last mouse event.
  121743. */
  121744. protected _altKey: boolean;
  121745. protected _ctrlKey: boolean;
  121746. protected _metaKey: boolean;
  121747. protected _shiftKey: boolean;
  121748. /**
  121749. * Which mouse buttons were pressed at time of last mouse event.
  121750. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  121751. */
  121752. protected _buttonsPressed: number;
  121753. /**
  121754. * Defines the buttons associated with the input to handle camera move.
  121755. */
  121756. buttons: number[];
  121757. /**
  121758. * Attach the input controls to a specific dom element to get the input from.
  121759. * @param element Defines the element the controls should be listened from
  121760. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121761. */
  121762. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121763. /**
  121764. * Detach the current controls from the specified dom element.
  121765. * @param element Defines the element to stop listening the inputs from
  121766. */
  121767. detachControl(element: Nullable<HTMLElement>): void;
  121768. /**
  121769. * Gets the class name of the current input.
  121770. * @returns the class name
  121771. */
  121772. getClassName(): string;
  121773. /**
  121774. * Get the friendly name associated with the input class.
  121775. * @returns the input friendly name
  121776. */
  121777. getSimpleName(): string;
  121778. /**
  121779. * Called on pointer POINTERDOUBLETAP event.
  121780. * Override this method to provide functionality on POINTERDOUBLETAP event.
  121781. */
  121782. protected onDoubleTap(type: string): void;
  121783. /**
  121784. * Called on pointer POINTERMOVE event if only a single touch is active.
  121785. * Override this method to provide functionality.
  121786. */
  121787. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  121788. /**
  121789. * Called on pointer POINTERMOVE event if multiple touches are active.
  121790. * Override this method to provide functionality.
  121791. */
  121792. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  121793. /**
  121794. * Called on JS contextmenu event.
  121795. * Override this method to provide functionality.
  121796. */
  121797. protected onContextMenu(evt: PointerEvent): void;
  121798. /**
  121799. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  121800. * press.
  121801. * Override this method to provide functionality.
  121802. */
  121803. protected onButtonDown(evt: PointerEvent): void;
  121804. /**
  121805. * Called each time a new POINTERUP event occurs. Ie, for each button
  121806. * release.
  121807. * Override this method to provide functionality.
  121808. */
  121809. protected onButtonUp(evt: PointerEvent): void;
  121810. /**
  121811. * Called when window becomes inactive.
  121812. * Override this method to provide functionality.
  121813. */
  121814. protected onLostFocus(): void;
  121815. private _pointerInput;
  121816. private _observer;
  121817. private _onLostFocus;
  121818. private pointA;
  121819. private pointB;
  121820. }
  121821. }
  121822. declare module BABYLON {
  121823. /**
  121824. * Manage the pointers inputs to control an arc rotate camera.
  121825. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121826. */
  121827. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  121828. /**
  121829. * Defines the camera the input is attached to.
  121830. */
  121831. camera: ArcRotateCamera;
  121832. /**
  121833. * Gets the class name of the current input.
  121834. * @returns the class name
  121835. */
  121836. getClassName(): string;
  121837. /**
  121838. * Defines the buttons associated with the input to handle camera move.
  121839. */
  121840. buttons: number[];
  121841. /**
  121842. * Defines the pointer angular sensibility along the X axis or how fast is
  121843. * the camera rotating.
  121844. */
  121845. angularSensibilityX: number;
  121846. /**
  121847. * Defines the pointer angular sensibility along the Y axis or how fast is
  121848. * the camera rotating.
  121849. */
  121850. angularSensibilityY: number;
  121851. /**
  121852. * Defines the pointer pinch precision or how fast is the camera zooming.
  121853. */
  121854. pinchPrecision: number;
  121855. /**
  121856. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  121857. * from 0.
  121858. * It defines the percentage of current camera.radius to use as delta when
  121859. * pinch zoom is used.
  121860. */
  121861. pinchDeltaPercentage: number;
  121862. /**
  121863. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  121864. * that any object in the plane at the camera's target point will scale
  121865. * perfectly with finger motion.
  121866. * Overrides pinchDeltaPercentage and pinchPrecision.
  121867. */
  121868. useNaturalPinchZoom: boolean;
  121869. /**
  121870. * Defines the pointer panning sensibility or how fast is the camera moving.
  121871. */
  121872. panningSensibility: number;
  121873. /**
  121874. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  121875. */
  121876. multiTouchPanning: boolean;
  121877. /**
  121878. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  121879. * zoom (pinch) through multitouch.
  121880. */
  121881. multiTouchPanAndZoom: boolean;
  121882. /**
  121883. * Revers pinch action direction.
  121884. */
  121885. pinchInwards: boolean;
  121886. private _isPanClick;
  121887. private _twoFingerActivityCount;
  121888. private _isPinching;
  121889. /**
  121890. * Called on pointer POINTERMOVE event if only a single touch is active.
  121891. */
  121892. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  121893. /**
  121894. * Called on pointer POINTERDOUBLETAP event.
  121895. */
  121896. protected onDoubleTap(type: string): void;
  121897. /**
  121898. * Called on pointer POINTERMOVE event if multiple touches are active.
  121899. */
  121900. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  121901. /**
  121902. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  121903. * press.
  121904. */
  121905. protected onButtonDown(evt: PointerEvent): void;
  121906. /**
  121907. * Called each time a new POINTERUP event occurs. Ie, for each button
  121908. * release.
  121909. */
  121910. protected onButtonUp(evt: PointerEvent): void;
  121911. /**
  121912. * Called when window becomes inactive.
  121913. */
  121914. protected onLostFocus(): void;
  121915. }
  121916. }
  121917. declare module BABYLON {
  121918. /**
  121919. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  121920. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121921. */
  121922. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  121923. /**
  121924. * Defines the camera the input is attached to.
  121925. */
  121926. camera: ArcRotateCamera;
  121927. /**
  121928. * Defines the list of key codes associated with the up action (increase alpha)
  121929. */
  121930. keysUp: number[];
  121931. /**
  121932. * Defines the list of key codes associated with the down action (decrease alpha)
  121933. */
  121934. keysDown: number[];
  121935. /**
  121936. * Defines the list of key codes associated with the left action (increase beta)
  121937. */
  121938. keysLeft: number[];
  121939. /**
  121940. * Defines the list of key codes associated with the right action (decrease beta)
  121941. */
  121942. keysRight: number[];
  121943. /**
  121944. * Defines the list of key codes associated with the reset action.
  121945. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  121946. */
  121947. keysReset: number[];
  121948. /**
  121949. * Defines the panning sensibility of the inputs.
  121950. * (How fast is the camera panning)
  121951. */
  121952. panningSensibility: number;
  121953. /**
  121954. * Defines the zooming sensibility of the inputs.
  121955. * (How fast is the camera zooming)
  121956. */
  121957. zoomingSensibility: number;
  121958. /**
  121959. * Defines whether maintaining the alt key down switch the movement mode from
  121960. * orientation to zoom.
  121961. */
  121962. useAltToZoom: boolean;
  121963. /**
  121964. * Rotation speed of the camera
  121965. */
  121966. angularSpeed: number;
  121967. private _keys;
  121968. private _ctrlPressed;
  121969. private _altPressed;
  121970. private _onCanvasBlurObserver;
  121971. private _onKeyboardObserver;
  121972. private _engine;
  121973. private _scene;
  121974. /**
  121975. * Attach the input controls to a specific dom element to get the input from.
  121976. * @param element Defines the element the controls should be listened from
  121977. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121978. */
  121979. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121980. /**
  121981. * Detach the current controls from the specified dom element.
  121982. * @param element Defines the element to stop listening the inputs from
  121983. */
  121984. detachControl(element: Nullable<HTMLElement>): void;
  121985. /**
  121986. * Update the current camera state depending on the inputs that have been used this frame.
  121987. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  121988. */
  121989. checkInputs(): void;
  121990. /**
  121991. * Gets the class name of the current intput.
  121992. * @returns the class name
  121993. */
  121994. getClassName(): string;
  121995. /**
  121996. * Get the friendly name associated with the input class.
  121997. * @returns the input friendly name
  121998. */
  121999. getSimpleName(): string;
  122000. }
  122001. }
  122002. declare module BABYLON {
  122003. /**
  122004. * Manage the mouse wheel inputs to control an arc rotate camera.
  122005. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122006. */
  122007. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122008. /**
  122009. * Defines the camera the input is attached to.
  122010. */
  122011. camera: ArcRotateCamera;
  122012. /**
  122013. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122014. */
  122015. wheelPrecision: number;
  122016. /**
  122017. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122018. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122019. */
  122020. wheelDeltaPercentage: number;
  122021. private _wheel;
  122022. private _observer;
  122023. private computeDeltaFromMouseWheelLegacyEvent;
  122024. /**
  122025. * Attach the input controls to a specific dom element to get the input from.
  122026. * @param element Defines the element the controls should be listened from
  122027. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122028. */
  122029. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122030. /**
  122031. * Detach the current controls from the specified dom element.
  122032. * @param element Defines the element to stop listening the inputs from
  122033. */
  122034. detachControl(element: Nullable<HTMLElement>): void;
  122035. /**
  122036. * Gets the class name of the current intput.
  122037. * @returns the class name
  122038. */
  122039. getClassName(): string;
  122040. /**
  122041. * Get the friendly name associated with the input class.
  122042. * @returns the input friendly name
  122043. */
  122044. getSimpleName(): string;
  122045. }
  122046. }
  122047. declare module BABYLON {
  122048. /**
  122049. * Default Inputs manager for the ArcRotateCamera.
  122050. * It groups all the default supported inputs for ease of use.
  122051. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122052. */
  122053. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122054. /**
  122055. * Instantiates a new ArcRotateCameraInputsManager.
  122056. * @param camera Defines the camera the inputs belong to
  122057. */
  122058. constructor(camera: ArcRotateCamera);
  122059. /**
  122060. * Add mouse wheel input support to the input manager.
  122061. * @returns the current input manager
  122062. */
  122063. addMouseWheel(): ArcRotateCameraInputsManager;
  122064. /**
  122065. * Add pointers input support to the input manager.
  122066. * @returns the current input manager
  122067. */
  122068. addPointers(): ArcRotateCameraInputsManager;
  122069. /**
  122070. * Add keyboard input support to the input manager.
  122071. * @returns the current input manager
  122072. */
  122073. addKeyboard(): ArcRotateCameraInputsManager;
  122074. }
  122075. }
  122076. declare module BABYLON {
  122077. /**
  122078. * This represents an orbital type of camera.
  122079. *
  122080. * 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.
  122081. * 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.
  122082. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122083. */
  122084. export class ArcRotateCamera extends TargetCamera {
  122085. /**
  122086. * Defines the rotation angle of the camera along the longitudinal axis.
  122087. */
  122088. alpha: number;
  122089. /**
  122090. * Defines the rotation angle of the camera along the latitudinal axis.
  122091. */
  122092. beta: number;
  122093. /**
  122094. * Defines the radius of the camera from it s target point.
  122095. */
  122096. radius: number;
  122097. protected _target: Vector3;
  122098. protected _targetHost: Nullable<AbstractMesh>;
  122099. /**
  122100. * Defines the target point of the camera.
  122101. * The camera looks towards it form the radius distance.
  122102. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122103. */
  122104. get target(): Vector3;
  122105. set target(value: Vector3);
  122106. /**
  122107. * Define the current local position of the camera in the scene
  122108. */
  122109. get position(): Vector3;
  122110. set position(newPosition: Vector3);
  122111. protected _upVector: Vector3;
  122112. protected _upToYMatrix: Matrix;
  122113. protected _YToUpMatrix: Matrix;
  122114. /**
  122115. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122116. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122117. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122118. */
  122119. set upVector(vec: Vector3);
  122120. get upVector(): Vector3;
  122121. /**
  122122. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122123. */
  122124. setMatUp(): void;
  122125. /**
  122126. * Current inertia value on the longitudinal axis.
  122127. * The bigger this number the longer it will take for the camera to stop.
  122128. */
  122129. inertialAlphaOffset: number;
  122130. /**
  122131. * Current inertia value on the latitudinal axis.
  122132. * The bigger this number the longer it will take for the camera to stop.
  122133. */
  122134. inertialBetaOffset: number;
  122135. /**
  122136. * Current inertia value on the radius axis.
  122137. * The bigger this number the longer it will take for the camera to stop.
  122138. */
  122139. inertialRadiusOffset: number;
  122140. /**
  122141. * Minimum allowed angle on the longitudinal axis.
  122142. * This can help limiting how the Camera is able to move in the scene.
  122143. */
  122144. lowerAlphaLimit: Nullable<number>;
  122145. /**
  122146. * Maximum allowed angle on the longitudinal axis.
  122147. * This can help limiting how the Camera is able to move in the scene.
  122148. */
  122149. upperAlphaLimit: Nullable<number>;
  122150. /**
  122151. * Minimum allowed angle on the latitudinal axis.
  122152. * This can help limiting how the Camera is able to move in the scene.
  122153. */
  122154. lowerBetaLimit: number;
  122155. /**
  122156. * Maximum allowed angle on the latitudinal axis.
  122157. * This can help limiting how the Camera is able to move in the scene.
  122158. */
  122159. upperBetaLimit: number;
  122160. /**
  122161. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122162. * This can help limiting how the Camera is able to move in the scene.
  122163. */
  122164. lowerRadiusLimit: Nullable<number>;
  122165. /**
  122166. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122167. * This can help limiting how the Camera is able to move in the scene.
  122168. */
  122169. upperRadiusLimit: Nullable<number>;
  122170. /**
  122171. * Defines the current inertia value used during panning of the camera along the X axis.
  122172. */
  122173. inertialPanningX: number;
  122174. /**
  122175. * Defines the current inertia value used during panning of the camera along the Y axis.
  122176. */
  122177. inertialPanningY: number;
  122178. /**
  122179. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122180. * Basically if your fingers moves away from more than this distance you will be considered
  122181. * in pinch mode.
  122182. */
  122183. pinchToPanMaxDistance: number;
  122184. /**
  122185. * Defines the maximum distance the camera can pan.
  122186. * This could help keeping the cammera always in your scene.
  122187. */
  122188. panningDistanceLimit: Nullable<number>;
  122189. /**
  122190. * Defines the target of the camera before paning.
  122191. */
  122192. panningOriginTarget: Vector3;
  122193. /**
  122194. * Defines the value of the inertia used during panning.
  122195. * 0 would mean stop inertia and one would mean no decelleration at all.
  122196. */
  122197. panningInertia: number;
  122198. /**
  122199. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122200. */
  122201. get angularSensibilityX(): number;
  122202. set angularSensibilityX(value: number);
  122203. /**
  122204. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122205. */
  122206. get angularSensibilityY(): number;
  122207. set angularSensibilityY(value: number);
  122208. /**
  122209. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122210. */
  122211. get pinchPrecision(): number;
  122212. set pinchPrecision(value: number);
  122213. /**
  122214. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122215. * It will be used instead of pinchDeltaPrecision if different from 0.
  122216. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122217. */
  122218. get pinchDeltaPercentage(): number;
  122219. set pinchDeltaPercentage(value: number);
  122220. /**
  122221. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122222. * and pinch delta percentage.
  122223. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122224. * that any object in the plane at the camera's target point will scale
  122225. * perfectly with finger motion.
  122226. */
  122227. get useNaturalPinchZoom(): boolean;
  122228. set useNaturalPinchZoom(value: boolean);
  122229. /**
  122230. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122231. */
  122232. get panningSensibility(): number;
  122233. set panningSensibility(value: number);
  122234. /**
  122235. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122236. */
  122237. get keysUp(): number[];
  122238. set keysUp(value: number[]);
  122239. /**
  122240. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122241. */
  122242. get keysDown(): number[];
  122243. set keysDown(value: number[]);
  122244. /**
  122245. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122246. */
  122247. get keysLeft(): number[];
  122248. set keysLeft(value: number[]);
  122249. /**
  122250. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122251. */
  122252. get keysRight(): number[];
  122253. set keysRight(value: number[]);
  122254. /**
  122255. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122256. */
  122257. get wheelPrecision(): number;
  122258. set wheelPrecision(value: number);
  122259. /**
  122260. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122261. * It will be used instead of pinchDeltaPrecision if different from 0.
  122262. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122263. */
  122264. get wheelDeltaPercentage(): number;
  122265. set wheelDeltaPercentage(value: number);
  122266. /**
  122267. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122268. */
  122269. zoomOnFactor: number;
  122270. /**
  122271. * Defines a screen offset for the camera position.
  122272. */
  122273. targetScreenOffset: Vector2;
  122274. /**
  122275. * Allows the camera to be completely reversed.
  122276. * If false the camera can not arrive upside down.
  122277. */
  122278. allowUpsideDown: boolean;
  122279. /**
  122280. * Define if double tap/click is used to restore the previously saved state of the camera.
  122281. */
  122282. useInputToRestoreState: boolean;
  122283. /** @hidden */
  122284. _viewMatrix: Matrix;
  122285. /** @hidden */
  122286. _useCtrlForPanning: boolean;
  122287. /** @hidden */
  122288. _panningMouseButton: number;
  122289. /**
  122290. * Defines the input associated to the camera.
  122291. */
  122292. inputs: ArcRotateCameraInputsManager;
  122293. /** @hidden */
  122294. _reset: () => void;
  122295. /**
  122296. * Defines the allowed panning axis.
  122297. */
  122298. panningAxis: Vector3;
  122299. protected _localDirection: Vector3;
  122300. protected _transformedDirection: Vector3;
  122301. private _bouncingBehavior;
  122302. /**
  122303. * Gets the bouncing behavior of the camera if it has been enabled.
  122304. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122305. */
  122306. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122307. /**
  122308. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122309. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122310. */
  122311. get useBouncingBehavior(): boolean;
  122312. set useBouncingBehavior(value: boolean);
  122313. private _framingBehavior;
  122314. /**
  122315. * Gets the framing behavior of the camera if it has been enabled.
  122316. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122317. */
  122318. get framingBehavior(): Nullable<FramingBehavior>;
  122319. /**
  122320. * Defines if the framing behavior of the camera is enabled on the camera.
  122321. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122322. */
  122323. get useFramingBehavior(): boolean;
  122324. set useFramingBehavior(value: boolean);
  122325. private _autoRotationBehavior;
  122326. /**
  122327. * Gets the auto rotation behavior of the camera if it has been enabled.
  122328. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122329. */
  122330. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122331. /**
  122332. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122333. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122334. */
  122335. get useAutoRotationBehavior(): boolean;
  122336. set useAutoRotationBehavior(value: boolean);
  122337. /**
  122338. * Observable triggered when the mesh target has been changed on the camera.
  122339. */
  122340. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122341. /**
  122342. * Event raised when the camera is colliding with a mesh.
  122343. */
  122344. onCollide: (collidedMesh: AbstractMesh) => void;
  122345. /**
  122346. * Defines whether the camera should check collision with the objects oh the scene.
  122347. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122348. */
  122349. checkCollisions: boolean;
  122350. /**
  122351. * Defines the collision radius of the camera.
  122352. * This simulates a sphere around the camera.
  122353. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122354. */
  122355. collisionRadius: Vector3;
  122356. protected _collider: Collider;
  122357. protected _previousPosition: Vector3;
  122358. protected _collisionVelocity: Vector3;
  122359. protected _newPosition: Vector3;
  122360. protected _previousAlpha: number;
  122361. protected _previousBeta: number;
  122362. protected _previousRadius: number;
  122363. protected _collisionTriggered: boolean;
  122364. protected _targetBoundingCenter: Nullable<Vector3>;
  122365. private _computationVector;
  122366. /**
  122367. * Instantiates a new ArcRotateCamera in a given scene
  122368. * @param name Defines the name of the camera
  122369. * @param alpha Defines the camera rotation along the logitudinal axis
  122370. * @param beta Defines the camera rotation along the latitudinal axis
  122371. * @param radius Defines the camera distance from its target
  122372. * @param target Defines the camera target
  122373. * @param scene Defines the scene the camera belongs to
  122374. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122375. */
  122376. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122377. /** @hidden */
  122378. _initCache(): void;
  122379. /** @hidden */
  122380. _updateCache(ignoreParentClass?: boolean): void;
  122381. protected _getTargetPosition(): Vector3;
  122382. private _storedAlpha;
  122383. private _storedBeta;
  122384. private _storedRadius;
  122385. private _storedTarget;
  122386. private _storedTargetScreenOffset;
  122387. /**
  122388. * Stores the current state of the camera (alpha, beta, radius and target)
  122389. * @returns the camera itself
  122390. */
  122391. storeState(): Camera;
  122392. /**
  122393. * @hidden
  122394. * Restored camera state. You must call storeState() first
  122395. */
  122396. _restoreStateValues(): boolean;
  122397. /** @hidden */
  122398. _isSynchronizedViewMatrix(): boolean;
  122399. /**
  122400. * Attached controls to the current camera.
  122401. * @param element Defines the element the controls should be listened from
  122402. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122403. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122404. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122405. */
  122406. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122407. /**
  122408. * Detach the current controls from the camera.
  122409. * The camera will stop reacting to inputs.
  122410. * @param element Defines the element to stop listening the inputs from
  122411. */
  122412. detachControl(element: HTMLElement): void;
  122413. /** @hidden */
  122414. _checkInputs(): void;
  122415. protected _checkLimits(): void;
  122416. /**
  122417. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122418. */
  122419. rebuildAnglesAndRadius(): void;
  122420. /**
  122421. * Use a position to define the current camera related information like alpha, beta and radius
  122422. * @param position Defines the position to set the camera at
  122423. */
  122424. setPosition(position: Vector3): void;
  122425. /**
  122426. * Defines the target the camera should look at.
  122427. * This will automatically adapt alpha beta and radius to fit within the new target.
  122428. * @param target Defines the new target as a Vector or a mesh
  122429. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122430. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122431. */
  122432. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122433. /** @hidden */
  122434. _getViewMatrix(): Matrix;
  122435. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122436. /**
  122437. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122438. * @param meshes Defines the mesh to zoom on
  122439. * @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)
  122440. */
  122441. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122442. /**
  122443. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122444. * The target will be changed but the radius
  122445. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122446. * @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)
  122447. */
  122448. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122449. min: Vector3;
  122450. max: Vector3;
  122451. distance: number;
  122452. }, doNotUpdateMaxZ?: boolean): void;
  122453. /**
  122454. * @override
  122455. * Override Camera.createRigCamera
  122456. */
  122457. createRigCamera(name: string, cameraIndex: number): Camera;
  122458. /**
  122459. * @hidden
  122460. * @override
  122461. * Override Camera._updateRigCameras
  122462. */
  122463. _updateRigCameras(): void;
  122464. /**
  122465. * Destroy the camera and release the current resources hold by it.
  122466. */
  122467. dispose(): void;
  122468. /**
  122469. * Gets the current object class name.
  122470. * @return the class name
  122471. */
  122472. getClassName(): string;
  122473. }
  122474. }
  122475. declare module BABYLON {
  122476. /**
  122477. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122478. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122479. */
  122480. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122481. /**
  122482. * Gets the name of the behavior.
  122483. */
  122484. get name(): string;
  122485. private _zoomStopsAnimation;
  122486. private _idleRotationSpeed;
  122487. private _idleRotationWaitTime;
  122488. private _idleRotationSpinupTime;
  122489. /**
  122490. * Sets the flag that indicates if user zooming should stop animation.
  122491. */
  122492. set zoomStopsAnimation(flag: boolean);
  122493. /**
  122494. * Gets the flag that indicates if user zooming should stop animation.
  122495. */
  122496. get zoomStopsAnimation(): boolean;
  122497. /**
  122498. * Sets the default speed at which the camera rotates around the model.
  122499. */
  122500. set idleRotationSpeed(speed: number);
  122501. /**
  122502. * Gets the default speed at which the camera rotates around the model.
  122503. */
  122504. get idleRotationSpeed(): number;
  122505. /**
  122506. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122507. */
  122508. set idleRotationWaitTime(time: number);
  122509. /**
  122510. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122511. */
  122512. get idleRotationWaitTime(): number;
  122513. /**
  122514. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122515. */
  122516. set idleRotationSpinupTime(time: number);
  122517. /**
  122518. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122519. */
  122520. get idleRotationSpinupTime(): number;
  122521. /**
  122522. * Gets a value indicating if the camera is currently rotating because of this behavior
  122523. */
  122524. get rotationInProgress(): boolean;
  122525. private _onPrePointerObservableObserver;
  122526. private _onAfterCheckInputsObserver;
  122527. private _attachedCamera;
  122528. private _isPointerDown;
  122529. private _lastFrameTime;
  122530. private _lastInteractionTime;
  122531. private _cameraRotationSpeed;
  122532. /**
  122533. * Initializes the behavior.
  122534. */
  122535. init(): void;
  122536. /**
  122537. * Attaches the behavior to its arc rotate camera.
  122538. * @param camera Defines the camera to attach the behavior to
  122539. */
  122540. attach(camera: ArcRotateCamera): void;
  122541. /**
  122542. * Detaches the behavior from its current arc rotate camera.
  122543. */
  122544. detach(): void;
  122545. /**
  122546. * Returns true if user is scrolling.
  122547. * @return true if user is scrolling.
  122548. */
  122549. private _userIsZooming;
  122550. private _lastFrameRadius;
  122551. private _shouldAnimationStopForInteraction;
  122552. /**
  122553. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122554. */
  122555. private _applyUserInteraction;
  122556. private _userIsMoving;
  122557. }
  122558. }
  122559. declare module BABYLON {
  122560. /**
  122561. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  122562. */
  122563. export class AttachToBoxBehavior implements Behavior<Mesh> {
  122564. private ui;
  122565. /**
  122566. * The name of the behavior
  122567. */
  122568. name: string;
  122569. /**
  122570. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  122571. */
  122572. distanceAwayFromFace: number;
  122573. /**
  122574. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  122575. */
  122576. distanceAwayFromBottomOfFace: number;
  122577. private _faceVectors;
  122578. private _target;
  122579. private _scene;
  122580. private _onRenderObserver;
  122581. private _tmpMatrix;
  122582. private _tmpVector;
  122583. /**
  122584. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  122585. * @param ui The transform node that should be attched to the mesh
  122586. */
  122587. constructor(ui: TransformNode);
  122588. /**
  122589. * Initializes the behavior
  122590. */
  122591. init(): void;
  122592. private _closestFace;
  122593. private _zeroVector;
  122594. private _lookAtTmpMatrix;
  122595. private _lookAtToRef;
  122596. /**
  122597. * Attaches the AttachToBoxBehavior to the passed in mesh
  122598. * @param target The mesh that the specified node will be attached to
  122599. */
  122600. attach(target: Mesh): void;
  122601. /**
  122602. * Detaches the behavior from the mesh
  122603. */
  122604. detach(): void;
  122605. }
  122606. }
  122607. declare module BABYLON {
  122608. /**
  122609. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  122610. */
  122611. export class FadeInOutBehavior implements Behavior<Mesh> {
  122612. /**
  122613. * Time in milliseconds to delay before fading in (Default: 0)
  122614. */
  122615. delay: number;
  122616. /**
  122617. * Time in milliseconds for the mesh to fade in (Default: 300)
  122618. */
  122619. fadeInTime: number;
  122620. private _millisecondsPerFrame;
  122621. private _hovered;
  122622. private _hoverValue;
  122623. private _ownerNode;
  122624. /**
  122625. * Instatiates the FadeInOutBehavior
  122626. */
  122627. constructor();
  122628. /**
  122629. * The name of the behavior
  122630. */
  122631. get name(): string;
  122632. /**
  122633. * Initializes the behavior
  122634. */
  122635. init(): void;
  122636. /**
  122637. * Attaches the fade behavior on the passed in mesh
  122638. * @param ownerNode The mesh that will be faded in/out once attached
  122639. */
  122640. attach(ownerNode: Mesh): void;
  122641. /**
  122642. * Detaches the behavior from the mesh
  122643. */
  122644. detach(): void;
  122645. /**
  122646. * Triggers the mesh to begin fading in or out
  122647. * @param value if the object should fade in or out (true to fade in)
  122648. */
  122649. fadeIn(value: boolean): void;
  122650. private _update;
  122651. private _setAllVisibility;
  122652. }
  122653. }
  122654. declare module BABYLON {
  122655. /**
  122656. * Class containing a set of static utilities functions for managing Pivots
  122657. * @hidden
  122658. */
  122659. export class PivotTools {
  122660. private static _PivotCached;
  122661. private static _OldPivotPoint;
  122662. private static _PivotTranslation;
  122663. private static _PivotTmpVector;
  122664. /** @hidden */
  122665. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  122666. /** @hidden */
  122667. static _RestorePivotPoint(mesh: AbstractMesh): void;
  122668. }
  122669. }
  122670. declare module BABYLON {
  122671. /**
  122672. * Class containing static functions to help procedurally build meshes
  122673. */
  122674. export class PlaneBuilder {
  122675. /**
  122676. * Creates a plane mesh
  122677. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  122678. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  122679. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  122680. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  122681. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  122682. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  122683. * @param name defines the name of the mesh
  122684. * @param options defines the options used to create the mesh
  122685. * @param scene defines the hosting scene
  122686. * @returns the plane mesh
  122687. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  122688. */
  122689. static CreatePlane(name: string, options: {
  122690. size?: number;
  122691. width?: number;
  122692. height?: number;
  122693. sideOrientation?: number;
  122694. frontUVs?: Vector4;
  122695. backUVs?: Vector4;
  122696. updatable?: boolean;
  122697. sourcePlane?: Plane;
  122698. }, scene?: Nullable<Scene>): Mesh;
  122699. }
  122700. }
  122701. declare module BABYLON {
  122702. /**
  122703. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  122704. */
  122705. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  122706. private static _AnyMouseID;
  122707. /**
  122708. * Abstract mesh the behavior is set on
  122709. */
  122710. attachedNode: AbstractMesh;
  122711. private _dragPlane;
  122712. private _scene;
  122713. private _pointerObserver;
  122714. private _beforeRenderObserver;
  122715. private static _planeScene;
  122716. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  122717. /**
  122718. * 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)
  122719. */
  122720. maxDragAngle: number;
  122721. /**
  122722. * @hidden
  122723. */
  122724. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  122725. /**
  122726. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  122727. */
  122728. currentDraggingPointerID: number;
  122729. /**
  122730. * The last position where the pointer hit the drag plane in world space
  122731. */
  122732. lastDragPosition: Vector3;
  122733. /**
  122734. * If the behavior is currently in a dragging state
  122735. */
  122736. dragging: boolean;
  122737. /**
  122738. * 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)
  122739. */
  122740. dragDeltaRatio: number;
  122741. /**
  122742. * If the drag plane orientation should be updated during the dragging (Default: true)
  122743. */
  122744. updateDragPlane: boolean;
  122745. private _debugMode;
  122746. private _moving;
  122747. /**
  122748. * Fires each time the attached mesh is dragged with the pointer
  122749. * * delta between last drag position and current drag position in world space
  122750. * * dragDistance along the drag axis
  122751. * * dragPlaneNormal normal of the current drag plane used during the drag
  122752. * * dragPlanePoint in world space where the drag intersects the drag plane
  122753. */
  122754. onDragObservable: Observable<{
  122755. delta: Vector3;
  122756. dragPlanePoint: Vector3;
  122757. dragPlaneNormal: Vector3;
  122758. dragDistance: number;
  122759. pointerId: number;
  122760. }>;
  122761. /**
  122762. * Fires each time a drag begins (eg. mouse down on mesh)
  122763. */
  122764. onDragStartObservable: Observable<{
  122765. dragPlanePoint: Vector3;
  122766. pointerId: number;
  122767. }>;
  122768. /**
  122769. * Fires each time a drag ends (eg. mouse release after drag)
  122770. */
  122771. onDragEndObservable: Observable<{
  122772. dragPlanePoint: Vector3;
  122773. pointerId: number;
  122774. }>;
  122775. /**
  122776. * If the attached mesh should be moved when dragged
  122777. */
  122778. moveAttached: boolean;
  122779. /**
  122780. * If the drag behavior will react to drag events (Default: true)
  122781. */
  122782. enabled: boolean;
  122783. /**
  122784. * If pointer events should start and release the drag (Default: true)
  122785. */
  122786. startAndReleaseDragOnPointerEvents: boolean;
  122787. /**
  122788. * If camera controls should be detached during the drag
  122789. */
  122790. detachCameraControls: boolean;
  122791. /**
  122792. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  122793. */
  122794. useObjectOrientationForDragging: boolean;
  122795. private _options;
  122796. /**
  122797. * Gets the options used by the behavior
  122798. */
  122799. get options(): {
  122800. dragAxis?: Vector3;
  122801. dragPlaneNormal?: Vector3;
  122802. };
  122803. /**
  122804. * Sets the options used by the behavior
  122805. */
  122806. set options(options: {
  122807. dragAxis?: Vector3;
  122808. dragPlaneNormal?: Vector3;
  122809. });
  122810. /**
  122811. * Creates a pointer drag behavior that can be attached to a mesh
  122812. * @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)
  122813. */
  122814. constructor(options?: {
  122815. dragAxis?: Vector3;
  122816. dragPlaneNormal?: Vector3;
  122817. });
  122818. /**
  122819. * Predicate to determine if it is valid to move the object to a new position when it is moved
  122820. */
  122821. validateDrag: (targetPosition: Vector3) => boolean;
  122822. /**
  122823. * The name of the behavior
  122824. */
  122825. get name(): string;
  122826. /**
  122827. * Initializes the behavior
  122828. */
  122829. init(): void;
  122830. private _tmpVector;
  122831. private _alternatePickedPoint;
  122832. private _worldDragAxis;
  122833. private _targetPosition;
  122834. private _attachedElement;
  122835. /**
  122836. * Attaches the drag behavior the passed in mesh
  122837. * @param ownerNode The mesh that will be dragged around once attached
  122838. * @param predicate Predicate to use for pick filtering
  122839. */
  122840. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  122841. /**
  122842. * Force relase the drag action by code.
  122843. */
  122844. releaseDrag(): void;
  122845. private _startDragRay;
  122846. private _lastPointerRay;
  122847. /**
  122848. * Simulates the start of a pointer drag event on the behavior
  122849. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  122850. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  122851. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  122852. */
  122853. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  122854. private _startDrag;
  122855. private _dragDelta;
  122856. private _moveDrag;
  122857. private _pickWithRayOnDragPlane;
  122858. private _pointA;
  122859. private _pointC;
  122860. private _localAxis;
  122861. private _lookAt;
  122862. private _updateDragPlanePosition;
  122863. /**
  122864. * Detaches the behavior from the mesh
  122865. */
  122866. detach(): void;
  122867. }
  122868. }
  122869. declare module BABYLON {
  122870. /**
  122871. * A behavior that when attached to a mesh will allow the mesh to be scaled
  122872. */
  122873. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  122874. private _dragBehaviorA;
  122875. private _dragBehaviorB;
  122876. private _startDistance;
  122877. private _initialScale;
  122878. private _targetScale;
  122879. private _ownerNode;
  122880. private _sceneRenderObserver;
  122881. /**
  122882. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  122883. */
  122884. constructor();
  122885. /**
  122886. * The name of the behavior
  122887. */
  122888. get name(): string;
  122889. /**
  122890. * Initializes the behavior
  122891. */
  122892. init(): void;
  122893. private _getCurrentDistance;
  122894. /**
  122895. * Attaches the scale behavior the passed in mesh
  122896. * @param ownerNode The mesh that will be scaled around once attached
  122897. */
  122898. attach(ownerNode: Mesh): void;
  122899. /**
  122900. * Detaches the behavior from the mesh
  122901. */
  122902. detach(): void;
  122903. }
  122904. }
  122905. declare module BABYLON {
  122906. /**
  122907. * 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
  122908. */
  122909. export class SixDofDragBehavior implements Behavior<Mesh> {
  122910. private static _virtualScene;
  122911. private _ownerNode;
  122912. private _sceneRenderObserver;
  122913. private _scene;
  122914. private _targetPosition;
  122915. private _virtualOriginMesh;
  122916. private _virtualDragMesh;
  122917. private _pointerObserver;
  122918. private _moving;
  122919. private _startingOrientation;
  122920. private _attachedElement;
  122921. /**
  122922. * 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)
  122923. */
  122924. private zDragFactor;
  122925. /**
  122926. * If the object should rotate to face the drag origin
  122927. */
  122928. rotateDraggedObject: boolean;
  122929. /**
  122930. * If the behavior is currently in a dragging state
  122931. */
  122932. dragging: boolean;
  122933. /**
  122934. * 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)
  122935. */
  122936. dragDeltaRatio: number;
  122937. /**
  122938. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  122939. */
  122940. currentDraggingPointerID: number;
  122941. /**
  122942. * If camera controls should be detached during the drag
  122943. */
  122944. detachCameraControls: boolean;
  122945. /**
  122946. * Fires each time a drag starts
  122947. */
  122948. onDragStartObservable: Observable<{}>;
  122949. /**
  122950. * Fires each time a drag ends (eg. mouse release after drag)
  122951. */
  122952. onDragEndObservable: Observable<{}>;
  122953. /**
  122954. * 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
  122955. */
  122956. constructor();
  122957. /**
  122958. * The name of the behavior
  122959. */
  122960. get name(): string;
  122961. /**
  122962. * Initializes the behavior
  122963. */
  122964. init(): void;
  122965. /**
  122966. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  122967. */
  122968. private get _pointerCamera();
  122969. /**
  122970. * Attaches the scale behavior the passed in mesh
  122971. * @param ownerNode The mesh that will be scaled around once attached
  122972. */
  122973. attach(ownerNode: Mesh): void;
  122974. /**
  122975. * Detaches the behavior from the mesh
  122976. */
  122977. detach(): void;
  122978. }
  122979. }
  122980. declare module BABYLON {
  122981. /**
  122982. * Class used to apply inverse kinematics to bones
  122983. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  122984. */
  122985. export class BoneIKController {
  122986. private static _tmpVecs;
  122987. private static _tmpQuat;
  122988. private static _tmpMats;
  122989. /**
  122990. * Gets or sets the target mesh
  122991. */
  122992. targetMesh: AbstractMesh;
  122993. /** Gets or sets the mesh used as pole */
  122994. poleTargetMesh: AbstractMesh;
  122995. /**
  122996. * Gets or sets the bone used as pole
  122997. */
  122998. poleTargetBone: Nullable<Bone>;
  122999. /**
  123000. * Gets or sets the target position
  123001. */
  123002. targetPosition: Vector3;
  123003. /**
  123004. * Gets or sets the pole target position
  123005. */
  123006. poleTargetPosition: Vector3;
  123007. /**
  123008. * Gets or sets the pole target local offset
  123009. */
  123010. poleTargetLocalOffset: Vector3;
  123011. /**
  123012. * Gets or sets the pole angle
  123013. */
  123014. poleAngle: number;
  123015. /**
  123016. * Gets or sets the mesh associated with the controller
  123017. */
  123018. mesh: AbstractMesh;
  123019. /**
  123020. * 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)
  123021. */
  123022. slerpAmount: number;
  123023. private _bone1Quat;
  123024. private _bone1Mat;
  123025. private _bone2Ang;
  123026. private _bone1;
  123027. private _bone2;
  123028. private _bone1Length;
  123029. private _bone2Length;
  123030. private _maxAngle;
  123031. private _maxReach;
  123032. private _rightHandedSystem;
  123033. private _bendAxis;
  123034. private _slerping;
  123035. private _adjustRoll;
  123036. /**
  123037. * Gets or sets maximum allowed angle
  123038. */
  123039. get maxAngle(): number;
  123040. set maxAngle(value: number);
  123041. /**
  123042. * Creates a new BoneIKController
  123043. * @param mesh defines the mesh to control
  123044. * @param bone defines the bone to control
  123045. * @param options defines options to set up the controller
  123046. */
  123047. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123048. targetMesh?: AbstractMesh;
  123049. poleTargetMesh?: AbstractMesh;
  123050. poleTargetBone?: Bone;
  123051. poleTargetLocalOffset?: Vector3;
  123052. poleAngle?: number;
  123053. bendAxis?: Vector3;
  123054. maxAngle?: number;
  123055. slerpAmount?: number;
  123056. });
  123057. private _setMaxAngle;
  123058. /**
  123059. * Force the controller to update the bones
  123060. */
  123061. update(): void;
  123062. }
  123063. }
  123064. declare module BABYLON {
  123065. /**
  123066. * Class used to make a bone look toward a point in space
  123067. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123068. */
  123069. export class BoneLookController {
  123070. private static _tmpVecs;
  123071. private static _tmpQuat;
  123072. private static _tmpMats;
  123073. /**
  123074. * The target Vector3 that the bone will look at
  123075. */
  123076. target: Vector3;
  123077. /**
  123078. * The mesh that the bone is attached to
  123079. */
  123080. mesh: AbstractMesh;
  123081. /**
  123082. * The bone that will be looking to the target
  123083. */
  123084. bone: Bone;
  123085. /**
  123086. * The up axis of the coordinate system that is used when the bone is rotated
  123087. */
  123088. upAxis: Vector3;
  123089. /**
  123090. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123091. */
  123092. upAxisSpace: Space;
  123093. /**
  123094. * Used to make an adjustment to the yaw of the bone
  123095. */
  123096. adjustYaw: number;
  123097. /**
  123098. * Used to make an adjustment to the pitch of the bone
  123099. */
  123100. adjustPitch: number;
  123101. /**
  123102. * Used to make an adjustment to the roll of the bone
  123103. */
  123104. adjustRoll: number;
  123105. /**
  123106. * 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)
  123107. */
  123108. slerpAmount: number;
  123109. private _minYaw;
  123110. private _maxYaw;
  123111. private _minPitch;
  123112. private _maxPitch;
  123113. private _minYawSin;
  123114. private _minYawCos;
  123115. private _maxYawSin;
  123116. private _maxYawCos;
  123117. private _midYawConstraint;
  123118. private _minPitchTan;
  123119. private _maxPitchTan;
  123120. private _boneQuat;
  123121. private _slerping;
  123122. private _transformYawPitch;
  123123. private _transformYawPitchInv;
  123124. private _firstFrameSkipped;
  123125. private _yawRange;
  123126. private _fowardAxis;
  123127. /**
  123128. * Gets or sets the minimum yaw angle that the bone can look to
  123129. */
  123130. get minYaw(): number;
  123131. set minYaw(value: number);
  123132. /**
  123133. * Gets or sets the maximum yaw angle that the bone can look to
  123134. */
  123135. get maxYaw(): number;
  123136. set maxYaw(value: number);
  123137. /**
  123138. * Gets or sets the minimum pitch angle that the bone can look to
  123139. */
  123140. get minPitch(): number;
  123141. set minPitch(value: number);
  123142. /**
  123143. * Gets or sets the maximum pitch angle that the bone can look to
  123144. */
  123145. get maxPitch(): number;
  123146. set maxPitch(value: number);
  123147. /**
  123148. * Create a BoneLookController
  123149. * @param mesh the mesh that the bone belongs to
  123150. * @param bone the bone that will be looking to the target
  123151. * @param target the target Vector3 to look at
  123152. * @param options optional settings:
  123153. * * maxYaw: the maximum angle the bone will yaw to
  123154. * * minYaw: the minimum angle the bone will yaw to
  123155. * * maxPitch: the maximum angle the bone will pitch to
  123156. * * minPitch: the minimum angle the bone will yaw to
  123157. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123158. * * upAxis: the up axis of the coordinate system
  123159. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123160. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123161. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123162. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123163. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123164. * * adjustRoll: used to make an adjustment to the roll of the bone
  123165. **/
  123166. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123167. maxYaw?: number;
  123168. minYaw?: number;
  123169. maxPitch?: number;
  123170. minPitch?: number;
  123171. slerpAmount?: number;
  123172. upAxis?: Vector3;
  123173. upAxisSpace?: Space;
  123174. yawAxis?: Vector3;
  123175. pitchAxis?: Vector3;
  123176. adjustYaw?: number;
  123177. adjustPitch?: number;
  123178. adjustRoll?: number;
  123179. });
  123180. /**
  123181. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123182. */
  123183. update(): void;
  123184. private _getAngleDiff;
  123185. private _getAngleBetween;
  123186. private _isAngleBetween;
  123187. }
  123188. }
  123189. declare module BABYLON {
  123190. /**
  123191. * Manage the gamepad inputs to control an arc rotate camera.
  123192. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123193. */
  123194. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123195. /**
  123196. * Defines the camera the input is attached to.
  123197. */
  123198. camera: ArcRotateCamera;
  123199. /**
  123200. * Defines the gamepad the input is gathering event from.
  123201. */
  123202. gamepad: Nullable<Gamepad>;
  123203. /**
  123204. * Defines the gamepad rotation sensiblity.
  123205. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123206. */
  123207. gamepadRotationSensibility: number;
  123208. /**
  123209. * Defines the gamepad move sensiblity.
  123210. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123211. */
  123212. gamepadMoveSensibility: number;
  123213. private _yAxisScale;
  123214. /**
  123215. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123216. */
  123217. get invertYAxis(): boolean;
  123218. set invertYAxis(value: boolean);
  123219. private _onGamepadConnectedObserver;
  123220. private _onGamepadDisconnectedObserver;
  123221. /**
  123222. * Attach the input controls to a specific dom element to get the input from.
  123223. * @param element Defines the element the controls should be listened from
  123224. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123225. */
  123226. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123227. /**
  123228. * Detach the current controls from the specified dom element.
  123229. * @param element Defines the element to stop listening the inputs from
  123230. */
  123231. detachControl(element: Nullable<HTMLElement>): void;
  123232. /**
  123233. * Update the current camera state depending on the inputs that have been used this frame.
  123234. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123235. */
  123236. checkInputs(): void;
  123237. /**
  123238. * Gets the class name of the current intput.
  123239. * @returns the class name
  123240. */
  123241. getClassName(): string;
  123242. /**
  123243. * Get the friendly name associated with the input class.
  123244. * @returns the input friendly name
  123245. */
  123246. getSimpleName(): string;
  123247. }
  123248. }
  123249. declare module BABYLON {
  123250. interface ArcRotateCameraInputsManager {
  123251. /**
  123252. * Add orientation input support to the input manager.
  123253. * @returns the current input manager
  123254. */
  123255. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123256. }
  123257. /**
  123258. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123259. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123260. */
  123261. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123262. /**
  123263. * Defines the camera the input is attached to.
  123264. */
  123265. camera: ArcRotateCamera;
  123266. /**
  123267. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123268. */
  123269. alphaCorrection: number;
  123270. /**
  123271. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123272. */
  123273. gammaCorrection: number;
  123274. private _alpha;
  123275. private _gamma;
  123276. private _dirty;
  123277. private _deviceOrientationHandler;
  123278. /**
  123279. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123280. */
  123281. constructor();
  123282. /**
  123283. * Attach the input controls to a specific dom element to get the input from.
  123284. * @param element Defines the element the controls should be listened from
  123285. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123286. */
  123287. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123288. /** @hidden */
  123289. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123290. /**
  123291. * Update the current camera state depending on the inputs that have been used this frame.
  123292. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123293. */
  123294. checkInputs(): void;
  123295. /**
  123296. * Detach the current controls from the specified dom element.
  123297. * @param element Defines the element to stop listening the inputs from
  123298. */
  123299. detachControl(element: Nullable<HTMLElement>): void;
  123300. /**
  123301. * Gets the class name of the current intput.
  123302. * @returns the class name
  123303. */
  123304. getClassName(): string;
  123305. /**
  123306. * Get the friendly name associated with the input class.
  123307. * @returns the input friendly name
  123308. */
  123309. getSimpleName(): string;
  123310. }
  123311. }
  123312. declare module BABYLON {
  123313. /**
  123314. * Listen to mouse events to control the camera.
  123315. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123316. */
  123317. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123318. /**
  123319. * Defines the camera the input is attached to.
  123320. */
  123321. camera: FlyCamera;
  123322. /**
  123323. * Defines if touch is enabled. (Default is true.)
  123324. */
  123325. touchEnabled: boolean;
  123326. /**
  123327. * Defines the buttons associated with the input to handle camera rotation.
  123328. */
  123329. buttons: number[];
  123330. /**
  123331. * Assign buttons for Yaw control.
  123332. */
  123333. buttonsYaw: number[];
  123334. /**
  123335. * Assign buttons for Pitch control.
  123336. */
  123337. buttonsPitch: number[];
  123338. /**
  123339. * Assign buttons for Roll control.
  123340. */
  123341. buttonsRoll: number[];
  123342. /**
  123343. * Detect if any button is being pressed while mouse is moved.
  123344. * -1 = Mouse locked.
  123345. * 0 = Left button.
  123346. * 1 = Middle Button.
  123347. * 2 = Right Button.
  123348. */
  123349. activeButton: number;
  123350. /**
  123351. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123352. * Higher values reduce its sensitivity.
  123353. */
  123354. angularSensibility: number;
  123355. private _mousemoveCallback;
  123356. private _observer;
  123357. private _rollObserver;
  123358. private previousPosition;
  123359. private noPreventDefault;
  123360. private element;
  123361. /**
  123362. * Listen to mouse events to control the camera.
  123363. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123364. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123365. */
  123366. constructor(touchEnabled?: boolean);
  123367. /**
  123368. * Attach the mouse control to the HTML DOM element.
  123369. * @param element Defines the element that listens to the input events.
  123370. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123371. */
  123372. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123373. /**
  123374. * Detach the current controls from the specified dom element.
  123375. * @param element Defines the element to stop listening the inputs from
  123376. */
  123377. detachControl(element: Nullable<HTMLElement>): void;
  123378. /**
  123379. * Gets the class name of the current input.
  123380. * @returns the class name.
  123381. */
  123382. getClassName(): string;
  123383. /**
  123384. * Get the friendly name associated with the input class.
  123385. * @returns the input's friendly name.
  123386. */
  123387. getSimpleName(): string;
  123388. private _pointerInput;
  123389. private _onMouseMove;
  123390. /**
  123391. * Rotate camera by mouse offset.
  123392. */
  123393. private rotateCamera;
  123394. }
  123395. }
  123396. declare module BABYLON {
  123397. /**
  123398. * Default Inputs manager for the FlyCamera.
  123399. * It groups all the default supported inputs for ease of use.
  123400. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123401. */
  123402. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123403. /**
  123404. * Instantiates a new FlyCameraInputsManager.
  123405. * @param camera Defines the camera the inputs belong to.
  123406. */
  123407. constructor(camera: FlyCamera);
  123408. /**
  123409. * Add keyboard input support to the input manager.
  123410. * @returns the new FlyCameraKeyboardMoveInput().
  123411. */
  123412. addKeyboard(): FlyCameraInputsManager;
  123413. /**
  123414. * Add mouse input support to the input manager.
  123415. * @param touchEnabled Enable touch screen support.
  123416. * @returns the new FlyCameraMouseInput().
  123417. */
  123418. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123419. }
  123420. }
  123421. declare module BABYLON {
  123422. /**
  123423. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123424. * such as in a 3D Space Shooter or a Flight Simulator.
  123425. */
  123426. export class FlyCamera extends TargetCamera {
  123427. /**
  123428. * Define the collision ellipsoid of the camera.
  123429. * This is helpful for simulating a camera body, like a player's body.
  123430. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123431. */
  123432. ellipsoid: Vector3;
  123433. /**
  123434. * Define an offset for the position of the ellipsoid around the camera.
  123435. * This can be helpful if the camera is attached away from the player's body center,
  123436. * such as at its head.
  123437. */
  123438. ellipsoidOffset: Vector3;
  123439. /**
  123440. * Enable or disable collisions of the camera with the rest of the scene objects.
  123441. */
  123442. checkCollisions: boolean;
  123443. /**
  123444. * Enable or disable gravity on the camera.
  123445. */
  123446. applyGravity: boolean;
  123447. /**
  123448. * Define the current direction the camera is moving to.
  123449. */
  123450. cameraDirection: Vector3;
  123451. /**
  123452. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123453. * This overrides and empties cameraRotation.
  123454. */
  123455. rotationQuaternion: Quaternion;
  123456. /**
  123457. * Track Roll to maintain the wanted Rolling when looking around.
  123458. */
  123459. _trackRoll: number;
  123460. /**
  123461. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123462. */
  123463. rollCorrect: number;
  123464. /**
  123465. * Mimic a banked turn, Rolling the camera when Yawing.
  123466. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123467. */
  123468. bankedTurn: boolean;
  123469. /**
  123470. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123471. */
  123472. bankedTurnLimit: number;
  123473. /**
  123474. * Value of 0 disables the banked Roll.
  123475. * Value of 1 is equal to the Yaw angle in radians.
  123476. */
  123477. bankedTurnMultiplier: number;
  123478. /**
  123479. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123480. */
  123481. inputs: FlyCameraInputsManager;
  123482. /**
  123483. * Gets the input sensibility for mouse input.
  123484. * Higher values reduce sensitivity.
  123485. */
  123486. get angularSensibility(): number;
  123487. /**
  123488. * Sets the input sensibility for a mouse input.
  123489. * Higher values reduce sensitivity.
  123490. */
  123491. set angularSensibility(value: number);
  123492. /**
  123493. * Get the keys for camera movement forward.
  123494. */
  123495. get keysForward(): number[];
  123496. /**
  123497. * Set the keys for camera movement forward.
  123498. */
  123499. set keysForward(value: number[]);
  123500. /**
  123501. * Get the keys for camera movement backward.
  123502. */
  123503. get keysBackward(): number[];
  123504. set keysBackward(value: number[]);
  123505. /**
  123506. * Get the keys for camera movement up.
  123507. */
  123508. get keysUp(): number[];
  123509. /**
  123510. * Set the keys for camera movement up.
  123511. */
  123512. set keysUp(value: number[]);
  123513. /**
  123514. * Get the keys for camera movement down.
  123515. */
  123516. get keysDown(): number[];
  123517. /**
  123518. * Set the keys for camera movement down.
  123519. */
  123520. set keysDown(value: number[]);
  123521. /**
  123522. * Get the keys for camera movement left.
  123523. */
  123524. get keysLeft(): number[];
  123525. /**
  123526. * Set the keys for camera movement left.
  123527. */
  123528. set keysLeft(value: number[]);
  123529. /**
  123530. * Set the keys for camera movement right.
  123531. */
  123532. get keysRight(): number[];
  123533. /**
  123534. * Set the keys for camera movement right.
  123535. */
  123536. set keysRight(value: number[]);
  123537. /**
  123538. * Event raised when the camera collides with a mesh in the scene.
  123539. */
  123540. onCollide: (collidedMesh: AbstractMesh) => void;
  123541. private _collider;
  123542. private _needMoveForGravity;
  123543. private _oldPosition;
  123544. private _diffPosition;
  123545. private _newPosition;
  123546. /** @hidden */
  123547. _localDirection: Vector3;
  123548. /** @hidden */
  123549. _transformedDirection: Vector3;
  123550. /**
  123551. * Instantiates a FlyCamera.
  123552. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123553. * such as in a 3D Space Shooter or a Flight Simulator.
  123554. * @param name Define the name of the camera in the scene.
  123555. * @param position Define the starting position of the camera in the scene.
  123556. * @param scene Define the scene the camera belongs to.
  123557. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  123558. */
  123559. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123560. /**
  123561. * Attach a control to the HTML DOM element.
  123562. * @param element Defines the element that listens to the input events.
  123563. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  123564. */
  123565. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123566. /**
  123567. * Detach a control from the HTML DOM element.
  123568. * The camera will stop reacting to that input.
  123569. * @param element Defines the element that listens to the input events.
  123570. */
  123571. detachControl(element: HTMLElement): void;
  123572. private _collisionMask;
  123573. /**
  123574. * Get the mask that the camera ignores in collision events.
  123575. */
  123576. get collisionMask(): number;
  123577. /**
  123578. * Set the mask that the camera ignores in collision events.
  123579. */
  123580. set collisionMask(mask: number);
  123581. /** @hidden */
  123582. _collideWithWorld(displacement: Vector3): void;
  123583. /** @hidden */
  123584. private _onCollisionPositionChange;
  123585. /** @hidden */
  123586. _checkInputs(): void;
  123587. /** @hidden */
  123588. _decideIfNeedsToMove(): boolean;
  123589. /** @hidden */
  123590. _updatePosition(): void;
  123591. /**
  123592. * Restore the Roll to its target value at the rate specified.
  123593. * @param rate - Higher means slower restoring.
  123594. * @hidden
  123595. */
  123596. restoreRoll(rate: number): void;
  123597. /**
  123598. * Destroy the camera and release the current resources held by it.
  123599. */
  123600. dispose(): void;
  123601. /**
  123602. * Get the current object class name.
  123603. * @returns the class name.
  123604. */
  123605. getClassName(): string;
  123606. }
  123607. }
  123608. declare module BABYLON {
  123609. /**
  123610. * Listen to keyboard events to control the camera.
  123611. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123612. */
  123613. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  123614. /**
  123615. * Defines the camera the input is attached to.
  123616. */
  123617. camera: FlyCamera;
  123618. /**
  123619. * The list of keyboard keys used to control the forward move of the camera.
  123620. */
  123621. keysForward: number[];
  123622. /**
  123623. * The list of keyboard keys used to control the backward move of the camera.
  123624. */
  123625. keysBackward: number[];
  123626. /**
  123627. * The list of keyboard keys used to control the forward move of the camera.
  123628. */
  123629. keysUp: number[];
  123630. /**
  123631. * The list of keyboard keys used to control the backward move of the camera.
  123632. */
  123633. keysDown: number[];
  123634. /**
  123635. * The list of keyboard keys used to control the right strafe move of the camera.
  123636. */
  123637. keysRight: number[];
  123638. /**
  123639. * The list of keyboard keys used to control the left strafe move of the camera.
  123640. */
  123641. keysLeft: number[];
  123642. private _keys;
  123643. private _onCanvasBlurObserver;
  123644. private _onKeyboardObserver;
  123645. private _engine;
  123646. private _scene;
  123647. /**
  123648. * Attach the input controls to a specific dom element to get the input from.
  123649. * @param element Defines the element the controls should be listened from
  123650. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123651. */
  123652. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123653. /**
  123654. * Detach the current controls from the specified dom element.
  123655. * @param element Defines the element to stop listening the inputs from
  123656. */
  123657. detachControl(element: Nullable<HTMLElement>): void;
  123658. /**
  123659. * Gets the class name of the current intput.
  123660. * @returns the class name
  123661. */
  123662. getClassName(): string;
  123663. /** @hidden */
  123664. _onLostFocus(e: FocusEvent): void;
  123665. /**
  123666. * Get the friendly name associated with the input class.
  123667. * @returns the input friendly name
  123668. */
  123669. getSimpleName(): string;
  123670. /**
  123671. * Update the current camera state depending on the inputs that have been used this frame.
  123672. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123673. */
  123674. checkInputs(): void;
  123675. }
  123676. }
  123677. declare module BABYLON {
  123678. /**
  123679. * Manage the mouse wheel inputs to control a follow camera.
  123680. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123681. */
  123682. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  123683. /**
  123684. * Defines the camera the input is attached to.
  123685. */
  123686. camera: FollowCamera;
  123687. /**
  123688. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  123689. */
  123690. axisControlRadius: boolean;
  123691. /**
  123692. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  123693. */
  123694. axisControlHeight: boolean;
  123695. /**
  123696. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  123697. */
  123698. axisControlRotation: boolean;
  123699. /**
  123700. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  123701. * relation to mouseWheel events.
  123702. */
  123703. wheelPrecision: number;
  123704. /**
  123705. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  123706. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  123707. */
  123708. wheelDeltaPercentage: number;
  123709. private _wheel;
  123710. private _observer;
  123711. /**
  123712. * Attach the input controls to a specific dom element to get the input from.
  123713. * @param element Defines the element the controls should be listened from
  123714. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123715. */
  123716. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123717. /**
  123718. * Detach the current controls from the specified dom element.
  123719. * @param element Defines the element to stop listening the inputs from
  123720. */
  123721. detachControl(element: Nullable<HTMLElement>): void;
  123722. /**
  123723. * Gets the class name of the current intput.
  123724. * @returns the class name
  123725. */
  123726. getClassName(): string;
  123727. /**
  123728. * Get the friendly name associated with the input class.
  123729. * @returns the input friendly name
  123730. */
  123731. getSimpleName(): string;
  123732. }
  123733. }
  123734. declare module BABYLON {
  123735. /**
  123736. * Manage the pointers inputs to control an follow camera.
  123737. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123738. */
  123739. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  123740. /**
  123741. * Defines the camera the input is attached to.
  123742. */
  123743. camera: FollowCamera;
  123744. /**
  123745. * Gets the class name of the current input.
  123746. * @returns the class name
  123747. */
  123748. getClassName(): string;
  123749. /**
  123750. * Defines the pointer angular sensibility along the X axis or how fast is
  123751. * the camera rotating.
  123752. * A negative number will reverse the axis direction.
  123753. */
  123754. angularSensibilityX: number;
  123755. /**
  123756. * Defines the pointer angular sensibility along the Y axis or how fast is
  123757. * the camera rotating.
  123758. * A negative number will reverse the axis direction.
  123759. */
  123760. angularSensibilityY: number;
  123761. /**
  123762. * Defines the pointer pinch precision or how fast is the camera zooming.
  123763. * A negative number will reverse the axis direction.
  123764. */
  123765. pinchPrecision: number;
  123766. /**
  123767. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  123768. * from 0.
  123769. * It defines the percentage of current camera.radius to use as delta when
  123770. * pinch zoom is used.
  123771. */
  123772. pinchDeltaPercentage: number;
  123773. /**
  123774. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  123775. */
  123776. axisXControlRadius: boolean;
  123777. /**
  123778. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  123779. */
  123780. axisXControlHeight: boolean;
  123781. /**
  123782. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  123783. */
  123784. axisXControlRotation: boolean;
  123785. /**
  123786. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  123787. */
  123788. axisYControlRadius: boolean;
  123789. /**
  123790. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  123791. */
  123792. axisYControlHeight: boolean;
  123793. /**
  123794. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  123795. */
  123796. axisYControlRotation: boolean;
  123797. /**
  123798. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  123799. */
  123800. axisPinchControlRadius: boolean;
  123801. /**
  123802. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  123803. */
  123804. axisPinchControlHeight: boolean;
  123805. /**
  123806. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  123807. */
  123808. axisPinchControlRotation: boolean;
  123809. /**
  123810. * Log error messages if basic misconfiguration has occurred.
  123811. */
  123812. warningEnable: boolean;
  123813. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  123814. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  123815. private _warningCounter;
  123816. private _warning;
  123817. }
  123818. }
  123819. declare module BABYLON {
  123820. /**
  123821. * Default Inputs manager for the FollowCamera.
  123822. * It groups all the default supported inputs for ease of use.
  123823. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123824. */
  123825. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  123826. /**
  123827. * Instantiates a new FollowCameraInputsManager.
  123828. * @param camera Defines the camera the inputs belong to
  123829. */
  123830. constructor(camera: FollowCamera);
  123831. /**
  123832. * Add keyboard input support to the input manager.
  123833. * @returns the current input manager
  123834. */
  123835. addKeyboard(): FollowCameraInputsManager;
  123836. /**
  123837. * Add mouse wheel input support to the input manager.
  123838. * @returns the current input manager
  123839. */
  123840. addMouseWheel(): FollowCameraInputsManager;
  123841. /**
  123842. * Add pointers input support to the input manager.
  123843. * @returns the current input manager
  123844. */
  123845. addPointers(): FollowCameraInputsManager;
  123846. /**
  123847. * Add orientation input support to the input manager.
  123848. * @returns the current input manager
  123849. */
  123850. addVRDeviceOrientation(): FollowCameraInputsManager;
  123851. }
  123852. }
  123853. declare module BABYLON {
  123854. /**
  123855. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  123856. * an arc rotate version arcFollowCamera are available.
  123857. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123858. */
  123859. export class FollowCamera extends TargetCamera {
  123860. /**
  123861. * Distance the follow camera should follow an object at
  123862. */
  123863. radius: number;
  123864. /**
  123865. * Minimum allowed distance of the camera to the axis of rotation
  123866. * (The camera can not get closer).
  123867. * This can help limiting how the Camera is able to move in the scene.
  123868. */
  123869. lowerRadiusLimit: Nullable<number>;
  123870. /**
  123871. * Maximum allowed distance of the camera to the axis of rotation
  123872. * (The camera can not get further).
  123873. * This can help limiting how the Camera is able to move in the scene.
  123874. */
  123875. upperRadiusLimit: Nullable<number>;
  123876. /**
  123877. * Define a rotation offset between the camera and the object it follows
  123878. */
  123879. rotationOffset: number;
  123880. /**
  123881. * Minimum allowed angle to camera position relative to target object.
  123882. * This can help limiting how the Camera is able to move in the scene.
  123883. */
  123884. lowerRotationOffsetLimit: Nullable<number>;
  123885. /**
  123886. * Maximum allowed angle to camera position relative to target object.
  123887. * This can help limiting how the Camera is able to move in the scene.
  123888. */
  123889. upperRotationOffsetLimit: Nullable<number>;
  123890. /**
  123891. * Define a height offset between the camera and the object it follows.
  123892. * It can help following an object from the top (like a car chaing a plane)
  123893. */
  123894. heightOffset: number;
  123895. /**
  123896. * Minimum allowed height of camera position relative to target object.
  123897. * This can help limiting how the Camera is able to move in the scene.
  123898. */
  123899. lowerHeightOffsetLimit: Nullable<number>;
  123900. /**
  123901. * Maximum allowed height of camera position relative to target object.
  123902. * This can help limiting how the Camera is able to move in the scene.
  123903. */
  123904. upperHeightOffsetLimit: Nullable<number>;
  123905. /**
  123906. * Define how fast the camera can accelerate to follow it s target.
  123907. */
  123908. cameraAcceleration: number;
  123909. /**
  123910. * Define the speed limit of the camera following an object.
  123911. */
  123912. maxCameraSpeed: number;
  123913. /**
  123914. * Define the target of the camera.
  123915. */
  123916. lockedTarget: Nullable<AbstractMesh>;
  123917. /**
  123918. * Defines the input associated with the camera.
  123919. */
  123920. inputs: FollowCameraInputsManager;
  123921. /**
  123922. * Instantiates the follow camera.
  123923. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123924. * @param name Define the name of the camera in the scene
  123925. * @param position Define the position of the camera
  123926. * @param scene Define the scene the camera belong to
  123927. * @param lockedTarget Define the target of the camera
  123928. */
  123929. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  123930. private _follow;
  123931. /**
  123932. * Attached controls to the current camera.
  123933. * @param element Defines the element the controls should be listened from
  123934. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123935. */
  123936. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123937. /**
  123938. * Detach the current controls from the camera.
  123939. * The camera will stop reacting to inputs.
  123940. * @param element Defines the element to stop listening the inputs from
  123941. */
  123942. detachControl(element: HTMLElement): void;
  123943. /** @hidden */
  123944. _checkInputs(): void;
  123945. private _checkLimits;
  123946. /**
  123947. * Gets the camera class name.
  123948. * @returns the class name
  123949. */
  123950. getClassName(): string;
  123951. }
  123952. /**
  123953. * Arc Rotate version of the follow camera.
  123954. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  123955. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123956. */
  123957. export class ArcFollowCamera extends TargetCamera {
  123958. /** The longitudinal angle of the camera */
  123959. alpha: number;
  123960. /** The latitudinal angle of the camera */
  123961. beta: number;
  123962. /** The radius of the camera from its target */
  123963. radius: number;
  123964. private _cartesianCoordinates;
  123965. /** Define the camera target (the mesh it should follow) */
  123966. private _meshTarget;
  123967. /**
  123968. * Instantiates a new ArcFollowCamera
  123969. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123970. * @param name Define the name of the camera
  123971. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  123972. * @param beta Define the rotation angle of the camera around the elevation axis
  123973. * @param radius Define the radius of the camera from its target point
  123974. * @param target Define the target of the camera
  123975. * @param scene Define the scene the camera belongs to
  123976. */
  123977. constructor(name: string,
  123978. /** The longitudinal angle of the camera */
  123979. alpha: number,
  123980. /** The latitudinal angle of the camera */
  123981. beta: number,
  123982. /** The radius of the camera from its target */
  123983. radius: number,
  123984. /** Define the camera target (the mesh it should follow) */
  123985. target: Nullable<AbstractMesh>, scene: Scene);
  123986. private _follow;
  123987. /** @hidden */
  123988. _checkInputs(): void;
  123989. /**
  123990. * Returns the class name of the object.
  123991. * It is mostly used internally for serialization purposes.
  123992. */
  123993. getClassName(): string;
  123994. }
  123995. }
  123996. declare module BABYLON {
  123997. /**
  123998. * Manage the keyboard inputs to control the movement of a follow camera.
  123999. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124000. */
  124001. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124002. /**
  124003. * Defines the camera the input is attached to.
  124004. */
  124005. camera: FollowCamera;
  124006. /**
  124007. * Defines the list of key codes associated with the up action (increase heightOffset)
  124008. */
  124009. keysHeightOffsetIncr: number[];
  124010. /**
  124011. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124012. */
  124013. keysHeightOffsetDecr: number[];
  124014. /**
  124015. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124016. */
  124017. keysHeightOffsetModifierAlt: boolean;
  124018. /**
  124019. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124020. */
  124021. keysHeightOffsetModifierCtrl: boolean;
  124022. /**
  124023. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124024. */
  124025. keysHeightOffsetModifierShift: boolean;
  124026. /**
  124027. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124028. */
  124029. keysRotationOffsetIncr: number[];
  124030. /**
  124031. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124032. */
  124033. keysRotationOffsetDecr: number[];
  124034. /**
  124035. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124036. */
  124037. keysRotationOffsetModifierAlt: boolean;
  124038. /**
  124039. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124040. */
  124041. keysRotationOffsetModifierCtrl: boolean;
  124042. /**
  124043. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124044. */
  124045. keysRotationOffsetModifierShift: boolean;
  124046. /**
  124047. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124048. */
  124049. keysRadiusIncr: number[];
  124050. /**
  124051. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124052. */
  124053. keysRadiusDecr: number[];
  124054. /**
  124055. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124056. */
  124057. keysRadiusModifierAlt: boolean;
  124058. /**
  124059. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124060. */
  124061. keysRadiusModifierCtrl: boolean;
  124062. /**
  124063. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124064. */
  124065. keysRadiusModifierShift: boolean;
  124066. /**
  124067. * Defines the rate of change of heightOffset.
  124068. */
  124069. heightSensibility: number;
  124070. /**
  124071. * Defines the rate of change of rotationOffset.
  124072. */
  124073. rotationSensibility: number;
  124074. /**
  124075. * Defines the rate of change of radius.
  124076. */
  124077. radiusSensibility: number;
  124078. private _keys;
  124079. private _ctrlPressed;
  124080. private _altPressed;
  124081. private _shiftPressed;
  124082. private _onCanvasBlurObserver;
  124083. private _onKeyboardObserver;
  124084. private _engine;
  124085. private _scene;
  124086. /**
  124087. * Attach the input controls to a specific dom element to get the input from.
  124088. * @param element Defines the element the controls should be listened from
  124089. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124090. */
  124091. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124092. /**
  124093. * Detach the current controls from the specified dom element.
  124094. * @param element Defines the element to stop listening the inputs from
  124095. */
  124096. detachControl(element: Nullable<HTMLElement>): void;
  124097. /**
  124098. * Update the current camera state depending on the inputs that have been used this frame.
  124099. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124100. */
  124101. checkInputs(): void;
  124102. /**
  124103. * Gets the class name of the current input.
  124104. * @returns the class name
  124105. */
  124106. getClassName(): string;
  124107. /**
  124108. * Get the friendly name associated with the input class.
  124109. * @returns the input friendly name
  124110. */
  124111. getSimpleName(): string;
  124112. /**
  124113. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124114. * allow modification of the heightOffset value.
  124115. */
  124116. private _modifierHeightOffset;
  124117. /**
  124118. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124119. * allow modification of the rotationOffset value.
  124120. */
  124121. private _modifierRotationOffset;
  124122. /**
  124123. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124124. * allow modification of the radius value.
  124125. */
  124126. private _modifierRadius;
  124127. }
  124128. }
  124129. declare module BABYLON {
  124130. interface FreeCameraInputsManager {
  124131. /**
  124132. * @hidden
  124133. */
  124134. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124135. /**
  124136. * Add orientation input support to the input manager.
  124137. * @returns the current input manager
  124138. */
  124139. addDeviceOrientation(): FreeCameraInputsManager;
  124140. }
  124141. /**
  124142. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124143. * Screen rotation is taken into account.
  124144. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124145. */
  124146. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124147. private _camera;
  124148. private _screenOrientationAngle;
  124149. private _constantTranform;
  124150. private _screenQuaternion;
  124151. private _alpha;
  124152. private _beta;
  124153. private _gamma;
  124154. /**
  124155. * Can be used to detect if a device orientation sensor is available on a device
  124156. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124157. * @returns a promise that will resolve on orientation change
  124158. */
  124159. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124160. /**
  124161. * @hidden
  124162. */
  124163. _onDeviceOrientationChangedObservable: Observable<void>;
  124164. /**
  124165. * Instantiates a new input
  124166. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124167. */
  124168. constructor();
  124169. /**
  124170. * Define the camera controlled by the input.
  124171. */
  124172. get camera(): FreeCamera;
  124173. set camera(camera: FreeCamera);
  124174. /**
  124175. * Attach the input controls to a specific dom element to get the input from.
  124176. * @param element Defines the element the controls should be listened from
  124177. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124178. */
  124179. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124180. private _orientationChanged;
  124181. private _deviceOrientation;
  124182. /**
  124183. * Detach the current controls from the specified dom element.
  124184. * @param element Defines the element to stop listening the inputs from
  124185. */
  124186. detachControl(element: Nullable<HTMLElement>): void;
  124187. /**
  124188. * Update the current camera state depending on the inputs that have been used this frame.
  124189. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124190. */
  124191. checkInputs(): void;
  124192. /**
  124193. * Gets the class name of the current intput.
  124194. * @returns the class name
  124195. */
  124196. getClassName(): string;
  124197. /**
  124198. * Get the friendly name associated with the input class.
  124199. * @returns the input friendly name
  124200. */
  124201. getSimpleName(): string;
  124202. }
  124203. }
  124204. declare module BABYLON {
  124205. /**
  124206. * Manage the gamepad inputs to control a free camera.
  124207. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124208. */
  124209. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124210. /**
  124211. * Define the camera the input is attached to.
  124212. */
  124213. camera: FreeCamera;
  124214. /**
  124215. * Define the Gamepad controlling the input
  124216. */
  124217. gamepad: Nullable<Gamepad>;
  124218. /**
  124219. * Defines the gamepad rotation sensiblity.
  124220. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124221. */
  124222. gamepadAngularSensibility: number;
  124223. /**
  124224. * Defines the gamepad move sensiblity.
  124225. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124226. */
  124227. gamepadMoveSensibility: number;
  124228. private _yAxisScale;
  124229. /**
  124230. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124231. */
  124232. get invertYAxis(): boolean;
  124233. set invertYAxis(value: boolean);
  124234. private _onGamepadConnectedObserver;
  124235. private _onGamepadDisconnectedObserver;
  124236. private _cameraTransform;
  124237. private _deltaTransform;
  124238. private _vector3;
  124239. private _vector2;
  124240. /**
  124241. * Attach the input controls to a specific dom element to get the input from.
  124242. * @param element Defines the element the controls should be listened from
  124243. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124244. */
  124245. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124246. /**
  124247. * Detach the current controls from the specified dom element.
  124248. * @param element Defines the element to stop listening the inputs from
  124249. */
  124250. detachControl(element: Nullable<HTMLElement>): void;
  124251. /**
  124252. * Update the current camera state depending on the inputs that have been used this frame.
  124253. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124254. */
  124255. checkInputs(): void;
  124256. /**
  124257. * Gets the class name of the current intput.
  124258. * @returns the class name
  124259. */
  124260. getClassName(): string;
  124261. /**
  124262. * Get the friendly name associated with the input class.
  124263. * @returns the input friendly name
  124264. */
  124265. getSimpleName(): string;
  124266. }
  124267. }
  124268. declare module BABYLON {
  124269. /**
  124270. * Defines the potential axis of a Joystick
  124271. */
  124272. export enum JoystickAxis {
  124273. /** X axis */
  124274. X = 0,
  124275. /** Y axis */
  124276. Y = 1,
  124277. /** Z axis */
  124278. Z = 2
  124279. }
  124280. /**
  124281. * Represents the different customization options available
  124282. * for VirtualJoystick
  124283. */
  124284. interface VirtualJoystickCustomizations {
  124285. /**
  124286. * Size of the joystick's puck
  124287. */
  124288. puckSize: number;
  124289. /**
  124290. * Size of the joystick's container
  124291. */
  124292. containerSize: number;
  124293. /**
  124294. * Color of the joystick && puck
  124295. */
  124296. color: string;
  124297. /**
  124298. * Image URL for the joystick's puck
  124299. */
  124300. puckImage?: string;
  124301. /**
  124302. * Image URL for the joystick's container
  124303. */
  124304. containerImage?: string;
  124305. /**
  124306. * Defines the unmoving position of the joystick container
  124307. */
  124308. position?: {
  124309. x: number;
  124310. y: number;
  124311. };
  124312. /**
  124313. * Defines whether or not the joystick container is always visible
  124314. */
  124315. alwaysVisible: boolean;
  124316. /**
  124317. * Defines whether or not to limit the movement of the puck to the joystick's container
  124318. */
  124319. limitToContainer: boolean;
  124320. }
  124321. /**
  124322. * Class used to define virtual joystick (used in touch mode)
  124323. */
  124324. export class VirtualJoystick {
  124325. /**
  124326. * Gets or sets a boolean indicating that left and right values must be inverted
  124327. */
  124328. reverseLeftRight: boolean;
  124329. /**
  124330. * Gets or sets a boolean indicating that up and down values must be inverted
  124331. */
  124332. reverseUpDown: boolean;
  124333. /**
  124334. * Gets the offset value for the position (ie. the change of the position value)
  124335. */
  124336. deltaPosition: Vector3;
  124337. /**
  124338. * Gets a boolean indicating if the virtual joystick was pressed
  124339. */
  124340. pressed: boolean;
  124341. /**
  124342. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124343. */
  124344. static Canvas: Nullable<HTMLCanvasElement>;
  124345. /**
  124346. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124347. */
  124348. limitToContainer: boolean;
  124349. private static _globalJoystickIndex;
  124350. private static _alwaysVisibleSticks;
  124351. private static vjCanvasContext;
  124352. private static vjCanvasWidth;
  124353. private static vjCanvasHeight;
  124354. private static halfWidth;
  124355. private static _GetDefaultOptions;
  124356. private _action;
  124357. private _axisTargetedByLeftAndRight;
  124358. private _axisTargetedByUpAndDown;
  124359. private _joystickSensibility;
  124360. private _inversedSensibility;
  124361. private _joystickPointerID;
  124362. private _joystickColor;
  124363. private _joystickPointerPos;
  124364. private _joystickPreviousPointerPos;
  124365. private _joystickPointerStartPos;
  124366. private _deltaJoystickVector;
  124367. private _leftJoystick;
  124368. private _touches;
  124369. private _joystickPosition;
  124370. private _alwaysVisible;
  124371. private _puckImage;
  124372. private _containerImage;
  124373. private _joystickPuckSize;
  124374. private _joystickContainerSize;
  124375. private _clearPuckSize;
  124376. private _clearContainerSize;
  124377. private _clearPuckSizeOffset;
  124378. private _clearContainerSizeOffset;
  124379. private _onPointerDownHandlerRef;
  124380. private _onPointerMoveHandlerRef;
  124381. private _onPointerUpHandlerRef;
  124382. private _onResize;
  124383. /**
  124384. * Creates a new virtual joystick
  124385. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124386. * @param customizations Defines the options we want to customize the VirtualJoystick
  124387. */
  124388. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124389. /**
  124390. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124391. * @param newJoystickSensibility defines the new sensibility
  124392. */
  124393. setJoystickSensibility(newJoystickSensibility: number): void;
  124394. private _onPointerDown;
  124395. private _onPointerMove;
  124396. private _onPointerUp;
  124397. /**
  124398. * Change the color of the virtual joystick
  124399. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124400. */
  124401. setJoystickColor(newColor: string): void;
  124402. /**
  124403. * Size of the joystick's container
  124404. */
  124405. set containerSize(newSize: number);
  124406. get containerSize(): number;
  124407. /**
  124408. * Size of the joystick's puck
  124409. */
  124410. set puckSize(newSize: number);
  124411. get puckSize(): number;
  124412. /**
  124413. * Clears the set position of the joystick
  124414. */
  124415. clearPosition(): void;
  124416. /**
  124417. * Defines whether or not the joystick container is always visible
  124418. */
  124419. set alwaysVisible(value: boolean);
  124420. get alwaysVisible(): boolean;
  124421. /**
  124422. * Sets the constant position of the Joystick container
  124423. * @param x X axis coordinate
  124424. * @param y Y axis coordinate
  124425. */
  124426. setPosition(x: number, y: number): void;
  124427. /**
  124428. * Defines a callback to call when the joystick is touched
  124429. * @param action defines the callback
  124430. */
  124431. setActionOnTouch(action: () => any): void;
  124432. /**
  124433. * Defines which axis you'd like to control for left & right
  124434. * @param axis defines the axis to use
  124435. */
  124436. setAxisForLeftRight(axis: JoystickAxis): void;
  124437. /**
  124438. * Defines which axis you'd like to control for up & down
  124439. * @param axis defines the axis to use
  124440. */
  124441. setAxisForUpDown(axis: JoystickAxis): void;
  124442. /**
  124443. * Clears the canvas from the previous puck / container draw
  124444. */
  124445. private _clearPreviousDraw;
  124446. /**
  124447. * Loads `urlPath` to be used for the container's image
  124448. * @param urlPath defines the urlPath of an image to use
  124449. */
  124450. setContainerImage(urlPath: string): void;
  124451. /**
  124452. * Loads `urlPath` to be used for the puck's image
  124453. * @param urlPath defines the urlPath of an image to use
  124454. */
  124455. setPuckImage(urlPath: string): void;
  124456. /**
  124457. * Draws the Virtual Joystick's container
  124458. */
  124459. private _drawContainer;
  124460. /**
  124461. * Draws the Virtual Joystick's puck
  124462. */
  124463. private _drawPuck;
  124464. private _drawVirtualJoystick;
  124465. /**
  124466. * Release internal HTML canvas
  124467. */
  124468. releaseCanvas(): void;
  124469. }
  124470. }
  124471. declare module BABYLON {
  124472. interface FreeCameraInputsManager {
  124473. /**
  124474. * Add virtual joystick input support to the input manager.
  124475. * @returns the current input manager
  124476. */
  124477. addVirtualJoystick(): FreeCameraInputsManager;
  124478. }
  124479. /**
  124480. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124481. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124482. */
  124483. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124484. /**
  124485. * Defines the camera the input is attached to.
  124486. */
  124487. camera: FreeCamera;
  124488. private _leftjoystick;
  124489. private _rightjoystick;
  124490. /**
  124491. * Gets the left stick of the virtual joystick.
  124492. * @returns The virtual Joystick
  124493. */
  124494. getLeftJoystick(): VirtualJoystick;
  124495. /**
  124496. * Gets the right stick of the virtual joystick.
  124497. * @returns The virtual Joystick
  124498. */
  124499. getRightJoystick(): VirtualJoystick;
  124500. /**
  124501. * Update the current camera state depending on the inputs that have been used this frame.
  124502. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124503. */
  124504. checkInputs(): void;
  124505. /**
  124506. * Attach the input controls to a specific dom element to get the input from.
  124507. * @param element Defines the element the controls should be listened from
  124508. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124509. */
  124510. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124511. /**
  124512. * Detach the current controls from the specified dom element.
  124513. * @param element Defines the element to stop listening the inputs from
  124514. */
  124515. detachControl(element: Nullable<HTMLElement>): void;
  124516. /**
  124517. * Gets the class name of the current intput.
  124518. * @returns the class name
  124519. */
  124520. getClassName(): string;
  124521. /**
  124522. * Get the friendly name associated with the input class.
  124523. * @returns the input friendly name
  124524. */
  124525. getSimpleName(): string;
  124526. }
  124527. }
  124528. declare module BABYLON {
  124529. /**
  124530. * This represents a FPS type of camera controlled by touch.
  124531. * This is like a universal camera minus the Gamepad controls.
  124532. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124533. */
  124534. export class TouchCamera extends FreeCamera {
  124535. /**
  124536. * Defines the touch sensibility for rotation.
  124537. * The higher the faster.
  124538. */
  124539. get touchAngularSensibility(): number;
  124540. set touchAngularSensibility(value: number);
  124541. /**
  124542. * Defines the touch sensibility for move.
  124543. * The higher the faster.
  124544. */
  124545. get touchMoveSensibility(): number;
  124546. set touchMoveSensibility(value: number);
  124547. /**
  124548. * Instantiates a new touch camera.
  124549. * This represents a FPS type of camera controlled by touch.
  124550. * This is like a universal camera minus the Gamepad controls.
  124551. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124552. * @param name Define the name of the camera in the scene
  124553. * @param position Define the start position of the camera in the scene
  124554. * @param scene Define the scene the camera belongs to
  124555. */
  124556. constructor(name: string, position: Vector3, scene: Scene);
  124557. /**
  124558. * Gets the current object class name.
  124559. * @return the class name
  124560. */
  124561. getClassName(): string;
  124562. /** @hidden */
  124563. _setupInputs(): void;
  124564. }
  124565. }
  124566. declare module BABYLON {
  124567. /**
  124568. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  124569. * being tilted forward or back and left or right.
  124570. */
  124571. export class DeviceOrientationCamera extends FreeCamera {
  124572. private _initialQuaternion;
  124573. private _quaternionCache;
  124574. private _tmpDragQuaternion;
  124575. private _disablePointerInputWhenUsingDeviceOrientation;
  124576. /**
  124577. * Creates a new device orientation camera
  124578. * @param name The name of the camera
  124579. * @param position The start position camera
  124580. * @param scene The scene the camera belongs to
  124581. */
  124582. constructor(name: string, position: Vector3, scene: Scene);
  124583. /**
  124584. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  124585. */
  124586. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  124587. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  124588. private _dragFactor;
  124589. /**
  124590. * Enabled turning on the y axis when the orientation sensor is active
  124591. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  124592. */
  124593. enableHorizontalDragging(dragFactor?: number): void;
  124594. /**
  124595. * Gets the current instance class name ("DeviceOrientationCamera").
  124596. * This helps avoiding instanceof at run time.
  124597. * @returns the class name
  124598. */
  124599. getClassName(): string;
  124600. /**
  124601. * @hidden
  124602. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  124603. */
  124604. _checkInputs(): void;
  124605. /**
  124606. * Reset the camera to its default orientation on the specified axis only.
  124607. * @param axis The axis to reset
  124608. */
  124609. resetToCurrentRotation(axis?: Axis): void;
  124610. }
  124611. }
  124612. declare module BABYLON {
  124613. /**
  124614. * Defines supported buttons for XBox360 compatible gamepads
  124615. */
  124616. export enum Xbox360Button {
  124617. /** A */
  124618. A = 0,
  124619. /** B */
  124620. B = 1,
  124621. /** X */
  124622. X = 2,
  124623. /** Y */
  124624. Y = 3,
  124625. /** Left button */
  124626. LB = 4,
  124627. /** Right button */
  124628. RB = 5,
  124629. /** Back */
  124630. Back = 8,
  124631. /** Start */
  124632. Start = 9,
  124633. /** Left stick */
  124634. LeftStick = 10,
  124635. /** Right stick */
  124636. RightStick = 11
  124637. }
  124638. /** Defines values for XBox360 DPad */
  124639. export enum Xbox360Dpad {
  124640. /** Up */
  124641. Up = 12,
  124642. /** Down */
  124643. Down = 13,
  124644. /** Left */
  124645. Left = 14,
  124646. /** Right */
  124647. Right = 15
  124648. }
  124649. /**
  124650. * Defines a XBox360 gamepad
  124651. */
  124652. export class Xbox360Pad extends Gamepad {
  124653. private _leftTrigger;
  124654. private _rightTrigger;
  124655. private _onlefttriggerchanged;
  124656. private _onrighttriggerchanged;
  124657. private _onbuttondown;
  124658. private _onbuttonup;
  124659. private _ondpaddown;
  124660. private _ondpadup;
  124661. /** Observable raised when a button is pressed */
  124662. onButtonDownObservable: Observable<Xbox360Button>;
  124663. /** Observable raised when a button is released */
  124664. onButtonUpObservable: Observable<Xbox360Button>;
  124665. /** Observable raised when a pad is pressed */
  124666. onPadDownObservable: Observable<Xbox360Dpad>;
  124667. /** Observable raised when a pad is released */
  124668. onPadUpObservable: Observable<Xbox360Dpad>;
  124669. private _buttonA;
  124670. private _buttonB;
  124671. private _buttonX;
  124672. private _buttonY;
  124673. private _buttonBack;
  124674. private _buttonStart;
  124675. private _buttonLB;
  124676. private _buttonRB;
  124677. private _buttonLeftStick;
  124678. private _buttonRightStick;
  124679. private _dPadUp;
  124680. private _dPadDown;
  124681. private _dPadLeft;
  124682. private _dPadRight;
  124683. private _isXboxOnePad;
  124684. /**
  124685. * Creates a new XBox360 gamepad object
  124686. * @param id defines the id of this gamepad
  124687. * @param index defines its index
  124688. * @param gamepad defines the internal HTML gamepad object
  124689. * @param xboxOne defines if it is a XBox One gamepad
  124690. */
  124691. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  124692. /**
  124693. * Defines the callback to call when left trigger is pressed
  124694. * @param callback defines the callback to use
  124695. */
  124696. onlefttriggerchanged(callback: (value: number) => void): void;
  124697. /**
  124698. * Defines the callback to call when right trigger is pressed
  124699. * @param callback defines the callback to use
  124700. */
  124701. onrighttriggerchanged(callback: (value: number) => void): void;
  124702. /**
  124703. * Gets the left trigger value
  124704. */
  124705. get leftTrigger(): number;
  124706. /**
  124707. * Sets the left trigger value
  124708. */
  124709. set leftTrigger(newValue: number);
  124710. /**
  124711. * Gets the right trigger value
  124712. */
  124713. get rightTrigger(): number;
  124714. /**
  124715. * Sets the right trigger value
  124716. */
  124717. set rightTrigger(newValue: number);
  124718. /**
  124719. * Defines the callback to call when a button is pressed
  124720. * @param callback defines the callback to use
  124721. */
  124722. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  124723. /**
  124724. * Defines the callback to call when a button is released
  124725. * @param callback defines the callback to use
  124726. */
  124727. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  124728. /**
  124729. * Defines the callback to call when a pad is pressed
  124730. * @param callback defines the callback to use
  124731. */
  124732. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  124733. /**
  124734. * Defines the callback to call when a pad is released
  124735. * @param callback defines the callback to use
  124736. */
  124737. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  124738. private _setButtonValue;
  124739. private _setDPadValue;
  124740. /**
  124741. * Gets the value of the `A` button
  124742. */
  124743. get buttonA(): number;
  124744. /**
  124745. * Sets the value of the `A` button
  124746. */
  124747. set buttonA(value: number);
  124748. /**
  124749. * Gets the value of the `B` button
  124750. */
  124751. get buttonB(): number;
  124752. /**
  124753. * Sets the value of the `B` button
  124754. */
  124755. set buttonB(value: number);
  124756. /**
  124757. * Gets the value of the `X` button
  124758. */
  124759. get buttonX(): number;
  124760. /**
  124761. * Sets the value of the `X` button
  124762. */
  124763. set buttonX(value: number);
  124764. /**
  124765. * Gets the value of the `Y` button
  124766. */
  124767. get buttonY(): number;
  124768. /**
  124769. * Sets the value of the `Y` button
  124770. */
  124771. set buttonY(value: number);
  124772. /**
  124773. * Gets the value of the `Start` button
  124774. */
  124775. get buttonStart(): number;
  124776. /**
  124777. * Sets the value of the `Start` button
  124778. */
  124779. set buttonStart(value: number);
  124780. /**
  124781. * Gets the value of the `Back` button
  124782. */
  124783. get buttonBack(): number;
  124784. /**
  124785. * Sets the value of the `Back` button
  124786. */
  124787. set buttonBack(value: number);
  124788. /**
  124789. * Gets the value of the `Left` button
  124790. */
  124791. get buttonLB(): number;
  124792. /**
  124793. * Sets the value of the `Left` button
  124794. */
  124795. set buttonLB(value: number);
  124796. /**
  124797. * Gets the value of the `Right` button
  124798. */
  124799. get buttonRB(): number;
  124800. /**
  124801. * Sets the value of the `Right` button
  124802. */
  124803. set buttonRB(value: number);
  124804. /**
  124805. * Gets the value of the Left joystick
  124806. */
  124807. get buttonLeftStick(): number;
  124808. /**
  124809. * Sets the value of the Left joystick
  124810. */
  124811. set buttonLeftStick(value: number);
  124812. /**
  124813. * Gets the value of the Right joystick
  124814. */
  124815. get buttonRightStick(): number;
  124816. /**
  124817. * Sets the value of the Right joystick
  124818. */
  124819. set buttonRightStick(value: number);
  124820. /**
  124821. * Gets the value of D-pad up
  124822. */
  124823. get dPadUp(): number;
  124824. /**
  124825. * Sets the value of D-pad up
  124826. */
  124827. set dPadUp(value: number);
  124828. /**
  124829. * Gets the value of D-pad down
  124830. */
  124831. get dPadDown(): number;
  124832. /**
  124833. * Sets the value of D-pad down
  124834. */
  124835. set dPadDown(value: number);
  124836. /**
  124837. * Gets the value of D-pad left
  124838. */
  124839. get dPadLeft(): number;
  124840. /**
  124841. * Sets the value of D-pad left
  124842. */
  124843. set dPadLeft(value: number);
  124844. /**
  124845. * Gets the value of D-pad right
  124846. */
  124847. get dPadRight(): number;
  124848. /**
  124849. * Sets the value of D-pad right
  124850. */
  124851. set dPadRight(value: number);
  124852. /**
  124853. * Force the gamepad to synchronize with device values
  124854. */
  124855. update(): void;
  124856. /**
  124857. * Disposes the gamepad
  124858. */
  124859. dispose(): void;
  124860. }
  124861. }
  124862. declare module BABYLON {
  124863. /**
  124864. * Defines supported buttons for DualShock compatible gamepads
  124865. */
  124866. export enum DualShockButton {
  124867. /** Cross */
  124868. Cross = 0,
  124869. /** Circle */
  124870. Circle = 1,
  124871. /** Square */
  124872. Square = 2,
  124873. /** Triangle */
  124874. Triangle = 3,
  124875. /** L1 */
  124876. L1 = 4,
  124877. /** R1 */
  124878. R1 = 5,
  124879. /** Share */
  124880. Share = 8,
  124881. /** Options */
  124882. Options = 9,
  124883. /** Left stick */
  124884. LeftStick = 10,
  124885. /** Right stick */
  124886. RightStick = 11
  124887. }
  124888. /** Defines values for DualShock DPad */
  124889. export enum DualShockDpad {
  124890. /** Up */
  124891. Up = 12,
  124892. /** Down */
  124893. Down = 13,
  124894. /** Left */
  124895. Left = 14,
  124896. /** Right */
  124897. Right = 15
  124898. }
  124899. /**
  124900. * Defines a DualShock gamepad
  124901. */
  124902. export class DualShockPad extends Gamepad {
  124903. private _leftTrigger;
  124904. private _rightTrigger;
  124905. private _onlefttriggerchanged;
  124906. private _onrighttriggerchanged;
  124907. private _onbuttondown;
  124908. private _onbuttonup;
  124909. private _ondpaddown;
  124910. private _ondpadup;
  124911. /** Observable raised when a button is pressed */
  124912. onButtonDownObservable: Observable<DualShockButton>;
  124913. /** Observable raised when a button is released */
  124914. onButtonUpObservable: Observable<DualShockButton>;
  124915. /** Observable raised when a pad is pressed */
  124916. onPadDownObservable: Observable<DualShockDpad>;
  124917. /** Observable raised when a pad is released */
  124918. onPadUpObservable: Observable<DualShockDpad>;
  124919. private _buttonCross;
  124920. private _buttonCircle;
  124921. private _buttonSquare;
  124922. private _buttonTriangle;
  124923. private _buttonShare;
  124924. private _buttonOptions;
  124925. private _buttonL1;
  124926. private _buttonR1;
  124927. private _buttonLeftStick;
  124928. private _buttonRightStick;
  124929. private _dPadUp;
  124930. private _dPadDown;
  124931. private _dPadLeft;
  124932. private _dPadRight;
  124933. /**
  124934. * Creates a new DualShock gamepad object
  124935. * @param id defines the id of this gamepad
  124936. * @param index defines its index
  124937. * @param gamepad defines the internal HTML gamepad object
  124938. */
  124939. constructor(id: string, index: number, gamepad: any);
  124940. /**
  124941. * Defines the callback to call when left trigger is pressed
  124942. * @param callback defines the callback to use
  124943. */
  124944. onlefttriggerchanged(callback: (value: number) => void): void;
  124945. /**
  124946. * Defines the callback to call when right trigger is pressed
  124947. * @param callback defines the callback to use
  124948. */
  124949. onrighttriggerchanged(callback: (value: number) => void): void;
  124950. /**
  124951. * Gets the left trigger value
  124952. */
  124953. get leftTrigger(): number;
  124954. /**
  124955. * Sets the left trigger value
  124956. */
  124957. set leftTrigger(newValue: number);
  124958. /**
  124959. * Gets the right trigger value
  124960. */
  124961. get rightTrigger(): number;
  124962. /**
  124963. * Sets the right trigger value
  124964. */
  124965. set rightTrigger(newValue: number);
  124966. /**
  124967. * Defines the callback to call when a button is pressed
  124968. * @param callback defines the callback to use
  124969. */
  124970. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  124971. /**
  124972. * Defines the callback to call when a button is released
  124973. * @param callback defines the callback to use
  124974. */
  124975. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  124976. /**
  124977. * Defines the callback to call when a pad is pressed
  124978. * @param callback defines the callback to use
  124979. */
  124980. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  124981. /**
  124982. * Defines the callback to call when a pad is released
  124983. * @param callback defines the callback to use
  124984. */
  124985. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  124986. private _setButtonValue;
  124987. private _setDPadValue;
  124988. /**
  124989. * Gets the value of the `Cross` button
  124990. */
  124991. get buttonCross(): number;
  124992. /**
  124993. * Sets the value of the `Cross` button
  124994. */
  124995. set buttonCross(value: number);
  124996. /**
  124997. * Gets the value of the `Circle` button
  124998. */
  124999. get buttonCircle(): number;
  125000. /**
  125001. * Sets the value of the `Circle` button
  125002. */
  125003. set buttonCircle(value: number);
  125004. /**
  125005. * Gets the value of the `Square` button
  125006. */
  125007. get buttonSquare(): number;
  125008. /**
  125009. * Sets the value of the `Square` button
  125010. */
  125011. set buttonSquare(value: number);
  125012. /**
  125013. * Gets the value of the `Triangle` button
  125014. */
  125015. get buttonTriangle(): number;
  125016. /**
  125017. * Sets the value of the `Triangle` button
  125018. */
  125019. set buttonTriangle(value: number);
  125020. /**
  125021. * Gets the value of the `Options` button
  125022. */
  125023. get buttonOptions(): number;
  125024. /**
  125025. * Sets the value of the `Options` button
  125026. */
  125027. set buttonOptions(value: number);
  125028. /**
  125029. * Gets the value of the `Share` button
  125030. */
  125031. get buttonShare(): number;
  125032. /**
  125033. * Sets the value of the `Share` button
  125034. */
  125035. set buttonShare(value: number);
  125036. /**
  125037. * Gets the value of the `L1` button
  125038. */
  125039. get buttonL1(): number;
  125040. /**
  125041. * Sets the value of the `L1` button
  125042. */
  125043. set buttonL1(value: number);
  125044. /**
  125045. * Gets the value of the `R1` button
  125046. */
  125047. get buttonR1(): number;
  125048. /**
  125049. * Sets the value of the `R1` button
  125050. */
  125051. set buttonR1(value: number);
  125052. /**
  125053. * Gets the value of the Left joystick
  125054. */
  125055. get buttonLeftStick(): number;
  125056. /**
  125057. * Sets the value of the Left joystick
  125058. */
  125059. set buttonLeftStick(value: number);
  125060. /**
  125061. * Gets the value of the Right joystick
  125062. */
  125063. get buttonRightStick(): number;
  125064. /**
  125065. * Sets the value of the Right joystick
  125066. */
  125067. set buttonRightStick(value: number);
  125068. /**
  125069. * Gets the value of D-pad up
  125070. */
  125071. get dPadUp(): number;
  125072. /**
  125073. * Sets the value of D-pad up
  125074. */
  125075. set dPadUp(value: number);
  125076. /**
  125077. * Gets the value of D-pad down
  125078. */
  125079. get dPadDown(): number;
  125080. /**
  125081. * Sets the value of D-pad down
  125082. */
  125083. set dPadDown(value: number);
  125084. /**
  125085. * Gets the value of D-pad left
  125086. */
  125087. get dPadLeft(): number;
  125088. /**
  125089. * Sets the value of D-pad left
  125090. */
  125091. set dPadLeft(value: number);
  125092. /**
  125093. * Gets the value of D-pad right
  125094. */
  125095. get dPadRight(): number;
  125096. /**
  125097. * Sets the value of D-pad right
  125098. */
  125099. set dPadRight(value: number);
  125100. /**
  125101. * Force the gamepad to synchronize with device values
  125102. */
  125103. update(): void;
  125104. /**
  125105. * Disposes the gamepad
  125106. */
  125107. dispose(): void;
  125108. }
  125109. }
  125110. declare module BABYLON {
  125111. /**
  125112. * Manager for handling gamepads
  125113. */
  125114. export class GamepadManager {
  125115. private _scene?;
  125116. private _babylonGamepads;
  125117. private _oneGamepadConnected;
  125118. /** @hidden */
  125119. _isMonitoring: boolean;
  125120. private _gamepadEventSupported;
  125121. private _gamepadSupport?;
  125122. /**
  125123. * observable to be triggered when the gamepad controller has been connected
  125124. */
  125125. onGamepadConnectedObservable: Observable<Gamepad>;
  125126. /**
  125127. * observable to be triggered when the gamepad controller has been disconnected
  125128. */
  125129. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125130. private _onGamepadConnectedEvent;
  125131. private _onGamepadDisconnectedEvent;
  125132. /**
  125133. * Initializes the gamepad manager
  125134. * @param _scene BabylonJS scene
  125135. */
  125136. constructor(_scene?: Scene | undefined);
  125137. /**
  125138. * The gamepads in the game pad manager
  125139. */
  125140. get gamepads(): Gamepad[];
  125141. /**
  125142. * Get the gamepad controllers based on type
  125143. * @param type The type of gamepad controller
  125144. * @returns Nullable gamepad
  125145. */
  125146. getGamepadByType(type?: number): Nullable<Gamepad>;
  125147. /**
  125148. * Disposes the gamepad manager
  125149. */
  125150. dispose(): void;
  125151. private _addNewGamepad;
  125152. private _startMonitoringGamepads;
  125153. private _stopMonitoringGamepads;
  125154. /** @hidden */
  125155. _checkGamepadsStatus(): void;
  125156. private _updateGamepadObjects;
  125157. }
  125158. }
  125159. declare module BABYLON {
  125160. interface Scene {
  125161. /** @hidden */
  125162. _gamepadManager: Nullable<GamepadManager>;
  125163. /**
  125164. * Gets the gamepad manager associated with the scene
  125165. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125166. */
  125167. gamepadManager: GamepadManager;
  125168. }
  125169. /**
  125170. * Interface representing a free camera inputs manager
  125171. */
  125172. interface FreeCameraInputsManager {
  125173. /**
  125174. * Adds gamepad input support to the FreeCameraInputsManager.
  125175. * @returns the FreeCameraInputsManager
  125176. */
  125177. addGamepad(): FreeCameraInputsManager;
  125178. }
  125179. /**
  125180. * Interface representing an arc rotate camera inputs manager
  125181. */
  125182. interface ArcRotateCameraInputsManager {
  125183. /**
  125184. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125185. * @returns the camera inputs manager
  125186. */
  125187. addGamepad(): ArcRotateCameraInputsManager;
  125188. }
  125189. /**
  125190. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125191. */
  125192. export class GamepadSystemSceneComponent implements ISceneComponent {
  125193. /**
  125194. * The component name helpfull to identify the component in the list of scene components.
  125195. */
  125196. readonly name: string;
  125197. /**
  125198. * The scene the component belongs to.
  125199. */
  125200. scene: Scene;
  125201. /**
  125202. * Creates a new instance of the component for the given scene
  125203. * @param scene Defines the scene to register the component in
  125204. */
  125205. constructor(scene: Scene);
  125206. /**
  125207. * Registers the component in a given scene
  125208. */
  125209. register(): void;
  125210. /**
  125211. * Rebuilds the elements related to this component in case of
  125212. * context lost for instance.
  125213. */
  125214. rebuild(): void;
  125215. /**
  125216. * Disposes the component and the associated ressources
  125217. */
  125218. dispose(): void;
  125219. private _beforeCameraUpdate;
  125220. }
  125221. }
  125222. declare module BABYLON {
  125223. /**
  125224. * 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,
  125225. * which still works and will still be found in many Playgrounds.
  125226. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125227. */
  125228. export class UniversalCamera extends TouchCamera {
  125229. /**
  125230. * Defines the gamepad rotation sensiblity.
  125231. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125232. */
  125233. get gamepadAngularSensibility(): number;
  125234. set gamepadAngularSensibility(value: number);
  125235. /**
  125236. * Defines the gamepad move sensiblity.
  125237. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125238. */
  125239. get gamepadMoveSensibility(): number;
  125240. set gamepadMoveSensibility(value: number);
  125241. /**
  125242. * 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,
  125243. * which still works and will still be found in many Playgrounds.
  125244. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125245. * @param name Define the name of the camera in the scene
  125246. * @param position Define the start position of the camera in the scene
  125247. * @param scene Define the scene the camera belongs to
  125248. */
  125249. constructor(name: string, position: Vector3, scene: Scene);
  125250. /**
  125251. * Gets the current object class name.
  125252. * @return the class name
  125253. */
  125254. getClassName(): string;
  125255. }
  125256. }
  125257. declare module BABYLON {
  125258. /**
  125259. * This represents a FPS type of camera. This is only here for back compat purpose.
  125260. * Please use the UniversalCamera instead as both are identical.
  125261. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125262. */
  125263. export class GamepadCamera extends UniversalCamera {
  125264. /**
  125265. * Instantiates a new Gamepad Camera
  125266. * This represents a FPS type of camera. This is only here for back compat purpose.
  125267. * Please use the UniversalCamera instead as both are identical.
  125268. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125269. * @param name Define the name of the camera in the scene
  125270. * @param position Define the start position of the camera in the scene
  125271. * @param scene Define the scene the camera belongs to
  125272. */
  125273. constructor(name: string, position: Vector3, scene: Scene);
  125274. /**
  125275. * Gets the current object class name.
  125276. * @return the class name
  125277. */
  125278. getClassName(): string;
  125279. }
  125280. }
  125281. declare module BABYLON {
  125282. /** @hidden */
  125283. export var passPixelShader: {
  125284. name: string;
  125285. shader: string;
  125286. };
  125287. }
  125288. declare module BABYLON {
  125289. /** @hidden */
  125290. export var passCubePixelShader: {
  125291. name: string;
  125292. shader: string;
  125293. };
  125294. }
  125295. declare module BABYLON {
  125296. /**
  125297. * PassPostProcess which produces an output the same as it's input
  125298. */
  125299. export class PassPostProcess extends PostProcess {
  125300. /**
  125301. * Gets a string identifying the name of the class
  125302. * @returns "PassPostProcess" string
  125303. */
  125304. getClassName(): string;
  125305. /**
  125306. * Creates the PassPostProcess
  125307. * @param name The name of the effect.
  125308. * @param options The required width/height ratio to downsize to before computing the render pass.
  125309. * @param camera The camera to apply the render pass to.
  125310. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125311. * @param engine The engine which the post process will be applied. (default: current engine)
  125312. * @param reusable If the post process can be reused on the same frame. (default: false)
  125313. * @param textureType The type of texture to be used when performing the post processing.
  125314. * @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)
  125315. */
  125316. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125317. /** @hidden */
  125318. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125319. }
  125320. /**
  125321. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125322. */
  125323. export class PassCubePostProcess extends PostProcess {
  125324. private _face;
  125325. /**
  125326. * Gets or sets the cube face to display.
  125327. * * 0 is +X
  125328. * * 1 is -X
  125329. * * 2 is +Y
  125330. * * 3 is -Y
  125331. * * 4 is +Z
  125332. * * 5 is -Z
  125333. */
  125334. get face(): number;
  125335. set face(value: number);
  125336. /**
  125337. * Gets a string identifying the name of the class
  125338. * @returns "PassCubePostProcess" string
  125339. */
  125340. getClassName(): string;
  125341. /**
  125342. * Creates the PassCubePostProcess
  125343. * @param name The name of the effect.
  125344. * @param options The required width/height ratio to downsize to before computing the render pass.
  125345. * @param camera The camera to apply the render pass to.
  125346. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125347. * @param engine The engine which the post process will be applied. (default: current engine)
  125348. * @param reusable If the post process can be reused on the same frame. (default: false)
  125349. * @param textureType The type of texture to be used when performing the post processing.
  125350. * @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)
  125351. */
  125352. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125353. /** @hidden */
  125354. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125355. }
  125356. }
  125357. declare module BABYLON {
  125358. /** @hidden */
  125359. export var anaglyphPixelShader: {
  125360. name: string;
  125361. shader: string;
  125362. };
  125363. }
  125364. declare module BABYLON {
  125365. /**
  125366. * Postprocess used to generate anaglyphic rendering
  125367. */
  125368. export class AnaglyphPostProcess extends PostProcess {
  125369. private _passedProcess;
  125370. /**
  125371. * Gets a string identifying the name of the class
  125372. * @returns "AnaglyphPostProcess" string
  125373. */
  125374. getClassName(): string;
  125375. /**
  125376. * Creates a new AnaglyphPostProcess
  125377. * @param name defines postprocess name
  125378. * @param options defines creation options or target ratio scale
  125379. * @param rigCameras defines cameras using this postprocess
  125380. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125381. * @param engine defines hosting engine
  125382. * @param reusable defines if the postprocess will be reused multiple times per frame
  125383. */
  125384. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125385. }
  125386. }
  125387. declare module BABYLON {
  125388. /**
  125389. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125390. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125391. */
  125392. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125393. /**
  125394. * Creates a new AnaglyphArcRotateCamera
  125395. * @param name defines camera name
  125396. * @param alpha defines alpha angle (in radians)
  125397. * @param beta defines beta angle (in radians)
  125398. * @param radius defines radius
  125399. * @param target defines camera target
  125400. * @param interaxialDistance defines distance between each color axis
  125401. * @param scene defines the hosting scene
  125402. */
  125403. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125404. /**
  125405. * Gets camera class name
  125406. * @returns AnaglyphArcRotateCamera
  125407. */
  125408. getClassName(): string;
  125409. }
  125410. }
  125411. declare module BABYLON {
  125412. /**
  125413. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125414. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125415. */
  125416. export class AnaglyphFreeCamera extends FreeCamera {
  125417. /**
  125418. * Creates a new AnaglyphFreeCamera
  125419. * @param name defines camera name
  125420. * @param position defines initial position
  125421. * @param interaxialDistance defines distance between each color axis
  125422. * @param scene defines the hosting scene
  125423. */
  125424. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125425. /**
  125426. * Gets camera class name
  125427. * @returns AnaglyphFreeCamera
  125428. */
  125429. getClassName(): string;
  125430. }
  125431. }
  125432. declare module BABYLON {
  125433. /**
  125434. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125435. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125436. */
  125437. export class AnaglyphGamepadCamera extends GamepadCamera {
  125438. /**
  125439. * Creates a new AnaglyphGamepadCamera
  125440. * @param name defines camera name
  125441. * @param position defines initial position
  125442. * @param interaxialDistance defines distance between each color axis
  125443. * @param scene defines the hosting scene
  125444. */
  125445. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125446. /**
  125447. * Gets camera class name
  125448. * @returns AnaglyphGamepadCamera
  125449. */
  125450. getClassName(): string;
  125451. }
  125452. }
  125453. declare module BABYLON {
  125454. /**
  125455. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125456. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125457. */
  125458. export class AnaglyphUniversalCamera extends UniversalCamera {
  125459. /**
  125460. * Creates a new AnaglyphUniversalCamera
  125461. * @param name defines camera name
  125462. * @param position defines initial position
  125463. * @param interaxialDistance defines distance between each color axis
  125464. * @param scene defines the hosting scene
  125465. */
  125466. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125467. /**
  125468. * Gets camera class name
  125469. * @returns AnaglyphUniversalCamera
  125470. */
  125471. getClassName(): string;
  125472. }
  125473. }
  125474. declare module BABYLON {
  125475. /**
  125476. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125477. * @see https://doc.babylonjs.com/features/cameras
  125478. */
  125479. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125480. /**
  125481. * Creates a new StereoscopicArcRotateCamera
  125482. * @param name defines camera name
  125483. * @param alpha defines alpha angle (in radians)
  125484. * @param beta defines beta angle (in radians)
  125485. * @param radius defines radius
  125486. * @param target defines camera target
  125487. * @param interaxialDistance defines distance between each color axis
  125488. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125489. * @param scene defines the hosting scene
  125490. */
  125491. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125492. /**
  125493. * Gets camera class name
  125494. * @returns StereoscopicArcRotateCamera
  125495. */
  125496. getClassName(): string;
  125497. }
  125498. }
  125499. declare module BABYLON {
  125500. /**
  125501. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125502. * @see https://doc.babylonjs.com/features/cameras
  125503. */
  125504. export class StereoscopicFreeCamera extends FreeCamera {
  125505. /**
  125506. * Creates a new StereoscopicFreeCamera
  125507. * @param name defines camera name
  125508. * @param position defines initial position
  125509. * @param interaxialDistance defines distance between each color axis
  125510. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125511. * @param scene defines the hosting scene
  125512. */
  125513. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125514. /**
  125515. * Gets camera class name
  125516. * @returns StereoscopicFreeCamera
  125517. */
  125518. getClassName(): string;
  125519. }
  125520. }
  125521. declare module BABYLON {
  125522. /**
  125523. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  125524. * @see https://doc.babylonjs.com/features/cameras
  125525. */
  125526. export class StereoscopicGamepadCamera extends GamepadCamera {
  125527. /**
  125528. * Creates a new StereoscopicGamepadCamera
  125529. * @param name defines camera name
  125530. * @param position defines initial position
  125531. * @param interaxialDistance defines distance between each color axis
  125532. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125533. * @param scene defines the hosting scene
  125534. */
  125535. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125536. /**
  125537. * Gets camera class name
  125538. * @returns StereoscopicGamepadCamera
  125539. */
  125540. getClassName(): string;
  125541. }
  125542. }
  125543. declare module BABYLON {
  125544. /**
  125545. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  125546. * @see https://doc.babylonjs.com/features/cameras
  125547. */
  125548. export class StereoscopicUniversalCamera extends UniversalCamera {
  125549. /**
  125550. * Creates a new StereoscopicUniversalCamera
  125551. * @param name defines camera name
  125552. * @param position defines initial position
  125553. * @param interaxialDistance defines distance between each color axis
  125554. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125555. * @param scene defines the hosting scene
  125556. */
  125557. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125558. /**
  125559. * Gets camera class name
  125560. * @returns StereoscopicUniversalCamera
  125561. */
  125562. getClassName(): string;
  125563. }
  125564. }
  125565. declare module BABYLON {
  125566. /**
  125567. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  125568. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125569. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125570. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125571. */
  125572. export class VirtualJoysticksCamera extends FreeCamera {
  125573. /**
  125574. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  125575. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125576. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125577. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125578. * @param name Define the name of the camera in the scene
  125579. * @param position Define the start position of the camera in the scene
  125580. * @param scene Define the scene the camera belongs to
  125581. */
  125582. constructor(name: string, position: Vector3, scene: Scene);
  125583. /**
  125584. * Gets the current object class name.
  125585. * @return the class name
  125586. */
  125587. getClassName(): string;
  125588. }
  125589. }
  125590. declare module BABYLON {
  125591. /**
  125592. * This represents all the required metrics to create a VR camera.
  125593. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  125594. */
  125595. export class VRCameraMetrics {
  125596. /**
  125597. * Define the horizontal resolution off the screen.
  125598. */
  125599. hResolution: number;
  125600. /**
  125601. * Define the vertical resolution off the screen.
  125602. */
  125603. vResolution: number;
  125604. /**
  125605. * Define the horizontal screen size.
  125606. */
  125607. hScreenSize: number;
  125608. /**
  125609. * Define the vertical screen size.
  125610. */
  125611. vScreenSize: number;
  125612. /**
  125613. * Define the vertical screen center position.
  125614. */
  125615. vScreenCenter: number;
  125616. /**
  125617. * Define the distance of the eyes to the screen.
  125618. */
  125619. eyeToScreenDistance: number;
  125620. /**
  125621. * Define the distance between both lenses
  125622. */
  125623. lensSeparationDistance: number;
  125624. /**
  125625. * Define the distance between both viewer's eyes.
  125626. */
  125627. interpupillaryDistance: number;
  125628. /**
  125629. * Define the distortion factor of the VR postprocess.
  125630. * Please, touch with care.
  125631. */
  125632. distortionK: number[];
  125633. /**
  125634. * Define the chromatic aberration correction factors for the VR post process.
  125635. */
  125636. chromaAbCorrection: number[];
  125637. /**
  125638. * Define the scale factor of the post process.
  125639. * The smaller the better but the slower.
  125640. */
  125641. postProcessScaleFactor: number;
  125642. /**
  125643. * Define an offset for the lens center.
  125644. */
  125645. lensCenterOffset: number;
  125646. /**
  125647. * Define if the current vr camera should compensate the distortion of the lense or not.
  125648. */
  125649. compensateDistortion: boolean;
  125650. /**
  125651. * Defines if multiview should be enabled when rendering (Default: false)
  125652. */
  125653. multiviewEnabled: boolean;
  125654. /**
  125655. * Gets the rendering aspect ratio based on the provided resolutions.
  125656. */
  125657. get aspectRatio(): number;
  125658. /**
  125659. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  125660. */
  125661. get aspectRatioFov(): number;
  125662. /**
  125663. * @hidden
  125664. */
  125665. get leftHMatrix(): Matrix;
  125666. /**
  125667. * @hidden
  125668. */
  125669. get rightHMatrix(): Matrix;
  125670. /**
  125671. * @hidden
  125672. */
  125673. get leftPreViewMatrix(): Matrix;
  125674. /**
  125675. * @hidden
  125676. */
  125677. get rightPreViewMatrix(): Matrix;
  125678. /**
  125679. * Get the default VRMetrics based on the most generic setup.
  125680. * @returns the default vr metrics
  125681. */
  125682. static GetDefault(): VRCameraMetrics;
  125683. }
  125684. }
  125685. declare module BABYLON {
  125686. /** @hidden */
  125687. export var vrDistortionCorrectionPixelShader: {
  125688. name: string;
  125689. shader: string;
  125690. };
  125691. }
  125692. declare module BABYLON {
  125693. /**
  125694. * VRDistortionCorrectionPostProcess used for mobile VR
  125695. */
  125696. export class VRDistortionCorrectionPostProcess extends PostProcess {
  125697. private _isRightEye;
  125698. private _distortionFactors;
  125699. private _postProcessScaleFactor;
  125700. private _lensCenterOffset;
  125701. private _scaleIn;
  125702. private _scaleFactor;
  125703. private _lensCenter;
  125704. /**
  125705. * Gets a string identifying the name of the class
  125706. * @returns "VRDistortionCorrectionPostProcess" string
  125707. */
  125708. getClassName(): string;
  125709. /**
  125710. * Initializes the VRDistortionCorrectionPostProcess
  125711. * @param name The name of the effect.
  125712. * @param camera The camera to apply the render pass to.
  125713. * @param isRightEye If this is for the right eye distortion
  125714. * @param vrMetrics All the required metrics for the VR camera
  125715. */
  125716. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  125717. }
  125718. }
  125719. declare module BABYLON {
  125720. /**
  125721. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  125722. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  125723. */
  125724. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  125725. /**
  125726. * Creates a new VRDeviceOrientationArcRotateCamera
  125727. * @param name defines camera name
  125728. * @param alpha defines the camera rotation along the logitudinal axis
  125729. * @param beta defines the camera rotation along the latitudinal axis
  125730. * @param radius defines the camera distance from its target
  125731. * @param target defines the camera target
  125732. * @param scene defines the scene the camera belongs to
  125733. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  125734. * @param vrCameraMetrics defines the vr metrics associated to the camera
  125735. */
  125736. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  125737. /**
  125738. * Gets camera class name
  125739. * @returns VRDeviceOrientationArcRotateCamera
  125740. */
  125741. getClassName(): string;
  125742. }
  125743. }
  125744. declare module BABYLON {
  125745. /**
  125746. * Camera used to simulate VR rendering (based on FreeCamera)
  125747. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  125748. */
  125749. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  125750. /**
  125751. * Creates a new VRDeviceOrientationFreeCamera
  125752. * @param name defines camera name
  125753. * @param position defines the start position of the camera
  125754. * @param scene defines the scene the camera belongs to
  125755. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  125756. * @param vrCameraMetrics defines the vr metrics associated to the camera
  125757. */
  125758. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  125759. /**
  125760. * Gets camera class name
  125761. * @returns VRDeviceOrientationFreeCamera
  125762. */
  125763. getClassName(): string;
  125764. }
  125765. }
  125766. declare module BABYLON {
  125767. /**
  125768. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  125769. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  125770. */
  125771. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  125772. /**
  125773. * Creates a new VRDeviceOrientationGamepadCamera
  125774. * @param name defines camera name
  125775. * @param position defines the start position of the camera
  125776. * @param scene defines the scene the camera belongs to
  125777. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  125778. * @param vrCameraMetrics defines the vr metrics associated to the camera
  125779. */
  125780. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  125781. /**
  125782. * Gets camera class name
  125783. * @returns VRDeviceOrientationGamepadCamera
  125784. */
  125785. getClassName(): string;
  125786. }
  125787. }
  125788. declare module BABYLON {
  125789. /**
  125790. * A class extending Texture allowing drawing on a texture
  125791. * @see https://doc.babylonjs.com/how_to/dynamictexture
  125792. */
  125793. export class DynamicTexture extends Texture {
  125794. private _generateMipMaps;
  125795. private _canvas;
  125796. private _context;
  125797. /**
  125798. * Creates a DynamicTexture
  125799. * @param name defines the name of the texture
  125800. * @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
  125801. * @param scene defines the scene where you want the texture
  125802. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  125803. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  125804. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  125805. */
  125806. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  125807. /**
  125808. * Get the current class name of the texture useful for serialization or dynamic coding.
  125809. * @returns "DynamicTexture"
  125810. */
  125811. getClassName(): string;
  125812. /**
  125813. * Gets the current state of canRescale
  125814. */
  125815. get canRescale(): boolean;
  125816. private _recreate;
  125817. /**
  125818. * Scales the texture
  125819. * @param ratio the scale factor to apply to both width and height
  125820. */
  125821. scale(ratio: number): void;
  125822. /**
  125823. * Resizes the texture
  125824. * @param width the new width
  125825. * @param height the new height
  125826. */
  125827. scaleTo(width: number, height: number): void;
  125828. /**
  125829. * Gets the context of the canvas used by the texture
  125830. * @returns the canvas context of the dynamic texture
  125831. */
  125832. getContext(): CanvasRenderingContext2D;
  125833. /**
  125834. * Clears the texture
  125835. */
  125836. clear(): void;
  125837. /**
  125838. * Updates the texture
  125839. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  125840. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  125841. */
  125842. update(invertY?: boolean, premulAlpha?: boolean): void;
  125843. /**
  125844. * Draws text onto the texture
  125845. * @param text defines the text to be drawn
  125846. * @param x defines the placement of the text from the left
  125847. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  125848. * @param font defines the font to be used with font-style, font-size, font-name
  125849. * @param color defines the color used for the text
  125850. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  125851. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  125852. * @param update defines whether texture is immediately update (default is true)
  125853. */
  125854. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  125855. /**
  125856. * Clones the texture
  125857. * @returns the clone of the texture.
  125858. */
  125859. clone(): DynamicTexture;
  125860. /**
  125861. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  125862. * @returns a serialized dynamic texture object
  125863. */
  125864. serialize(): any;
  125865. private _IsCanvasElement;
  125866. /** @hidden */
  125867. _rebuild(): void;
  125868. }
  125869. }
  125870. declare module BABYLON {
  125871. /**
  125872. * Class containing static functions to help procedurally build meshes
  125873. */
  125874. export class GroundBuilder {
  125875. /**
  125876. * Creates a ground mesh
  125877. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  125878. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  125879. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125880. * @param name defines the name of the mesh
  125881. * @param options defines the options used to create the mesh
  125882. * @param scene defines the hosting scene
  125883. * @returns the ground mesh
  125884. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  125885. */
  125886. static CreateGround(name: string, options: {
  125887. width?: number;
  125888. height?: number;
  125889. subdivisions?: number;
  125890. subdivisionsX?: number;
  125891. subdivisionsY?: number;
  125892. updatable?: boolean;
  125893. }, scene: any): Mesh;
  125894. /**
  125895. * Creates a tiled ground mesh
  125896. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  125897. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  125898. * * 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
  125899. * * 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
  125900. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125901. * @param name defines the name of the mesh
  125902. * @param options defines the options used to create the mesh
  125903. * @param scene defines the hosting scene
  125904. * @returns the tiled ground mesh
  125905. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  125906. */
  125907. static CreateTiledGround(name: string, options: {
  125908. xmin: number;
  125909. zmin: number;
  125910. xmax: number;
  125911. zmax: number;
  125912. subdivisions?: {
  125913. w: number;
  125914. h: number;
  125915. };
  125916. precision?: {
  125917. w: number;
  125918. h: number;
  125919. };
  125920. updatable?: boolean;
  125921. }, scene?: Nullable<Scene>): Mesh;
  125922. /**
  125923. * Creates a ground mesh from a height map
  125924. * * The parameter `url` sets the URL of the height map image resource.
  125925. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  125926. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  125927. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  125928. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  125929. * * 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.
  125930. * * 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).
  125931. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  125932. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125933. * @param name defines the name of the mesh
  125934. * @param url defines the url to the height map
  125935. * @param options defines the options used to create the mesh
  125936. * @param scene defines the hosting scene
  125937. * @returns the ground mesh
  125938. * @see https://doc.babylonjs.com/babylon101/height_map
  125939. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  125940. */
  125941. static CreateGroundFromHeightMap(name: string, url: string, options: {
  125942. width?: number;
  125943. height?: number;
  125944. subdivisions?: number;
  125945. minHeight?: number;
  125946. maxHeight?: number;
  125947. colorFilter?: Color3;
  125948. alphaFilter?: number;
  125949. updatable?: boolean;
  125950. onReady?: (mesh: GroundMesh) => void;
  125951. }, scene?: Nullable<Scene>): GroundMesh;
  125952. }
  125953. }
  125954. declare module BABYLON {
  125955. /**
  125956. * Class containing static functions to help procedurally build meshes
  125957. */
  125958. export class TorusBuilder {
  125959. /**
  125960. * Creates a torus mesh
  125961. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  125962. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  125963. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  125964. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125965. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125966. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125967. * @param name defines the name of the mesh
  125968. * @param options defines the options used to create the mesh
  125969. * @param scene defines the hosting scene
  125970. * @returns the torus mesh
  125971. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  125972. */
  125973. static CreateTorus(name: string, options: {
  125974. diameter?: number;
  125975. thickness?: number;
  125976. tessellation?: number;
  125977. updatable?: boolean;
  125978. sideOrientation?: number;
  125979. frontUVs?: Vector4;
  125980. backUVs?: Vector4;
  125981. }, scene: any): Mesh;
  125982. }
  125983. }
  125984. declare module BABYLON {
  125985. /**
  125986. * Class containing static functions to help procedurally build meshes
  125987. */
  125988. export class CylinderBuilder {
  125989. /**
  125990. * Creates a cylinder or a cone mesh
  125991. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  125992. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  125993. * * 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.
  125994. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  125995. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  125996. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  125997. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  125998. * * 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).
  125999. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126000. * * 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).
  126001. * * 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
  126002. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126003. * * 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
  126004. * * 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.
  126005. * * If `enclose` is false, a ring surface is one element.
  126006. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126007. * * 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
  126008. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126009. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126010. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126011. * @param name defines the name of the mesh
  126012. * @param options defines the options used to create the mesh
  126013. * @param scene defines the hosting scene
  126014. * @returns the cylinder mesh
  126015. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126016. */
  126017. static CreateCylinder(name: string, options: {
  126018. height?: number;
  126019. diameterTop?: number;
  126020. diameterBottom?: number;
  126021. diameter?: number;
  126022. tessellation?: number;
  126023. subdivisions?: number;
  126024. arc?: number;
  126025. faceColors?: Color4[];
  126026. faceUV?: Vector4[];
  126027. updatable?: boolean;
  126028. hasRings?: boolean;
  126029. enclose?: boolean;
  126030. cap?: number;
  126031. sideOrientation?: number;
  126032. frontUVs?: Vector4;
  126033. backUVs?: Vector4;
  126034. }, scene: any): Mesh;
  126035. }
  126036. }
  126037. declare module BABYLON {
  126038. /**
  126039. * States of the webXR experience
  126040. */
  126041. export enum WebXRState {
  126042. /**
  126043. * Transitioning to being in XR mode
  126044. */
  126045. ENTERING_XR = 0,
  126046. /**
  126047. * Transitioning to non XR mode
  126048. */
  126049. EXITING_XR = 1,
  126050. /**
  126051. * In XR mode and presenting
  126052. */
  126053. IN_XR = 2,
  126054. /**
  126055. * Not entered XR mode
  126056. */
  126057. NOT_IN_XR = 3
  126058. }
  126059. /**
  126060. * Abstraction of the XR render target
  126061. */
  126062. export interface WebXRRenderTarget extends IDisposable {
  126063. /**
  126064. * xrpresent context of the canvas which can be used to display/mirror xr content
  126065. */
  126066. canvasContext: WebGLRenderingContext;
  126067. /**
  126068. * xr layer for the canvas
  126069. */
  126070. xrLayer: Nullable<XRWebGLLayer>;
  126071. /**
  126072. * Initializes the xr layer for the session
  126073. * @param xrSession xr session
  126074. * @returns a promise that will resolve once the XR Layer has been created
  126075. */
  126076. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126077. }
  126078. }
  126079. declare module BABYLON {
  126080. /**
  126081. * COnfiguration object for WebXR output canvas
  126082. */
  126083. export class WebXRManagedOutputCanvasOptions {
  126084. /**
  126085. * An optional canvas in case you wish to create it yourself and provide it here.
  126086. * If not provided, a new canvas will be created
  126087. */
  126088. canvasElement?: HTMLCanvasElement;
  126089. /**
  126090. * Options for this XR Layer output
  126091. */
  126092. canvasOptions?: XRWebGLLayerOptions;
  126093. /**
  126094. * CSS styling for a newly created canvas (if not provided)
  126095. */
  126096. newCanvasCssStyle?: string;
  126097. /**
  126098. * Get the default values of the configuration object
  126099. * @returns default values of this configuration object
  126100. */
  126101. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  126102. }
  126103. /**
  126104. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126105. */
  126106. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126107. private _options;
  126108. private _canvas;
  126109. private _engine;
  126110. private _originalCanvasSize;
  126111. /**
  126112. * Rendering context of the canvas which can be used to display/mirror xr content
  126113. */
  126114. canvasContext: WebGLRenderingContext;
  126115. /**
  126116. * xr layer for the canvas
  126117. */
  126118. xrLayer: Nullable<XRWebGLLayer>;
  126119. /**
  126120. * Obseervers registered here will be triggered when the xr layer was initialized
  126121. */
  126122. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126123. /**
  126124. * Initializes the canvas to be added/removed upon entering/exiting xr
  126125. * @param _xrSessionManager The XR Session manager
  126126. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126127. */
  126128. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126129. /**
  126130. * Disposes of the object
  126131. */
  126132. dispose(): void;
  126133. /**
  126134. * Initializes the xr layer for the session
  126135. * @param xrSession xr session
  126136. * @returns a promise that will resolve once the XR Layer has been created
  126137. */
  126138. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126139. private _addCanvas;
  126140. private _removeCanvas;
  126141. private _setCanvasSize;
  126142. private _setManagedOutputCanvas;
  126143. }
  126144. }
  126145. declare module BABYLON {
  126146. /**
  126147. * Manages an XRSession to work with Babylon's engine
  126148. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126149. */
  126150. export class WebXRSessionManager implements IDisposable {
  126151. /** The scene which the session should be created for */
  126152. scene: Scene;
  126153. private _referenceSpace;
  126154. private _rttProvider;
  126155. private _sessionEnded;
  126156. private _xrNavigator;
  126157. private baseLayer;
  126158. /**
  126159. * The base reference space from which the session started. good if you want to reset your
  126160. * reference space
  126161. */
  126162. baseReferenceSpace: XRReferenceSpace;
  126163. /**
  126164. * Current XR frame
  126165. */
  126166. currentFrame: Nullable<XRFrame>;
  126167. /** WebXR timestamp updated every frame */
  126168. currentTimestamp: number;
  126169. /**
  126170. * Used just in case of a failure to initialize an immersive session.
  126171. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126172. */
  126173. defaultHeightCompensation: number;
  126174. /**
  126175. * Fires every time a new xrFrame arrives which can be used to update the camera
  126176. */
  126177. onXRFrameObservable: Observable<XRFrame>;
  126178. /**
  126179. * Fires when the reference space changed
  126180. */
  126181. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126182. /**
  126183. * Fires when the xr session is ended either by the device or manually done
  126184. */
  126185. onXRSessionEnded: Observable<any>;
  126186. /**
  126187. * Fires when the xr session is ended either by the device or manually done
  126188. */
  126189. onXRSessionInit: Observable<XRSession>;
  126190. /**
  126191. * Underlying xr session
  126192. */
  126193. session: XRSession;
  126194. /**
  126195. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126196. * or get the offset the player is currently at.
  126197. */
  126198. viewerReferenceSpace: XRReferenceSpace;
  126199. /**
  126200. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126201. * @param scene The scene which the session should be created for
  126202. */
  126203. constructor(
  126204. /** The scene which the session should be created for */
  126205. scene: Scene);
  126206. /**
  126207. * The current reference space used in this session. This reference space can constantly change!
  126208. * It is mainly used to offset the camera's position.
  126209. */
  126210. get referenceSpace(): XRReferenceSpace;
  126211. /**
  126212. * Set a new reference space and triggers the observable
  126213. */
  126214. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126215. /**
  126216. * Disposes of the session manager
  126217. */
  126218. dispose(): void;
  126219. /**
  126220. * Stops the xrSession and restores the render loop
  126221. * @returns Promise which resolves after it exits XR
  126222. */
  126223. exitXRAsync(): Promise<void>;
  126224. /**
  126225. * Gets the correct render target texture to be rendered this frame for this eye
  126226. * @param eye the eye for which to get the render target
  126227. * @returns the render target for the specified eye
  126228. */
  126229. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126230. /**
  126231. * Creates a WebXRRenderTarget object for the XR session
  126232. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126233. * @param options optional options to provide when creating a new render target
  126234. * @returns a WebXR render target to which the session can render
  126235. */
  126236. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126237. /**
  126238. * Initializes the manager
  126239. * After initialization enterXR can be called to start an XR session
  126240. * @returns Promise which resolves after it is initialized
  126241. */
  126242. initializeAsync(): Promise<void>;
  126243. /**
  126244. * Initializes an xr session
  126245. * @param xrSessionMode mode to initialize
  126246. * @param xrSessionInit defines optional and required values to pass to the session builder
  126247. * @returns a promise which will resolve once the session has been initialized
  126248. */
  126249. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126250. /**
  126251. * Checks if a session would be supported for the creation options specified
  126252. * @param sessionMode session mode to check if supported eg. immersive-vr
  126253. * @returns A Promise that resolves to true if supported and false if not
  126254. */
  126255. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126256. /**
  126257. * Resets the reference space to the one started the session
  126258. */
  126259. resetReferenceSpace(): void;
  126260. /**
  126261. * Starts rendering to the xr layer
  126262. */
  126263. runXRRenderLoop(): void;
  126264. /**
  126265. * Sets the reference space on the xr session
  126266. * @param referenceSpaceType space to set
  126267. * @returns a promise that will resolve once the reference space has been set
  126268. */
  126269. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126270. /**
  126271. * Updates the render state of the session
  126272. * @param state state to set
  126273. * @returns a promise that resolves once the render state has been updated
  126274. */
  126275. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126276. /**
  126277. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126278. * @param sessionMode defines the session to test
  126279. * @returns a promise with boolean as final value
  126280. */
  126281. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126282. private _createRenderTargetTexture;
  126283. }
  126284. }
  126285. declare module BABYLON {
  126286. /**
  126287. * WebXR Camera which holds the views for the xrSession
  126288. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126289. */
  126290. export class WebXRCamera extends FreeCamera {
  126291. private _xrSessionManager;
  126292. private _firstFrame;
  126293. private _referenceQuaternion;
  126294. private _referencedPosition;
  126295. private _xrInvPositionCache;
  126296. private _xrInvQuaternionCache;
  126297. /**
  126298. * Observable raised before camera teleportation
  126299. */
  126300. onBeforeCameraTeleport: Observable<Vector3>;
  126301. /**
  126302. * Observable raised after camera teleportation
  126303. */
  126304. onAfterCameraTeleport: Observable<Vector3>;
  126305. /**
  126306. * Should position compensation execute on first frame.
  126307. * This is used when copying the position from a native (non XR) camera
  126308. */
  126309. compensateOnFirstFrame: boolean;
  126310. /**
  126311. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126312. * @param name the name of the camera
  126313. * @param scene the scene to add the camera to
  126314. * @param _xrSessionManager a constructed xr session manager
  126315. */
  126316. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126317. /**
  126318. * Return the user's height, unrelated to the current ground.
  126319. * This will be the y position of this camera, when ground level is 0.
  126320. */
  126321. get realWorldHeight(): number;
  126322. /** @hidden */
  126323. _updateForDualEyeDebugging(): void;
  126324. /**
  126325. * Sets this camera's transformation based on a non-vr camera
  126326. * @param otherCamera the non-vr camera to copy the transformation from
  126327. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126328. */
  126329. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126330. /**
  126331. * Gets the current instance class name ("WebXRCamera").
  126332. * @returns the class name
  126333. */
  126334. getClassName(): string;
  126335. private _rotate180;
  126336. private _updateFromXRSession;
  126337. private _updateNumberOfRigCameras;
  126338. private _updateReferenceSpace;
  126339. private _updateReferenceSpaceOffset;
  126340. }
  126341. }
  126342. declare module BABYLON {
  126343. /**
  126344. * Defining the interface required for a (webxr) feature
  126345. */
  126346. export interface IWebXRFeature extends IDisposable {
  126347. /**
  126348. * Is this feature attached
  126349. */
  126350. attached: boolean;
  126351. /**
  126352. * Should auto-attach be disabled?
  126353. */
  126354. disableAutoAttach: boolean;
  126355. /**
  126356. * Attach the feature to the session
  126357. * Will usually be called by the features manager
  126358. *
  126359. * @param force should attachment be forced (even when already attached)
  126360. * @returns true if successful.
  126361. */
  126362. attach(force?: boolean): boolean;
  126363. /**
  126364. * Detach the feature from the session
  126365. * Will usually be called by the features manager
  126366. *
  126367. * @returns true if successful.
  126368. */
  126369. detach(): boolean;
  126370. /**
  126371. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126372. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126373. *
  126374. * @returns whether or not the feature is compatible in this environment
  126375. */
  126376. isCompatible(): boolean;
  126377. /**
  126378. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126379. */
  126380. xrNativeFeatureName?: string;
  126381. }
  126382. /**
  126383. * A list of the currently available features without referencing them
  126384. */
  126385. export class WebXRFeatureName {
  126386. /**
  126387. * The name of the anchor system feature
  126388. */
  126389. static ANCHOR_SYSTEM: string;
  126390. /**
  126391. * The name of the background remover feature
  126392. */
  126393. static BACKGROUND_REMOVER: string;
  126394. /**
  126395. * The name of the hit test feature
  126396. */
  126397. static HIT_TEST: string;
  126398. /**
  126399. * physics impostors for xr controllers feature
  126400. */
  126401. static PHYSICS_CONTROLLERS: string;
  126402. /**
  126403. * The name of the plane detection feature
  126404. */
  126405. static PLANE_DETECTION: string;
  126406. /**
  126407. * The name of the pointer selection feature
  126408. */
  126409. static POINTER_SELECTION: string;
  126410. /**
  126411. * The name of the teleportation feature
  126412. */
  126413. static TELEPORTATION: string;
  126414. }
  126415. /**
  126416. * Defining the constructor of a feature. Used to register the modules.
  126417. */
  126418. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126419. /**
  126420. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126421. * It is mainly used in AR sessions.
  126422. *
  126423. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126424. */
  126425. export class WebXRFeaturesManager implements IDisposable {
  126426. private _xrSessionManager;
  126427. private static readonly _AvailableFeatures;
  126428. private _features;
  126429. /**
  126430. * constructs a new features manages.
  126431. *
  126432. * @param _xrSessionManager an instance of WebXRSessionManager
  126433. */
  126434. constructor(_xrSessionManager: WebXRSessionManager);
  126435. /**
  126436. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126437. * Mainly used internally.
  126438. *
  126439. * @param featureName the name of the feature to register
  126440. * @param constructorFunction the function used to construct the module
  126441. * @param version the (babylon) version of the module
  126442. * @param stable is that a stable version of this module
  126443. */
  126444. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126445. /**
  126446. * Returns a constructor of a specific feature.
  126447. *
  126448. * @param featureName the name of the feature to construct
  126449. * @param version the version of the feature to load
  126450. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126451. * @param options optional options provided to the module.
  126452. * @returns a function that, when called, will return a new instance of this feature
  126453. */
  126454. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126455. /**
  126456. * Can be used to return the list of features currently registered
  126457. *
  126458. * @returns an Array of available features
  126459. */
  126460. static GetAvailableFeatures(): string[];
  126461. /**
  126462. * Gets the versions available for a specific feature
  126463. * @param featureName the name of the feature
  126464. * @returns an array with the available versions
  126465. */
  126466. static GetAvailableVersions(featureName: string): string[];
  126467. /**
  126468. * Return the latest unstable version of this feature
  126469. * @param featureName the name of the feature to search
  126470. * @returns the version number. if not found will return -1
  126471. */
  126472. static GetLatestVersionOfFeature(featureName: string): number;
  126473. /**
  126474. * Return the latest stable version of this feature
  126475. * @param featureName the name of the feature to search
  126476. * @returns the version number. if not found will return -1
  126477. */
  126478. static GetStableVersionOfFeature(featureName: string): number;
  126479. /**
  126480. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126481. * Can be used during a session to start a feature
  126482. * @param featureName the name of feature to attach
  126483. */
  126484. attachFeature(featureName: string): void;
  126485. /**
  126486. * Can be used inside a session or when the session ends to detach a specific feature
  126487. * @param featureName the name of the feature to detach
  126488. */
  126489. detachFeature(featureName: string): void;
  126490. /**
  126491. * Used to disable an already-enabled feature
  126492. * The feature will be disposed and will be recreated once enabled.
  126493. * @param featureName the feature to disable
  126494. * @returns true if disable was successful
  126495. */
  126496. disableFeature(featureName: string | {
  126497. Name: string;
  126498. }): boolean;
  126499. /**
  126500. * dispose this features manager
  126501. */
  126502. dispose(): void;
  126503. /**
  126504. * 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.
  126505. * 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.
  126506. *
  126507. * @param featureName the name of the feature to load or the class of the feature
  126508. * @param version optional version to load. if not provided the latest version will be enabled
  126509. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  126510. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  126511. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  126512. * @returns a new constructed feature or throws an error if feature not found.
  126513. */
  126514. enableFeature(featureName: string | {
  126515. Name: string;
  126516. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  126517. /**
  126518. * get the implementation of an enabled feature.
  126519. * @param featureName the name of the feature to load
  126520. * @returns the feature class, if found
  126521. */
  126522. getEnabledFeature(featureName: string): IWebXRFeature;
  126523. /**
  126524. * Get the list of enabled features
  126525. * @returns an array of enabled features
  126526. */
  126527. getEnabledFeatures(): string[];
  126528. /**
  126529. * This function will exten the session creation configuration object with enabled features.
  126530. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  126531. * according to the defined "required" variable, provided during enableFeature call
  126532. * @param xrSessionInit the xr Session init object to extend
  126533. *
  126534. * @returns an extended XRSessionInit object
  126535. */
  126536. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  126537. }
  126538. }
  126539. declare module BABYLON {
  126540. /**
  126541. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  126542. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  126543. */
  126544. export class WebXRExperienceHelper implements IDisposable {
  126545. private scene;
  126546. private _nonVRCamera;
  126547. private _originalSceneAutoClear;
  126548. private _supported;
  126549. /**
  126550. * Camera used to render xr content
  126551. */
  126552. camera: WebXRCamera;
  126553. /** A features manager for this xr session */
  126554. featuresManager: WebXRFeaturesManager;
  126555. /**
  126556. * Observers registered here will be triggered after the camera's initial transformation is set
  126557. * This can be used to set a different ground level or an extra rotation.
  126558. *
  126559. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  126560. * to the position set after this observable is done executing.
  126561. */
  126562. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  126563. /**
  126564. * Fires when the state of the experience helper has changed
  126565. */
  126566. onStateChangedObservable: Observable<WebXRState>;
  126567. /** Session manager used to keep track of xr session */
  126568. sessionManager: WebXRSessionManager;
  126569. /**
  126570. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  126571. */
  126572. state: WebXRState;
  126573. /**
  126574. * Creates a WebXRExperienceHelper
  126575. * @param scene The scene the helper should be created in
  126576. */
  126577. private constructor();
  126578. /**
  126579. * Creates the experience helper
  126580. * @param scene the scene to attach the experience helper to
  126581. * @returns a promise for the experience helper
  126582. */
  126583. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  126584. /**
  126585. * Disposes of the experience helper
  126586. */
  126587. dispose(): void;
  126588. /**
  126589. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  126590. * @param sessionMode options for the XR session
  126591. * @param referenceSpaceType frame of reference of the XR session
  126592. * @param renderTarget the output canvas that will be used to enter XR mode
  126593. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  126594. * @returns promise that resolves after xr mode has entered
  126595. */
  126596. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  126597. /**
  126598. * Exits XR mode and returns the scene to its original state
  126599. * @returns promise that resolves after xr mode has exited
  126600. */
  126601. exitXRAsync(): Promise<void>;
  126602. private _nonXRToXRCamera;
  126603. private _setState;
  126604. }
  126605. }
  126606. declare module BABYLON {
  126607. /**
  126608. * X-Y values for axes in WebXR
  126609. */
  126610. export interface IWebXRMotionControllerAxesValue {
  126611. /**
  126612. * The value of the x axis
  126613. */
  126614. x: number;
  126615. /**
  126616. * The value of the y-axis
  126617. */
  126618. y: number;
  126619. }
  126620. /**
  126621. * changed / previous values for the values of this component
  126622. */
  126623. export interface IWebXRMotionControllerComponentChangesValues<T> {
  126624. /**
  126625. * current (this frame) value
  126626. */
  126627. current: T;
  126628. /**
  126629. * previous (last change) value
  126630. */
  126631. previous: T;
  126632. }
  126633. /**
  126634. * Represents changes in the component between current frame and last values recorded
  126635. */
  126636. export interface IWebXRMotionControllerComponentChanges {
  126637. /**
  126638. * will be populated with previous and current values if axes changed
  126639. */
  126640. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  126641. /**
  126642. * will be populated with previous and current values if pressed changed
  126643. */
  126644. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  126645. /**
  126646. * will be populated with previous and current values if touched changed
  126647. */
  126648. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  126649. /**
  126650. * will be populated with previous and current values if value changed
  126651. */
  126652. value?: IWebXRMotionControllerComponentChangesValues<number>;
  126653. }
  126654. /**
  126655. * This class represents a single component (for example button or thumbstick) of a motion controller
  126656. */
  126657. export class WebXRControllerComponent implements IDisposable {
  126658. /**
  126659. * the id of this component
  126660. */
  126661. id: string;
  126662. /**
  126663. * the type of the component
  126664. */
  126665. type: MotionControllerComponentType;
  126666. private _buttonIndex;
  126667. private _axesIndices;
  126668. private _axes;
  126669. private _changes;
  126670. private _currentValue;
  126671. private _hasChanges;
  126672. private _pressed;
  126673. private _touched;
  126674. /**
  126675. * button component type
  126676. */
  126677. static BUTTON_TYPE: MotionControllerComponentType;
  126678. /**
  126679. * squeeze component type
  126680. */
  126681. static SQUEEZE_TYPE: MotionControllerComponentType;
  126682. /**
  126683. * Thumbstick component type
  126684. */
  126685. static THUMBSTICK_TYPE: MotionControllerComponentType;
  126686. /**
  126687. * Touchpad component type
  126688. */
  126689. static TOUCHPAD_TYPE: MotionControllerComponentType;
  126690. /**
  126691. * trigger component type
  126692. */
  126693. static TRIGGER_TYPE: MotionControllerComponentType;
  126694. /**
  126695. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  126696. * the axes data changes
  126697. */
  126698. onAxisValueChangedObservable: Observable<{
  126699. x: number;
  126700. y: number;
  126701. }>;
  126702. /**
  126703. * Observers registered here will be triggered when the state of a button changes
  126704. * State change is either pressed / touched / value
  126705. */
  126706. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  126707. /**
  126708. * Creates a new component for a motion controller.
  126709. * It is created by the motion controller itself
  126710. *
  126711. * @param id the id of this component
  126712. * @param type the type of the component
  126713. * @param _buttonIndex index in the buttons array of the gamepad
  126714. * @param _axesIndices indices of the values in the axes array of the gamepad
  126715. */
  126716. constructor(
  126717. /**
  126718. * the id of this component
  126719. */
  126720. id: string,
  126721. /**
  126722. * the type of the component
  126723. */
  126724. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  126725. /**
  126726. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  126727. */
  126728. get axes(): IWebXRMotionControllerAxesValue;
  126729. /**
  126730. * Get the changes. Elements will be populated only if they changed with their previous and current value
  126731. */
  126732. get changes(): IWebXRMotionControllerComponentChanges;
  126733. /**
  126734. * Return whether or not the component changed the last frame
  126735. */
  126736. get hasChanges(): boolean;
  126737. /**
  126738. * is the button currently pressed
  126739. */
  126740. get pressed(): boolean;
  126741. /**
  126742. * is the button currently touched
  126743. */
  126744. get touched(): boolean;
  126745. /**
  126746. * Get the current value of this component
  126747. */
  126748. get value(): number;
  126749. /**
  126750. * Dispose this component
  126751. */
  126752. dispose(): void;
  126753. /**
  126754. * Are there axes correlating to this component
  126755. * @return true is axes data is available
  126756. */
  126757. isAxes(): boolean;
  126758. /**
  126759. * Is this component a button (hence - pressable)
  126760. * @returns true if can be pressed
  126761. */
  126762. isButton(): boolean;
  126763. /**
  126764. * update this component using the gamepad object it is in. Called on every frame
  126765. * @param nativeController the native gamepad controller object
  126766. */
  126767. update(nativeController: IMinimalMotionControllerObject): void;
  126768. }
  126769. }
  126770. declare module BABYLON {
  126771. /**
  126772. * Interface used to represent data loading progression
  126773. */
  126774. export interface ISceneLoaderProgressEvent {
  126775. /**
  126776. * Defines if data length to load can be evaluated
  126777. */
  126778. readonly lengthComputable: boolean;
  126779. /**
  126780. * Defines the loaded data length
  126781. */
  126782. readonly loaded: number;
  126783. /**
  126784. * Defines the data length to load
  126785. */
  126786. readonly total: number;
  126787. }
  126788. /**
  126789. * Interface used by SceneLoader plugins to define supported file extensions
  126790. */
  126791. export interface ISceneLoaderPluginExtensions {
  126792. /**
  126793. * Defines the list of supported extensions
  126794. */
  126795. [extension: string]: {
  126796. isBinary: boolean;
  126797. };
  126798. }
  126799. /**
  126800. * Interface used by SceneLoader plugin factory
  126801. */
  126802. export interface ISceneLoaderPluginFactory {
  126803. /**
  126804. * Defines the name of the factory
  126805. */
  126806. name: string;
  126807. /**
  126808. * Function called to create a new plugin
  126809. * @return the new plugin
  126810. */
  126811. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  126812. /**
  126813. * The callback that returns true if the data can be directly loaded.
  126814. * @param data string containing the file data
  126815. * @returns if the data can be loaded directly
  126816. */
  126817. canDirectLoad?(data: string): boolean;
  126818. }
  126819. /**
  126820. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  126821. */
  126822. export interface ISceneLoaderPluginBase {
  126823. /**
  126824. * The friendly name of this plugin.
  126825. */
  126826. name: string;
  126827. /**
  126828. * The file extensions supported by this plugin.
  126829. */
  126830. extensions: string | ISceneLoaderPluginExtensions;
  126831. /**
  126832. * The callback called when loading from a url.
  126833. * @param scene scene loading this url
  126834. * @param url url to load
  126835. * @param onSuccess callback called when the file successfully loads
  126836. * @param onProgress callback called while file is loading (if the server supports this mode)
  126837. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  126838. * @param onError callback called when the file fails to load
  126839. * @returns a file request object
  126840. */
  126841. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  126842. /**
  126843. * The callback called when loading from a file object.
  126844. * @param scene scene loading this file
  126845. * @param file defines the file to load
  126846. * @param onSuccess defines the callback to call when data is loaded
  126847. * @param onProgress defines the callback to call during loading process
  126848. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  126849. * @param onError defines the callback to call when an error occurs
  126850. * @returns a file request object
  126851. */
  126852. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  126853. /**
  126854. * The callback that returns true if the data can be directly loaded.
  126855. * @param data string containing the file data
  126856. * @returns if the data can be loaded directly
  126857. */
  126858. canDirectLoad?(data: string): boolean;
  126859. /**
  126860. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  126861. * @param scene scene loading this data
  126862. * @param data string containing the data
  126863. * @returns data to pass to the plugin
  126864. */
  126865. directLoad?(scene: Scene, data: string): any;
  126866. /**
  126867. * The callback that allows custom handling of the root url based on the response url.
  126868. * @param rootUrl the original root url
  126869. * @param responseURL the response url if available
  126870. * @returns the new root url
  126871. */
  126872. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  126873. }
  126874. /**
  126875. * Interface used to define a SceneLoader plugin
  126876. */
  126877. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  126878. /**
  126879. * Import meshes into a scene.
  126880. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126881. * @param scene The scene to import into
  126882. * @param data The data to import
  126883. * @param rootUrl The root url for scene and resources
  126884. * @param meshes The meshes array to import into
  126885. * @param particleSystems The particle systems array to import into
  126886. * @param skeletons The skeletons array to import into
  126887. * @param onError The callback when import fails
  126888. * @returns True if successful or false otherwise
  126889. */
  126890. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  126891. /**
  126892. * Load into a scene.
  126893. * @param scene The scene to load into
  126894. * @param data The data to import
  126895. * @param rootUrl The root url for scene and resources
  126896. * @param onError The callback when import fails
  126897. * @returns True if successful or false otherwise
  126898. */
  126899. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  126900. /**
  126901. * Load into an asset container.
  126902. * @param scene The scene to load into
  126903. * @param data The data to import
  126904. * @param rootUrl The root url for scene and resources
  126905. * @param onError The callback when import fails
  126906. * @returns The loaded asset container
  126907. */
  126908. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  126909. }
  126910. /**
  126911. * Interface used to define an async SceneLoader plugin
  126912. */
  126913. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  126914. /**
  126915. * Import meshes into a scene.
  126916. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126917. * @param scene The scene to import into
  126918. * @param data The data to import
  126919. * @param rootUrl The root url for scene and resources
  126920. * @param onProgress The callback when the load progresses
  126921. * @param fileName Defines the name of the file to load
  126922. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  126923. */
  126924. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  126925. meshes: AbstractMesh[];
  126926. particleSystems: IParticleSystem[];
  126927. skeletons: Skeleton[];
  126928. animationGroups: AnimationGroup[];
  126929. }>;
  126930. /**
  126931. * Load into a scene.
  126932. * @param scene The scene to load into
  126933. * @param data The data to import
  126934. * @param rootUrl The root url for scene and resources
  126935. * @param onProgress The callback when the load progresses
  126936. * @param fileName Defines the name of the file to load
  126937. * @returns Nothing
  126938. */
  126939. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  126940. /**
  126941. * Load into an asset container.
  126942. * @param scene The scene to load into
  126943. * @param data The data to import
  126944. * @param rootUrl The root url for scene and resources
  126945. * @param onProgress The callback when the load progresses
  126946. * @param fileName Defines the name of the file to load
  126947. * @returns The loaded asset container
  126948. */
  126949. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  126950. }
  126951. /**
  126952. * Mode that determines how to handle old animation groups before loading new ones.
  126953. */
  126954. export enum SceneLoaderAnimationGroupLoadingMode {
  126955. /**
  126956. * Reset all old animations to initial state then dispose them.
  126957. */
  126958. Clean = 0,
  126959. /**
  126960. * Stop all old animations.
  126961. */
  126962. Stop = 1,
  126963. /**
  126964. * Restart old animations from first frame.
  126965. */
  126966. Sync = 2,
  126967. /**
  126968. * Old animations remains untouched.
  126969. */
  126970. NoSync = 3
  126971. }
  126972. /**
  126973. * Defines a plugin registered by the SceneLoader
  126974. */
  126975. interface IRegisteredPlugin {
  126976. /**
  126977. * Defines the plugin to use
  126978. */
  126979. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  126980. /**
  126981. * Defines if the plugin supports binary data
  126982. */
  126983. isBinary: boolean;
  126984. }
  126985. /**
  126986. * Class used to load scene from various file formats using registered plugins
  126987. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  126988. */
  126989. export class SceneLoader {
  126990. /**
  126991. * No logging while loading
  126992. */
  126993. static readonly NO_LOGGING: number;
  126994. /**
  126995. * Minimal logging while loading
  126996. */
  126997. static readonly MINIMAL_LOGGING: number;
  126998. /**
  126999. * Summary logging while loading
  127000. */
  127001. static readonly SUMMARY_LOGGING: number;
  127002. /**
  127003. * Detailled logging while loading
  127004. */
  127005. static readonly DETAILED_LOGGING: number;
  127006. /**
  127007. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127008. */
  127009. static get ForceFullSceneLoadingForIncremental(): boolean;
  127010. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127011. /**
  127012. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127013. */
  127014. static get ShowLoadingScreen(): boolean;
  127015. static set ShowLoadingScreen(value: boolean);
  127016. /**
  127017. * Defines the current logging level (while loading the scene)
  127018. * @ignorenaming
  127019. */
  127020. static get loggingLevel(): number;
  127021. static set loggingLevel(value: number);
  127022. /**
  127023. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127024. */
  127025. static get CleanBoneMatrixWeights(): boolean;
  127026. static set CleanBoneMatrixWeights(value: boolean);
  127027. /**
  127028. * Event raised when a plugin is used to load a scene
  127029. */
  127030. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127031. private static _registeredPlugins;
  127032. private static _showingLoadingScreen;
  127033. /**
  127034. * Gets the default plugin (used to load Babylon files)
  127035. * @returns the .babylon plugin
  127036. */
  127037. static GetDefaultPlugin(): IRegisteredPlugin;
  127038. private static _GetPluginForExtension;
  127039. private static _GetPluginForDirectLoad;
  127040. private static _GetPluginForFilename;
  127041. private static _GetDirectLoad;
  127042. private static _LoadData;
  127043. private static _GetFileInfo;
  127044. /**
  127045. * Gets a plugin that can load the given extension
  127046. * @param extension defines the extension to load
  127047. * @returns a plugin or null if none works
  127048. */
  127049. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127050. /**
  127051. * Gets a boolean indicating that the given extension can be loaded
  127052. * @param extension defines the extension to load
  127053. * @returns true if the extension is supported
  127054. */
  127055. static IsPluginForExtensionAvailable(extension: string): boolean;
  127056. /**
  127057. * Adds a new plugin to the list of registered plugins
  127058. * @param plugin defines the plugin to add
  127059. */
  127060. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127061. /**
  127062. * Import meshes into a scene
  127063. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127064. * @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)
  127065. * @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)
  127066. * @param scene the instance of BABYLON.Scene to append to
  127067. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127068. * @param onProgress a callback with a progress event for each file being loaded
  127069. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127070. * @param pluginExtension the extension used to determine the plugin
  127071. * @returns The loaded plugin
  127072. */
  127073. 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>;
  127074. /**
  127075. * Import meshes into a scene
  127076. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127077. * @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)
  127078. * @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)
  127079. * @param scene the instance of BABYLON.Scene to append to
  127080. * @param onProgress a callback with a progress event for each file being loaded
  127081. * @param pluginExtension the extension used to determine the plugin
  127082. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127083. */
  127084. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127085. meshes: AbstractMesh[];
  127086. particleSystems: IParticleSystem[];
  127087. skeletons: Skeleton[];
  127088. animationGroups: AnimationGroup[];
  127089. }>;
  127090. /**
  127091. * Load a scene
  127092. * @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)
  127093. * @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)
  127094. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127095. * @param onSuccess a callback with the scene when import succeeds
  127096. * @param onProgress a callback with a progress event for each file being loaded
  127097. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127098. * @param pluginExtension the extension used to determine the plugin
  127099. * @returns The loaded plugin
  127100. */
  127101. 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>;
  127102. /**
  127103. * Load a scene
  127104. * @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)
  127105. * @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)
  127106. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127107. * @param onProgress a callback with a progress event for each file being loaded
  127108. * @param pluginExtension the extension used to determine the plugin
  127109. * @returns The loaded scene
  127110. */
  127111. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127112. /**
  127113. * Append a scene
  127114. * @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)
  127115. * @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)
  127116. * @param scene is the instance of BABYLON.Scene to append to
  127117. * @param onSuccess a callback with the scene when import succeeds
  127118. * @param onProgress a callback with a progress event for each file being loaded
  127119. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127120. * @param pluginExtension the extension used to determine the plugin
  127121. * @returns The loaded plugin
  127122. */
  127123. 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>;
  127124. /**
  127125. * Append a scene
  127126. * @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)
  127127. * @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)
  127128. * @param scene is the instance of BABYLON.Scene to append to
  127129. * @param onProgress a callback with a progress event for each file being loaded
  127130. * @param pluginExtension the extension used to determine the plugin
  127131. * @returns The given scene
  127132. */
  127133. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127134. /**
  127135. * Load a scene into an asset container
  127136. * @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)
  127137. * @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)
  127138. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127139. * @param onSuccess a callback with the scene when import succeeds
  127140. * @param onProgress a callback with a progress event for each file being loaded
  127141. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127142. * @param pluginExtension the extension used to determine the plugin
  127143. * @returns The loaded plugin
  127144. */
  127145. 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>;
  127146. /**
  127147. * Load a scene into an asset container
  127148. * @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)
  127149. * @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)
  127150. * @param scene is the instance of Scene to append to
  127151. * @param onProgress a callback with a progress event for each file being loaded
  127152. * @param pluginExtension the extension used to determine the plugin
  127153. * @returns The loaded asset container
  127154. */
  127155. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127156. /**
  127157. * Import animations from a file into a scene
  127158. * @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)
  127159. * @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)
  127160. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127161. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127162. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127163. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127164. * @param onSuccess a callback with the scene when import succeeds
  127165. * @param onProgress a callback with a progress event for each file being loaded
  127166. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127167. * @param pluginExtension the extension used to determine the plugin
  127168. */
  127169. 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;
  127170. /**
  127171. * Import animations from a file into a scene
  127172. * @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)
  127173. * @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)
  127174. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127175. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127176. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127177. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127178. * @param onSuccess a callback with the scene when import succeeds
  127179. * @param onProgress a callback with a progress event for each file being loaded
  127180. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127181. * @param pluginExtension the extension used to determine the plugin
  127182. * @returns the updated scene with imported animations
  127183. */
  127184. 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>;
  127185. }
  127186. }
  127187. declare module BABYLON {
  127188. /**
  127189. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127190. */
  127191. export type MotionControllerHandedness = "none" | "left" | "right";
  127192. /**
  127193. * The type of components available in motion controllers.
  127194. * This is not the name of the component.
  127195. */
  127196. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127197. /**
  127198. * The state of a controller component
  127199. */
  127200. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127201. /**
  127202. * The schema of motion controller layout.
  127203. * No object will be initialized using this interface
  127204. * This is used just to define the profile.
  127205. */
  127206. export interface IMotionControllerLayout {
  127207. /**
  127208. * Path to load the assets. Usually relative to the base path
  127209. */
  127210. assetPath: string;
  127211. /**
  127212. * Available components (unsorted)
  127213. */
  127214. components: {
  127215. /**
  127216. * A map of component Ids
  127217. */
  127218. [componentId: string]: {
  127219. /**
  127220. * The type of input the component outputs
  127221. */
  127222. type: MotionControllerComponentType;
  127223. /**
  127224. * The indices of this component in the gamepad object
  127225. */
  127226. gamepadIndices: {
  127227. /**
  127228. * Index of button
  127229. */
  127230. button?: number;
  127231. /**
  127232. * If available, index of x-axis
  127233. */
  127234. xAxis?: number;
  127235. /**
  127236. * If available, index of y-axis
  127237. */
  127238. yAxis?: number;
  127239. };
  127240. /**
  127241. * The mesh's root node name
  127242. */
  127243. rootNodeName: string;
  127244. /**
  127245. * Animation definitions for this model
  127246. */
  127247. visualResponses: {
  127248. [stateKey: string]: {
  127249. /**
  127250. * What property will be animated
  127251. */
  127252. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127253. /**
  127254. * What states influence this visual response
  127255. */
  127256. states: MotionControllerComponentStateType[];
  127257. /**
  127258. * Type of animation - movement or visibility
  127259. */
  127260. valueNodeProperty: "transform" | "visibility";
  127261. /**
  127262. * Base node name to move. Its position will be calculated according to the min and max nodes
  127263. */
  127264. valueNodeName?: string;
  127265. /**
  127266. * Minimum movement node
  127267. */
  127268. minNodeName?: string;
  127269. /**
  127270. * Max movement node
  127271. */
  127272. maxNodeName?: string;
  127273. };
  127274. };
  127275. /**
  127276. * If touch enabled, what is the name of node to display user feedback
  127277. */
  127278. touchPointNodeName?: string;
  127279. };
  127280. };
  127281. /**
  127282. * Is it xr standard mapping or not
  127283. */
  127284. gamepadMapping: "" | "xr-standard";
  127285. /**
  127286. * Base root node of this entire model
  127287. */
  127288. rootNodeName: string;
  127289. /**
  127290. * Defines the main button component id
  127291. */
  127292. selectComponentId: string;
  127293. }
  127294. /**
  127295. * A definition for the layout map in the input profile
  127296. */
  127297. export interface IMotionControllerLayoutMap {
  127298. /**
  127299. * Layouts with handedness type as a key
  127300. */
  127301. [handedness: string]: IMotionControllerLayout;
  127302. }
  127303. /**
  127304. * The XR Input profile schema
  127305. * Profiles can be found here:
  127306. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127307. */
  127308. export interface IMotionControllerProfile {
  127309. /**
  127310. * fallback profiles for this profileId
  127311. */
  127312. fallbackProfileIds: string[];
  127313. /**
  127314. * The layout map, with handedness as key
  127315. */
  127316. layouts: IMotionControllerLayoutMap;
  127317. /**
  127318. * The id of this profile
  127319. * correlates to the profile(s) in the xrInput.profiles array
  127320. */
  127321. profileId: string;
  127322. }
  127323. /**
  127324. * A helper-interface for the 3 meshes needed for controller button animation
  127325. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127326. */
  127327. export interface IMotionControllerButtonMeshMap {
  127328. /**
  127329. * the mesh that defines the pressed value mesh position.
  127330. * This is used to find the max-position of this button
  127331. */
  127332. pressedMesh: AbstractMesh;
  127333. /**
  127334. * the mesh that defines the unpressed value mesh position.
  127335. * This is used to find the min (or initial) position of this button
  127336. */
  127337. unpressedMesh: AbstractMesh;
  127338. /**
  127339. * The mesh that will be changed when value changes
  127340. */
  127341. valueMesh: AbstractMesh;
  127342. }
  127343. /**
  127344. * A helper-interface for the 3 meshes needed for controller axis animation.
  127345. * This will be expanded when touchpad animations are fully supported
  127346. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127347. */
  127348. export interface IMotionControllerMeshMap {
  127349. /**
  127350. * the mesh that defines the maximum value mesh position.
  127351. */
  127352. maxMesh?: AbstractMesh;
  127353. /**
  127354. * the mesh that defines the minimum value mesh position.
  127355. */
  127356. minMesh?: AbstractMesh;
  127357. /**
  127358. * The mesh that will be changed when axis value changes
  127359. */
  127360. valueMesh: AbstractMesh;
  127361. }
  127362. /**
  127363. * The elements needed for change-detection of the gamepad objects in motion controllers
  127364. */
  127365. export interface IMinimalMotionControllerObject {
  127366. /**
  127367. * Available axes of this controller
  127368. */
  127369. axes: number[];
  127370. /**
  127371. * An array of available buttons
  127372. */
  127373. buttons: Array<{
  127374. /**
  127375. * Value of the button/trigger
  127376. */
  127377. value: number;
  127378. /**
  127379. * If the button/trigger is currently touched
  127380. */
  127381. touched: boolean;
  127382. /**
  127383. * If the button/trigger is currently pressed
  127384. */
  127385. pressed: boolean;
  127386. }>;
  127387. /**
  127388. * EXPERIMENTAL haptic support.
  127389. */
  127390. hapticActuators?: Array<{
  127391. pulse: (value: number, duration: number) => Promise<boolean>;
  127392. }>;
  127393. }
  127394. /**
  127395. * An Abstract Motion controller
  127396. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127397. * Each component has an observable to check for changes in value and state
  127398. */
  127399. export abstract class WebXRAbstractMotionController implements IDisposable {
  127400. protected scene: Scene;
  127401. protected layout: IMotionControllerLayout;
  127402. /**
  127403. * The gamepad object correlating to this controller
  127404. */
  127405. gamepadObject: IMinimalMotionControllerObject;
  127406. /**
  127407. * handedness (left/right/none) of this controller
  127408. */
  127409. handedness: MotionControllerHandedness;
  127410. private _initComponent;
  127411. private _modelReady;
  127412. /**
  127413. * A map of components (WebXRControllerComponent) in this motion controller
  127414. * Components have a ComponentType and can also have both button and axis definitions
  127415. */
  127416. readonly components: {
  127417. [id: string]: WebXRControllerComponent;
  127418. };
  127419. /**
  127420. * Disable the model's animation. Can be set at any time.
  127421. */
  127422. disableAnimation: boolean;
  127423. /**
  127424. * Observers registered here will be triggered when the model of this controller is done loading
  127425. */
  127426. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127427. /**
  127428. * The profile id of this motion controller
  127429. */
  127430. abstract profileId: string;
  127431. /**
  127432. * The root mesh of the model. It is null if the model was not yet initialized
  127433. */
  127434. rootMesh: Nullable<AbstractMesh>;
  127435. /**
  127436. * constructs a new abstract motion controller
  127437. * @param scene the scene to which the model of the controller will be added
  127438. * @param layout The profile layout to load
  127439. * @param gamepadObject The gamepad object correlating to this controller
  127440. * @param handedness handedness (left/right/none) of this controller
  127441. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127442. */
  127443. constructor(scene: Scene, layout: IMotionControllerLayout,
  127444. /**
  127445. * The gamepad object correlating to this controller
  127446. */
  127447. gamepadObject: IMinimalMotionControllerObject,
  127448. /**
  127449. * handedness (left/right/none) of this controller
  127450. */
  127451. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127452. /**
  127453. * Dispose this controller, the model mesh and all its components
  127454. */
  127455. dispose(): void;
  127456. /**
  127457. * Returns all components of specific type
  127458. * @param type the type to search for
  127459. * @return an array of components with this type
  127460. */
  127461. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127462. /**
  127463. * get a component based an its component id as defined in layout.components
  127464. * @param id the id of the component
  127465. * @returns the component correlates to the id or undefined if not found
  127466. */
  127467. getComponent(id: string): WebXRControllerComponent;
  127468. /**
  127469. * Get the list of components available in this motion controller
  127470. * @returns an array of strings correlating to available components
  127471. */
  127472. getComponentIds(): string[];
  127473. /**
  127474. * Get the first component of specific type
  127475. * @param type type of component to find
  127476. * @return a controller component or null if not found
  127477. */
  127478. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127479. /**
  127480. * Get the main (Select) component of this controller as defined in the layout
  127481. * @returns the main component of this controller
  127482. */
  127483. getMainComponent(): WebXRControllerComponent;
  127484. /**
  127485. * Loads the model correlating to this controller
  127486. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127487. * @returns A promise fulfilled with the result of the model loading
  127488. */
  127489. loadModel(): Promise<boolean>;
  127490. /**
  127491. * Update this model using the current XRFrame
  127492. * @param xrFrame the current xr frame to use and update the model
  127493. */
  127494. updateFromXRFrame(xrFrame: XRFrame): void;
  127495. /**
  127496. * Backwards compatibility due to a deeply-integrated typo
  127497. */
  127498. get handness(): XREye;
  127499. /**
  127500. * Pulse (vibrate) this controller
  127501. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127502. * Consecutive calls to this function will cancel the last pulse call
  127503. *
  127504. * @param value the strength of the pulse in 0.0...1.0 range
  127505. * @param duration Duration of the pulse in milliseconds
  127506. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  127507. * @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
  127508. */
  127509. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  127510. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  127511. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  127512. /**
  127513. * Moves the axis on the controller mesh based on its current state
  127514. * @param axis the index of the axis
  127515. * @param axisValue the value of the axis which determines the meshes new position
  127516. * @hidden
  127517. */
  127518. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  127519. /**
  127520. * Update the model itself with the current frame data
  127521. * @param xrFrame the frame to use for updating the model mesh
  127522. */
  127523. protected updateModel(xrFrame: XRFrame): void;
  127524. /**
  127525. * Get the filename and path for this controller's model
  127526. * @returns a map of filename and path
  127527. */
  127528. protected abstract _getFilenameAndPath(): {
  127529. filename: string;
  127530. path: string;
  127531. };
  127532. /**
  127533. * This function is called before the mesh is loaded. It checks for loading constraints.
  127534. * For example, this function can check if the GLB loader is available
  127535. * If this function returns false, the generic controller will be loaded instead
  127536. * @returns Is the client ready to load the mesh
  127537. */
  127538. protected abstract _getModelLoadingConstraints(): boolean;
  127539. /**
  127540. * This function will be called after the model was successfully loaded and can be used
  127541. * for mesh transformations before it is available for the user
  127542. * @param meshes the loaded meshes
  127543. */
  127544. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  127545. /**
  127546. * Set the root mesh for this controller. Important for the WebXR controller class
  127547. * @param meshes the loaded meshes
  127548. */
  127549. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  127550. /**
  127551. * A function executed each frame that updates the mesh (if needed)
  127552. * @param xrFrame the current xrFrame
  127553. */
  127554. protected abstract _updateModel(xrFrame: XRFrame): void;
  127555. private _getGenericFilenameAndPath;
  127556. private _getGenericParentMesh;
  127557. }
  127558. }
  127559. declare module BABYLON {
  127560. /**
  127561. * A generic trigger-only motion controller for WebXR
  127562. */
  127563. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  127564. /**
  127565. * Static version of the profile id of this controller
  127566. */
  127567. static ProfileId: string;
  127568. profileId: string;
  127569. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  127570. protected _getFilenameAndPath(): {
  127571. filename: string;
  127572. path: string;
  127573. };
  127574. protected _getModelLoadingConstraints(): boolean;
  127575. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  127576. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127577. protected _updateModel(): void;
  127578. }
  127579. }
  127580. declare module BABYLON {
  127581. /**
  127582. * Class containing static functions to help procedurally build meshes
  127583. */
  127584. export class SphereBuilder {
  127585. /**
  127586. * Creates a sphere mesh
  127587. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  127588. * * 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`)
  127589. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  127590. * * 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
  127591. * * 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)
  127592. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127593. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127594. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127595. * @param name defines the name of the mesh
  127596. * @param options defines the options used to create the mesh
  127597. * @param scene defines the hosting scene
  127598. * @returns the sphere mesh
  127599. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  127600. */
  127601. static CreateSphere(name: string, options: {
  127602. segments?: number;
  127603. diameter?: number;
  127604. diameterX?: number;
  127605. diameterY?: number;
  127606. diameterZ?: number;
  127607. arc?: number;
  127608. slice?: number;
  127609. sideOrientation?: number;
  127610. frontUVs?: Vector4;
  127611. backUVs?: Vector4;
  127612. updatable?: boolean;
  127613. }, scene?: Nullable<Scene>): Mesh;
  127614. }
  127615. }
  127616. declare module BABYLON {
  127617. /**
  127618. * A profiled motion controller has its profile loaded from an online repository.
  127619. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  127620. */
  127621. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  127622. private _repositoryUrl;
  127623. private _buttonMeshMapping;
  127624. private _touchDots;
  127625. /**
  127626. * The profile ID of this controller. Will be populated when the controller initializes.
  127627. */
  127628. profileId: string;
  127629. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  127630. dispose(): void;
  127631. protected _getFilenameAndPath(): {
  127632. filename: string;
  127633. path: string;
  127634. };
  127635. protected _getModelLoadingConstraints(): boolean;
  127636. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  127637. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127638. protected _updateModel(_xrFrame: XRFrame): void;
  127639. }
  127640. }
  127641. declare module BABYLON {
  127642. /**
  127643. * A construction function type to create a new controller based on an xrInput object
  127644. */
  127645. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  127646. /**
  127647. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  127648. *
  127649. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  127650. * it should be replaced with auto-loaded controllers.
  127651. *
  127652. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  127653. */
  127654. export class WebXRMotionControllerManager {
  127655. private static _AvailableControllers;
  127656. private static _Fallbacks;
  127657. private static _ProfileLoadingPromises;
  127658. private static _ProfilesList;
  127659. /**
  127660. * The base URL of the online controller repository. Can be changed at any time.
  127661. */
  127662. static BaseRepositoryUrl: string;
  127663. /**
  127664. * Which repository gets priority - local or online
  127665. */
  127666. static PrioritizeOnlineRepository: boolean;
  127667. /**
  127668. * Use the online repository, or use only locally-defined controllers
  127669. */
  127670. static UseOnlineRepository: boolean;
  127671. /**
  127672. * Clear the cache used for profile loading and reload when requested again
  127673. */
  127674. static ClearProfilesCache(): void;
  127675. /**
  127676. * Register the default fallbacks.
  127677. * This function is called automatically when this file is imported.
  127678. */
  127679. static DefaultFallbacks(): void;
  127680. /**
  127681. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  127682. * @param profileId the profile to which a fallback needs to be found
  127683. * @return an array with corresponding fallback profiles
  127684. */
  127685. static FindFallbackWithProfileId(profileId: string): string[];
  127686. /**
  127687. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  127688. * The order of search:
  127689. *
  127690. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  127691. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  127692. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  127693. * 4) return the generic trigger controller if none were found
  127694. *
  127695. * @param xrInput the xrInput to which a new controller is initialized
  127696. * @param scene the scene to which the model will be added
  127697. * @param forceProfile force a certain profile for this controller
  127698. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  127699. */
  127700. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  127701. /**
  127702. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  127703. *
  127704. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  127705. *
  127706. * @param type the profile type to register
  127707. * @param constructFunction the function to be called when loading this profile
  127708. */
  127709. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  127710. /**
  127711. * Register a fallback to a specific profile.
  127712. * @param profileId the profileId that will receive the fallbacks
  127713. * @param fallbacks A list of fallback profiles
  127714. */
  127715. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  127716. /**
  127717. * Will update the list of profiles available in the repository
  127718. * @return a promise that resolves to a map of profiles available online
  127719. */
  127720. static UpdateProfilesList(): Promise<{
  127721. [profile: string]: string;
  127722. }>;
  127723. private static _LoadProfileFromRepository;
  127724. private static _LoadProfilesFromAvailableControllers;
  127725. }
  127726. }
  127727. declare module BABYLON {
  127728. /**
  127729. * Configuration options for the WebXR controller creation
  127730. */
  127731. export interface IWebXRControllerOptions {
  127732. /**
  127733. * Should the controller mesh be animated when a user interacts with it
  127734. * The pressed buttons / thumbstick and touchpad animations will be disabled
  127735. */
  127736. disableMotionControllerAnimation?: boolean;
  127737. /**
  127738. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  127739. */
  127740. doNotLoadControllerMesh?: boolean;
  127741. /**
  127742. * Force a specific controller type for this controller.
  127743. * This can be used when creating your own profile or when testing different controllers
  127744. */
  127745. forceControllerProfile?: string;
  127746. /**
  127747. * Defines a rendering group ID for meshes that will be loaded.
  127748. * This is for the default controllers only.
  127749. */
  127750. renderingGroupId?: number;
  127751. }
  127752. /**
  127753. * Represents an XR controller
  127754. */
  127755. export class WebXRInputSource {
  127756. private _scene;
  127757. /** The underlying input source for the controller */
  127758. inputSource: XRInputSource;
  127759. private _options;
  127760. private _tmpVector;
  127761. private _uniqueId;
  127762. /**
  127763. * 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
  127764. */
  127765. grip?: AbstractMesh;
  127766. /**
  127767. * If available, this is the gamepad object related to this controller.
  127768. * Using this object it is possible to get click events and trackpad changes of the
  127769. * webxr controller that is currently being used.
  127770. */
  127771. motionController?: WebXRAbstractMotionController;
  127772. /**
  127773. * Event that fires when the controller is removed/disposed.
  127774. * The object provided as event data is this controller, after associated assets were disposed.
  127775. * uniqueId is still available.
  127776. */
  127777. onDisposeObservable: Observable<WebXRInputSource>;
  127778. /**
  127779. * Will be triggered when the mesh associated with the motion controller is done loading.
  127780. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  127781. * A shortened version of controller -> motion controller -> on mesh loaded.
  127782. */
  127783. onMeshLoadedObservable: Observable<AbstractMesh>;
  127784. /**
  127785. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  127786. */
  127787. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  127788. /**
  127789. * Pointer which can be used to select objects or attach a visible laser to
  127790. */
  127791. pointer: AbstractMesh;
  127792. /**
  127793. * Creates the input source object
  127794. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  127795. * @param _scene the scene which the controller should be associated to
  127796. * @param inputSource the underlying input source for the controller
  127797. * @param _options options for this controller creation
  127798. */
  127799. constructor(_scene: Scene,
  127800. /** The underlying input source for the controller */
  127801. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  127802. /**
  127803. * Get this controllers unique id
  127804. */
  127805. get uniqueId(): string;
  127806. /**
  127807. * Disposes of the object
  127808. */
  127809. dispose(): void;
  127810. /**
  127811. * Gets a world space ray coming from the pointer or grip
  127812. * @param result the resulting ray
  127813. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  127814. */
  127815. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  127816. /**
  127817. * Updates the controller pose based on the given XRFrame
  127818. * @param xrFrame xr frame to update the pose with
  127819. * @param referenceSpace reference space to use
  127820. */
  127821. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  127822. }
  127823. }
  127824. declare module BABYLON {
  127825. /**
  127826. * The schema for initialization options of the XR Input class
  127827. */
  127828. export interface IWebXRInputOptions {
  127829. /**
  127830. * If set to true no model will be automatically loaded
  127831. */
  127832. doNotLoadControllerMeshes?: boolean;
  127833. /**
  127834. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  127835. * If not found, the xr input profile data will be used.
  127836. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  127837. */
  127838. forceInputProfile?: string;
  127839. /**
  127840. * Do not send a request to the controller repository to load the profile.
  127841. *
  127842. * Instead, use the controllers available in babylon itself.
  127843. */
  127844. disableOnlineControllerRepository?: boolean;
  127845. /**
  127846. * A custom URL for the controllers repository
  127847. */
  127848. customControllersRepositoryURL?: string;
  127849. /**
  127850. * Should the controller model's components not move according to the user input
  127851. */
  127852. disableControllerAnimation?: boolean;
  127853. /**
  127854. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  127855. */
  127856. controllerOptions?: IWebXRControllerOptions;
  127857. }
  127858. /**
  127859. * XR input used to track XR inputs such as controllers/rays
  127860. */
  127861. export class WebXRInput implements IDisposable {
  127862. /**
  127863. * the xr session manager for this session
  127864. */
  127865. xrSessionManager: WebXRSessionManager;
  127866. /**
  127867. * the WebXR camera for this session. Mainly used for teleportation
  127868. */
  127869. xrCamera: WebXRCamera;
  127870. private readonly options;
  127871. /**
  127872. * XR controllers being tracked
  127873. */
  127874. controllers: Array<WebXRInputSource>;
  127875. private _frameObserver;
  127876. private _sessionEndedObserver;
  127877. private _sessionInitObserver;
  127878. /**
  127879. * Event when a controller has been connected/added
  127880. */
  127881. onControllerAddedObservable: Observable<WebXRInputSource>;
  127882. /**
  127883. * Event when a controller has been removed/disconnected
  127884. */
  127885. onControllerRemovedObservable: Observable<WebXRInputSource>;
  127886. /**
  127887. * Initializes the WebXRInput
  127888. * @param xrSessionManager the xr session manager for this session
  127889. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  127890. * @param options = initialization options for this xr input
  127891. */
  127892. constructor(
  127893. /**
  127894. * the xr session manager for this session
  127895. */
  127896. xrSessionManager: WebXRSessionManager,
  127897. /**
  127898. * the WebXR camera for this session. Mainly used for teleportation
  127899. */
  127900. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  127901. private _onInputSourcesChange;
  127902. private _addAndRemoveControllers;
  127903. /**
  127904. * Disposes of the object
  127905. */
  127906. dispose(): void;
  127907. }
  127908. }
  127909. declare module BABYLON {
  127910. /**
  127911. * This is the base class for all WebXR features.
  127912. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  127913. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  127914. */
  127915. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  127916. protected _xrSessionManager: WebXRSessionManager;
  127917. private _attached;
  127918. private _removeOnDetach;
  127919. /**
  127920. * Should auto-attach be disabled?
  127921. */
  127922. disableAutoAttach: boolean;
  127923. /**
  127924. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  127925. */
  127926. xrNativeFeatureName: string;
  127927. /**
  127928. * Construct a new (abstract) WebXR feature
  127929. * @param _xrSessionManager the xr session manager for this feature
  127930. */
  127931. constructor(_xrSessionManager: WebXRSessionManager);
  127932. /**
  127933. * Is this feature attached
  127934. */
  127935. get attached(): boolean;
  127936. /**
  127937. * attach this feature
  127938. *
  127939. * @param force should attachment be forced (even when already attached)
  127940. * @returns true if successful, false is failed or already attached
  127941. */
  127942. attach(force?: boolean): boolean;
  127943. /**
  127944. * detach this feature.
  127945. *
  127946. * @returns true if successful, false if failed or already detached
  127947. */
  127948. detach(): boolean;
  127949. /**
  127950. * Dispose this feature and all of the resources attached
  127951. */
  127952. dispose(): void;
  127953. /**
  127954. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  127955. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  127956. *
  127957. * @returns whether or not the feature is compatible in this environment
  127958. */
  127959. isCompatible(): boolean;
  127960. /**
  127961. * This is used to register callbacks that will automatically be removed when detach is called.
  127962. * @param observable the observable to which the observer will be attached
  127963. * @param callback the callback to register
  127964. */
  127965. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  127966. /**
  127967. * Code in this function will be executed on each xrFrame received from the browser.
  127968. * This function will not execute after the feature is detached.
  127969. * @param _xrFrame the current frame
  127970. */
  127971. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  127972. }
  127973. }
  127974. declare module BABYLON {
  127975. /**
  127976. * Renders a layer on top of an existing scene
  127977. */
  127978. export class UtilityLayerRenderer implements IDisposable {
  127979. /** the original scene that will be rendered on top of */
  127980. originalScene: Scene;
  127981. private _pointerCaptures;
  127982. private _lastPointerEvents;
  127983. private static _DefaultUtilityLayer;
  127984. private static _DefaultKeepDepthUtilityLayer;
  127985. private _sharedGizmoLight;
  127986. private _renderCamera;
  127987. /**
  127988. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  127989. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  127990. * @returns the camera that is used when rendering the utility layer
  127991. */
  127992. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  127993. /**
  127994. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  127995. * @param cam the camera that should be used when rendering the utility layer
  127996. */
  127997. setRenderCamera(cam: Nullable<Camera>): void;
  127998. /**
  127999. * @hidden
  128000. * Light which used by gizmos to get light shading
  128001. */
  128002. _getSharedGizmoLight(): HemisphericLight;
  128003. /**
  128004. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128005. */
  128006. pickUtilitySceneFirst: boolean;
  128007. /**
  128008. * 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)
  128009. */
  128010. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128011. /**
  128012. * 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)
  128013. */
  128014. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128015. /**
  128016. * The scene that is rendered on top of the original scene
  128017. */
  128018. utilityLayerScene: Scene;
  128019. /**
  128020. * If the utility layer should automatically be rendered on top of existing scene
  128021. */
  128022. shouldRender: boolean;
  128023. /**
  128024. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128025. */
  128026. onlyCheckPointerDownEvents: boolean;
  128027. /**
  128028. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128029. */
  128030. processAllEvents: boolean;
  128031. /**
  128032. * Observable raised when the pointer move from the utility layer scene to the main scene
  128033. */
  128034. onPointerOutObservable: Observable<number>;
  128035. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128036. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128037. private _afterRenderObserver;
  128038. private _sceneDisposeObserver;
  128039. private _originalPointerObserver;
  128040. /**
  128041. * Instantiates a UtilityLayerRenderer
  128042. * @param originalScene the original scene that will be rendered on top of
  128043. * @param handleEvents boolean indicating if the utility layer should handle events
  128044. */
  128045. constructor(
  128046. /** the original scene that will be rendered on top of */
  128047. originalScene: Scene, handleEvents?: boolean);
  128048. private _notifyObservers;
  128049. /**
  128050. * Renders the utility layers scene on top of the original scene
  128051. */
  128052. render(): void;
  128053. /**
  128054. * Disposes of the renderer
  128055. */
  128056. dispose(): void;
  128057. private _updateCamera;
  128058. }
  128059. }
  128060. declare module BABYLON {
  128061. /**
  128062. * Options interface for the pointer selection module
  128063. */
  128064. export interface IWebXRControllerPointerSelectionOptions {
  128065. /**
  128066. * if provided, this scene will be used to render meshes.
  128067. */
  128068. customUtilityLayerScene?: Scene;
  128069. /**
  128070. * 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)
  128071. * If not disabled, the last picked point will be used to execute a pointer up event
  128072. * If disabled, pointer up event will be triggered right after the pointer down event.
  128073. * Used in screen and gaze target ray mode only
  128074. */
  128075. disablePointerUpOnTouchOut: boolean;
  128076. /**
  128077. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128078. */
  128079. forceGazeMode: boolean;
  128080. /**
  128081. * 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
  128082. * to start a new countdown to the pointer down event.
  128083. * Defaults to 1.
  128084. */
  128085. gazeModePointerMovedFactor?: number;
  128086. /**
  128087. * Different button type to use instead of the main component
  128088. */
  128089. overrideButtonId?: string;
  128090. /**
  128091. * use this rendering group id for the meshes (optional)
  128092. */
  128093. renderingGroupId?: number;
  128094. /**
  128095. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128096. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128097. * 3000 means 3 seconds between pointing at something and selecting it
  128098. */
  128099. timeToSelect?: number;
  128100. /**
  128101. * Should meshes created here be added to a utility layer or the main scene
  128102. */
  128103. useUtilityLayer?: boolean;
  128104. /**
  128105. * Optional WebXR camera to be used for gaze selection
  128106. */
  128107. gazeCamera?: WebXRCamera;
  128108. /**
  128109. * the xr input to use with this pointer selection
  128110. */
  128111. xrInput: WebXRInput;
  128112. }
  128113. /**
  128114. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128115. */
  128116. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128117. private readonly _options;
  128118. private static _idCounter;
  128119. private _attachController;
  128120. private _controllers;
  128121. private _scene;
  128122. private _tmpVectorForPickCompare;
  128123. /**
  128124. * The module's name
  128125. */
  128126. static readonly Name: string;
  128127. /**
  128128. * The (Babylon) version of this module.
  128129. * This is an integer representing the implementation version.
  128130. * This number does not correspond to the WebXR specs version
  128131. */
  128132. static readonly Version: number;
  128133. /**
  128134. * Disable lighting on the laser pointer (so it will always be visible)
  128135. */
  128136. disablePointerLighting: boolean;
  128137. /**
  128138. * Disable lighting on the selection mesh (so it will always be visible)
  128139. */
  128140. disableSelectionMeshLighting: boolean;
  128141. /**
  128142. * Should the laser pointer be displayed
  128143. */
  128144. displayLaserPointer: boolean;
  128145. /**
  128146. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128147. */
  128148. displaySelectionMesh: boolean;
  128149. /**
  128150. * This color will be set to the laser pointer when selection is triggered
  128151. */
  128152. laserPointerPickedColor: Color3;
  128153. /**
  128154. * Default color of the laser pointer
  128155. */
  128156. laserPointerDefaultColor: Color3;
  128157. /**
  128158. * default color of the selection ring
  128159. */
  128160. selectionMeshDefaultColor: Color3;
  128161. /**
  128162. * This color will be applied to the selection ring when selection is triggered
  128163. */
  128164. selectionMeshPickedColor: Color3;
  128165. /**
  128166. * Optional filter to be used for ray selection. This predicate shares behavior with
  128167. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128168. */
  128169. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128170. /**
  128171. * constructs a new background remover module
  128172. * @param _xrSessionManager the session manager for this module
  128173. * @param _options read-only options to be used in this module
  128174. */
  128175. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128176. /**
  128177. * attach this feature
  128178. * Will usually be called by the features manager
  128179. *
  128180. * @returns true if successful.
  128181. */
  128182. attach(): boolean;
  128183. /**
  128184. * detach this feature.
  128185. * Will usually be called by the features manager
  128186. *
  128187. * @returns true if successful.
  128188. */
  128189. detach(): boolean;
  128190. /**
  128191. * Will get the mesh under a specific pointer.
  128192. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128193. * @param controllerId the controllerId to check
  128194. * @returns The mesh under pointer or null if no mesh is under the pointer
  128195. */
  128196. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128197. /**
  128198. * Get the xr controller that correlates to the pointer id in the pointer event
  128199. *
  128200. * @param id the pointer id to search for
  128201. * @returns the controller that correlates to this id or null if not found
  128202. */
  128203. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128204. protected _onXRFrame(_xrFrame: XRFrame): void;
  128205. private _attachGazeMode;
  128206. private _attachScreenRayMode;
  128207. private _attachTrackedPointerRayMode;
  128208. private _convertNormalToDirectionOfRay;
  128209. private _detachController;
  128210. private _generateNewMeshPair;
  128211. private _pickingMoved;
  128212. private _updatePointerDistance;
  128213. /** @hidden */
  128214. get lasterPointerDefaultColor(): Color3;
  128215. }
  128216. }
  128217. declare module BABYLON {
  128218. /**
  128219. * Button which can be used to enter a different mode of XR
  128220. */
  128221. export class WebXREnterExitUIButton {
  128222. /** button element */
  128223. element: HTMLElement;
  128224. /** XR initialization options for the button */
  128225. sessionMode: XRSessionMode;
  128226. /** Reference space type */
  128227. referenceSpaceType: XRReferenceSpaceType;
  128228. /**
  128229. * Creates a WebXREnterExitUIButton
  128230. * @param element button element
  128231. * @param sessionMode XR initialization session mode
  128232. * @param referenceSpaceType the type of reference space to be used
  128233. */
  128234. constructor(
  128235. /** button element */
  128236. element: HTMLElement,
  128237. /** XR initialization options for the button */
  128238. sessionMode: XRSessionMode,
  128239. /** Reference space type */
  128240. referenceSpaceType: XRReferenceSpaceType);
  128241. /**
  128242. * Extendable function which can be used to update the button's visuals when the state changes
  128243. * @param activeButton the current active button in the UI
  128244. */
  128245. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128246. }
  128247. /**
  128248. * Options to create the webXR UI
  128249. */
  128250. export class WebXREnterExitUIOptions {
  128251. /**
  128252. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128253. */
  128254. customButtons?: Array<WebXREnterExitUIButton>;
  128255. /**
  128256. * A reference space type to use when creating the default button.
  128257. * Default is local-floor
  128258. */
  128259. referenceSpaceType?: XRReferenceSpaceType;
  128260. /**
  128261. * Context to enter xr with
  128262. */
  128263. renderTarget?: Nullable<WebXRRenderTarget>;
  128264. /**
  128265. * A session mode to use when creating the default button.
  128266. * Default is immersive-vr
  128267. */
  128268. sessionMode?: XRSessionMode;
  128269. /**
  128270. * A list of optional features to init the session with
  128271. */
  128272. optionalFeatures?: string[];
  128273. /**
  128274. * A list of optional features to init the session with
  128275. */
  128276. requiredFeatures?: string[];
  128277. }
  128278. /**
  128279. * UI to allow the user to enter/exit XR mode
  128280. */
  128281. export class WebXREnterExitUI implements IDisposable {
  128282. private scene;
  128283. /** version of the options passed to this UI */
  128284. options: WebXREnterExitUIOptions;
  128285. private _activeButton;
  128286. private _buttons;
  128287. private _overlay;
  128288. /**
  128289. * Fired every time the active button is changed.
  128290. *
  128291. * When xr is entered via a button that launches xr that button will be the callback parameter
  128292. *
  128293. * When exiting xr the callback parameter will be null)
  128294. */
  128295. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128296. /**
  128297. *
  128298. * @param scene babylon scene object to use
  128299. * @param options (read-only) version of the options passed to this UI
  128300. */
  128301. private constructor();
  128302. /**
  128303. * Creates UI to allow the user to enter/exit XR mode
  128304. * @param scene the scene to add the ui to
  128305. * @param helper the xr experience helper to enter/exit xr with
  128306. * @param options options to configure the UI
  128307. * @returns the created ui
  128308. */
  128309. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128310. /**
  128311. * Disposes of the XR UI component
  128312. */
  128313. dispose(): void;
  128314. private _updateButtons;
  128315. }
  128316. }
  128317. declare module BABYLON {
  128318. /**
  128319. * Class containing static functions to help procedurally build meshes
  128320. */
  128321. export class LinesBuilder {
  128322. /**
  128323. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128324. * * 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
  128325. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128326. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128327. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128328. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128329. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128330. * * 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
  128331. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128332. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128333. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128334. * @param name defines the name of the new line system
  128335. * @param options defines the options used to create the line system
  128336. * @param scene defines the hosting scene
  128337. * @returns a new line system mesh
  128338. */
  128339. static CreateLineSystem(name: string, options: {
  128340. lines: Vector3[][];
  128341. updatable?: boolean;
  128342. instance?: Nullable<LinesMesh>;
  128343. colors?: Nullable<Color4[][]>;
  128344. useVertexAlpha?: boolean;
  128345. }, scene: Nullable<Scene>): LinesMesh;
  128346. /**
  128347. * Creates a line mesh
  128348. * 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
  128349. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128350. * * The parameter `points` is an array successive Vector3
  128351. * * 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
  128352. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128353. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128354. * * When updating an instance, remember that only point positions can change, not the number of points
  128355. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128356. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128357. * @param name defines the name of the new line system
  128358. * @param options defines the options used to create the line system
  128359. * @param scene defines the hosting scene
  128360. * @returns a new line mesh
  128361. */
  128362. static CreateLines(name: string, options: {
  128363. points: Vector3[];
  128364. updatable?: boolean;
  128365. instance?: Nullable<LinesMesh>;
  128366. colors?: Color4[];
  128367. useVertexAlpha?: boolean;
  128368. }, scene?: Nullable<Scene>): LinesMesh;
  128369. /**
  128370. * Creates a dashed line mesh
  128371. * * 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
  128372. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128373. * * The parameter `points` is an array successive Vector3
  128374. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128375. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128376. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128377. * * 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
  128378. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128379. * * When updating an instance, remember that only point positions can change, not the number of points
  128380. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128381. * @param name defines the name of the mesh
  128382. * @param options defines the options used to create the mesh
  128383. * @param scene defines the hosting scene
  128384. * @returns the dashed line mesh
  128385. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128386. */
  128387. static CreateDashedLines(name: string, options: {
  128388. points: Vector3[];
  128389. dashSize?: number;
  128390. gapSize?: number;
  128391. dashNb?: number;
  128392. updatable?: boolean;
  128393. instance?: LinesMesh;
  128394. useVertexAlpha?: boolean;
  128395. }, scene?: Nullable<Scene>): LinesMesh;
  128396. }
  128397. }
  128398. declare module BABYLON {
  128399. /**
  128400. * Construction options for a timer
  128401. */
  128402. export interface ITimerOptions<T> {
  128403. /**
  128404. * Time-to-end
  128405. */
  128406. timeout: number;
  128407. /**
  128408. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128409. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128410. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128411. */
  128412. contextObservable: Observable<T>;
  128413. /**
  128414. * Optional parameters when adding an observer to the observable
  128415. */
  128416. observableParameters?: {
  128417. mask?: number;
  128418. insertFirst?: boolean;
  128419. scope?: any;
  128420. };
  128421. /**
  128422. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128423. */
  128424. breakCondition?: (data?: ITimerData<T>) => boolean;
  128425. /**
  128426. * Will be triggered when the time condition has met
  128427. */
  128428. onEnded?: (data: ITimerData<any>) => void;
  128429. /**
  128430. * Will be triggered when the break condition has met (prematurely ended)
  128431. */
  128432. onAborted?: (data: ITimerData<any>) => void;
  128433. /**
  128434. * Optional function to execute on each tick (or count)
  128435. */
  128436. onTick?: (data: ITimerData<any>) => void;
  128437. }
  128438. /**
  128439. * An interface defining the data sent by the timer
  128440. */
  128441. export interface ITimerData<T> {
  128442. /**
  128443. * When did it start
  128444. */
  128445. startTime: number;
  128446. /**
  128447. * Time now
  128448. */
  128449. currentTime: number;
  128450. /**
  128451. * Time passed since started
  128452. */
  128453. deltaTime: number;
  128454. /**
  128455. * How much is completed, in [0.0...1.0].
  128456. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128457. */
  128458. completeRate: number;
  128459. /**
  128460. * What the registered observable sent in the last count
  128461. */
  128462. payload: T;
  128463. }
  128464. /**
  128465. * The current state of the timer
  128466. */
  128467. export enum TimerState {
  128468. /**
  128469. * Timer initialized, not yet started
  128470. */
  128471. INIT = 0,
  128472. /**
  128473. * Timer started and counting
  128474. */
  128475. STARTED = 1,
  128476. /**
  128477. * Timer ended (whether aborted or time reached)
  128478. */
  128479. ENDED = 2
  128480. }
  128481. /**
  128482. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128483. *
  128484. * @param options options with which to initialize this timer
  128485. */
  128486. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128487. /**
  128488. * An advanced implementation of a timer class
  128489. */
  128490. export class AdvancedTimer<T = any> implements IDisposable {
  128491. /**
  128492. * Will notify each time the timer calculates the remaining time
  128493. */
  128494. onEachCountObservable: Observable<ITimerData<T>>;
  128495. /**
  128496. * Will trigger when the timer was aborted due to the break condition
  128497. */
  128498. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128499. /**
  128500. * Will trigger when the timer ended successfully
  128501. */
  128502. onTimerEndedObservable: Observable<ITimerData<T>>;
  128503. /**
  128504. * Will trigger when the timer state has changed
  128505. */
  128506. onStateChangedObservable: Observable<TimerState>;
  128507. private _observer;
  128508. private _contextObservable;
  128509. private _observableParameters;
  128510. private _startTime;
  128511. private _timer;
  128512. private _state;
  128513. private _breakCondition;
  128514. private _timeToEnd;
  128515. private _breakOnNextTick;
  128516. /**
  128517. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  128518. * @param options construction options for this advanced timer
  128519. */
  128520. constructor(options: ITimerOptions<T>);
  128521. /**
  128522. * set a breaking condition for this timer. Default is to never break during count
  128523. * @param predicate the new break condition. Returns true to break, false otherwise
  128524. */
  128525. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  128526. /**
  128527. * Reset ALL associated observables in this advanced timer
  128528. */
  128529. clearObservables(): void;
  128530. /**
  128531. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  128532. *
  128533. * @param timeToEnd how much time to measure until timer ended
  128534. */
  128535. start(timeToEnd?: number): void;
  128536. /**
  128537. * Will force a stop on the next tick.
  128538. */
  128539. stop(): void;
  128540. /**
  128541. * Dispose this timer, clearing all resources
  128542. */
  128543. dispose(): void;
  128544. private _setState;
  128545. private _tick;
  128546. private _stop;
  128547. }
  128548. }
  128549. declare module BABYLON {
  128550. /**
  128551. * The options container for the teleportation module
  128552. */
  128553. export interface IWebXRTeleportationOptions {
  128554. /**
  128555. * if provided, this scene will be used to render meshes.
  128556. */
  128557. customUtilityLayerScene?: Scene;
  128558. /**
  128559. * Values to configure the default target mesh
  128560. */
  128561. defaultTargetMeshOptions?: {
  128562. /**
  128563. * Fill color of the teleportation area
  128564. */
  128565. teleportationFillColor?: string;
  128566. /**
  128567. * Border color for the teleportation area
  128568. */
  128569. teleportationBorderColor?: string;
  128570. /**
  128571. * Disable the mesh's animation sequence
  128572. */
  128573. disableAnimation?: boolean;
  128574. /**
  128575. * Disable lighting on the material or the ring and arrow
  128576. */
  128577. disableLighting?: boolean;
  128578. /**
  128579. * Override the default material of the torus and arrow
  128580. */
  128581. torusArrowMaterial?: Material;
  128582. };
  128583. /**
  128584. * A list of meshes to use as floor meshes.
  128585. * Meshes can be added and removed after initializing the feature using the
  128586. * addFloorMesh and removeFloorMesh functions
  128587. * If empty, rotation will still work
  128588. */
  128589. floorMeshes?: AbstractMesh[];
  128590. /**
  128591. * use this rendering group id for the meshes (optional)
  128592. */
  128593. renderingGroupId?: number;
  128594. /**
  128595. * Should teleportation move only to snap points
  128596. */
  128597. snapPointsOnly?: boolean;
  128598. /**
  128599. * An array of points to which the teleportation will snap to.
  128600. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  128601. */
  128602. snapPositions?: Vector3[];
  128603. /**
  128604. * How close should the teleportation ray be in order to snap to position.
  128605. * Default to 0.8 units (meters)
  128606. */
  128607. snapToPositionRadius?: number;
  128608. /**
  128609. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  128610. * If you want to support rotation, make sure your mesh has a direction indicator.
  128611. *
  128612. * When left untouched, the default mesh will be initialized.
  128613. */
  128614. teleportationTargetMesh?: AbstractMesh;
  128615. /**
  128616. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  128617. */
  128618. timeToTeleport?: number;
  128619. /**
  128620. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  128621. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  128622. */
  128623. useMainComponentOnly?: boolean;
  128624. /**
  128625. * Should meshes created here be added to a utility layer or the main scene
  128626. */
  128627. useUtilityLayer?: boolean;
  128628. /**
  128629. * Babylon XR Input class for controller
  128630. */
  128631. xrInput: WebXRInput;
  128632. }
  128633. /**
  128634. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  128635. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  128636. * the input of the attached controllers.
  128637. */
  128638. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  128639. private _options;
  128640. private _controllers;
  128641. private _currentTeleportationControllerId;
  128642. private _floorMeshes;
  128643. private _quadraticBezierCurve;
  128644. private _selectionFeature;
  128645. private _snapToPositions;
  128646. private _snappedToPoint;
  128647. private _teleportationRingMaterial?;
  128648. private _tmpRay;
  128649. private _tmpVector;
  128650. /**
  128651. * The module's name
  128652. */
  128653. static readonly Name: string;
  128654. /**
  128655. * The (Babylon) version of this module.
  128656. * This is an integer representing the implementation version.
  128657. * This number does not correspond to the webxr specs version
  128658. */
  128659. static readonly Version: number;
  128660. /**
  128661. * Is movement backwards enabled
  128662. */
  128663. backwardsMovementEnabled: boolean;
  128664. /**
  128665. * Distance to travel when moving backwards
  128666. */
  128667. backwardsTeleportationDistance: number;
  128668. /**
  128669. * The distance from the user to the inspection point in the direction of the controller
  128670. * A higher number will allow the user to move further
  128671. * defaults to 5 (meters, in xr units)
  128672. */
  128673. parabolicCheckRadius: number;
  128674. /**
  128675. * Should the module support parabolic ray on top of direct ray
  128676. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  128677. * Very helpful when moving between floors / different heights
  128678. */
  128679. parabolicRayEnabled: boolean;
  128680. /**
  128681. * How much rotation should be applied when rotating right and left
  128682. */
  128683. rotationAngle: number;
  128684. /**
  128685. * Is rotation enabled when moving forward?
  128686. * Disabling this feature will prevent the user from deciding the direction when teleporting
  128687. */
  128688. rotationEnabled: boolean;
  128689. /**
  128690. * constructs a new anchor system
  128691. * @param _xrSessionManager an instance of WebXRSessionManager
  128692. * @param _options configuration object for this feature
  128693. */
  128694. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  128695. /**
  128696. * Get the snapPointsOnly flag
  128697. */
  128698. get snapPointsOnly(): boolean;
  128699. /**
  128700. * Sets the snapPointsOnly flag
  128701. * @param snapToPoints should teleportation be exclusively to snap points
  128702. */
  128703. set snapPointsOnly(snapToPoints: boolean);
  128704. /**
  128705. * Add a new mesh to the floor meshes array
  128706. * @param mesh the mesh to use as floor mesh
  128707. */
  128708. addFloorMesh(mesh: AbstractMesh): void;
  128709. /**
  128710. * Add a new snap-to point to fix teleportation to this position
  128711. * @param newSnapPoint The new Snap-To point
  128712. */
  128713. addSnapPoint(newSnapPoint: Vector3): void;
  128714. attach(): boolean;
  128715. detach(): boolean;
  128716. dispose(): void;
  128717. /**
  128718. * Remove a mesh from the floor meshes array
  128719. * @param mesh the mesh to remove
  128720. */
  128721. removeFloorMesh(mesh: AbstractMesh): void;
  128722. /**
  128723. * Remove a mesh from the floor meshes array using its name
  128724. * @param name the mesh name to remove
  128725. */
  128726. removeFloorMeshByName(name: string): void;
  128727. /**
  128728. * 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
  128729. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  128730. * @returns was the point found and removed or not
  128731. */
  128732. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  128733. /**
  128734. * This function sets a selection feature that will be disabled when
  128735. * the forward ray is shown and will be reattached when hidden.
  128736. * This is used to remove the selection rays when moving.
  128737. * @param selectionFeature the feature to disable when forward movement is enabled
  128738. */
  128739. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  128740. protected _onXRFrame(_xrFrame: XRFrame): void;
  128741. private _attachController;
  128742. private _createDefaultTargetMesh;
  128743. private _detachController;
  128744. private _findClosestSnapPointWithRadius;
  128745. private _setTargetMeshPosition;
  128746. private _setTargetMeshVisibility;
  128747. private _showParabolicPath;
  128748. private _teleportForward;
  128749. }
  128750. }
  128751. declare module BABYLON {
  128752. /**
  128753. * Options for the default xr helper
  128754. */
  128755. export class WebXRDefaultExperienceOptions {
  128756. /**
  128757. * Enable or disable default UI to enter XR
  128758. */
  128759. disableDefaultUI?: boolean;
  128760. /**
  128761. * Should teleportation not initialize. defaults to false.
  128762. */
  128763. disableTeleportation?: boolean;
  128764. /**
  128765. * Floor meshes that will be used for teleport
  128766. */
  128767. floorMeshes?: Array<AbstractMesh>;
  128768. /**
  128769. * If set to true, the first frame will not be used to reset position
  128770. * The first frame is mainly used when copying transformation from the old camera
  128771. * Mainly used in AR
  128772. */
  128773. ignoreNativeCameraTransformation?: boolean;
  128774. /**
  128775. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  128776. */
  128777. inputOptions?: IWebXRInputOptions;
  128778. /**
  128779. * optional configuration for the output canvas
  128780. */
  128781. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  128782. /**
  128783. * optional UI options. This can be used among other to change session mode and reference space type
  128784. */
  128785. uiOptions?: WebXREnterExitUIOptions;
  128786. /**
  128787. * When loading teleportation and pointer select, use stable versions instead of latest.
  128788. */
  128789. useStablePlugins?: boolean;
  128790. /**
  128791. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  128792. */
  128793. renderingGroupId?: number;
  128794. /**
  128795. * A list of optional features to init the session with
  128796. * If set to true, all features we support will be added
  128797. */
  128798. optionalFeatures?: boolean | string[];
  128799. }
  128800. /**
  128801. * Default experience which provides a similar setup to the previous webVRExperience
  128802. */
  128803. export class WebXRDefaultExperience {
  128804. /**
  128805. * Base experience
  128806. */
  128807. baseExperience: WebXRExperienceHelper;
  128808. /**
  128809. * Enables ui for entering/exiting xr
  128810. */
  128811. enterExitUI: WebXREnterExitUI;
  128812. /**
  128813. * Input experience extension
  128814. */
  128815. input: WebXRInput;
  128816. /**
  128817. * Enables laser pointer and selection
  128818. */
  128819. pointerSelection: WebXRControllerPointerSelection;
  128820. /**
  128821. * Default target xr should render to
  128822. */
  128823. renderTarget: WebXRRenderTarget;
  128824. /**
  128825. * Enables teleportation
  128826. */
  128827. teleportation: WebXRMotionControllerTeleportation;
  128828. private constructor();
  128829. /**
  128830. * Creates the default xr experience
  128831. * @param scene scene
  128832. * @param options options for basic configuration
  128833. * @returns resulting WebXRDefaultExperience
  128834. */
  128835. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  128836. /**
  128837. * DIsposes of the experience helper
  128838. */
  128839. dispose(): void;
  128840. }
  128841. }
  128842. declare module BABYLON {
  128843. /**
  128844. * Options to modify the vr teleportation behavior.
  128845. */
  128846. export interface VRTeleportationOptions {
  128847. /**
  128848. * The name of the mesh which should be used as the teleportation floor. (default: null)
  128849. */
  128850. floorMeshName?: string;
  128851. /**
  128852. * A list of meshes to be used as the teleportation floor. (default: empty)
  128853. */
  128854. floorMeshes?: Mesh[];
  128855. /**
  128856. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  128857. */
  128858. teleportationMode?: number;
  128859. /**
  128860. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  128861. */
  128862. teleportationTime?: number;
  128863. /**
  128864. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  128865. */
  128866. teleportationSpeed?: number;
  128867. /**
  128868. * The easing function used in the animation or null for Linear. (default CircleEase)
  128869. */
  128870. easingFunction?: EasingFunction;
  128871. }
  128872. /**
  128873. * Options to modify the vr experience helper's behavior.
  128874. */
  128875. export interface VRExperienceHelperOptions extends WebVROptions {
  128876. /**
  128877. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  128878. */
  128879. createDeviceOrientationCamera?: boolean;
  128880. /**
  128881. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  128882. */
  128883. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  128884. /**
  128885. * Uses the main button on the controller to toggle the laser casted. (default: true)
  128886. */
  128887. laserToggle?: boolean;
  128888. /**
  128889. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  128890. */
  128891. floorMeshes?: Mesh[];
  128892. /**
  128893. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  128894. */
  128895. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  128896. /**
  128897. * Defines if WebXR should be used instead of WebVR (if available)
  128898. */
  128899. useXR?: boolean;
  128900. }
  128901. /**
  128902. * Event containing information after VR has been entered
  128903. */
  128904. export class OnAfterEnteringVRObservableEvent {
  128905. /**
  128906. * If entering vr was successful
  128907. */
  128908. success: boolean;
  128909. }
  128910. /**
  128911. * Helps to quickly add VR support to an existing scene.
  128912. * See https://doc.babylonjs.com/how_to/webvr_helper
  128913. */
  128914. export class VRExperienceHelper {
  128915. /** Options to modify the vr experience helper's behavior. */
  128916. webVROptions: VRExperienceHelperOptions;
  128917. private _scene;
  128918. private _position;
  128919. private _btnVR;
  128920. private _btnVRDisplayed;
  128921. private _webVRsupported;
  128922. private _webVRready;
  128923. private _webVRrequesting;
  128924. private _webVRpresenting;
  128925. private _hasEnteredVR;
  128926. private _fullscreenVRpresenting;
  128927. private _inputElement;
  128928. private _webVRCamera;
  128929. private _vrDeviceOrientationCamera;
  128930. private _deviceOrientationCamera;
  128931. private _existingCamera;
  128932. private _onKeyDown;
  128933. private _onVrDisplayPresentChange;
  128934. private _onVRDisplayChanged;
  128935. private _onVRRequestPresentStart;
  128936. private _onVRRequestPresentComplete;
  128937. /**
  128938. * 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)
  128939. */
  128940. enableGazeEvenWhenNoPointerLock: boolean;
  128941. /**
  128942. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  128943. */
  128944. exitVROnDoubleTap: boolean;
  128945. /**
  128946. * Observable raised right before entering VR.
  128947. */
  128948. onEnteringVRObservable: Observable<VRExperienceHelper>;
  128949. /**
  128950. * Observable raised when entering VR has completed.
  128951. */
  128952. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  128953. /**
  128954. * Observable raised when exiting VR.
  128955. */
  128956. onExitingVRObservable: Observable<VRExperienceHelper>;
  128957. /**
  128958. * Observable raised when controller mesh is loaded.
  128959. */
  128960. onControllerMeshLoadedObservable: Observable<WebVRController>;
  128961. /** Return this.onEnteringVRObservable
  128962. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  128963. */
  128964. get onEnteringVR(): Observable<VRExperienceHelper>;
  128965. /** Return this.onExitingVRObservable
  128966. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  128967. */
  128968. get onExitingVR(): Observable<VRExperienceHelper>;
  128969. /** Return this.onControllerMeshLoadedObservable
  128970. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  128971. */
  128972. get onControllerMeshLoaded(): Observable<WebVRController>;
  128973. private _rayLength;
  128974. private _useCustomVRButton;
  128975. private _teleportationRequested;
  128976. private _teleportActive;
  128977. private _floorMeshName;
  128978. private _floorMeshesCollection;
  128979. private _teleportationMode;
  128980. private _teleportationTime;
  128981. private _teleportationSpeed;
  128982. private _teleportationEasing;
  128983. private _rotationAllowed;
  128984. private _teleportBackwardsVector;
  128985. private _teleportationTarget;
  128986. private _isDefaultTeleportationTarget;
  128987. private _postProcessMove;
  128988. private _teleportationFillColor;
  128989. private _teleportationBorderColor;
  128990. private _rotationAngle;
  128991. private _haloCenter;
  128992. private _cameraGazer;
  128993. private _padSensibilityUp;
  128994. private _padSensibilityDown;
  128995. private _leftController;
  128996. private _rightController;
  128997. private _gazeColor;
  128998. private _laserColor;
  128999. private _pickedLaserColor;
  129000. private _pickedGazeColor;
  129001. /**
  129002. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129003. */
  129004. onNewMeshSelected: Observable<AbstractMesh>;
  129005. /**
  129006. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129007. * This observable will provide the mesh and the controller used to select the mesh
  129008. */
  129009. onMeshSelectedWithController: Observable<{
  129010. mesh: AbstractMesh;
  129011. controller: WebVRController;
  129012. }>;
  129013. /**
  129014. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129015. */
  129016. onNewMeshPicked: Observable<PickingInfo>;
  129017. private _circleEase;
  129018. /**
  129019. * Observable raised before camera teleportation
  129020. */
  129021. onBeforeCameraTeleport: Observable<Vector3>;
  129022. /**
  129023. * Observable raised after camera teleportation
  129024. */
  129025. onAfterCameraTeleport: Observable<Vector3>;
  129026. /**
  129027. * Observable raised when current selected mesh gets unselected
  129028. */
  129029. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129030. private _raySelectionPredicate;
  129031. /**
  129032. * To be optionaly changed by user to define custom ray selection
  129033. */
  129034. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129035. /**
  129036. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129037. */
  129038. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129039. /**
  129040. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129041. */
  129042. teleportationEnabled: boolean;
  129043. private _defaultHeight;
  129044. private _teleportationInitialized;
  129045. private _interactionsEnabled;
  129046. private _interactionsRequested;
  129047. private _displayGaze;
  129048. private _displayLaserPointer;
  129049. /**
  129050. * The mesh used to display where the user is going to teleport.
  129051. */
  129052. get teleportationTarget(): Mesh;
  129053. /**
  129054. * Sets the mesh to be used to display where the user is going to teleport.
  129055. */
  129056. set teleportationTarget(value: Mesh);
  129057. /**
  129058. * 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
  129059. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129060. * See https://doc.babylonjs.com/resources/baking_transformations
  129061. */
  129062. get gazeTrackerMesh(): Mesh;
  129063. set gazeTrackerMesh(value: Mesh);
  129064. /**
  129065. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129066. */
  129067. updateGazeTrackerScale: boolean;
  129068. /**
  129069. * If the gaze trackers color should be updated when selecting meshes
  129070. */
  129071. updateGazeTrackerColor: boolean;
  129072. /**
  129073. * If the controller laser color should be updated when selecting meshes
  129074. */
  129075. updateControllerLaserColor: boolean;
  129076. /**
  129077. * The gaze tracking mesh corresponding to the left controller
  129078. */
  129079. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129080. /**
  129081. * The gaze tracking mesh corresponding to the right controller
  129082. */
  129083. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129084. /**
  129085. * If the ray of the gaze should be displayed.
  129086. */
  129087. get displayGaze(): boolean;
  129088. /**
  129089. * Sets if the ray of the gaze should be displayed.
  129090. */
  129091. set displayGaze(value: boolean);
  129092. /**
  129093. * If the ray of the LaserPointer should be displayed.
  129094. */
  129095. get displayLaserPointer(): boolean;
  129096. /**
  129097. * Sets if the ray of the LaserPointer should be displayed.
  129098. */
  129099. set displayLaserPointer(value: boolean);
  129100. /**
  129101. * The deviceOrientationCamera used as the camera when not in VR.
  129102. */
  129103. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129104. /**
  129105. * Based on the current WebVR support, returns the current VR camera used.
  129106. */
  129107. get currentVRCamera(): Nullable<Camera>;
  129108. /**
  129109. * The webVRCamera which is used when in VR.
  129110. */
  129111. get webVRCamera(): WebVRFreeCamera;
  129112. /**
  129113. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129114. */
  129115. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129116. /**
  129117. * The html button that is used to trigger entering into VR.
  129118. */
  129119. get vrButton(): Nullable<HTMLButtonElement>;
  129120. private get _teleportationRequestInitiated();
  129121. /**
  129122. * Defines whether or not Pointer lock should be requested when switching to
  129123. * full screen.
  129124. */
  129125. requestPointerLockOnFullScreen: boolean;
  129126. /**
  129127. * If asking to force XR, this will be populated with the default xr experience
  129128. */
  129129. xr: WebXRDefaultExperience;
  129130. /**
  129131. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129132. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129133. */
  129134. xrTestDone: boolean;
  129135. /**
  129136. * Instantiates a VRExperienceHelper.
  129137. * Helps to quickly add VR support to an existing scene.
  129138. * @param scene The scene the VRExperienceHelper belongs to.
  129139. * @param webVROptions Options to modify the vr experience helper's behavior.
  129140. */
  129141. constructor(scene: Scene,
  129142. /** Options to modify the vr experience helper's behavior. */
  129143. webVROptions?: VRExperienceHelperOptions);
  129144. private completeVRInit;
  129145. private _onDefaultMeshLoaded;
  129146. private _onResize;
  129147. private _onFullscreenChange;
  129148. /**
  129149. * Gets a value indicating if we are currently in VR mode.
  129150. */
  129151. get isInVRMode(): boolean;
  129152. private onVrDisplayPresentChange;
  129153. private onVRDisplayChanged;
  129154. private moveButtonToBottomRight;
  129155. private displayVRButton;
  129156. private updateButtonVisibility;
  129157. private _cachedAngularSensibility;
  129158. /**
  129159. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129160. * Otherwise, will use the fullscreen API.
  129161. */
  129162. enterVR(): void;
  129163. /**
  129164. * Attempt to exit VR, or fullscreen.
  129165. */
  129166. exitVR(): void;
  129167. /**
  129168. * The position of the vr experience helper.
  129169. */
  129170. get position(): Vector3;
  129171. /**
  129172. * Sets the position of the vr experience helper.
  129173. */
  129174. set position(value: Vector3);
  129175. /**
  129176. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129177. */
  129178. enableInteractions(): void;
  129179. private get _noControllerIsActive();
  129180. private beforeRender;
  129181. private _isTeleportationFloor;
  129182. /**
  129183. * Adds a floor mesh to be used for teleportation.
  129184. * @param floorMesh the mesh to be used for teleportation.
  129185. */
  129186. addFloorMesh(floorMesh: Mesh): void;
  129187. /**
  129188. * Removes a floor mesh from being used for teleportation.
  129189. * @param floorMesh the mesh to be removed.
  129190. */
  129191. removeFloorMesh(floorMesh: Mesh): void;
  129192. /**
  129193. * Enables interactions and teleportation using the VR controllers and gaze.
  129194. * @param vrTeleportationOptions options to modify teleportation behavior.
  129195. */
  129196. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129197. private _onNewGamepadConnected;
  129198. private _tryEnableInteractionOnController;
  129199. private _onNewGamepadDisconnected;
  129200. private _enableInteractionOnController;
  129201. private _checkTeleportWithRay;
  129202. private _checkRotate;
  129203. private _checkTeleportBackwards;
  129204. private _enableTeleportationOnController;
  129205. private _createTeleportationCircles;
  129206. private _displayTeleportationTarget;
  129207. private _hideTeleportationTarget;
  129208. private _rotateCamera;
  129209. private _moveTeleportationSelectorTo;
  129210. private _workingVector;
  129211. private _workingQuaternion;
  129212. private _workingMatrix;
  129213. /**
  129214. * Time Constant Teleportation Mode
  129215. */
  129216. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129217. /**
  129218. * Speed Constant Teleportation Mode
  129219. */
  129220. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129221. /**
  129222. * Teleports the users feet to the desired location
  129223. * @param location The location where the user's feet should be placed
  129224. */
  129225. teleportCamera(location: Vector3): void;
  129226. private _convertNormalToDirectionOfRay;
  129227. private _castRayAndSelectObject;
  129228. private _notifySelectedMeshUnselected;
  129229. /**
  129230. * Permanently set new colors for the laser pointer
  129231. * @param color the new laser color
  129232. * @param pickedColor the new laser color when picked mesh detected
  129233. */
  129234. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129235. /**
  129236. * Set lighting enabled / disabled on the laser pointer of both controllers
  129237. * @param enabled should the lighting be enabled on the laser pointer
  129238. */
  129239. setLaserLightingState(enabled?: boolean): void;
  129240. /**
  129241. * Permanently set new colors for the gaze pointer
  129242. * @param color the new gaze color
  129243. * @param pickedColor the new gaze color when picked mesh detected
  129244. */
  129245. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129246. /**
  129247. * Sets the color of the laser ray from the vr controllers.
  129248. * @param color new color for the ray.
  129249. */
  129250. changeLaserColor(color: Color3): void;
  129251. /**
  129252. * Sets the color of the ray from the vr headsets gaze.
  129253. * @param color new color for the ray.
  129254. */
  129255. changeGazeColor(color: Color3): void;
  129256. /**
  129257. * Exits VR and disposes of the vr experience helper
  129258. */
  129259. dispose(): void;
  129260. /**
  129261. * Gets the name of the VRExperienceHelper class
  129262. * @returns "VRExperienceHelper"
  129263. */
  129264. getClassName(): string;
  129265. }
  129266. }
  129267. declare module BABYLON {
  129268. /**
  129269. * Contains an array of blocks representing the octree
  129270. */
  129271. export interface IOctreeContainer<T> {
  129272. /**
  129273. * Blocks within the octree
  129274. */
  129275. blocks: Array<OctreeBlock<T>>;
  129276. }
  129277. /**
  129278. * Class used to store a cell in an octree
  129279. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129280. */
  129281. export class OctreeBlock<T> {
  129282. /**
  129283. * Gets the content of the current block
  129284. */
  129285. entries: T[];
  129286. /**
  129287. * Gets the list of block children
  129288. */
  129289. blocks: Array<OctreeBlock<T>>;
  129290. private _depth;
  129291. private _maxDepth;
  129292. private _capacity;
  129293. private _minPoint;
  129294. private _maxPoint;
  129295. private _boundingVectors;
  129296. private _creationFunc;
  129297. /**
  129298. * Creates a new block
  129299. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129300. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129301. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129302. * @param depth defines the current depth of this block in the octree
  129303. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129304. * @param creationFunc defines a callback to call when an element is added to the block
  129305. */
  129306. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129307. /**
  129308. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129309. */
  129310. get capacity(): number;
  129311. /**
  129312. * Gets the minimum vector (in world space) of the block's bounding box
  129313. */
  129314. get minPoint(): Vector3;
  129315. /**
  129316. * Gets the maximum vector (in world space) of the block's bounding box
  129317. */
  129318. get maxPoint(): Vector3;
  129319. /**
  129320. * Add a new element to this block
  129321. * @param entry defines the element to add
  129322. */
  129323. addEntry(entry: T): void;
  129324. /**
  129325. * Remove an element from this block
  129326. * @param entry defines the element to remove
  129327. */
  129328. removeEntry(entry: T): void;
  129329. /**
  129330. * Add an array of elements to this block
  129331. * @param entries defines the array of elements to add
  129332. */
  129333. addEntries(entries: T[]): void;
  129334. /**
  129335. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129336. * @param frustumPlanes defines the frustum planes to test
  129337. * @param selection defines the array to store current content if selection is positive
  129338. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129339. */
  129340. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129341. /**
  129342. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129343. * @param sphereCenter defines the bounding sphere center
  129344. * @param sphereRadius defines the bounding sphere radius
  129345. * @param selection defines the array to store current content if selection is positive
  129346. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129347. */
  129348. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129349. /**
  129350. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129351. * @param ray defines the ray to test with
  129352. * @param selection defines the array to store current content if selection is positive
  129353. */
  129354. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129355. /**
  129356. * Subdivide the content into child blocks (this block will then be empty)
  129357. */
  129358. createInnerBlocks(): void;
  129359. /**
  129360. * @hidden
  129361. */
  129362. 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;
  129363. }
  129364. }
  129365. declare module BABYLON {
  129366. /**
  129367. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129368. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129369. */
  129370. export class Octree<T> {
  129371. /** 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.) */
  129372. maxDepth: number;
  129373. /**
  129374. * Blocks within the octree containing objects
  129375. */
  129376. blocks: Array<OctreeBlock<T>>;
  129377. /**
  129378. * Content stored in the octree
  129379. */
  129380. dynamicContent: T[];
  129381. private _maxBlockCapacity;
  129382. private _selectionContent;
  129383. private _creationFunc;
  129384. /**
  129385. * Creates a octree
  129386. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129387. * @param creationFunc function to be used to instatiate the octree
  129388. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129389. * @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.)
  129390. */
  129391. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129392. /** 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.) */
  129393. maxDepth?: number);
  129394. /**
  129395. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129396. * @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);
  129397. * @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);
  129398. * @param entries meshes to be added to the octree blocks
  129399. */
  129400. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129401. /**
  129402. * Adds a mesh to the octree
  129403. * @param entry Mesh to add to the octree
  129404. */
  129405. addMesh(entry: T): void;
  129406. /**
  129407. * Remove an element from the octree
  129408. * @param entry defines the element to remove
  129409. */
  129410. removeMesh(entry: T): void;
  129411. /**
  129412. * Selects an array of meshes within the frustum
  129413. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129414. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129415. * @returns array of meshes within the frustum
  129416. */
  129417. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129418. /**
  129419. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129420. * @param sphereCenter defines the bounding sphere center
  129421. * @param sphereRadius defines the bounding sphere radius
  129422. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129423. * @returns an array of objects that intersect the sphere
  129424. */
  129425. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129426. /**
  129427. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129428. * @param ray defines the ray to test with
  129429. * @returns array of intersected objects
  129430. */
  129431. intersectsRay(ray: Ray): SmartArray<T>;
  129432. /**
  129433. * Adds a mesh into the octree block if it intersects the block
  129434. */
  129435. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129436. /**
  129437. * Adds a submesh into the octree block if it intersects the block
  129438. */
  129439. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129440. }
  129441. }
  129442. declare module BABYLON {
  129443. interface Scene {
  129444. /**
  129445. * @hidden
  129446. * Backing Filed
  129447. */
  129448. _selectionOctree: Octree<AbstractMesh>;
  129449. /**
  129450. * Gets the octree used to boost mesh selection (picking)
  129451. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129452. */
  129453. selectionOctree: Octree<AbstractMesh>;
  129454. /**
  129455. * Creates or updates the octree used to boost selection (picking)
  129456. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129457. * @param maxCapacity defines the maximum capacity per leaf
  129458. * @param maxDepth defines the maximum depth of the octree
  129459. * @returns an octree of AbstractMesh
  129460. */
  129461. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129462. }
  129463. interface AbstractMesh {
  129464. /**
  129465. * @hidden
  129466. * Backing Field
  129467. */
  129468. _submeshesOctree: Octree<SubMesh>;
  129469. /**
  129470. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129471. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129472. * @param maxCapacity defines the maximum size of each block (64 by default)
  129473. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129474. * @returns the new octree
  129475. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129476. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129477. */
  129478. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129479. }
  129480. /**
  129481. * Defines the octree scene component responsible to manage any octrees
  129482. * in a given scene.
  129483. */
  129484. export class OctreeSceneComponent {
  129485. /**
  129486. * The component name help to identify the component in the list of scene components.
  129487. */
  129488. readonly name: string;
  129489. /**
  129490. * The scene the component belongs to.
  129491. */
  129492. scene: Scene;
  129493. /**
  129494. * Indicates if the meshes have been checked to make sure they are isEnabled()
  129495. */
  129496. readonly checksIsEnabled: boolean;
  129497. /**
  129498. * Creates a new instance of the component for the given scene
  129499. * @param scene Defines the scene to register the component in
  129500. */
  129501. constructor(scene: Scene);
  129502. /**
  129503. * Registers the component in a given scene
  129504. */
  129505. register(): void;
  129506. /**
  129507. * Return the list of active meshes
  129508. * @returns the list of active meshes
  129509. */
  129510. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  129511. /**
  129512. * Return the list of active sub meshes
  129513. * @param mesh The mesh to get the candidates sub meshes from
  129514. * @returns the list of active sub meshes
  129515. */
  129516. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  129517. private _tempRay;
  129518. /**
  129519. * Return the list of sub meshes intersecting with a given local ray
  129520. * @param mesh defines the mesh to find the submesh for
  129521. * @param localRay defines the ray in local space
  129522. * @returns the list of intersecting sub meshes
  129523. */
  129524. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  129525. /**
  129526. * Return the list of sub meshes colliding with a collider
  129527. * @param mesh defines the mesh to find the submesh for
  129528. * @param collider defines the collider to evaluate the collision against
  129529. * @returns the list of colliding sub meshes
  129530. */
  129531. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  129532. /**
  129533. * Rebuilds the elements related to this component in case of
  129534. * context lost for instance.
  129535. */
  129536. rebuild(): void;
  129537. /**
  129538. * Disposes the component and the associated ressources.
  129539. */
  129540. dispose(): void;
  129541. }
  129542. }
  129543. declare module BABYLON {
  129544. /**
  129545. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  129546. */
  129547. export class Gizmo implements IDisposable {
  129548. /** The utility layer the gizmo will be added to */
  129549. gizmoLayer: UtilityLayerRenderer;
  129550. /**
  129551. * The root mesh of the gizmo
  129552. */
  129553. _rootMesh: Mesh;
  129554. private _attachedMesh;
  129555. private _attachedNode;
  129556. /**
  129557. * Ratio for the scale of the gizmo (Default: 1)
  129558. */
  129559. scaleRatio: number;
  129560. /**
  129561. * If a custom mesh has been set (Default: false)
  129562. */
  129563. protected _customMeshSet: boolean;
  129564. /**
  129565. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  129566. * * When set, interactions will be enabled
  129567. */
  129568. get attachedMesh(): Nullable<AbstractMesh>;
  129569. set attachedMesh(value: Nullable<AbstractMesh>);
  129570. /**
  129571. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  129572. * * When set, interactions will be enabled
  129573. */
  129574. get attachedNode(): Nullable<Node>;
  129575. set attachedNode(value: Nullable<Node>);
  129576. /**
  129577. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  129578. * @param mesh The mesh to replace the default mesh of the gizmo
  129579. */
  129580. setCustomMesh(mesh: Mesh): void;
  129581. /**
  129582. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  129583. */
  129584. updateGizmoRotationToMatchAttachedMesh: boolean;
  129585. /**
  129586. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  129587. */
  129588. updateGizmoPositionToMatchAttachedMesh: boolean;
  129589. /**
  129590. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  129591. */
  129592. updateScale: boolean;
  129593. protected _interactionsEnabled: boolean;
  129594. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129595. private _beforeRenderObserver;
  129596. private _tempQuaternion;
  129597. private _tempVector;
  129598. private _tempVector2;
  129599. /**
  129600. * Creates a gizmo
  129601. * @param gizmoLayer The utility layer the gizmo will be added to
  129602. */
  129603. constructor(
  129604. /** The utility layer the gizmo will be added to */
  129605. gizmoLayer?: UtilityLayerRenderer);
  129606. /**
  129607. * Updates the gizmo to match the attached mesh's position/rotation
  129608. */
  129609. protected _update(): void;
  129610. /**
  129611. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  129612. * @param value Node, TransformNode or mesh
  129613. */
  129614. protected _matrixChanged(): void;
  129615. /**
  129616. * Disposes of the gizmo
  129617. */
  129618. dispose(): void;
  129619. }
  129620. }
  129621. declare module BABYLON {
  129622. /**
  129623. * Single plane drag gizmo
  129624. */
  129625. export class PlaneDragGizmo extends Gizmo {
  129626. /**
  129627. * Drag behavior responsible for the gizmos dragging interactions
  129628. */
  129629. dragBehavior: PointerDragBehavior;
  129630. private _pointerObserver;
  129631. /**
  129632. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  129633. */
  129634. snapDistance: number;
  129635. /**
  129636. * Event that fires each time the gizmo snaps to a new location.
  129637. * * snapDistance is the the change in distance
  129638. */
  129639. onSnapObservable: Observable<{
  129640. snapDistance: number;
  129641. }>;
  129642. private _plane;
  129643. private _coloredMaterial;
  129644. private _hoverMaterial;
  129645. private _isEnabled;
  129646. private _parent;
  129647. /** @hidden */
  129648. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  129649. /** @hidden */
  129650. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  129651. /**
  129652. * Creates a PlaneDragGizmo
  129653. * @param gizmoLayer The utility layer the gizmo will be added to
  129654. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  129655. * @param color The color of the gizmo
  129656. */
  129657. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  129658. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129659. /**
  129660. * If the gizmo is enabled
  129661. */
  129662. set isEnabled(value: boolean);
  129663. get isEnabled(): boolean;
  129664. /**
  129665. * Disposes of the gizmo
  129666. */
  129667. dispose(): void;
  129668. }
  129669. }
  129670. declare module BABYLON {
  129671. /**
  129672. * Gizmo that enables dragging a mesh along 3 axis
  129673. */
  129674. export class PositionGizmo extends Gizmo {
  129675. /**
  129676. * Internal gizmo used for interactions on the x axis
  129677. */
  129678. xGizmo: AxisDragGizmo;
  129679. /**
  129680. * Internal gizmo used for interactions on the y axis
  129681. */
  129682. yGizmo: AxisDragGizmo;
  129683. /**
  129684. * Internal gizmo used for interactions on the z axis
  129685. */
  129686. zGizmo: AxisDragGizmo;
  129687. /**
  129688. * Internal gizmo used for interactions on the yz plane
  129689. */
  129690. xPlaneGizmo: PlaneDragGizmo;
  129691. /**
  129692. * Internal gizmo used for interactions on the xz plane
  129693. */
  129694. yPlaneGizmo: PlaneDragGizmo;
  129695. /**
  129696. * Internal gizmo used for interactions on the xy plane
  129697. */
  129698. zPlaneGizmo: PlaneDragGizmo;
  129699. /**
  129700. * private variables
  129701. */
  129702. private _meshAttached;
  129703. private _nodeAttached;
  129704. private _updateGizmoRotationToMatchAttachedMesh;
  129705. private _snapDistance;
  129706. private _scaleRatio;
  129707. /** Fires an event when any of it's sub gizmos are dragged */
  129708. onDragStartObservable: Observable<unknown>;
  129709. /** Fires an event when any of it's sub gizmos are released from dragging */
  129710. onDragEndObservable: Observable<unknown>;
  129711. /**
  129712. * If set to true, planar drag is enabled
  129713. */
  129714. private _planarGizmoEnabled;
  129715. get attachedMesh(): Nullable<AbstractMesh>;
  129716. set attachedMesh(mesh: Nullable<AbstractMesh>);
  129717. get attachedNode(): Nullable<Node>;
  129718. set attachedNode(node: Nullable<Node>);
  129719. /**
  129720. * Creates a PositionGizmo
  129721. * @param gizmoLayer The utility layer the gizmo will be added to
  129722. @param thickness display gizmo axis thickness
  129723. */
  129724. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  129725. /**
  129726. * If the planar drag gizmo is enabled
  129727. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  129728. */
  129729. set planarGizmoEnabled(value: boolean);
  129730. get planarGizmoEnabled(): boolean;
  129731. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  129732. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  129733. /**
  129734. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  129735. */
  129736. set snapDistance(value: number);
  129737. get snapDistance(): number;
  129738. /**
  129739. * Ratio for the scale of the gizmo (Default: 1)
  129740. */
  129741. set scaleRatio(value: number);
  129742. get scaleRatio(): number;
  129743. /**
  129744. * Disposes of the gizmo
  129745. */
  129746. dispose(): void;
  129747. /**
  129748. * CustomMeshes are not supported by this gizmo
  129749. * @param mesh The mesh to replace the default mesh of the gizmo
  129750. */
  129751. setCustomMesh(mesh: Mesh): void;
  129752. }
  129753. }
  129754. declare module BABYLON {
  129755. /**
  129756. * Single axis drag gizmo
  129757. */
  129758. export class AxisDragGizmo extends Gizmo {
  129759. /**
  129760. * Drag behavior responsible for the gizmos dragging interactions
  129761. */
  129762. dragBehavior: PointerDragBehavior;
  129763. private _pointerObserver;
  129764. /**
  129765. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  129766. */
  129767. snapDistance: number;
  129768. /**
  129769. * Event that fires each time the gizmo snaps to a new location.
  129770. * * snapDistance is the the change in distance
  129771. */
  129772. onSnapObservable: Observable<{
  129773. snapDistance: number;
  129774. }>;
  129775. private _isEnabled;
  129776. private _parent;
  129777. private _arrow;
  129778. private _coloredMaterial;
  129779. private _hoverMaterial;
  129780. /** @hidden */
  129781. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  129782. /** @hidden */
  129783. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  129784. /**
  129785. * Creates an AxisDragGizmo
  129786. * @param gizmoLayer The utility layer the gizmo will be added to
  129787. * @param dragAxis The axis which the gizmo will be able to drag on
  129788. * @param color The color of the gizmo
  129789. * @param thickness display gizmo axis thickness
  129790. */
  129791. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  129792. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129793. /**
  129794. * If the gizmo is enabled
  129795. */
  129796. set isEnabled(value: boolean);
  129797. get isEnabled(): boolean;
  129798. /**
  129799. * Disposes of the gizmo
  129800. */
  129801. dispose(): void;
  129802. }
  129803. }
  129804. declare module BABYLON.Debug {
  129805. /**
  129806. * The Axes viewer will show 3 axes in a specific point in space
  129807. */
  129808. export class AxesViewer {
  129809. private _xAxis;
  129810. private _yAxis;
  129811. private _zAxis;
  129812. private _scaleLinesFactor;
  129813. private _instanced;
  129814. /**
  129815. * Gets the hosting scene
  129816. */
  129817. scene: Scene;
  129818. /**
  129819. * Gets or sets a number used to scale line length
  129820. */
  129821. scaleLines: number;
  129822. /** Gets the node hierarchy used to render x-axis */
  129823. get xAxis(): TransformNode;
  129824. /** Gets the node hierarchy used to render y-axis */
  129825. get yAxis(): TransformNode;
  129826. /** Gets the node hierarchy used to render z-axis */
  129827. get zAxis(): TransformNode;
  129828. /**
  129829. * Creates a new AxesViewer
  129830. * @param scene defines the hosting scene
  129831. * @param scaleLines defines a number used to scale line length (1 by default)
  129832. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  129833. * @param xAxis defines the node hierarchy used to render the x-axis
  129834. * @param yAxis defines the node hierarchy used to render the y-axis
  129835. * @param zAxis defines the node hierarchy used to render the z-axis
  129836. */
  129837. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  129838. /**
  129839. * Force the viewer to update
  129840. * @param position defines the position of the viewer
  129841. * @param xaxis defines the x axis of the viewer
  129842. * @param yaxis defines the y axis of the viewer
  129843. * @param zaxis defines the z axis of the viewer
  129844. */
  129845. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  129846. /**
  129847. * Creates an instance of this axes viewer.
  129848. * @returns a new axes viewer with instanced meshes
  129849. */
  129850. createInstance(): AxesViewer;
  129851. /** Releases resources */
  129852. dispose(): void;
  129853. private static _SetRenderingGroupId;
  129854. }
  129855. }
  129856. declare module BABYLON.Debug {
  129857. /**
  129858. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  129859. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  129860. */
  129861. export class BoneAxesViewer extends AxesViewer {
  129862. /**
  129863. * Gets or sets the target mesh where to display the axes viewer
  129864. */
  129865. mesh: Nullable<Mesh>;
  129866. /**
  129867. * Gets or sets the target bone where to display the axes viewer
  129868. */
  129869. bone: Nullable<Bone>;
  129870. /** Gets current position */
  129871. pos: Vector3;
  129872. /** Gets direction of X axis */
  129873. xaxis: Vector3;
  129874. /** Gets direction of Y axis */
  129875. yaxis: Vector3;
  129876. /** Gets direction of Z axis */
  129877. zaxis: Vector3;
  129878. /**
  129879. * Creates a new BoneAxesViewer
  129880. * @param scene defines the hosting scene
  129881. * @param bone defines the target bone
  129882. * @param mesh defines the target mesh
  129883. * @param scaleLines defines a scaling factor for line length (1 by default)
  129884. */
  129885. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  129886. /**
  129887. * Force the viewer to update
  129888. */
  129889. update(): void;
  129890. /** Releases resources */
  129891. dispose(): void;
  129892. }
  129893. }
  129894. declare module BABYLON {
  129895. /**
  129896. * Interface used to define scene explorer extensibility option
  129897. */
  129898. export interface IExplorerExtensibilityOption {
  129899. /**
  129900. * Define the option label
  129901. */
  129902. label: string;
  129903. /**
  129904. * Defines the action to execute on click
  129905. */
  129906. action: (entity: any) => void;
  129907. }
  129908. /**
  129909. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  129910. */
  129911. export interface IExplorerExtensibilityGroup {
  129912. /**
  129913. * Defines a predicate to test if a given type mut be extended
  129914. */
  129915. predicate: (entity: any) => boolean;
  129916. /**
  129917. * Gets the list of options added to a type
  129918. */
  129919. entries: IExplorerExtensibilityOption[];
  129920. }
  129921. /**
  129922. * Interface used to define the options to use to create the Inspector
  129923. */
  129924. export interface IInspectorOptions {
  129925. /**
  129926. * Display in overlay mode (default: false)
  129927. */
  129928. overlay?: boolean;
  129929. /**
  129930. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  129931. */
  129932. globalRoot?: HTMLElement;
  129933. /**
  129934. * Display the Scene explorer
  129935. */
  129936. showExplorer?: boolean;
  129937. /**
  129938. * Display the property inspector
  129939. */
  129940. showInspector?: boolean;
  129941. /**
  129942. * Display in embed mode (both panes on the right)
  129943. */
  129944. embedMode?: boolean;
  129945. /**
  129946. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  129947. */
  129948. handleResize?: boolean;
  129949. /**
  129950. * Allow the panes to popup (default: true)
  129951. */
  129952. enablePopup?: boolean;
  129953. /**
  129954. * Allow the panes to be closed by users (default: true)
  129955. */
  129956. enableClose?: boolean;
  129957. /**
  129958. * Optional list of extensibility entries
  129959. */
  129960. explorerExtensibility?: IExplorerExtensibilityGroup[];
  129961. /**
  129962. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  129963. */
  129964. inspectorURL?: string;
  129965. /**
  129966. * Optional initial tab (default to DebugLayerTab.Properties)
  129967. */
  129968. initialTab?: DebugLayerTab;
  129969. }
  129970. interface Scene {
  129971. /**
  129972. * @hidden
  129973. * Backing field
  129974. */
  129975. _debugLayer: DebugLayer;
  129976. /**
  129977. * Gets the debug layer (aka Inspector) associated with the scene
  129978. * @see https://doc.babylonjs.com/features/playground_debuglayer
  129979. */
  129980. debugLayer: DebugLayer;
  129981. }
  129982. /**
  129983. * Enum of inspector action tab
  129984. */
  129985. export enum DebugLayerTab {
  129986. /**
  129987. * Properties tag (default)
  129988. */
  129989. Properties = 0,
  129990. /**
  129991. * Debug tab
  129992. */
  129993. Debug = 1,
  129994. /**
  129995. * Statistics tab
  129996. */
  129997. Statistics = 2,
  129998. /**
  129999. * Tools tab
  130000. */
  130001. Tools = 3,
  130002. /**
  130003. * Settings tab
  130004. */
  130005. Settings = 4
  130006. }
  130007. /**
  130008. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130009. * what is happening in your scene
  130010. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130011. */
  130012. export class DebugLayer {
  130013. /**
  130014. * Define the url to get the inspector script from.
  130015. * By default it uses the babylonjs CDN.
  130016. * @ignoreNaming
  130017. */
  130018. static InspectorURL: string;
  130019. private _scene;
  130020. private BJSINSPECTOR;
  130021. private _onPropertyChangedObservable?;
  130022. /**
  130023. * Observable triggered when a property is changed through the inspector.
  130024. */
  130025. get onPropertyChangedObservable(): any;
  130026. /**
  130027. * Instantiates a new debug layer.
  130028. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130029. * what is happening in your scene
  130030. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130031. * @param scene Defines the scene to inspect
  130032. */
  130033. constructor(scene: Scene);
  130034. /** Creates the inspector window. */
  130035. private _createInspector;
  130036. /**
  130037. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130038. * @param entity defines the entity to select
  130039. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130040. */
  130041. select(entity: any, lineContainerTitles?: string | string[]): void;
  130042. /** Get the inspector from bundle or global */
  130043. private _getGlobalInspector;
  130044. /**
  130045. * Get if the inspector is visible or not.
  130046. * @returns true if visible otherwise, false
  130047. */
  130048. isVisible(): boolean;
  130049. /**
  130050. * Hide the inspector and close its window.
  130051. */
  130052. hide(): void;
  130053. /**
  130054. * Update the scene in the inspector
  130055. */
  130056. setAsActiveScene(): void;
  130057. /**
  130058. * Launch the debugLayer.
  130059. * @param config Define the configuration of the inspector
  130060. * @return a promise fulfilled when the debug layer is visible
  130061. */
  130062. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130063. }
  130064. }
  130065. declare module BABYLON {
  130066. /**
  130067. * Class containing static functions to help procedurally build meshes
  130068. */
  130069. export class BoxBuilder {
  130070. /**
  130071. * Creates a box mesh
  130072. * * The parameter `size` sets the size (float) of each box side (default 1)
  130073. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130074. * * 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)
  130075. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130076. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130077. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130078. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130079. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130080. * @param name defines the name of the mesh
  130081. * @param options defines the options used to create the mesh
  130082. * @param scene defines the hosting scene
  130083. * @returns the box mesh
  130084. */
  130085. static CreateBox(name: string, options: {
  130086. size?: number;
  130087. width?: number;
  130088. height?: number;
  130089. depth?: number;
  130090. faceUV?: Vector4[];
  130091. faceColors?: Color4[];
  130092. sideOrientation?: number;
  130093. frontUVs?: Vector4;
  130094. backUVs?: Vector4;
  130095. wrap?: boolean;
  130096. topBaseAt?: number;
  130097. bottomBaseAt?: number;
  130098. updatable?: boolean;
  130099. }, scene?: Nullable<Scene>): Mesh;
  130100. }
  130101. }
  130102. declare module BABYLON.Debug {
  130103. /**
  130104. * Used to show the physics impostor around the specific mesh
  130105. */
  130106. export class PhysicsViewer {
  130107. /** @hidden */
  130108. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130109. /** @hidden */
  130110. protected _meshes: Array<Nullable<AbstractMesh>>;
  130111. /** @hidden */
  130112. protected _scene: Nullable<Scene>;
  130113. /** @hidden */
  130114. protected _numMeshes: number;
  130115. /** @hidden */
  130116. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130117. private _renderFunction;
  130118. private _utilityLayer;
  130119. private _debugBoxMesh;
  130120. private _debugSphereMesh;
  130121. private _debugCylinderMesh;
  130122. private _debugMaterial;
  130123. private _debugMeshMeshes;
  130124. /**
  130125. * Creates a new PhysicsViewer
  130126. * @param scene defines the hosting scene
  130127. */
  130128. constructor(scene: Scene);
  130129. /** @hidden */
  130130. protected _updateDebugMeshes(): void;
  130131. /**
  130132. * Renders a specified physic impostor
  130133. * @param impostor defines the impostor to render
  130134. * @param targetMesh defines the mesh represented by the impostor
  130135. * @returns the new debug mesh used to render the impostor
  130136. */
  130137. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130138. /**
  130139. * Hides a specified physic impostor
  130140. * @param impostor defines the impostor to hide
  130141. */
  130142. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130143. private _getDebugMaterial;
  130144. private _getDebugBoxMesh;
  130145. private _getDebugSphereMesh;
  130146. private _getDebugCylinderMesh;
  130147. private _getDebugMeshMesh;
  130148. private _getDebugMesh;
  130149. /** Releases all resources */
  130150. dispose(): void;
  130151. }
  130152. }
  130153. declare module BABYLON {
  130154. /**
  130155. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130156. * in order to better appreciate the issue one might have.
  130157. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130158. */
  130159. export class RayHelper {
  130160. /**
  130161. * Defines the ray we are currently tryin to visualize.
  130162. */
  130163. ray: Nullable<Ray>;
  130164. private _renderPoints;
  130165. private _renderLine;
  130166. private _renderFunction;
  130167. private _scene;
  130168. private _onAfterRenderObserver;
  130169. private _onAfterStepObserver;
  130170. private _attachedToMesh;
  130171. private _meshSpaceDirection;
  130172. private _meshSpaceOrigin;
  130173. /**
  130174. * Helper function to create a colored helper in a scene in one line.
  130175. * @param ray Defines the ray we are currently tryin to visualize
  130176. * @param scene Defines the scene the ray is used in
  130177. * @param color Defines the color we want to see the ray in
  130178. * @returns The newly created ray helper.
  130179. */
  130180. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130181. /**
  130182. * Instantiate a new ray helper.
  130183. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130184. * in order to better appreciate the issue one might have.
  130185. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130186. * @param ray Defines the ray we are currently tryin to visualize
  130187. */
  130188. constructor(ray: Ray);
  130189. /**
  130190. * Shows the ray we are willing to debug.
  130191. * @param scene Defines the scene the ray needs to be rendered in
  130192. * @param color Defines the color the ray needs to be rendered in
  130193. */
  130194. show(scene: Scene, color?: Color3): void;
  130195. /**
  130196. * Hides the ray we are debugging.
  130197. */
  130198. hide(): void;
  130199. private _render;
  130200. /**
  130201. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130202. * @param mesh Defines the mesh we want the helper attached to
  130203. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130204. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130205. * @param length Defines the length of the ray
  130206. */
  130207. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130208. /**
  130209. * Detach the ray helper from the mesh it has previously been attached to.
  130210. */
  130211. detachFromMesh(): void;
  130212. private _updateToMesh;
  130213. /**
  130214. * Dispose the helper and release its associated resources.
  130215. */
  130216. dispose(): void;
  130217. }
  130218. }
  130219. declare module BABYLON {
  130220. /**
  130221. * Defines the options associated with the creation of a SkeletonViewer.
  130222. */
  130223. export interface ISkeletonViewerOptions {
  130224. /** Should the system pause animations before building the Viewer? */
  130225. pauseAnimations: boolean;
  130226. /** Should the system return the skeleton to rest before building? */
  130227. returnToRest: boolean;
  130228. /** public Display Mode of the Viewer */
  130229. displayMode: number;
  130230. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130231. displayOptions: ISkeletonViewerDisplayOptions;
  130232. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130233. computeBonesUsingShaders: boolean;
  130234. }
  130235. /**
  130236. * Defines how to display the various bone meshes for the viewer.
  130237. */
  130238. export interface ISkeletonViewerDisplayOptions {
  130239. /** How far down to start tapering the bone spurs */
  130240. midStep?: number;
  130241. /** How big is the midStep? */
  130242. midStepFactor?: number;
  130243. /** Base for the Sphere Size */
  130244. sphereBaseSize?: number;
  130245. /** The ratio of the sphere to the longest bone in units */
  130246. sphereScaleUnit?: number;
  130247. /** Ratio for the Sphere Size */
  130248. sphereFactor?: number;
  130249. }
  130250. }
  130251. declare module BABYLON {
  130252. /**
  130253. * Class containing static functions to help procedurally build meshes
  130254. */
  130255. export class RibbonBuilder {
  130256. /**
  130257. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130258. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130259. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130260. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130261. * * 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
  130262. * * 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
  130263. * * 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
  130264. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130265. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130266. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130267. * * 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
  130268. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130269. * * 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
  130270. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130271. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130272. * @param name defines the name of the mesh
  130273. * @param options defines the options used to create the mesh
  130274. * @param scene defines the hosting scene
  130275. * @returns the ribbon mesh
  130276. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130277. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130278. */
  130279. static CreateRibbon(name: string, options: {
  130280. pathArray: Vector3[][];
  130281. closeArray?: boolean;
  130282. closePath?: boolean;
  130283. offset?: number;
  130284. updatable?: boolean;
  130285. sideOrientation?: number;
  130286. frontUVs?: Vector4;
  130287. backUVs?: Vector4;
  130288. instance?: Mesh;
  130289. invertUV?: boolean;
  130290. uvs?: Vector2[];
  130291. colors?: Color4[];
  130292. }, scene?: Nullable<Scene>): Mesh;
  130293. }
  130294. }
  130295. declare module BABYLON {
  130296. /**
  130297. * Class containing static functions to help procedurally build meshes
  130298. */
  130299. export class ShapeBuilder {
  130300. /**
  130301. * 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.
  130302. * * 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.
  130303. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130304. * * 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.
  130305. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130306. * * 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
  130307. * * 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
  130308. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130309. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130310. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130311. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130312. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130313. * @param name defines the name of the mesh
  130314. * @param options defines the options used to create the mesh
  130315. * @param scene defines the hosting scene
  130316. * @returns the extruded shape mesh
  130317. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130318. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130319. */
  130320. static ExtrudeShape(name: string, options: {
  130321. shape: Vector3[];
  130322. path: Vector3[];
  130323. scale?: number;
  130324. rotation?: number;
  130325. cap?: number;
  130326. updatable?: boolean;
  130327. sideOrientation?: number;
  130328. frontUVs?: Vector4;
  130329. backUVs?: Vector4;
  130330. instance?: Mesh;
  130331. invertUV?: boolean;
  130332. }, scene?: Nullable<Scene>): Mesh;
  130333. /**
  130334. * Creates an custom extruded shape mesh.
  130335. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130336. * * 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.
  130337. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130338. * * 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
  130339. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130340. * * 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
  130341. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130342. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130343. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130344. * * 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
  130345. * * 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
  130346. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130347. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130348. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130349. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130350. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130351. * @param name defines the name of the mesh
  130352. * @param options defines the options used to create the mesh
  130353. * @param scene defines the hosting scene
  130354. * @returns the custom extruded shape mesh
  130355. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130356. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130357. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130358. */
  130359. static ExtrudeShapeCustom(name: string, options: {
  130360. shape: Vector3[];
  130361. path: Vector3[];
  130362. scaleFunction?: any;
  130363. rotationFunction?: any;
  130364. ribbonCloseArray?: boolean;
  130365. ribbonClosePath?: boolean;
  130366. cap?: number;
  130367. updatable?: boolean;
  130368. sideOrientation?: number;
  130369. frontUVs?: Vector4;
  130370. backUVs?: Vector4;
  130371. instance?: Mesh;
  130372. invertUV?: boolean;
  130373. }, scene?: Nullable<Scene>): Mesh;
  130374. private static _ExtrudeShapeGeneric;
  130375. }
  130376. }
  130377. declare module BABYLON.Debug {
  130378. /**
  130379. * Class used to render a debug view of a given skeleton
  130380. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130381. */
  130382. export class SkeletonViewer {
  130383. /** defines the skeleton to render */
  130384. skeleton: Skeleton;
  130385. /** defines the mesh attached to the skeleton */
  130386. mesh: AbstractMesh;
  130387. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130388. autoUpdateBonesMatrices: boolean;
  130389. /** defines the rendering group id to use with the viewer */
  130390. renderingGroupId: number;
  130391. /** is the options for the viewer */
  130392. options: Partial<ISkeletonViewerOptions>;
  130393. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130394. static readonly DISPLAY_LINES: number;
  130395. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130396. static readonly DISPLAY_SPHERES: number;
  130397. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130398. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130399. /** If SkeletonViewer scene scope. */
  130400. private _scene;
  130401. /** Gets or sets the color used to render the skeleton */
  130402. color: Color3;
  130403. /** Array of the points of the skeleton fo the line view. */
  130404. private _debugLines;
  130405. /** The SkeletonViewers Mesh. */
  130406. private _debugMesh;
  130407. /** If SkeletonViewer is enabled. */
  130408. private _isEnabled;
  130409. /** If SkeletonViewer is ready. */
  130410. private _ready;
  130411. /** SkeletonViewer render observable. */
  130412. private _obs;
  130413. /** The Utility Layer to render the gizmos in. */
  130414. private _utilityLayer;
  130415. private _boneIndices;
  130416. /** Gets the Scene. */
  130417. get scene(): Scene;
  130418. /** Gets the utilityLayer. */
  130419. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130420. /** Checks Ready Status. */
  130421. get isReady(): Boolean;
  130422. /** Sets Ready Status. */
  130423. set ready(value: boolean);
  130424. /** Gets the debugMesh */
  130425. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130426. /** Sets the debugMesh */
  130427. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  130428. /** Gets the material */
  130429. get material(): StandardMaterial;
  130430. /** Sets the material */
  130431. set material(value: StandardMaterial);
  130432. /** Gets the material */
  130433. get displayMode(): number;
  130434. /** Sets the material */
  130435. set displayMode(value: number);
  130436. /**
  130437. * Creates a new SkeletonViewer
  130438. * @param skeleton defines the skeleton to render
  130439. * @param mesh defines the mesh attached to the skeleton
  130440. * @param scene defines the hosting scene
  130441. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  130442. * @param renderingGroupId defines the rendering group id to use with the viewer
  130443. * @param options All of the extra constructor options for the SkeletonViewer
  130444. */
  130445. constructor(
  130446. /** defines the skeleton to render */
  130447. skeleton: Skeleton,
  130448. /** defines the mesh attached to the skeleton */
  130449. mesh: AbstractMesh,
  130450. /** The Scene scope*/
  130451. scene: Scene,
  130452. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130453. autoUpdateBonesMatrices?: boolean,
  130454. /** defines the rendering group id to use with the viewer */
  130455. renderingGroupId?: number,
  130456. /** is the options for the viewer */
  130457. options?: Partial<ISkeletonViewerOptions>);
  130458. /** The Dynamic bindings for the update functions */
  130459. private _bindObs;
  130460. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  130461. update(): void;
  130462. /** Gets or sets a boolean indicating if the viewer is enabled */
  130463. set isEnabled(value: boolean);
  130464. get isEnabled(): boolean;
  130465. private _getBonePosition;
  130466. private _getLinesForBonesWithLength;
  130467. private _getLinesForBonesNoLength;
  130468. /** function to revert the mesh and scene back to the initial state. */
  130469. private _revert;
  130470. /** function to build and bind sphere joint points and spur bone representations. */
  130471. private _buildSpheresAndSpurs;
  130472. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  130473. private _displayLinesUpdate;
  130474. /** Changes the displayMode of the skeleton viewer
  130475. * @param mode The displayMode numerical value
  130476. */
  130477. changeDisplayMode(mode: number): void;
  130478. /** Changes the displayMode of the skeleton viewer
  130479. * @param option String of the option name
  130480. * @param value The numerical option value
  130481. */
  130482. changeDisplayOptions(option: string, value: number): void;
  130483. /** Release associated resources */
  130484. dispose(): void;
  130485. }
  130486. }
  130487. declare module BABYLON {
  130488. /**
  130489. * Enum for Device Types
  130490. */
  130491. export enum DeviceType {
  130492. /** Generic */
  130493. Generic = 0,
  130494. /** Keyboard */
  130495. Keyboard = 1,
  130496. /** Mouse */
  130497. Mouse = 2,
  130498. /** Touch Pointers */
  130499. Touch = 3,
  130500. /** PS4 Dual Shock */
  130501. DualShock = 4,
  130502. /** Xbox */
  130503. Xbox = 5,
  130504. /** Switch Controller */
  130505. Switch = 6
  130506. }
  130507. /**
  130508. * Enum for All Pointers (Touch/Mouse)
  130509. */
  130510. export enum PointerInput {
  130511. /** Horizontal Axis */
  130512. Horizontal = 0,
  130513. /** Vertical Axis */
  130514. Vertical = 1,
  130515. /** Left Click or Touch */
  130516. LeftClick = 2,
  130517. /** Middle Click */
  130518. MiddleClick = 3,
  130519. /** Right Click */
  130520. RightClick = 4,
  130521. /** Browser Back */
  130522. BrowserBack = 5,
  130523. /** Browser Forward */
  130524. BrowserForward = 6
  130525. }
  130526. /**
  130527. * Enum for Dual Shock Gamepad
  130528. */
  130529. export enum DualShockInput {
  130530. /** Cross */
  130531. Cross = 0,
  130532. /** Circle */
  130533. Circle = 1,
  130534. /** Square */
  130535. Square = 2,
  130536. /** Triangle */
  130537. Triangle = 3,
  130538. /** L1 */
  130539. L1 = 4,
  130540. /** R1 */
  130541. R1 = 5,
  130542. /** L2 */
  130543. L2 = 6,
  130544. /** R2 */
  130545. R2 = 7,
  130546. /** Share */
  130547. Share = 8,
  130548. /** Options */
  130549. Options = 9,
  130550. /** L3 */
  130551. L3 = 10,
  130552. /** R3 */
  130553. R3 = 11,
  130554. /** DPadUp */
  130555. DPadUp = 12,
  130556. /** DPadDown */
  130557. DPadDown = 13,
  130558. /** DPadLeft */
  130559. DPadLeft = 14,
  130560. /** DRight */
  130561. DPadRight = 15,
  130562. /** Home */
  130563. Home = 16,
  130564. /** TouchPad */
  130565. TouchPad = 17,
  130566. /** LStickXAxis */
  130567. LStickXAxis = 18,
  130568. /** LStickYAxis */
  130569. LStickYAxis = 19,
  130570. /** RStickXAxis */
  130571. RStickXAxis = 20,
  130572. /** RStickYAxis */
  130573. RStickYAxis = 21
  130574. }
  130575. /**
  130576. * Enum for Xbox Gamepad
  130577. */
  130578. export enum XboxInput {
  130579. /** A */
  130580. A = 0,
  130581. /** B */
  130582. B = 1,
  130583. /** X */
  130584. X = 2,
  130585. /** Y */
  130586. Y = 3,
  130587. /** LB */
  130588. LB = 4,
  130589. /** RB */
  130590. RB = 5,
  130591. /** LT */
  130592. LT = 6,
  130593. /** RT */
  130594. RT = 7,
  130595. /** Back */
  130596. Back = 8,
  130597. /** Start */
  130598. Start = 9,
  130599. /** LS */
  130600. LS = 10,
  130601. /** RS */
  130602. RS = 11,
  130603. /** DPadUp */
  130604. DPadUp = 12,
  130605. /** DPadDown */
  130606. DPadDown = 13,
  130607. /** DPadLeft */
  130608. DPadLeft = 14,
  130609. /** DRight */
  130610. DPadRight = 15,
  130611. /** Home */
  130612. Home = 16,
  130613. /** LStickXAxis */
  130614. LStickXAxis = 17,
  130615. /** LStickYAxis */
  130616. LStickYAxis = 18,
  130617. /** RStickXAxis */
  130618. RStickXAxis = 19,
  130619. /** RStickYAxis */
  130620. RStickYAxis = 20
  130621. }
  130622. /**
  130623. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  130624. */
  130625. export enum SwitchInput {
  130626. /** B */
  130627. B = 0,
  130628. /** A */
  130629. A = 1,
  130630. /** Y */
  130631. Y = 2,
  130632. /** X */
  130633. X = 3,
  130634. /** L */
  130635. L = 4,
  130636. /** R */
  130637. R = 5,
  130638. /** ZL */
  130639. ZL = 6,
  130640. /** ZR */
  130641. ZR = 7,
  130642. /** Minus */
  130643. Minus = 8,
  130644. /** Plus */
  130645. Plus = 9,
  130646. /** LS */
  130647. LS = 10,
  130648. /** RS */
  130649. RS = 11,
  130650. /** DPadUp */
  130651. DPadUp = 12,
  130652. /** DPadDown */
  130653. DPadDown = 13,
  130654. /** DPadLeft */
  130655. DPadLeft = 14,
  130656. /** DRight */
  130657. DPadRight = 15,
  130658. /** Home */
  130659. Home = 16,
  130660. /** Capture */
  130661. Capture = 17,
  130662. /** LStickXAxis */
  130663. LStickXAxis = 18,
  130664. /** LStickYAxis */
  130665. LStickYAxis = 19,
  130666. /** RStickXAxis */
  130667. RStickXAxis = 20,
  130668. /** RStickYAxis */
  130669. RStickYAxis = 21
  130670. }
  130671. }
  130672. declare module BABYLON {
  130673. /**
  130674. * This class will take all inputs from Keyboard, Pointer, and
  130675. * any Gamepads and provide a polling system that all devices
  130676. * will use. This class assumes that there will only be one
  130677. * pointer device and one keyboard.
  130678. */
  130679. export class DeviceInputSystem implements IDisposable {
  130680. /**
  130681. * Callback to be triggered when a device is connected
  130682. */
  130683. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  130684. /**
  130685. * Callback to be triggered when a device is disconnected
  130686. */
  130687. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  130688. /**
  130689. * Callback to be triggered when event driven input is updated
  130690. */
  130691. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  130692. private _inputs;
  130693. private _gamepads;
  130694. private _keyboardActive;
  130695. private _pointerActive;
  130696. private _elementToAttachTo;
  130697. private _keyboardDownEvent;
  130698. private _keyboardUpEvent;
  130699. private _pointerMoveEvent;
  130700. private _pointerDownEvent;
  130701. private _pointerUpEvent;
  130702. private _gamepadConnectedEvent;
  130703. private _gamepadDisconnectedEvent;
  130704. private static _MAX_KEYCODES;
  130705. private static _MAX_POINTER_INPUTS;
  130706. private constructor();
  130707. /**
  130708. * Creates a new DeviceInputSystem instance
  130709. * @param engine Engine to pull input element from
  130710. * @returns The new instance
  130711. */
  130712. static Create(engine: Engine): DeviceInputSystem;
  130713. /**
  130714. * Checks for current device input value, given an id and input index
  130715. * @param deviceName Id of connected device
  130716. * @param inputIndex Index of device input
  130717. * @returns Current value of input
  130718. */
  130719. /**
  130720. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  130721. * @param deviceType Enum specifiying device type
  130722. * @param deviceSlot "Slot" or index that device is referenced in
  130723. * @param inputIndex Id of input to be checked
  130724. * @returns Current value of input
  130725. */
  130726. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  130727. /**
  130728. * Dispose of all the eventlisteners
  130729. */
  130730. dispose(): void;
  130731. /**
  130732. * Add device and inputs to device array
  130733. * @param deviceType Enum specifiying device type
  130734. * @param deviceSlot "Slot" or index that device is referenced in
  130735. * @param numberOfInputs Number of input entries to create for given device
  130736. */
  130737. private _registerDevice;
  130738. /**
  130739. * Given a specific device name, remove that device from the device map
  130740. * @param deviceType Enum specifiying device type
  130741. * @param deviceSlot "Slot" or index that device is referenced in
  130742. */
  130743. private _unregisterDevice;
  130744. /**
  130745. * Handle all actions that come from keyboard interaction
  130746. */
  130747. private _handleKeyActions;
  130748. /**
  130749. * Handle all actions that come from pointer interaction
  130750. */
  130751. private _handlePointerActions;
  130752. /**
  130753. * Handle all actions that come from gamepad interaction
  130754. */
  130755. private _handleGamepadActions;
  130756. /**
  130757. * Update all non-event based devices with each frame
  130758. * @param deviceType Enum specifiying device type
  130759. * @param deviceSlot "Slot" or index that device is referenced in
  130760. * @param inputIndex Id of input to be checked
  130761. */
  130762. private _updateDevice;
  130763. /**
  130764. * Gets DeviceType from the device name
  130765. * @param deviceName Name of Device from DeviceInputSystem
  130766. * @returns DeviceType enum value
  130767. */
  130768. private _getGamepadDeviceType;
  130769. }
  130770. }
  130771. declare module BABYLON {
  130772. /**
  130773. * Type to handle enforcement of inputs
  130774. */
  130775. 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;
  130776. }
  130777. declare module BABYLON {
  130778. /**
  130779. * Class that handles all input for a specific device
  130780. */
  130781. export class DeviceSource<T extends DeviceType> {
  130782. /** Type of device */
  130783. readonly deviceType: DeviceType;
  130784. /** "Slot" or index that device is referenced in */
  130785. readonly deviceSlot: number;
  130786. /**
  130787. * Observable to handle device input changes per device
  130788. */
  130789. readonly onInputChangedObservable: Observable<{
  130790. inputIndex: DeviceInput<T>;
  130791. previousState: Nullable<number>;
  130792. currentState: Nullable<number>;
  130793. }>;
  130794. private readonly _deviceInputSystem;
  130795. /**
  130796. * Default Constructor
  130797. * @param deviceInputSystem Reference to DeviceInputSystem
  130798. * @param deviceType Type of device
  130799. * @param deviceSlot "Slot" or index that device is referenced in
  130800. */
  130801. constructor(deviceInputSystem: DeviceInputSystem,
  130802. /** Type of device */
  130803. deviceType: DeviceType,
  130804. /** "Slot" or index that device is referenced in */
  130805. deviceSlot?: number);
  130806. /**
  130807. * Get input for specific input
  130808. * @param inputIndex index of specific input on device
  130809. * @returns Input value from DeviceInputSystem
  130810. */
  130811. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  130812. }
  130813. /**
  130814. * Class to keep track of devices
  130815. */
  130816. export class DeviceSourceManager implements IDisposable {
  130817. /**
  130818. * Observable to be triggered when before a device is connected
  130819. */
  130820. readonly onBeforeDeviceConnectedObservable: Observable<{
  130821. deviceType: DeviceType;
  130822. deviceSlot: number;
  130823. }>;
  130824. /**
  130825. * Observable to be triggered when before a device is disconnected
  130826. */
  130827. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  130828. deviceType: DeviceType;
  130829. deviceSlot: number;
  130830. }>;
  130831. /**
  130832. * Observable to be triggered when after a device is connected
  130833. */
  130834. readonly onAfterDeviceConnectedObservable: Observable<{
  130835. deviceType: DeviceType;
  130836. deviceSlot: number;
  130837. }>;
  130838. /**
  130839. * Observable to be triggered when after a device is disconnected
  130840. */
  130841. readonly onAfterDeviceDisconnectedObservable: Observable<{
  130842. deviceType: DeviceType;
  130843. deviceSlot: number;
  130844. }>;
  130845. private readonly _devices;
  130846. private readonly _firstDevice;
  130847. private readonly _deviceInputSystem;
  130848. /**
  130849. * Default Constructor
  130850. * @param engine engine to pull input element from
  130851. */
  130852. constructor(engine: Engine);
  130853. /**
  130854. * Gets a DeviceSource, given a type and slot
  130855. * @param deviceType Enum specifying device type
  130856. * @param deviceSlot "Slot" or index that device is referenced in
  130857. * @returns DeviceSource object
  130858. */
  130859. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  130860. /**
  130861. * Gets an array of DeviceSource objects for a given device type
  130862. * @param deviceType Enum specifying device type
  130863. * @returns Array of DeviceSource objects
  130864. */
  130865. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  130866. /**
  130867. * Dispose of DeviceInputSystem and other parts
  130868. */
  130869. dispose(): void;
  130870. /**
  130871. * Function to add device name to device list
  130872. * @param deviceType Enum specifying device type
  130873. * @param deviceSlot "Slot" or index that device is referenced in
  130874. */
  130875. private _addDevice;
  130876. /**
  130877. * Function to remove device name to device list
  130878. * @param deviceType Enum specifying device type
  130879. * @param deviceSlot "Slot" or index that device is referenced in
  130880. */
  130881. private _removeDevice;
  130882. /**
  130883. * Updates array storing first connected device of each type
  130884. * @param type Type of Device
  130885. */
  130886. private _updateFirstDevices;
  130887. }
  130888. }
  130889. declare module BABYLON {
  130890. /**
  130891. * Options to create the null engine
  130892. */
  130893. export class NullEngineOptions {
  130894. /**
  130895. * Render width (Default: 512)
  130896. */
  130897. renderWidth: number;
  130898. /**
  130899. * Render height (Default: 256)
  130900. */
  130901. renderHeight: number;
  130902. /**
  130903. * Texture size (Default: 512)
  130904. */
  130905. textureSize: number;
  130906. /**
  130907. * If delta time between frames should be constant
  130908. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  130909. */
  130910. deterministicLockstep: boolean;
  130911. /**
  130912. * Maximum about of steps between frames (Default: 4)
  130913. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  130914. */
  130915. lockstepMaxSteps: number;
  130916. /**
  130917. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  130918. */
  130919. useHighPrecisionMatrix?: boolean;
  130920. }
  130921. /**
  130922. * The null engine class provides support for headless version of babylon.js.
  130923. * This can be used in server side scenario or for testing purposes
  130924. */
  130925. export class NullEngine extends Engine {
  130926. private _options;
  130927. /**
  130928. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  130929. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  130930. * @returns true if engine is in deterministic lock step mode
  130931. */
  130932. isDeterministicLockStep(): boolean;
  130933. /**
  130934. * Gets the max steps when engine is running in deterministic lock step
  130935. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  130936. * @returns the max steps
  130937. */
  130938. getLockstepMaxSteps(): number;
  130939. /**
  130940. * Gets the current hardware scaling level.
  130941. * By default the hardware scaling level is computed from the window device ratio.
  130942. * 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.
  130943. * @returns a number indicating the current hardware scaling level
  130944. */
  130945. getHardwareScalingLevel(): number;
  130946. constructor(options?: NullEngineOptions);
  130947. /**
  130948. * Creates a vertex buffer
  130949. * @param vertices the data for the vertex buffer
  130950. * @returns the new WebGL static buffer
  130951. */
  130952. createVertexBuffer(vertices: FloatArray): DataBuffer;
  130953. /**
  130954. * Creates a new index buffer
  130955. * @param indices defines the content of the index buffer
  130956. * @param updatable defines if the index buffer must be updatable
  130957. * @returns a new webGL buffer
  130958. */
  130959. createIndexBuffer(indices: IndicesArray): DataBuffer;
  130960. /**
  130961. * Clear the current render buffer or the current render target (if any is set up)
  130962. * @param color defines the color to use
  130963. * @param backBuffer defines if the back buffer must be cleared
  130964. * @param depth defines if the depth buffer must be cleared
  130965. * @param stencil defines if the stencil buffer must be cleared
  130966. */
  130967. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  130968. /**
  130969. * Gets the current render width
  130970. * @param useScreen defines if screen size must be used (or the current render target if any)
  130971. * @returns a number defining the current render width
  130972. */
  130973. getRenderWidth(useScreen?: boolean): number;
  130974. /**
  130975. * Gets the current render height
  130976. * @param useScreen defines if screen size must be used (or the current render target if any)
  130977. * @returns a number defining the current render height
  130978. */
  130979. getRenderHeight(useScreen?: boolean): number;
  130980. /**
  130981. * Set the WebGL's viewport
  130982. * @param viewport defines the viewport element to be used
  130983. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  130984. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  130985. */
  130986. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  130987. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  130988. /**
  130989. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  130990. * @param pipelineContext defines the pipeline context to use
  130991. * @param uniformsNames defines the list of uniform names
  130992. * @returns an array of webGL uniform locations
  130993. */
  130994. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  130995. /**
  130996. * Gets the lsit of active attributes for a given webGL program
  130997. * @param pipelineContext defines the pipeline context to use
  130998. * @param attributesNames defines the list of attribute names to get
  130999. * @returns an array of indices indicating the offset of each attribute
  131000. */
  131001. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131002. /**
  131003. * Binds an effect to the webGL context
  131004. * @param effect defines the effect to bind
  131005. */
  131006. bindSamplers(effect: Effect): void;
  131007. /**
  131008. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131009. * @param effect defines the effect to activate
  131010. */
  131011. enableEffect(effect: Effect): void;
  131012. /**
  131013. * Set various states to the webGL context
  131014. * @param culling defines backface culling state
  131015. * @param zOffset defines the value to apply to zOffset (0 by default)
  131016. * @param force defines if states must be applied even if cache is up to date
  131017. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131018. */
  131019. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131020. /**
  131021. * Set the value of an uniform to an array of int32
  131022. * @param uniform defines the webGL uniform location where to store the value
  131023. * @param array defines the array of int32 to store
  131024. */
  131025. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131026. /**
  131027. * Set the value of an uniform to an array of int32 (stored as vec2)
  131028. * @param uniform defines the webGL uniform location where to store the value
  131029. * @param array defines the array of int32 to store
  131030. */
  131031. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131032. /**
  131033. * Set the value of an uniform to an array of int32 (stored as vec3)
  131034. * @param uniform defines the webGL uniform location where to store the value
  131035. * @param array defines the array of int32 to store
  131036. */
  131037. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131038. /**
  131039. * Set the value of an uniform to an array of int32 (stored as vec4)
  131040. * @param uniform defines the webGL uniform location where to store the value
  131041. * @param array defines the array of int32 to store
  131042. */
  131043. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131044. /**
  131045. * Set the value of an uniform to an array of float32
  131046. * @param uniform defines the webGL uniform location where to store the value
  131047. * @param array defines the array of float32 to store
  131048. */
  131049. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131050. /**
  131051. * Set the value of an uniform to an array of float32 (stored as vec2)
  131052. * @param uniform defines the webGL uniform location where to store the value
  131053. * @param array defines the array of float32 to store
  131054. */
  131055. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131056. /**
  131057. * Set the value of an uniform to an array of float32 (stored as vec3)
  131058. * @param uniform defines the webGL uniform location where to store the value
  131059. * @param array defines the array of float32 to store
  131060. */
  131061. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131062. /**
  131063. * Set the value of an uniform to an array of float32 (stored as vec4)
  131064. * @param uniform defines the webGL uniform location where to store the value
  131065. * @param array defines the array of float32 to store
  131066. */
  131067. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131068. /**
  131069. * Set the value of an uniform to an array of number
  131070. * @param uniform defines the webGL uniform location where to store the value
  131071. * @param array defines the array of number to store
  131072. */
  131073. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131074. /**
  131075. * Set the value of an uniform to an array of number (stored as vec2)
  131076. * @param uniform defines the webGL uniform location where to store the value
  131077. * @param array defines the array of number to store
  131078. */
  131079. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131080. /**
  131081. * Set the value of an uniform to an array of number (stored as vec3)
  131082. * @param uniform defines the webGL uniform location where to store the value
  131083. * @param array defines the array of number to store
  131084. */
  131085. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131086. /**
  131087. * Set the value of an uniform to an array of number (stored as vec4)
  131088. * @param uniform defines the webGL uniform location where to store the value
  131089. * @param array defines the array of number to store
  131090. */
  131091. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131092. /**
  131093. * Set the value of an uniform to an array of float32 (stored as matrices)
  131094. * @param uniform defines the webGL uniform location where to store the value
  131095. * @param matrices defines the array of float32 to store
  131096. */
  131097. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131098. /**
  131099. * Set the value of an uniform to a matrix (3x3)
  131100. * @param uniform defines the webGL uniform location where to store the value
  131101. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131102. */
  131103. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131104. /**
  131105. * Set the value of an uniform to a matrix (2x2)
  131106. * @param uniform defines the webGL uniform location where to store the value
  131107. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131108. */
  131109. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131110. /**
  131111. * Set the value of an uniform to a number (float)
  131112. * @param uniform defines the webGL uniform location where to store the value
  131113. * @param value defines the float number to store
  131114. */
  131115. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131116. /**
  131117. * Set the value of an uniform to a vec2
  131118. * @param uniform defines the webGL uniform location where to store the value
  131119. * @param x defines the 1st component of the value
  131120. * @param y defines the 2nd component of the value
  131121. */
  131122. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131123. /**
  131124. * Set the value of an uniform to a vec3
  131125. * @param uniform defines the webGL uniform location where to store the value
  131126. * @param x defines the 1st component of the value
  131127. * @param y defines the 2nd component of the value
  131128. * @param z defines the 3rd component of the value
  131129. */
  131130. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131131. /**
  131132. * Set the value of an uniform to a boolean
  131133. * @param uniform defines the webGL uniform location where to store the value
  131134. * @param bool defines the boolean to store
  131135. */
  131136. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131137. /**
  131138. * Set the value of an uniform to a vec4
  131139. * @param uniform defines the webGL uniform location where to store the value
  131140. * @param x defines the 1st component of the value
  131141. * @param y defines the 2nd component of the value
  131142. * @param z defines the 3rd component of the value
  131143. * @param w defines the 4th component of the value
  131144. */
  131145. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131146. /**
  131147. * Sets the current alpha mode
  131148. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131149. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131150. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131151. */
  131152. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131153. /**
  131154. * Bind webGl buffers directly to the webGL context
  131155. * @param vertexBuffers defines the vertex buffer to bind
  131156. * @param indexBuffer defines the index buffer to bind
  131157. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131158. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131159. * @param effect defines the effect associated with the vertex buffer
  131160. */
  131161. bindBuffers(vertexBuffers: {
  131162. [key: string]: VertexBuffer;
  131163. }, indexBuffer: DataBuffer, effect: Effect): void;
  131164. /**
  131165. * Force the entire cache to be cleared
  131166. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131167. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131168. */
  131169. wipeCaches(bruteForce?: boolean): void;
  131170. /**
  131171. * Send a draw order
  131172. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131173. * @param indexStart defines the starting index
  131174. * @param indexCount defines the number of index to draw
  131175. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131176. */
  131177. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131178. /**
  131179. * Draw a list of indexed primitives
  131180. * @param fillMode defines the primitive to use
  131181. * @param indexStart defines the starting index
  131182. * @param indexCount defines the number of index to draw
  131183. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131184. */
  131185. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131186. /**
  131187. * Draw a list of unindexed primitives
  131188. * @param fillMode defines the primitive to use
  131189. * @param verticesStart defines the index of first vertex to draw
  131190. * @param verticesCount defines the count of vertices to draw
  131191. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131192. */
  131193. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131194. /** @hidden */
  131195. _createTexture(): WebGLTexture;
  131196. /** @hidden */
  131197. _releaseTexture(texture: InternalTexture): void;
  131198. /**
  131199. * Usually called from Texture.ts.
  131200. * Passed information to create a WebGLTexture
  131201. * @param urlArg defines a value which contains one of the following:
  131202. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131203. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131204. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131205. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131206. * @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)
  131207. * @param scene needed for loading to the correct scene
  131208. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131209. * @param onLoad optional callback to be called upon successful completion
  131210. * @param onError optional callback to be called upon failure
  131211. * @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
  131212. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131213. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131214. * @param forcedExtension defines the extension to use to pick the right loader
  131215. * @param mimeType defines an optional mime type
  131216. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131217. */
  131218. 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;
  131219. /**
  131220. * Creates a new render target texture
  131221. * @param size defines the size of the texture
  131222. * @param options defines the options used to create the texture
  131223. * @returns a new render target texture stored in an InternalTexture
  131224. */
  131225. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131226. /**
  131227. * Update the sampling mode of a given texture
  131228. * @param samplingMode defines the required sampling mode
  131229. * @param texture defines the texture to update
  131230. */
  131231. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131232. /**
  131233. * Binds the frame buffer to the specified texture.
  131234. * @param texture The texture to render to or null for the default canvas
  131235. * @param faceIndex The face of the texture to render to in case of cube texture
  131236. * @param requiredWidth The width of the target to render to
  131237. * @param requiredHeight The height of the target to render to
  131238. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131239. * @param lodLevel defines le lod level to bind to the frame buffer
  131240. */
  131241. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131242. /**
  131243. * Unbind the current render target texture from the webGL context
  131244. * @param texture defines the render target texture to unbind
  131245. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131246. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131247. */
  131248. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131249. /**
  131250. * Creates a dynamic vertex buffer
  131251. * @param vertices the data for the dynamic vertex buffer
  131252. * @returns the new WebGL dynamic buffer
  131253. */
  131254. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131255. /**
  131256. * Update the content of a dynamic texture
  131257. * @param texture defines the texture to update
  131258. * @param canvas defines the canvas containing the source
  131259. * @param invertY defines if data must be stored with Y axis inverted
  131260. * @param premulAlpha defines if alpha is stored as premultiplied
  131261. * @param format defines the format of the data
  131262. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131263. */
  131264. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131265. /**
  131266. * Gets a boolean indicating if all created effects are ready
  131267. * @returns true if all effects are ready
  131268. */
  131269. areAllEffectsReady(): boolean;
  131270. /**
  131271. * @hidden
  131272. * Get the current error code of the webGL context
  131273. * @returns the error code
  131274. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131275. */
  131276. getError(): number;
  131277. /** @hidden */
  131278. _getUnpackAlignement(): number;
  131279. /** @hidden */
  131280. _unpackFlipY(value: boolean): void;
  131281. /**
  131282. * Update a dynamic index buffer
  131283. * @param indexBuffer defines the target index buffer
  131284. * @param indices defines the data to update
  131285. * @param offset defines the offset in the target index buffer where update should start
  131286. */
  131287. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131288. /**
  131289. * Updates a dynamic vertex buffer.
  131290. * @param vertexBuffer the vertex buffer to update
  131291. * @param vertices the data used to update the vertex buffer
  131292. * @param byteOffset the byte offset of the data (optional)
  131293. * @param byteLength the byte length of the data (optional)
  131294. */
  131295. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131296. /** @hidden */
  131297. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131298. /** @hidden */
  131299. _bindTexture(channel: number, texture: InternalTexture): void;
  131300. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131301. /**
  131302. * 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
  131303. */
  131304. releaseEffects(): void;
  131305. displayLoadingUI(): void;
  131306. hideLoadingUI(): void;
  131307. /** @hidden */
  131308. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131309. /** @hidden */
  131310. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131311. /** @hidden */
  131312. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131313. /** @hidden */
  131314. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131315. }
  131316. }
  131317. declare module BABYLON {
  131318. /**
  131319. * @hidden
  131320. **/
  131321. export class _TimeToken {
  131322. _startTimeQuery: Nullable<WebGLQuery>;
  131323. _endTimeQuery: Nullable<WebGLQuery>;
  131324. _timeElapsedQuery: Nullable<WebGLQuery>;
  131325. _timeElapsedQueryEnded: boolean;
  131326. }
  131327. }
  131328. declare module BABYLON {
  131329. /** @hidden */
  131330. export class _OcclusionDataStorage {
  131331. /** @hidden */
  131332. occlusionInternalRetryCounter: number;
  131333. /** @hidden */
  131334. isOcclusionQueryInProgress: boolean;
  131335. /** @hidden */
  131336. isOccluded: boolean;
  131337. /** @hidden */
  131338. occlusionRetryCount: number;
  131339. /** @hidden */
  131340. occlusionType: number;
  131341. /** @hidden */
  131342. occlusionQueryAlgorithmType: number;
  131343. }
  131344. interface Engine {
  131345. /**
  131346. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131347. * @return the new query
  131348. */
  131349. createQuery(): WebGLQuery;
  131350. /**
  131351. * Delete and release a webGL query
  131352. * @param query defines the query to delete
  131353. * @return the current engine
  131354. */
  131355. deleteQuery(query: WebGLQuery): Engine;
  131356. /**
  131357. * Check if a given query has resolved and got its value
  131358. * @param query defines the query to check
  131359. * @returns true if the query got its value
  131360. */
  131361. isQueryResultAvailable(query: WebGLQuery): boolean;
  131362. /**
  131363. * Gets the value of a given query
  131364. * @param query defines the query to check
  131365. * @returns the value of the query
  131366. */
  131367. getQueryResult(query: WebGLQuery): number;
  131368. /**
  131369. * Initiates an occlusion query
  131370. * @param algorithmType defines the algorithm to use
  131371. * @param query defines the query to use
  131372. * @returns the current engine
  131373. * @see https://doc.babylonjs.com/features/occlusionquery
  131374. */
  131375. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131376. /**
  131377. * Ends an occlusion query
  131378. * @see https://doc.babylonjs.com/features/occlusionquery
  131379. * @param algorithmType defines the algorithm to use
  131380. * @returns the current engine
  131381. */
  131382. endOcclusionQuery(algorithmType: number): Engine;
  131383. /**
  131384. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131385. * Please note that only one query can be issued at a time
  131386. * @returns a time token used to track the time span
  131387. */
  131388. startTimeQuery(): Nullable<_TimeToken>;
  131389. /**
  131390. * Ends a time query
  131391. * @param token defines the token used to measure the time span
  131392. * @returns the time spent (in ns)
  131393. */
  131394. endTimeQuery(token: _TimeToken): int;
  131395. /** @hidden */
  131396. _currentNonTimestampToken: Nullable<_TimeToken>;
  131397. /** @hidden */
  131398. _createTimeQuery(): WebGLQuery;
  131399. /** @hidden */
  131400. _deleteTimeQuery(query: WebGLQuery): void;
  131401. /** @hidden */
  131402. _getGlAlgorithmType(algorithmType: number): number;
  131403. /** @hidden */
  131404. _getTimeQueryResult(query: WebGLQuery): any;
  131405. /** @hidden */
  131406. _getTimeQueryAvailability(query: WebGLQuery): any;
  131407. }
  131408. interface AbstractMesh {
  131409. /**
  131410. * Backing filed
  131411. * @hidden
  131412. */
  131413. __occlusionDataStorage: _OcclusionDataStorage;
  131414. /**
  131415. * Access property
  131416. * @hidden
  131417. */
  131418. _occlusionDataStorage: _OcclusionDataStorage;
  131419. /**
  131420. * 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.
  131421. * The default value is -1 which means don't break the query and wait till the result
  131422. * @see https://doc.babylonjs.com/features/occlusionquery
  131423. */
  131424. occlusionRetryCount: number;
  131425. /**
  131426. * 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:
  131427. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  131428. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  131429. * * 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.
  131430. * @see https://doc.babylonjs.com/features/occlusionquery
  131431. */
  131432. occlusionType: number;
  131433. /**
  131434. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  131435. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  131436. * * 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.
  131437. * @see https://doc.babylonjs.com/features/occlusionquery
  131438. */
  131439. occlusionQueryAlgorithmType: number;
  131440. /**
  131441. * 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
  131442. * @see https://doc.babylonjs.com/features/occlusionquery
  131443. */
  131444. isOccluded: boolean;
  131445. /**
  131446. * Flag to check the progress status of the query
  131447. * @see https://doc.babylonjs.com/features/occlusionquery
  131448. */
  131449. isOcclusionQueryInProgress: boolean;
  131450. }
  131451. }
  131452. declare module BABYLON {
  131453. /** @hidden */
  131454. export var _forceTransformFeedbackToBundle: boolean;
  131455. interface Engine {
  131456. /**
  131457. * Creates a webGL transform feedback object
  131458. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  131459. * @returns the webGL transform feedback object
  131460. */
  131461. createTransformFeedback(): WebGLTransformFeedback;
  131462. /**
  131463. * Delete a webGL transform feedback object
  131464. * @param value defines the webGL transform feedback object to delete
  131465. */
  131466. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  131467. /**
  131468. * Bind a webGL transform feedback object to the webgl context
  131469. * @param value defines the webGL transform feedback object to bind
  131470. */
  131471. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  131472. /**
  131473. * Begins a transform feedback operation
  131474. * @param usePoints defines if points or triangles must be used
  131475. */
  131476. beginTransformFeedback(usePoints: boolean): void;
  131477. /**
  131478. * Ends a transform feedback operation
  131479. */
  131480. endTransformFeedback(): void;
  131481. /**
  131482. * Specify the varyings to use with transform feedback
  131483. * @param program defines the associated webGL program
  131484. * @param value defines the list of strings representing the varying names
  131485. */
  131486. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  131487. /**
  131488. * Bind a webGL buffer for a transform feedback operation
  131489. * @param value defines the webGL buffer to bind
  131490. */
  131491. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  131492. }
  131493. }
  131494. declare module BABYLON {
  131495. /**
  131496. * Class used to define an additional view for the engine
  131497. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131498. */
  131499. export class EngineView {
  131500. /** Defines the canvas where to render the view */
  131501. target: HTMLCanvasElement;
  131502. /** Defines an optional camera used to render the view (will use active camera else) */
  131503. camera?: Camera;
  131504. }
  131505. interface Engine {
  131506. /**
  131507. * Gets or sets the HTML element to use for attaching events
  131508. */
  131509. inputElement: Nullable<HTMLElement>;
  131510. /**
  131511. * Gets the current engine view
  131512. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131513. */
  131514. activeView: Nullable<EngineView>;
  131515. /** Gets or sets the list of views */
  131516. views: EngineView[];
  131517. /**
  131518. * Register a new child canvas
  131519. * @param canvas defines the canvas to register
  131520. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  131521. * @returns the associated view
  131522. */
  131523. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  131524. /**
  131525. * Remove a registered child canvas
  131526. * @param canvas defines the canvas to remove
  131527. * @returns the current engine
  131528. */
  131529. unRegisterView(canvas: HTMLCanvasElement): Engine;
  131530. }
  131531. }
  131532. declare module BABYLON {
  131533. interface Engine {
  131534. /** @hidden */
  131535. _excludedCompressedTextures: string[];
  131536. /** @hidden */
  131537. _textureFormatInUse: string;
  131538. /**
  131539. * Gets the list of texture formats supported
  131540. */
  131541. readonly texturesSupported: Array<string>;
  131542. /**
  131543. * Gets the texture format in use
  131544. */
  131545. readonly textureFormatInUse: Nullable<string>;
  131546. /**
  131547. * Set the compressed texture extensions or file names to skip.
  131548. *
  131549. * @param skippedFiles defines the list of those texture files you want to skip
  131550. * Example: [".dds", ".env", "myfile.png"]
  131551. */
  131552. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  131553. /**
  131554. * Set the compressed texture format to use, based on the formats you have, and the formats
  131555. * supported by the hardware / browser.
  131556. *
  131557. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  131558. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  131559. * to API arguments needed to compressed textures. This puts the burden on the container
  131560. * generator to house the arcane code for determining these for current & future formats.
  131561. *
  131562. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  131563. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  131564. *
  131565. * Note: The result of this call is not taken into account when a texture is base64.
  131566. *
  131567. * @param formatsAvailable defines the list of those format families you have created
  131568. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  131569. *
  131570. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  131571. * @returns The extension selected.
  131572. */
  131573. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  131574. }
  131575. }
  131576. declare module BABYLON {
  131577. /**
  131578. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  131579. */
  131580. export interface CubeMapInfo {
  131581. /**
  131582. * The pixel array for the front face.
  131583. * This is stored in format, left to right, up to down format.
  131584. */
  131585. front: Nullable<ArrayBufferView>;
  131586. /**
  131587. * The pixel array for the back face.
  131588. * This is stored in format, left to right, up to down format.
  131589. */
  131590. back: Nullable<ArrayBufferView>;
  131591. /**
  131592. * The pixel array for the left face.
  131593. * This is stored in format, left to right, up to down format.
  131594. */
  131595. left: Nullable<ArrayBufferView>;
  131596. /**
  131597. * The pixel array for the right face.
  131598. * This is stored in format, left to right, up to down format.
  131599. */
  131600. right: Nullable<ArrayBufferView>;
  131601. /**
  131602. * The pixel array for the up face.
  131603. * This is stored in format, left to right, up to down format.
  131604. */
  131605. up: Nullable<ArrayBufferView>;
  131606. /**
  131607. * The pixel array for the down face.
  131608. * This is stored in format, left to right, up to down format.
  131609. */
  131610. down: Nullable<ArrayBufferView>;
  131611. /**
  131612. * The size of the cubemap stored.
  131613. *
  131614. * Each faces will be size * size pixels.
  131615. */
  131616. size: number;
  131617. /**
  131618. * The format of the texture.
  131619. *
  131620. * RGBA, RGB.
  131621. */
  131622. format: number;
  131623. /**
  131624. * The type of the texture data.
  131625. *
  131626. * UNSIGNED_INT, FLOAT.
  131627. */
  131628. type: number;
  131629. /**
  131630. * Specifies whether the texture is in gamma space.
  131631. */
  131632. gammaSpace: boolean;
  131633. }
  131634. /**
  131635. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  131636. */
  131637. export class PanoramaToCubeMapTools {
  131638. private static FACE_LEFT;
  131639. private static FACE_RIGHT;
  131640. private static FACE_FRONT;
  131641. private static FACE_BACK;
  131642. private static FACE_DOWN;
  131643. private static FACE_UP;
  131644. /**
  131645. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  131646. *
  131647. * @param float32Array The source data.
  131648. * @param inputWidth The width of the input panorama.
  131649. * @param inputHeight The height of the input panorama.
  131650. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  131651. * @return The cubemap data
  131652. */
  131653. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  131654. private static CreateCubemapTexture;
  131655. private static CalcProjectionSpherical;
  131656. }
  131657. }
  131658. declare module BABYLON {
  131659. /**
  131660. * Helper class dealing with the extraction of spherical polynomial dataArray
  131661. * from a cube map.
  131662. */
  131663. export class CubeMapToSphericalPolynomialTools {
  131664. private static FileFaces;
  131665. /**
  131666. * Converts a texture to the according Spherical Polynomial data.
  131667. * This extracts the first 3 orders only as they are the only one used in the lighting.
  131668. *
  131669. * @param texture The texture to extract the information from.
  131670. * @return The Spherical Polynomial data.
  131671. */
  131672. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  131673. /**
  131674. * Converts a cubemap to the according Spherical Polynomial data.
  131675. * This extracts the first 3 orders only as they are the only one used in the lighting.
  131676. *
  131677. * @param cubeInfo The Cube map to extract the information from.
  131678. * @return The Spherical Polynomial data.
  131679. */
  131680. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  131681. }
  131682. }
  131683. declare module BABYLON {
  131684. interface BaseTexture {
  131685. /**
  131686. * Get the polynomial representation of the texture data.
  131687. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  131688. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  131689. */
  131690. sphericalPolynomial: Nullable<SphericalPolynomial>;
  131691. }
  131692. }
  131693. declare module BABYLON {
  131694. /** @hidden */
  131695. export var rgbdEncodePixelShader: {
  131696. name: string;
  131697. shader: string;
  131698. };
  131699. }
  131700. declare module BABYLON {
  131701. /** @hidden */
  131702. export var rgbdDecodePixelShader: {
  131703. name: string;
  131704. shader: string;
  131705. };
  131706. }
  131707. declare module BABYLON {
  131708. /**
  131709. * Raw texture data and descriptor sufficient for WebGL texture upload
  131710. */
  131711. export interface EnvironmentTextureInfo {
  131712. /**
  131713. * Version of the environment map
  131714. */
  131715. version: number;
  131716. /**
  131717. * Width of image
  131718. */
  131719. width: number;
  131720. /**
  131721. * Irradiance information stored in the file.
  131722. */
  131723. irradiance: any;
  131724. /**
  131725. * Specular information stored in the file.
  131726. */
  131727. specular: any;
  131728. }
  131729. /**
  131730. * Defines One Image in the file. It requires only the position in the file
  131731. * as well as the length.
  131732. */
  131733. interface BufferImageData {
  131734. /**
  131735. * Length of the image data.
  131736. */
  131737. length: number;
  131738. /**
  131739. * Position of the data from the null terminator delimiting the end of the JSON.
  131740. */
  131741. position: number;
  131742. }
  131743. /**
  131744. * Defines the specular data enclosed in the file.
  131745. * This corresponds to the version 1 of the data.
  131746. */
  131747. export interface EnvironmentTextureSpecularInfoV1 {
  131748. /**
  131749. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  131750. */
  131751. specularDataPosition?: number;
  131752. /**
  131753. * This contains all the images data needed to reconstruct the cubemap.
  131754. */
  131755. mipmaps: Array<BufferImageData>;
  131756. /**
  131757. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  131758. */
  131759. lodGenerationScale: number;
  131760. }
  131761. /**
  131762. * Sets of helpers addressing the serialization and deserialization of environment texture
  131763. * stored in a BabylonJS env file.
  131764. * Those files are usually stored as .env files.
  131765. */
  131766. export class EnvironmentTextureTools {
  131767. /**
  131768. * Magic number identifying the env file.
  131769. */
  131770. private static _MagicBytes;
  131771. /**
  131772. * Gets the environment info from an env file.
  131773. * @param data The array buffer containing the .env bytes.
  131774. * @returns the environment file info (the json header) if successfully parsed.
  131775. */
  131776. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  131777. /**
  131778. * Creates an environment texture from a loaded cube texture.
  131779. * @param texture defines the cube texture to convert in env file
  131780. * @return a promise containing the environment data if succesfull.
  131781. */
  131782. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  131783. /**
  131784. * Creates a JSON representation of the spherical data.
  131785. * @param texture defines the texture containing the polynomials
  131786. * @return the JSON representation of the spherical info
  131787. */
  131788. private static _CreateEnvTextureIrradiance;
  131789. /**
  131790. * Creates the ArrayBufferViews used for initializing environment texture image data.
  131791. * @param data the image data
  131792. * @param info parameters that determine what views will be created for accessing the underlying buffer
  131793. * @return the views described by info providing access to the underlying buffer
  131794. */
  131795. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  131796. /**
  131797. * Uploads the texture info contained in the env file to the GPU.
  131798. * @param texture defines the internal texture to upload to
  131799. * @param data defines the data to load
  131800. * @param info defines the texture info retrieved through the GetEnvInfo method
  131801. * @returns a promise
  131802. */
  131803. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  131804. private static _OnImageReadyAsync;
  131805. /**
  131806. * Uploads the levels of image data to the GPU.
  131807. * @param texture defines the internal texture to upload to
  131808. * @param imageData defines the array buffer views of image data [mipmap][face]
  131809. * @returns a promise
  131810. */
  131811. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  131812. /**
  131813. * Uploads spherical polynomials information to the texture.
  131814. * @param texture defines the texture we are trying to upload the information to
  131815. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  131816. */
  131817. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  131818. /** @hidden */
  131819. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  131820. }
  131821. }
  131822. declare module BABYLON {
  131823. /**
  131824. * Class used to inline functions in shader code
  131825. */
  131826. export class ShaderCodeInliner {
  131827. private static readonly _RegexpFindFunctionNameAndType;
  131828. private _sourceCode;
  131829. private _functionDescr;
  131830. private _numMaxIterations;
  131831. /** Gets or sets the token used to mark the functions to inline */
  131832. inlineToken: string;
  131833. /** Gets or sets the debug mode */
  131834. debug: boolean;
  131835. /** Gets the code after the inlining process */
  131836. get code(): string;
  131837. /**
  131838. * Initializes the inliner
  131839. * @param sourceCode shader code source to inline
  131840. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  131841. */
  131842. constructor(sourceCode: string, numMaxIterations?: number);
  131843. /**
  131844. * Start the processing of the shader code
  131845. */
  131846. processCode(): void;
  131847. private _collectFunctions;
  131848. private _processInlining;
  131849. private _extractBetweenMarkers;
  131850. private _skipWhitespaces;
  131851. private _removeComments;
  131852. private _replaceFunctionCallsByCode;
  131853. private _findBackward;
  131854. private _escapeRegExp;
  131855. private _replaceNames;
  131856. }
  131857. }
  131858. declare module BABYLON {
  131859. /**
  131860. * Container for accessors for natively-stored mesh data buffers.
  131861. */
  131862. class NativeDataBuffer extends DataBuffer {
  131863. /**
  131864. * Accessor value used to identify/retrieve a natively-stored index buffer.
  131865. */
  131866. nativeIndexBuffer?: any;
  131867. /**
  131868. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  131869. */
  131870. nativeVertexBuffer?: any;
  131871. }
  131872. /** @hidden */
  131873. class NativeTexture extends InternalTexture {
  131874. getInternalTexture(): InternalTexture;
  131875. getViewCount(): number;
  131876. }
  131877. /** @hidden */
  131878. export class NativeEngine extends Engine {
  131879. private readonly _native;
  131880. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  131881. private readonly INVALID_HANDLE;
  131882. private _boundBuffersVertexArray;
  131883. getHardwareScalingLevel(): number;
  131884. constructor();
  131885. dispose(): void;
  131886. /**
  131887. * Can be used to override the current requestAnimationFrame requester.
  131888. * @hidden
  131889. */
  131890. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  131891. /**
  131892. * Override default engine behavior.
  131893. * @param color
  131894. * @param backBuffer
  131895. * @param depth
  131896. * @param stencil
  131897. */
  131898. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  131899. /**
  131900. * Gets host document
  131901. * @returns the host document object
  131902. */
  131903. getHostDocument(): Nullable<Document>;
  131904. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131905. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  131906. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  131907. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  131908. [key: string]: VertexBuffer;
  131909. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  131910. bindBuffers(vertexBuffers: {
  131911. [key: string]: VertexBuffer;
  131912. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  131913. recordVertexArrayObject(vertexBuffers: {
  131914. [key: string]: VertexBuffer;
  131915. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  131916. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  131917. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  131918. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131919. /**
  131920. * Draw a list of indexed primitives
  131921. * @param fillMode defines the primitive to use
  131922. * @param indexStart defines the starting index
  131923. * @param indexCount defines the number of index to draw
  131924. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131925. */
  131926. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131927. /**
  131928. * Draw a list of unindexed primitives
  131929. * @param fillMode defines the primitive to use
  131930. * @param verticesStart defines the index of first vertex to draw
  131931. * @param verticesCount defines the count of vertices to draw
  131932. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131933. */
  131934. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131935. createPipelineContext(): IPipelineContext;
  131936. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  131937. /** @hidden */
  131938. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  131939. /** @hidden */
  131940. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  131941. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  131942. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  131943. protected _setProgram(program: WebGLProgram): void;
  131944. _releaseEffect(effect: Effect): void;
  131945. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  131946. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  131947. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  131948. bindSamplers(effect: Effect): void;
  131949. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  131950. getRenderWidth(useScreen?: boolean): number;
  131951. getRenderHeight(useScreen?: boolean): number;
  131952. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  131953. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131954. /**
  131955. * Set the z offset to apply to current rendering
  131956. * @param value defines the offset to apply
  131957. */
  131958. setZOffset(value: number): void;
  131959. /**
  131960. * Gets the current value of the zOffset
  131961. * @returns the current zOffset state
  131962. */
  131963. getZOffset(): number;
  131964. /**
  131965. * Enable or disable depth buffering
  131966. * @param enable defines the state to set
  131967. */
  131968. setDepthBuffer(enable: boolean): void;
  131969. /**
  131970. * Gets a boolean indicating if depth writing is enabled
  131971. * @returns the current depth writing state
  131972. */
  131973. getDepthWrite(): boolean;
  131974. /**
  131975. * Enable or disable depth writing
  131976. * @param enable defines the state to set
  131977. */
  131978. setDepthWrite(enable: boolean): void;
  131979. /**
  131980. * Enable or disable color writing
  131981. * @param enable defines the state to set
  131982. */
  131983. setColorWrite(enable: boolean): void;
  131984. /**
  131985. * Gets a boolean indicating if color writing is enabled
  131986. * @returns the current color writing state
  131987. */
  131988. getColorWrite(): boolean;
  131989. /**
  131990. * Sets alpha constants used by some alpha blending modes
  131991. * @param r defines the red component
  131992. * @param g defines the green component
  131993. * @param b defines the blue component
  131994. * @param a defines the alpha component
  131995. */
  131996. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  131997. /**
  131998. * Sets the current alpha mode
  131999. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132000. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132001. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132002. */
  132003. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132004. /**
  132005. * Gets the current alpha mode
  132006. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132007. * @returns the current alpha mode
  132008. */
  132009. getAlphaMode(): number;
  132010. setInt(uniform: WebGLUniformLocation, int: number): void;
  132011. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132012. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132013. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132014. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132015. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132016. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132017. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132018. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132019. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132020. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132021. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132022. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132023. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132024. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132025. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132026. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132027. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132028. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132029. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132030. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132031. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132032. wipeCaches(bruteForce?: boolean): void;
  132033. _createTexture(): WebGLTexture;
  132034. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132035. /**
  132036. * Usually called from Texture.ts.
  132037. * Passed information to create a WebGLTexture
  132038. * @param url defines a value which contains one of the following:
  132039. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132040. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132041. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132042. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132043. * @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)
  132044. * @param scene needed for loading to the correct scene
  132045. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132046. * @param onLoad optional callback to be called upon successful completion
  132047. * @param onError optional callback to be called upon failure
  132048. * @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
  132049. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132050. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132051. * @param forcedExtension defines the extension to use to pick the right loader
  132052. * @param mimeType defines an optional mime type
  132053. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132054. */
  132055. 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;
  132056. /**
  132057. * Creates a cube texture
  132058. * @param rootUrl defines the url where the files to load is located
  132059. * @param scene defines the current scene
  132060. * @param files defines the list of files to load (1 per face)
  132061. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132062. * @param onLoad defines an optional callback raised when the texture is loaded
  132063. * @param onError defines an optional callback raised if there is an issue to load the texture
  132064. * @param format defines the format of the data
  132065. * @param forcedExtension defines the extension to use to pick the right loader
  132066. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132067. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132068. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132069. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132070. * @returns the cube texture as an InternalTexture
  132071. */
  132072. 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;
  132073. private _getSamplingFilter;
  132074. private static _GetNativeTextureFormat;
  132075. createRenderTargetTexture(size: number | {
  132076. width: number;
  132077. height: number;
  132078. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132079. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132080. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132081. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132082. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132083. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132084. /**
  132085. * Updates a dynamic vertex buffer.
  132086. * @param vertexBuffer the vertex buffer to update
  132087. * @param data the data used to update the vertex buffer
  132088. * @param byteOffset the byte offset of the data (optional)
  132089. * @param byteLength the byte length of the data (optional)
  132090. */
  132091. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132092. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132093. private _updateAnisotropicLevel;
  132094. private _getAddressMode;
  132095. /** @hidden */
  132096. _bindTexture(channel: number, texture: InternalTexture): void;
  132097. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132098. releaseEffects(): void;
  132099. /** @hidden */
  132100. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132101. /** @hidden */
  132102. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132103. /** @hidden */
  132104. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132105. /** @hidden */
  132106. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132107. }
  132108. }
  132109. declare module BABYLON {
  132110. /**
  132111. * Gather the list of clipboard event types as constants.
  132112. */
  132113. export class ClipboardEventTypes {
  132114. /**
  132115. * The clipboard event is fired when a copy command is active (pressed).
  132116. */
  132117. static readonly COPY: number;
  132118. /**
  132119. * The clipboard event is fired when a cut command is active (pressed).
  132120. */
  132121. static readonly CUT: number;
  132122. /**
  132123. * The clipboard event is fired when a paste command is active (pressed).
  132124. */
  132125. static readonly PASTE: number;
  132126. }
  132127. /**
  132128. * This class is used to store clipboard related info for the onClipboardObservable event.
  132129. */
  132130. export class ClipboardInfo {
  132131. /**
  132132. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132133. */
  132134. type: number;
  132135. /**
  132136. * Defines the related dom event
  132137. */
  132138. event: ClipboardEvent;
  132139. /**
  132140. *Creates an instance of ClipboardInfo.
  132141. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132142. * @param event Defines the related dom event
  132143. */
  132144. constructor(
  132145. /**
  132146. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132147. */
  132148. type: number,
  132149. /**
  132150. * Defines the related dom event
  132151. */
  132152. event: ClipboardEvent);
  132153. /**
  132154. * Get the clipboard event's type from the keycode.
  132155. * @param keyCode Defines the keyCode for the current keyboard event.
  132156. * @return {number}
  132157. */
  132158. static GetTypeFromCharacter(keyCode: number): number;
  132159. }
  132160. }
  132161. declare module BABYLON {
  132162. /**
  132163. * Google Daydream controller
  132164. */
  132165. export class DaydreamController extends WebVRController {
  132166. /**
  132167. * Base Url for the controller model.
  132168. */
  132169. static MODEL_BASE_URL: string;
  132170. /**
  132171. * File name for the controller model.
  132172. */
  132173. static MODEL_FILENAME: string;
  132174. /**
  132175. * Gamepad Id prefix used to identify Daydream Controller.
  132176. */
  132177. static readonly GAMEPAD_ID_PREFIX: string;
  132178. /**
  132179. * Creates a new DaydreamController from a gamepad
  132180. * @param vrGamepad the gamepad that the controller should be created from
  132181. */
  132182. constructor(vrGamepad: any);
  132183. /**
  132184. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132185. * @param scene scene in which to add meshes
  132186. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132187. */
  132188. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132189. /**
  132190. * Called once for each button that changed state since the last frame
  132191. * @param buttonIdx Which button index changed
  132192. * @param state New state of the button
  132193. * @param changes Which properties on the state changed since last frame
  132194. */
  132195. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132196. }
  132197. }
  132198. declare module BABYLON {
  132199. /**
  132200. * Gear VR Controller
  132201. */
  132202. export class GearVRController extends WebVRController {
  132203. /**
  132204. * Base Url for the controller model.
  132205. */
  132206. static MODEL_BASE_URL: string;
  132207. /**
  132208. * File name for the controller model.
  132209. */
  132210. static MODEL_FILENAME: string;
  132211. /**
  132212. * Gamepad Id prefix used to identify this controller.
  132213. */
  132214. static readonly GAMEPAD_ID_PREFIX: string;
  132215. private readonly _buttonIndexToObservableNameMap;
  132216. /**
  132217. * Creates a new GearVRController from a gamepad
  132218. * @param vrGamepad the gamepad that the controller should be created from
  132219. */
  132220. constructor(vrGamepad: any);
  132221. /**
  132222. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132223. * @param scene scene in which to add meshes
  132224. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132225. */
  132226. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132227. /**
  132228. * Called once for each button that changed state since the last frame
  132229. * @param buttonIdx Which button index changed
  132230. * @param state New state of the button
  132231. * @param changes Which properties on the state changed since last frame
  132232. */
  132233. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132234. }
  132235. }
  132236. declare module BABYLON {
  132237. /**
  132238. * Generic Controller
  132239. */
  132240. export class GenericController extends WebVRController {
  132241. /**
  132242. * Base Url for the controller model.
  132243. */
  132244. static readonly MODEL_BASE_URL: string;
  132245. /**
  132246. * File name for the controller model.
  132247. */
  132248. static readonly MODEL_FILENAME: string;
  132249. /**
  132250. * Creates a new GenericController from a gamepad
  132251. * @param vrGamepad the gamepad that the controller should be created from
  132252. */
  132253. constructor(vrGamepad: any);
  132254. /**
  132255. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132256. * @param scene scene in which to add meshes
  132257. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132258. */
  132259. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132260. /**
  132261. * Called once for each button that changed state since the last frame
  132262. * @param buttonIdx Which button index changed
  132263. * @param state New state of the button
  132264. * @param changes Which properties on the state changed since last frame
  132265. */
  132266. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132267. }
  132268. }
  132269. declare module BABYLON {
  132270. /**
  132271. * Oculus Touch Controller
  132272. */
  132273. export class OculusTouchController extends WebVRController {
  132274. /**
  132275. * Base Url for the controller model.
  132276. */
  132277. static MODEL_BASE_URL: string;
  132278. /**
  132279. * File name for the left controller model.
  132280. */
  132281. static MODEL_LEFT_FILENAME: string;
  132282. /**
  132283. * File name for the right controller model.
  132284. */
  132285. static MODEL_RIGHT_FILENAME: string;
  132286. /**
  132287. * Base Url for the Quest controller model.
  132288. */
  132289. static QUEST_MODEL_BASE_URL: string;
  132290. /**
  132291. * @hidden
  132292. * If the controllers are running on a device that needs the updated Quest controller models
  132293. */
  132294. static _IsQuest: boolean;
  132295. /**
  132296. * Fired when the secondary trigger on this controller is modified
  132297. */
  132298. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132299. /**
  132300. * Fired when the thumb rest on this controller is modified
  132301. */
  132302. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132303. /**
  132304. * Creates a new OculusTouchController from a gamepad
  132305. * @param vrGamepad the gamepad that the controller should be created from
  132306. */
  132307. constructor(vrGamepad: any);
  132308. /**
  132309. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132310. * @param scene scene in which to add meshes
  132311. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132312. */
  132313. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132314. /**
  132315. * Fired when the A button on this controller is modified
  132316. */
  132317. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132318. /**
  132319. * Fired when the B button on this controller is modified
  132320. */
  132321. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132322. /**
  132323. * Fired when the X button on this controller is modified
  132324. */
  132325. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132326. /**
  132327. * Fired when the Y button on this controller is modified
  132328. */
  132329. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132330. /**
  132331. * Called once for each button that changed state since the last frame
  132332. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132333. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132334. * 2) secondary trigger (same)
  132335. * 3) A (right) X (left), touch, pressed = value
  132336. * 4) B / Y
  132337. * 5) thumb rest
  132338. * @param buttonIdx Which button index changed
  132339. * @param state New state of the button
  132340. * @param changes Which properties on the state changed since last frame
  132341. */
  132342. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132343. }
  132344. }
  132345. declare module BABYLON {
  132346. /**
  132347. * Vive Controller
  132348. */
  132349. export class ViveController extends WebVRController {
  132350. /**
  132351. * Base Url for the controller model.
  132352. */
  132353. static MODEL_BASE_URL: string;
  132354. /**
  132355. * File name for the controller model.
  132356. */
  132357. static MODEL_FILENAME: string;
  132358. /**
  132359. * Creates a new ViveController from a gamepad
  132360. * @param vrGamepad the gamepad that the controller should be created from
  132361. */
  132362. constructor(vrGamepad: any);
  132363. /**
  132364. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132365. * @param scene scene in which to add meshes
  132366. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132367. */
  132368. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132369. /**
  132370. * Fired when the left button on this controller is modified
  132371. */
  132372. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132373. /**
  132374. * Fired when the right button on this controller is modified
  132375. */
  132376. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132377. /**
  132378. * Fired when the menu button on this controller is modified
  132379. */
  132380. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132381. /**
  132382. * Called once for each button that changed state since the last frame
  132383. * Vive mapping:
  132384. * 0: touchpad
  132385. * 1: trigger
  132386. * 2: left AND right buttons
  132387. * 3: menu button
  132388. * @param buttonIdx Which button index changed
  132389. * @param state New state of the button
  132390. * @param changes Which properties on the state changed since last frame
  132391. */
  132392. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132393. }
  132394. }
  132395. declare module BABYLON {
  132396. /**
  132397. * Defines the WindowsMotionController object that the state of the windows motion controller
  132398. */
  132399. export class WindowsMotionController extends WebVRController {
  132400. /**
  132401. * The base url used to load the left and right controller models
  132402. */
  132403. static MODEL_BASE_URL: string;
  132404. /**
  132405. * The name of the left controller model file
  132406. */
  132407. static MODEL_LEFT_FILENAME: string;
  132408. /**
  132409. * The name of the right controller model file
  132410. */
  132411. static MODEL_RIGHT_FILENAME: string;
  132412. /**
  132413. * The controller name prefix for this controller type
  132414. */
  132415. static readonly GAMEPAD_ID_PREFIX: string;
  132416. /**
  132417. * The controller id pattern for this controller type
  132418. */
  132419. private static readonly GAMEPAD_ID_PATTERN;
  132420. private _loadedMeshInfo;
  132421. protected readonly _mapping: {
  132422. buttons: string[];
  132423. buttonMeshNames: {
  132424. trigger: string;
  132425. menu: string;
  132426. grip: string;
  132427. thumbstick: string;
  132428. trackpad: string;
  132429. };
  132430. buttonObservableNames: {
  132431. trigger: string;
  132432. menu: string;
  132433. grip: string;
  132434. thumbstick: string;
  132435. trackpad: string;
  132436. };
  132437. axisMeshNames: string[];
  132438. pointingPoseMeshName: string;
  132439. };
  132440. /**
  132441. * Fired when the trackpad on this controller is clicked
  132442. */
  132443. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132444. /**
  132445. * Fired when the trackpad on this controller is modified
  132446. */
  132447. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132448. /**
  132449. * The current x and y values of this controller's trackpad
  132450. */
  132451. trackpad: StickValues;
  132452. /**
  132453. * Creates a new WindowsMotionController from a gamepad
  132454. * @param vrGamepad the gamepad that the controller should be created from
  132455. */
  132456. constructor(vrGamepad: any);
  132457. /**
  132458. * Fired when the trigger on this controller is modified
  132459. */
  132460. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132461. /**
  132462. * Fired when the menu button on this controller is modified
  132463. */
  132464. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132465. /**
  132466. * Fired when the grip button on this controller is modified
  132467. */
  132468. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132469. /**
  132470. * Fired when the thumbstick button on this controller is modified
  132471. */
  132472. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132473. /**
  132474. * Fired when the touchpad button on this controller is modified
  132475. */
  132476. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132477. /**
  132478. * Fired when the touchpad values on this controller are modified
  132479. */
  132480. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  132481. protected _updateTrackpad(): void;
  132482. /**
  132483. * Called once per frame by the engine.
  132484. */
  132485. update(): void;
  132486. /**
  132487. * Called once for each button that changed state since the last frame
  132488. * @param buttonIdx Which button index changed
  132489. * @param state New state of the button
  132490. * @param changes Which properties on the state changed since last frame
  132491. */
  132492. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132493. /**
  132494. * Moves the buttons on the controller mesh based on their current state
  132495. * @param buttonName the name of the button to move
  132496. * @param buttonValue the value of the button which determines the buttons new position
  132497. */
  132498. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  132499. /**
  132500. * Moves the axis on the controller mesh based on its current state
  132501. * @param axis the index of the axis
  132502. * @param axisValue the value of the axis which determines the meshes new position
  132503. * @hidden
  132504. */
  132505. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  132506. /**
  132507. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132508. * @param scene scene in which to add meshes
  132509. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132510. */
  132511. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  132512. /**
  132513. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  132514. * can be transformed by button presses and axes values, based on this._mapping.
  132515. *
  132516. * @param scene scene in which the meshes exist
  132517. * @param meshes list of meshes that make up the controller model to process
  132518. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  132519. */
  132520. private processModel;
  132521. private createMeshInfo;
  132522. /**
  132523. * Gets the ray of the controller in the direction the controller is pointing
  132524. * @param length the length the resulting ray should be
  132525. * @returns a ray in the direction the controller is pointing
  132526. */
  132527. getForwardRay(length?: number): Ray;
  132528. /**
  132529. * Disposes of the controller
  132530. */
  132531. dispose(): void;
  132532. }
  132533. /**
  132534. * This class represents a new windows motion controller in XR.
  132535. */
  132536. export class XRWindowsMotionController extends WindowsMotionController {
  132537. /**
  132538. * Changing the original WIndowsMotionController mapping to fir the new mapping
  132539. */
  132540. protected readonly _mapping: {
  132541. buttons: string[];
  132542. buttonMeshNames: {
  132543. trigger: string;
  132544. menu: string;
  132545. grip: string;
  132546. thumbstick: string;
  132547. trackpad: string;
  132548. };
  132549. buttonObservableNames: {
  132550. trigger: string;
  132551. menu: string;
  132552. grip: string;
  132553. thumbstick: string;
  132554. trackpad: string;
  132555. };
  132556. axisMeshNames: string[];
  132557. pointingPoseMeshName: string;
  132558. };
  132559. /**
  132560. * Construct a new XR-Based windows motion controller
  132561. *
  132562. * @param gamepadInfo the gamepad object from the browser
  132563. */
  132564. constructor(gamepadInfo: any);
  132565. /**
  132566. * holds the thumbstick values (X,Y)
  132567. */
  132568. thumbstickValues: StickValues;
  132569. /**
  132570. * Fired when the thumbstick on this controller is clicked
  132571. */
  132572. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  132573. /**
  132574. * Fired when the thumbstick on this controller is modified
  132575. */
  132576. onThumbstickValuesChangedObservable: Observable<StickValues>;
  132577. /**
  132578. * Fired when the touchpad button on this controller is modified
  132579. */
  132580. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132581. /**
  132582. * Fired when the touchpad values on this controller are modified
  132583. */
  132584. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132585. /**
  132586. * Fired when the thumbstick button on this controller is modified
  132587. * here to prevent breaking changes
  132588. */
  132589. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132590. /**
  132591. * updating the thumbstick(!) and not the trackpad.
  132592. * This is named this way due to the difference between WebVR and XR and to avoid
  132593. * changing the parent class.
  132594. */
  132595. protected _updateTrackpad(): void;
  132596. /**
  132597. * Disposes the class with joy
  132598. */
  132599. dispose(): void;
  132600. }
  132601. }
  132602. declare module BABYLON {
  132603. /**
  132604. * Class containing static functions to help procedurally build meshes
  132605. */
  132606. export class PolyhedronBuilder {
  132607. /**
  132608. * Creates a polyhedron mesh
  132609. * * 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
  132610. * * The parameter `size` (positive float, default 1) sets the polygon size
  132611. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  132612. * * 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`
  132613. * * 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
  132614. * * 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)`)
  132615. * * 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
  132616. * * 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
  132617. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  132618. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  132619. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  132620. * @param name defines the name of the mesh
  132621. * @param options defines the options used to create the mesh
  132622. * @param scene defines the hosting scene
  132623. * @returns the polyhedron mesh
  132624. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  132625. */
  132626. static CreatePolyhedron(name: string, options: {
  132627. type?: number;
  132628. size?: number;
  132629. sizeX?: number;
  132630. sizeY?: number;
  132631. sizeZ?: number;
  132632. custom?: any;
  132633. faceUV?: Vector4[];
  132634. faceColors?: Color4[];
  132635. flat?: boolean;
  132636. updatable?: boolean;
  132637. sideOrientation?: number;
  132638. frontUVs?: Vector4;
  132639. backUVs?: Vector4;
  132640. }, scene?: Nullable<Scene>): Mesh;
  132641. }
  132642. }
  132643. declare module BABYLON {
  132644. /**
  132645. * Gizmo that enables scaling a mesh along 3 axis
  132646. */
  132647. export class ScaleGizmo extends Gizmo {
  132648. /**
  132649. * Internal gizmo used for interactions on the x axis
  132650. */
  132651. xGizmo: AxisScaleGizmo;
  132652. /**
  132653. * Internal gizmo used for interactions on the y axis
  132654. */
  132655. yGizmo: AxisScaleGizmo;
  132656. /**
  132657. * Internal gizmo used for interactions on the z axis
  132658. */
  132659. zGizmo: AxisScaleGizmo;
  132660. /**
  132661. * Internal gizmo used to scale all axis equally
  132662. */
  132663. uniformScaleGizmo: AxisScaleGizmo;
  132664. private _meshAttached;
  132665. private _nodeAttached;
  132666. private _updateGizmoRotationToMatchAttachedMesh;
  132667. private _snapDistance;
  132668. private _scaleRatio;
  132669. private _uniformScalingMesh;
  132670. private _octahedron;
  132671. private _sensitivity;
  132672. /** Fires an event when any of it's sub gizmos are dragged */
  132673. onDragStartObservable: Observable<unknown>;
  132674. /** Fires an event when any of it's sub gizmos are released from dragging */
  132675. onDragEndObservable: Observable<unknown>;
  132676. get attachedMesh(): Nullable<AbstractMesh>;
  132677. set attachedMesh(mesh: Nullable<AbstractMesh>);
  132678. get attachedNode(): Nullable<Node>;
  132679. set attachedNode(node: Nullable<Node>);
  132680. /**
  132681. * Creates a ScaleGizmo
  132682. * @param gizmoLayer The utility layer the gizmo will be added to
  132683. * @param thickness display gizmo axis thickness
  132684. */
  132685. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  132686. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  132687. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  132688. /**
  132689. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  132690. */
  132691. set snapDistance(value: number);
  132692. get snapDistance(): number;
  132693. /**
  132694. * Ratio for the scale of the gizmo (Default: 1)
  132695. */
  132696. set scaleRatio(value: number);
  132697. get scaleRatio(): number;
  132698. /**
  132699. * Sensitivity factor for dragging (Default: 1)
  132700. */
  132701. set sensitivity(value: number);
  132702. get sensitivity(): number;
  132703. /**
  132704. * Disposes of the gizmo
  132705. */
  132706. dispose(): void;
  132707. }
  132708. }
  132709. declare module BABYLON {
  132710. /**
  132711. * Single axis scale gizmo
  132712. */
  132713. export class AxisScaleGizmo extends Gizmo {
  132714. /**
  132715. * Drag behavior responsible for the gizmos dragging interactions
  132716. */
  132717. dragBehavior: PointerDragBehavior;
  132718. private _pointerObserver;
  132719. /**
  132720. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  132721. */
  132722. snapDistance: number;
  132723. /**
  132724. * Event that fires each time the gizmo snaps to a new location.
  132725. * * snapDistance is the the change in distance
  132726. */
  132727. onSnapObservable: Observable<{
  132728. snapDistance: number;
  132729. }>;
  132730. /**
  132731. * If the scaling operation should be done on all axis (default: false)
  132732. */
  132733. uniformScaling: boolean;
  132734. /**
  132735. * Custom sensitivity value for the drag strength
  132736. */
  132737. sensitivity: number;
  132738. private _isEnabled;
  132739. private _parent;
  132740. private _arrow;
  132741. private _coloredMaterial;
  132742. private _hoverMaterial;
  132743. /**
  132744. * Creates an AxisScaleGizmo
  132745. * @param gizmoLayer The utility layer the gizmo will be added to
  132746. * @param dragAxis The axis which the gizmo will be able to scale on
  132747. * @param color The color of the gizmo
  132748. * @param thickness display gizmo axis thickness
  132749. */
  132750. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  132751. protected _attachedNodeChanged(value: Nullable<Node>): void;
  132752. /**
  132753. * If the gizmo is enabled
  132754. */
  132755. set isEnabled(value: boolean);
  132756. get isEnabled(): boolean;
  132757. /**
  132758. * Disposes of the gizmo
  132759. */
  132760. dispose(): void;
  132761. /**
  132762. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  132763. * @param mesh The mesh to replace the default mesh of the gizmo
  132764. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  132765. */
  132766. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  132767. }
  132768. }
  132769. declare module BABYLON {
  132770. /**
  132771. * Bounding box gizmo
  132772. */
  132773. export class BoundingBoxGizmo extends Gizmo {
  132774. private _lineBoundingBox;
  132775. private _rotateSpheresParent;
  132776. private _scaleBoxesParent;
  132777. private _boundingDimensions;
  132778. private _renderObserver;
  132779. private _pointerObserver;
  132780. private _scaleDragSpeed;
  132781. private _tmpQuaternion;
  132782. private _tmpVector;
  132783. private _tmpRotationMatrix;
  132784. /**
  132785. * 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)
  132786. */
  132787. ignoreChildren: boolean;
  132788. /**
  132789. * 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)
  132790. */
  132791. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  132792. /**
  132793. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  132794. */
  132795. rotationSphereSize: number;
  132796. /**
  132797. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  132798. */
  132799. scaleBoxSize: number;
  132800. /**
  132801. * 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)
  132802. */
  132803. fixedDragMeshScreenSize: boolean;
  132804. /**
  132805. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  132806. */
  132807. fixedDragMeshScreenSizeDistanceFactor: number;
  132808. /**
  132809. * Fired when a rotation sphere or scale box is dragged
  132810. */
  132811. onDragStartObservable: Observable<{}>;
  132812. /**
  132813. * Fired when a scale box is dragged
  132814. */
  132815. onScaleBoxDragObservable: Observable<{}>;
  132816. /**
  132817. * Fired when a scale box drag is ended
  132818. */
  132819. onScaleBoxDragEndObservable: Observable<{}>;
  132820. /**
  132821. * Fired when a rotation sphere is dragged
  132822. */
  132823. onRotationSphereDragObservable: Observable<{}>;
  132824. /**
  132825. * Fired when a rotation sphere drag is ended
  132826. */
  132827. onRotationSphereDragEndObservable: Observable<{}>;
  132828. /**
  132829. * 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)
  132830. */
  132831. scalePivot: Nullable<Vector3>;
  132832. /**
  132833. * Mesh used as a pivot to rotate the attached node
  132834. */
  132835. private _anchorMesh;
  132836. private _existingMeshScale;
  132837. private _dragMesh;
  132838. private pointerDragBehavior;
  132839. private coloredMaterial;
  132840. private hoverColoredMaterial;
  132841. /**
  132842. * Sets the color of the bounding box gizmo
  132843. * @param color the color to set
  132844. */
  132845. setColor(color: Color3): void;
  132846. /**
  132847. * Creates an BoundingBoxGizmo
  132848. * @param gizmoLayer The utility layer the gizmo will be added to
  132849. * @param color The color of the gizmo
  132850. */
  132851. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  132852. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  132853. private _selectNode;
  132854. /**
  132855. * Updates the bounding box information for the Gizmo
  132856. */
  132857. updateBoundingBox(): void;
  132858. private _updateRotationSpheres;
  132859. private _updateScaleBoxes;
  132860. /**
  132861. * Enables rotation on the specified axis and disables rotation on the others
  132862. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  132863. */
  132864. setEnabledRotationAxis(axis: string): void;
  132865. /**
  132866. * Enables/disables scaling
  132867. * @param enable if scaling should be enabled
  132868. * @param homogeneousScaling defines if scaling should only be homogeneous
  132869. */
  132870. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  132871. private _updateDummy;
  132872. /**
  132873. * Enables a pointer drag behavior on the bounding box of the gizmo
  132874. */
  132875. enableDragBehavior(): void;
  132876. /**
  132877. * Disposes of the gizmo
  132878. */
  132879. dispose(): void;
  132880. /**
  132881. * 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)
  132882. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  132883. * @returns the bounding box mesh with the passed in mesh as a child
  132884. */
  132885. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  132886. /**
  132887. * CustomMeshes are not supported by this gizmo
  132888. * @param mesh The mesh to replace the default mesh of the gizmo
  132889. */
  132890. setCustomMesh(mesh: Mesh): void;
  132891. }
  132892. }
  132893. declare module BABYLON {
  132894. /**
  132895. * Single plane rotation gizmo
  132896. */
  132897. export class PlaneRotationGizmo extends Gizmo {
  132898. /**
  132899. * Drag behavior responsible for the gizmos dragging interactions
  132900. */
  132901. dragBehavior: PointerDragBehavior;
  132902. private _pointerObserver;
  132903. /**
  132904. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  132905. */
  132906. snapDistance: number;
  132907. /**
  132908. * Event that fires each time the gizmo snaps to a new location.
  132909. * * snapDistance is the the change in distance
  132910. */
  132911. onSnapObservable: Observable<{
  132912. snapDistance: number;
  132913. }>;
  132914. private _isEnabled;
  132915. private _parent;
  132916. /**
  132917. * Creates a PlaneRotationGizmo
  132918. * @param gizmoLayer The utility layer the gizmo will be added to
  132919. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  132920. * @param color The color of the gizmo
  132921. * @param tessellation Amount of tessellation to be used when creating rotation circles
  132922. * @param useEulerRotation Use and update Euler angle instead of quaternion
  132923. * @param thickness display gizmo axis thickness
  132924. */
  132925. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  132926. protected _attachedNodeChanged(value: Nullable<Node>): void;
  132927. /**
  132928. * If the gizmo is enabled
  132929. */
  132930. set isEnabled(value: boolean);
  132931. get isEnabled(): boolean;
  132932. /**
  132933. * Disposes of the gizmo
  132934. */
  132935. dispose(): void;
  132936. }
  132937. }
  132938. declare module BABYLON {
  132939. /**
  132940. * Gizmo that enables rotating a mesh along 3 axis
  132941. */
  132942. export class RotationGizmo extends Gizmo {
  132943. /**
  132944. * Internal gizmo used for interactions on the x axis
  132945. */
  132946. xGizmo: PlaneRotationGizmo;
  132947. /**
  132948. * Internal gizmo used for interactions on the y axis
  132949. */
  132950. yGizmo: PlaneRotationGizmo;
  132951. /**
  132952. * Internal gizmo used for interactions on the z axis
  132953. */
  132954. zGizmo: PlaneRotationGizmo;
  132955. /** Fires an event when any of it's sub gizmos are dragged */
  132956. onDragStartObservable: Observable<unknown>;
  132957. /** Fires an event when any of it's sub gizmos are released from dragging */
  132958. onDragEndObservable: Observable<unknown>;
  132959. private _meshAttached;
  132960. private _nodeAttached;
  132961. get attachedMesh(): Nullable<AbstractMesh>;
  132962. set attachedMesh(mesh: Nullable<AbstractMesh>);
  132963. get attachedNode(): Nullable<Node>;
  132964. set attachedNode(node: Nullable<Node>);
  132965. /**
  132966. * Creates a RotationGizmo
  132967. * @param gizmoLayer The utility layer the gizmo will be added to
  132968. * @param tessellation Amount of tessellation to be used when creating rotation circles
  132969. * @param useEulerRotation Use and update Euler angle instead of quaternion
  132970. * @param thickness display gizmo axis thickness
  132971. */
  132972. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  132973. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  132974. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  132975. /**
  132976. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  132977. */
  132978. set snapDistance(value: number);
  132979. get snapDistance(): number;
  132980. /**
  132981. * Ratio for the scale of the gizmo (Default: 1)
  132982. */
  132983. set scaleRatio(value: number);
  132984. get scaleRatio(): number;
  132985. /**
  132986. * Disposes of the gizmo
  132987. */
  132988. dispose(): void;
  132989. /**
  132990. * CustomMeshes are not supported by this gizmo
  132991. * @param mesh The mesh to replace the default mesh of the gizmo
  132992. */
  132993. setCustomMesh(mesh: Mesh): void;
  132994. }
  132995. }
  132996. declare module BABYLON {
  132997. /**
  132998. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  132999. */
  133000. export class GizmoManager implements IDisposable {
  133001. private scene;
  133002. /**
  133003. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133004. */
  133005. gizmos: {
  133006. positionGizmo: Nullable<PositionGizmo>;
  133007. rotationGizmo: Nullable<RotationGizmo>;
  133008. scaleGizmo: Nullable<ScaleGizmo>;
  133009. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133010. };
  133011. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133012. clearGizmoOnEmptyPointerEvent: boolean;
  133013. /** Fires an event when the manager is attached to a mesh */
  133014. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133015. /** Fires an event when the manager is attached to a node */
  133016. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133017. private _gizmosEnabled;
  133018. private _pointerObserver;
  133019. private _attachedMesh;
  133020. private _attachedNode;
  133021. private _boundingBoxColor;
  133022. private _defaultUtilityLayer;
  133023. private _defaultKeepDepthUtilityLayer;
  133024. private _thickness;
  133025. /**
  133026. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133027. */
  133028. boundingBoxDragBehavior: SixDofDragBehavior;
  133029. /**
  133030. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133031. */
  133032. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133033. /**
  133034. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133035. */
  133036. attachableNodes: Nullable<Array<Node>>;
  133037. /**
  133038. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133039. */
  133040. usePointerToAttachGizmos: boolean;
  133041. /**
  133042. * Utility layer that the bounding box gizmo belongs to
  133043. */
  133044. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133045. /**
  133046. * Utility layer that all gizmos besides bounding box belong to
  133047. */
  133048. get utilityLayer(): UtilityLayerRenderer;
  133049. /**
  133050. * Instatiates a gizmo manager
  133051. * @param scene the scene to overlay the gizmos on top of
  133052. * @param thickness display gizmo axis thickness
  133053. */
  133054. constructor(scene: Scene, thickness?: number);
  133055. /**
  133056. * Attaches a set of gizmos to the specified mesh
  133057. * @param mesh The mesh the gizmo's should be attached to
  133058. */
  133059. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133060. /**
  133061. * Attaches a set of gizmos to the specified node
  133062. * @param node The node the gizmo's should be attached to
  133063. */
  133064. attachToNode(node: Nullable<Node>): void;
  133065. /**
  133066. * If the position gizmo is enabled
  133067. */
  133068. set positionGizmoEnabled(value: boolean);
  133069. get positionGizmoEnabled(): boolean;
  133070. /**
  133071. * If the rotation gizmo is enabled
  133072. */
  133073. set rotationGizmoEnabled(value: boolean);
  133074. get rotationGizmoEnabled(): boolean;
  133075. /**
  133076. * If the scale gizmo is enabled
  133077. */
  133078. set scaleGizmoEnabled(value: boolean);
  133079. get scaleGizmoEnabled(): boolean;
  133080. /**
  133081. * If the boundingBox gizmo is enabled
  133082. */
  133083. set boundingBoxGizmoEnabled(value: boolean);
  133084. get boundingBoxGizmoEnabled(): boolean;
  133085. /**
  133086. * Disposes of the gizmo manager
  133087. */
  133088. dispose(): void;
  133089. }
  133090. }
  133091. declare module BABYLON {
  133092. /**
  133093. * A directional light is defined by a direction (what a surprise!).
  133094. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133095. * 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.
  133096. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133097. */
  133098. export class DirectionalLight extends ShadowLight {
  133099. private _shadowFrustumSize;
  133100. /**
  133101. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133102. */
  133103. get shadowFrustumSize(): number;
  133104. /**
  133105. * Specifies a fix frustum size for the shadow generation.
  133106. */
  133107. set shadowFrustumSize(value: number);
  133108. private _shadowOrthoScale;
  133109. /**
  133110. * Gets the shadow projection scale against the optimal computed one.
  133111. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133112. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133113. */
  133114. get shadowOrthoScale(): number;
  133115. /**
  133116. * Sets the shadow projection scale against the optimal computed one.
  133117. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133118. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133119. */
  133120. set shadowOrthoScale(value: number);
  133121. /**
  133122. * Automatically compute the projection matrix to best fit (including all the casters)
  133123. * on each frame.
  133124. */
  133125. autoUpdateExtends: boolean;
  133126. /**
  133127. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133128. * on each frame. autoUpdateExtends must be set to true for this to work
  133129. */
  133130. autoCalcShadowZBounds: boolean;
  133131. private _orthoLeft;
  133132. private _orthoRight;
  133133. private _orthoTop;
  133134. private _orthoBottom;
  133135. /**
  133136. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133137. * The directional light is emitted from everywhere in the given direction.
  133138. * It can cast shadows.
  133139. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133140. * @param name The friendly name of the light
  133141. * @param direction The direction of the light
  133142. * @param scene The scene the light belongs to
  133143. */
  133144. constructor(name: string, direction: Vector3, scene: Scene);
  133145. /**
  133146. * Returns the string "DirectionalLight".
  133147. * @return The class name
  133148. */
  133149. getClassName(): string;
  133150. /**
  133151. * Returns the integer 1.
  133152. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133153. */
  133154. getTypeID(): number;
  133155. /**
  133156. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133157. * Returns the DirectionalLight Shadow projection matrix.
  133158. */
  133159. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133160. /**
  133161. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133162. * Returns the DirectionalLight Shadow projection matrix.
  133163. */
  133164. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133165. /**
  133166. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133167. * Returns the DirectionalLight Shadow projection matrix.
  133168. */
  133169. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133170. protected _buildUniformLayout(): void;
  133171. /**
  133172. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133173. * @param effect The effect to update
  133174. * @param lightIndex The index of the light in the effect to update
  133175. * @returns The directional light
  133176. */
  133177. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133178. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133179. /**
  133180. * Gets the minZ used for shadow according to both the scene and the light.
  133181. *
  133182. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133183. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133184. * @param activeCamera The camera we are returning the min for
  133185. * @returns the depth min z
  133186. */
  133187. getDepthMinZ(activeCamera: Camera): number;
  133188. /**
  133189. * Gets the maxZ used for shadow according to both the scene and the light.
  133190. *
  133191. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133192. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133193. * @param activeCamera The camera we are returning the max for
  133194. * @returns the depth max z
  133195. */
  133196. getDepthMaxZ(activeCamera: Camera): number;
  133197. /**
  133198. * Prepares the list of defines specific to the light type.
  133199. * @param defines the list of defines
  133200. * @param lightIndex defines the index of the light for the effect
  133201. */
  133202. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133203. }
  133204. }
  133205. declare module BABYLON {
  133206. /**
  133207. * Class containing static functions to help procedurally build meshes
  133208. */
  133209. export class HemisphereBuilder {
  133210. /**
  133211. * Creates a hemisphere mesh
  133212. * @param name defines the name of the mesh
  133213. * @param options defines the options used to create the mesh
  133214. * @param scene defines the hosting scene
  133215. * @returns the hemisphere mesh
  133216. */
  133217. static CreateHemisphere(name: string, options: {
  133218. segments?: number;
  133219. diameter?: number;
  133220. sideOrientation?: number;
  133221. }, scene: any): Mesh;
  133222. }
  133223. }
  133224. declare module BABYLON {
  133225. /**
  133226. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133227. * These values define a cone of light starting from the position, emitting toward the direction.
  133228. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133229. * and the exponent defines the speed of the decay of the light with distance (reach).
  133230. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133231. */
  133232. export class SpotLight extends ShadowLight {
  133233. private _angle;
  133234. private _innerAngle;
  133235. private _cosHalfAngle;
  133236. private _lightAngleScale;
  133237. private _lightAngleOffset;
  133238. /**
  133239. * Gets the cone angle of the spot light in Radians.
  133240. */
  133241. get angle(): number;
  133242. /**
  133243. * Sets the cone angle of the spot light in Radians.
  133244. */
  133245. set angle(value: number);
  133246. /**
  133247. * Only used in gltf falloff mode, this defines the angle where
  133248. * the directional falloff will start before cutting at angle which could be seen
  133249. * as outer angle.
  133250. */
  133251. get innerAngle(): number;
  133252. /**
  133253. * Only used in gltf falloff mode, this defines the angle where
  133254. * the directional falloff will start before cutting at angle which could be seen
  133255. * as outer angle.
  133256. */
  133257. set innerAngle(value: number);
  133258. private _shadowAngleScale;
  133259. /**
  133260. * Allows scaling the angle of the light for shadow generation only.
  133261. */
  133262. get shadowAngleScale(): number;
  133263. /**
  133264. * Allows scaling the angle of the light for shadow generation only.
  133265. */
  133266. set shadowAngleScale(value: number);
  133267. /**
  133268. * The light decay speed with the distance from the emission spot.
  133269. */
  133270. exponent: number;
  133271. private _projectionTextureMatrix;
  133272. /**
  133273. * Allows reading the projecton texture
  133274. */
  133275. get projectionTextureMatrix(): Matrix;
  133276. protected _projectionTextureLightNear: number;
  133277. /**
  133278. * Gets the near clip of the Spotlight for texture projection.
  133279. */
  133280. get projectionTextureLightNear(): number;
  133281. /**
  133282. * Sets the near clip of the Spotlight for texture projection.
  133283. */
  133284. set projectionTextureLightNear(value: number);
  133285. protected _projectionTextureLightFar: number;
  133286. /**
  133287. * Gets the far clip of the Spotlight for texture projection.
  133288. */
  133289. get projectionTextureLightFar(): number;
  133290. /**
  133291. * Sets the far clip of the Spotlight for texture projection.
  133292. */
  133293. set projectionTextureLightFar(value: number);
  133294. protected _projectionTextureUpDirection: Vector3;
  133295. /**
  133296. * Gets the Up vector of the Spotlight for texture projection.
  133297. */
  133298. get projectionTextureUpDirection(): Vector3;
  133299. /**
  133300. * Sets the Up vector of the Spotlight for texture projection.
  133301. */
  133302. set projectionTextureUpDirection(value: Vector3);
  133303. private _projectionTexture;
  133304. /**
  133305. * Gets the projection texture of the light.
  133306. */
  133307. get projectionTexture(): Nullable<BaseTexture>;
  133308. /**
  133309. * Sets the projection texture of the light.
  133310. */
  133311. set projectionTexture(value: Nullable<BaseTexture>);
  133312. private _projectionTextureViewLightDirty;
  133313. private _projectionTextureProjectionLightDirty;
  133314. private _projectionTextureDirty;
  133315. private _projectionTextureViewTargetVector;
  133316. private _projectionTextureViewLightMatrix;
  133317. private _projectionTextureProjectionLightMatrix;
  133318. private _projectionTextureScalingMatrix;
  133319. /**
  133320. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133321. * It can cast shadows.
  133322. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133323. * @param name The light friendly name
  133324. * @param position The position of the spot light in the scene
  133325. * @param direction The direction of the light in the scene
  133326. * @param angle The cone angle of the light in Radians
  133327. * @param exponent The light decay speed with the distance from the emission spot
  133328. * @param scene The scene the lights belongs to
  133329. */
  133330. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133331. /**
  133332. * Returns the string "SpotLight".
  133333. * @returns the class name
  133334. */
  133335. getClassName(): string;
  133336. /**
  133337. * Returns the integer 2.
  133338. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133339. */
  133340. getTypeID(): number;
  133341. /**
  133342. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133343. */
  133344. protected _setDirection(value: Vector3): void;
  133345. /**
  133346. * Overrides the position setter to recompute the projection texture view light Matrix.
  133347. */
  133348. protected _setPosition(value: Vector3): void;
  133349. /**
  133350. * 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.
  133351. * Returns the SpotLight.
  133352. */
  133353. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133354. protected _computeProjectionTextureViewLightMatrix(): void;
  133355. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133356. /**
  133357. * Main function for light texture projection matrix computing.
  133358. */
  133359. protected _computeProjectionTextureMatrix(): void;
  133360. protected _buildUniformLayout(): void;
  133361. private _computeAngleValues;
  133362. /**
  133363. * Sets the passed Effect "effect" with the Light textures.
  133364. * @param effect The effect to update
  133365. * @param lightIndex The index of the light in the effect to update
  133366. * @returns The light
  133367. */
  133368. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133369. /**
  133370. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133371. * @param effect The effect to update
  133372. * @param lightIndex The index of the light in the effect to update
  133373. * @returns The spot light
  133374. */
  133375. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133376. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133377. /**
  133378. * Disposes the light and the associated resources.
  133379. */
  133380. dispose(): void;
  133381. /**
  133382. * Prepares the list of defines specific to the light type.
  133383. * @param defines the list of defines
  133384. * @param lightIndex defines the index of the light for the effect
  133385. */
  133386. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133387. }
  133388. }
  133389. declare module BABYLON {
  133390. /**
  133391. * Gizmo that enables viewing a light
  133392. */
  133393. export class LightGizmo extends Gizmo {
  133394. private _lightMesh;
  133395. private _material;
  133396. private _cachedPosition;
  133397. private _cachedForward;
  133398. private _attachedMeshParent;
  133399. /**
  133400. * Creates a LightGizmo
  133401. * @param gizmoLayer The utility layer the gizmo will be added to
  133402. */
  133403. constructor(gizmoLayer?: UtilityLayerRenderer);
  133404. private _light;
  133405. /**
  133406. * The light that the gizmo is attached to
  133407. */
  133408. set light(light: Nullable<Light>);
  133409. get light(): Nullable<Light>;
  133410. /**
  133411. * Gets the material used to render the light gizmo
  133412. */
  133413. get material(): StandardMaterial;
  133414. /**
  133415. * @hidden
  133416. * Updates the gizmo to match the attached mesh's position/rotation
  133417. */
  133418. protected _update(): void;
  133419. private static _Scale;
  133420. /**
  133421. * Creates the lines for a light mesh
  133422. */
  133423. private static _CreateLightLines;
  133424. /**
  133425. * Disposes of the light gizmo
  133426. */
  133427. dispose(): void;
  133428. private static _CreateHemisphericLightMesh;
  133429. private static _CreatePointLightMesh;
  133430. private static _CreateSpotLightMesh;
  133431. private static _CreateDirectionalLightMesh;
  133432. }
  133433. }
  133434. declare module BABYLON {
  133435. /**
  133436. * Gizmo that enables viewing a camera
  133437. */
  133438. export class CameraGizmo extends Gizmo {
  133439. private _cameraMesh;
  133440. private _cameraLinesMesh;
  133441. private _material;
  133442. /**
  133443. * Creates a CameraGizmo
  133444. * @param gizmoLayer The utility layer the gizmo will be added to
  133445. */
  133446. constructor(gizmoLayer?: UtilityLayerRenderer);
  133447. private _camera;
  133448. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  133449. get displayFrustum(): boolean;
  133450. set displayFrustum(value: boolean);
  133451. /**
  133452. * The camera that the gizmo is attached to
  133453. */
  133454. set camera(camera: Nullable<Camera>);
  133455. get camera(): Nullable<Camera>;
  133456. /**
  133457. * Gets the material used to render the camera gizmo
  133458. */
  133459. get material(): StandardMaterial;
  133460. /**
  133461. * @hidden
  133462. * Updates the gizmo to match the attached mesh's position/rotation
  133463. */
  133464. protected _update(): void;
  133465. private static _Scale;
  133466. private _invProjection;
  133467. /**
  133468. * Disposes of the camera gizmo
  133469. */
  133470. dispose(): void;
  133471. private static _CreateCameraMesh;
  133472. private static _CreateCameraFrustum;
  133473. }
  133474. }
  133475. declare module BABYLON {
  133476. /** @hidden */
  133477. export var backgroundFragmentDeclaration: {
  133478. name: string;
  133479. shader: string;
  133480. };
  133481. }
  133482. declare module BABYLON {
  133483. /** @hidden */
  133484. export var backgroundUboDeclaration: {
  133485. name: string;
  133486. shader: string;
  133487. };
  133488. }
  133489. declare module BABYLON {
  133490. /** @hidden */
  133491. export var backgroundPixelShader: {
  133492. name: string;
  133493. shader: string;
  133494. };
  133495. }
  133496. declare module BABYLON {
  133497. /** @hidden */
  133498. export var backgroundVertexDeclaration: {
  133499. name: string;
  133500. shader: string;
  133501. };
  133502. }
  133503. declare module BABYLON {
  133504. /** @hidden */
  133505. export var backgroundVertexShader: {
  133506. name: string;
  133507. shader: string;
  133508. };
  133509. }
  133510. declare module BABYLON {
  133511. /**
  133512. * Background material used to create an efficient environement around your scene.
  133513. */
  133514. export class BackgroundMaterial extends PushMaterial {
  133515. /**
  133516. * Standard reflectance value at parallel view angle.
  133517. */
  133518. static StandardReflectance0: number;
  133519. /**
  133520. * Standard reflectance value at grazing angle.
  133521. */
  133522. static StandardReflectance90: number;
  133523. protected _primaryColor: Color3;
  133524. /**
  133525. * Key light Color (multiply against the environement texture)
  133526. */
  133527. primaryColor: Color3;
  133528. protected __perceptualColor: Nullable<Color3>;
  133529. /**
  133530. * Experimental Internal Use Only.
  133531. *
  133532. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  133533. * This acts as a helper to set the primary color to a more "human friendly" value.
  133534. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  133535. * output color as close as possible from the chosen value.
  133536. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  133537. * part of lighting setup.)
  133538. */
  133539. get _perceptualColor(): Nullable<Color3>;
  133540. set _perceptualColor(value: Nullable<Color3>);
  133541. protected _primaryColorShadowLevel: float;
  133542. /**
  133543. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  133544. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  133545. */
  133546. get primaryColorShadowLevel(): float;
  133547. set primaryColorShadowLevel(value: float);
  133548. protected _primaryColorHighlightLevel: float;
  133549. /**
  133550. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  133551. * The primary color is used at the level chosen to define what the white area would look.
  133552. */
  133553. get primaryColorHighlightLevel(): float;
  133554. set primaryColorHighlightLevel(value: float);
  133555. protected _reflectionTexture: Nullable<BaseTexture>;
  133556. /**
  133557. * Reflection Texture used in the material.
  133558. * Should be author in a specific way for the best result (refer to the documentation).
  133559. */
  133560. reflectionTexture: Nullable<BaseTexture>;
  133561. protected _reflectionBlur: float;
  133562. /**
  133563. * Reflection Texture level of blur.
  133564. *
  133565. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  133566. * texture twice.
  133567. */
  133568. reflectionBlur: float;
  133569. protected _diffuseTexture: Nullable<BaseTexture>;
  133570. /**
  133571. * Diffuse Texture used in the material.
  133572. * Should be author in a specific way for the best result (refer to the documentation).
  133573. */
  133574. diffuseTexture: Nullable<BaseTexture>;
  133575. protected _shadowLights: Nullable<IShadowLight[]>;
  133576. /**
  133577. * Specify the list of lights casting shadow on the material.
  133578. * All scene shadow lights will be included if null.
  133579. */
  133580. shadowLights: Nullable<IShadowLight[]>;
  133581. protected _shadowLevel: float;
  133582. /**
  133583. * Helps adjusting the shadow to a softer level if required.
  133584. * 0 means black shadows and 1 means no shadows.
  133585. */
  133586. shadowLevel: float;
  133587. protected _sceneCenter: Vector3;
  133588. /**
  133589. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  133590. * It is usually zero but might be interesting to modify according to your setup.
  133591. */
  133592. sceneCenter: Vector3;
  133593. protected _opacityFresnel: boolean;
  133594. /**
  133595. * This helps specifying that the material is falling off to the sky box at grazing angle.
  133596. * This helps ensuring a nice transition when the camera goes under the ground.
  133597. */
  133598. opacityFresnel: boolean;
  133599. protected _reflectionFresnel: boolean;
  133600. /**
  133601. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  133602. * This helps adding a mirror texture on the ground.
  133603. */
  133604. reflectionFresnel: boolean;
  133605. protected _reflectionFalloffDistance: number;
  133606. /**
  133607. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  133608. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  133609. */
  133610. reflectionFalloffDistance: number;
  133611. protected _reflectionAmount: number;
  133612. /**
  133613. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  133614. */
  133615. reflectionAmount: number;
  133616. protected _reflectionReflectance0: number;
  133617. /**
  133618. * This specifies the weight of the reflection at grazing angle.
  133619. */
  133620. reflectionReflectance0: number;
  133621. protected _reflectionReflectance90: number;
  133622. /**
  133623. * This specifies the weight of the reflection at a perpendicular point of view.
  133624. */
  133625. reflectionReflectance90: number;
  133626. /**
  133627. * Sets the reflection reflectance fresnel values according to the default standard
  133628. * empirically know to work well :-)
  133629. */
  133630. set reflectionStandardFresnelWeight(value: number);
  133631. protected _useRGBColor: boolean;
  133632. /**
  133633. * Helps to directly use the maps channels instead of their level.
  133634. */
  133635. useRGBColor: boolean;
  133636. protected _enableNoise: boolean;
  133637. /**
  133638. * This helps reducing the banding effect that could occur on the background.
  133639. */
  133640. enableNoise: boolean;
  133641. /**
  133642. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  133643. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  133644. * Recommended to be keep at 1.0 except for special cases.
  133645. */
  133646. get fovMultiplier(): number;
  133647. set fovMultiplier(value: number);
  133648. private _fovMultiplier;
  133649. /**
  133650. * Enable the FOV adjustment feature controlled by fovMultiplier.
  133651. */
  133652. useEquirectangularFOV: boolean;
  133653. private _maxSimultaneousLights;
  133654. /**
  133655. * Number of Simultaneous lights allowed on the material.
  133656. */
  133657. maxSimultaneousLights: int;
  133658. private _shadowOnly;
  133659. /**
  133660. * Make the material only render shadows
  133661. */
  133662. shadowOnly: boolean;
  133663. /**
  133664. * Default configuration related to image processing available in the Background Material.
  133665. */
  133666. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  133667. /**
  133668. * Keep track of the image processing observer to allow dispose and replace.
  133669. */
  133670. private _imageProcessingObserver;
  133671. /**
  133672. * Attaches a new image processing configuration to the PBR Material.
  133673. * @param configuration (if null the scene configuration will be use)
  133674. */
  133675. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  133676. /**
  133677. * Gets the image processing configuration used either in this material.
  133678. */
  133679. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  133680. /**
  133681. * Sets the Default image processing configuration used either in the this material.
  133682. *
  133683. * If sets to null, the scene one is in use.
  133684. */
  133685. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  133686. /**
  133687. * Gets wether the color curves effect is enabled.
  133688. */
  133689. get cameraColorCurvesEnabled(): boolean;
  133690. /**
  133691. * Sets wether the color curves effect is enabled.
  133692. */
  133693. set cameraColorCurvesEnabled(value: boolean);
  133694. /**
  133695. * Gets wether the color grading effect is enabled.
  133696. */
  133697. get cameraColorGradingEnabled(): boolean;
  133698. /**
  133699. * Gets wether the color grading effect is enabled.
  133700. */
  133701. set cameraColorGradingEnabled(value: boolean);
  133702. /**
  133703. * Gets wether tonemapping is enabled or not.
  133704. */
  133705. get cameraToneMappingEnabled(): boolean;
  133706. /**
  133707. * Sets wether tonemapping is enabled or not
  133708. */
  133709. set cameraToneMappingEnabled(value: boolean);
  133710. /**
  133711. * The camera exposure used on this material.
  133712. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  133713. * This corresponds to a photographic exposure.
  133714. */
  133715. get cameraExposure(): float;
  133716. /**
  133717. * The camera exposure used on this material.
  133718. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  133719. * This corresponds to a photographic exposure.
  133720. */
  133721. set cameraExposure(value: float);
  133722. /**
  133723. * Gets The camera contrast used on this material.
  133724. */
  133725. get cameraContrast(): float;
  133726. /**
  133727. * Sets The camera contrast used on this material.
  133728. */
  133729. set cameraContrast(value: float);
  133730. /**
  133731. * Gets the Color Grading 2D Lookup Texture.
  133732. */
  133733. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  133734. /**
  133735. * Sets the Color Grading 2D Lookup Texture.
  133736. */
  133737. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  133738. /**
  133739. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  133740. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  133741. * 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;
  133742. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  133743. */
  133744. get cameraColorCurves(): Nullable<ColorCurves>;
  133745. /**
  133746. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  133747. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  133748. * 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;
  133749. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  133750. */
  133751. set cameraColorCurves(value: Nullable<ColorCurves>);
  133752. /**
  133753. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  133754. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  133755. */
  133756. switchToBGR: boolean;
  133757. private _renderTargets;
  133758. private _reflectionControls;
  133759. private _white;
  133760. private _primaryShadowColor;
  133761. private _primaryHighlightColor;
  133762. /**
  133763. * Instantiates a Background Material in the given scene
  133764. * @param name The friendly name of the material
  133765. * @param scene The scene to add the material to
  133766. */
  133767. constructor(name: string, scene: Scene);
  133768. /**
  133769. * Gets a boolean indicating that current material needs to register RTT
  133770. */
  133771. get hasRenderTargetTextures(): boolean;
  133772. /**
  133773. * The entire material has been created in order to prevent overdraw.
  133774. * @returns false
  133775. */
  133776. needAlphaTesting(): boolean;
  133777. /**
  133778. * The entire material has been created in order to prevent overdraw.
  133779. * @returns true if blending is enable
  133780. */
  133781. needAlphaBlending(): boolean;
  133782. /**
  133783. * Checks wether the material is ready to be rendered for a given mesh.
  133784. * @param mesh The mesh to render
  133785. * @param subMesh The submesh to check against
  133786. * @param useInstances Specify wether or not the material is used with instances
  133787. * @returns true if all the dependencies are ready (Textures, Effects...)
  133788. */
  133789. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  133790. /**
  133791. * Compute the primary color according to the chosen perceptual color.
  133792. */
  133793. private _computePrimaryColorFromPerceptualColor;
  133794. /**
  133795. * Compute the highlights and shadow colors according to their chosen levels.
  133796. */
  133797. private _computePrimaryColors;
  133798. /**
  133799. * Build the uniform buffer used in the material.
  133800. */
  133801. buildUniformLayout(): void;
  133802. /**
  133803. * Unbind the material.
  133804. */
  133805. unbind(): void;
  133806. /**
  133807. * Bind only the world matrix to the material.
  133808. * @param world The world matrix to bind.
  133809. */
  133810. bindOnlyWorldMatrix(world: Matrix): void;
  133811. /**
  133812. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  133813. * @param world The world matrix to bind.
  133814. * @param subMesh The submesh to bind for.
  133815. */
  133816. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  133817. /**
  133818. * Checks to see if a texture is used in the material.
  133819. * @param texture - Base texture to use.
  133820. * @returns - Boolean specifying if a texture is used in the material.
  133821. */
  133822. hasTexture(texture: BaseTexture): boolean;
  133823. /**
  133824. * Dispose the material.
  133825. * @param forceDisposeEffect Force disposal of the associated effect.
  133826. * @param forceDisposeTextures Force disposal of the associated textures.
  133827. */
  133828. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  133829. /**
  133830. * Clones the material.
  133831. * @param name The cloned name.
  133832. * @returns The cloned material.
  133833. */
  133834. clone(name: string): BackgroundMaterial;
  133835. /**
  133836. * Serializes the current material to its JSON representation.
  133837. * @returns The JSON representation.
  133838. */
  133839. serialize(): any;
  133840. /**
  133841. * Gets the class name of the material
  133842. * @returns "BackgroundMaterial"
  133843. */
  133844. getClassName(): string;
  133845. /**
  133846. * Parse a JSON input to create back a background material.
  133847. * @param source The JSON data to parse
  133848. * @param scene The scene to create the parsed material in
  133849. * @param rootUrl The root url of the assets the material depends upon
  133850. * @returns the instantiated BackgroundMaterial.
  133851. */
  133852. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  133853. }
  133854. }
  133855. declare module BABYLON {
  133856. /**
  133857. * Represents the different options available during the creation of
  133858. * a Environment helper.
  133859. *
  133860. * This can control the default ground, skybox and image processing setup of your scene.
  133861. */
  133862. export interface IEnvironmentHelperOptions {
  133863. /**
  133864. * Specifies whether or not to create a ground.
  133865. * True by default.
  133866. */
  133867. createGround: boolean;
  133868. /**
  133869. * Specifies the ground size.
  133870. * 15 by default.
  133871. */
  133872. groundSize: number;
  133873. /**
  133874. * The texture used on the ground for the main color.
  133875. * Comes from the BabylonJS CDN by default.
  133876. *
  133877. * Remarks: Can be either a texture or a url.
  133878. */
  133879. groundTexture: string | BaseTexture;
  133880. /**
  133881. * The color mixed in the ground texture by default.
  133882. * BabylonJS clearColor by default.
  133883. */
  133884. groundColor: Color3;
  133885. /**
  133886. * Specifies the ground opacity.
  133887. * 1 by default.
  133888. */
  133889. groundOpacity: number;
  133890. /**
  133891. * Enables the ground to receive shadows.
  133892. * True by default.
  133893. */
  133894. enableGroundShadow: boolean;
  133895. /**
  133896. * Helps preventing the shadow to be fully black on the ground.
  133897. * 0.5 by default.
  133898. */
  133899. groundShadowLevel: number;
  133900. /**
  133901. * Creates a mirror texture attach to the ground.
  133902. * false by default.
  133903. */
  133904. enableGroundMirror: boolean;
  133905. /**
  133906. * Specifies the ground mirror size ratio.
  133907. * 0.3 by default as the default kernel is 64.
  133908. */
  133909. groundMirrorSizeRatio: number;
  133910. /**
  133911. * Specifies the ground mirror blur kernel size.
  133912. * 64 by default.
  133913. */
  133914. groundMirrorBlurKernel: number;
  133915. /**
  133916. * Specifies the ground mirror visibility amount.
  133917. * 1 by default
  133918. */
  133919. groundMirrorAmount: number;
  133920. /**
  133921. * Specifies the ground mirror reflectance weight.
  133922. * This uses the standard weight of the background material to setup the fresnel effect
  133923. * of the mirror.
  133924. * 1 by default.
  133925. */
  133926. groundMirrorFresnelWeight: number;
  133927. /**
  133928. * Specifies the ground mirror Falloff distance.
  133929. * This can helps reducing the size of the reflection.
  133930. * 0 by Default.
  133931. */
  133932. groundMirrorFallOffDistance: number;
  133933. /**
  133934. * Specifies the ground mirror texture type.
  133935. * Unsigned Int by Default.
  133936. */
  133937. groundMirrorTextureType: number;
  133938. /**
  133939. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  133940. * the shown objects.
  133941. */
  133942. groundYBias: number;
  133943. /**
  133944. * Specifies whether or not to create a skybox.
  133945. * True by default.
  133946. */
  133947. createSkybox: boolean;
  133948. /**
  133949. * Specifies the skybox size.
  133950. * 20 by default.
  133951. */
  133952. skyboxSize: number;
  133953. /**
  133954. * The texture used on the skybox for the main color.
  133955. * Comes from the BabylonJS CDN by default.
  133956. *
  133957. * Remarks: Can be either a texture or a url.
  133958. */
  133959. skyboxTexture: string | BaseTexture;
  133960. /**
  133961. * The color mixed in the skybox texture by default.
  133962. * BabylonJS clearColor by default.
  133963. */
  133964. skyboxColor: Color3;
  133965. /**
  133966. * The background rotation around the Y axis of the scene.
  133967. * This helps aligning the key lights of your scene with the background.
  133968. * 0 by default.
  133969. */
  133970. backgroundYRotation: number;
  133971. /**
  133972. * Compute automatically the size of the elements to best fit with the scene.
  133973. */
  133974. sizeAuto: boolean;
  133975. /**
  133976. * Default position of the rootMesh if autoSize is not true.
  133977. */
  133978. rootPosition: Vector3;
  133979. /**
  133980. * Sets up the image processing in the scene.
  133981. * true by default.
  133982. */
  133983. setupImageProcessing: boolean;
  133984. /**
  133985. * The texture used as your environment texture in the scene.
  133986. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  133987. *
  133988. * Remarks: Can be either a texture or a url.
  133989. */
  133990. environmentTexture: string | BaseTexture;
  133991. /**
  133992. * The value of the exposure to apply to the scene.
  133993. * 0.6 by default if setupImageProcessing is true.
  133994. */
  133995. cameraExposure: number;
  133996. /**
  133997. * The value of the contrast to apply to the scene.
  133998. * 1.6 by default if setupImageProcessing is true.
  133999. */
  134000. cameraContrast: number;
  134001. /**
  134002. * Specifies whether or not tonemapping should be enabled in the scene.
  134003. * true by default if setupImageProcessing is true.
  134004. */
  134005. toneMappingEnabled: boolean;
  134006. }
  134007. /**
  134008. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134009. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134010. * It also helps with the default setup of your imageProcessing configuration.
  134011. */
  134012. export class EnvironmentHelper {
  134013. /**
  134014. * Default ground texture URL.
  134015. */
  134016. private static _groundTextureCDNUrl;
  134017. /**
  134018. * Default skybox texture URL.
  134019. */
  134020. private static _skyboxTextureCDNUrl;
  134021. /**
  134022. * Default environment texture URL.
  134023. */
  134024. private static _environmentTextureCDNUrl;
  134025. /**
  134026. * Creates the default options for the helper.
  134027. */
  134028. private static _getDefaultOptions;
  134029. private _rootMesh;
  134030. /**
  134031. * Gets the root mesh created by the helper.
  134032. */
  134033. get rootMesh(): Mesh;
  134034. private _skybox;
  134035. /**
  134036. * Gets the skybox created by the helper.
  134037. */
  134038. get skybox(): Nullable<Mesh>;
  134039. private _skyboxTexture;
  134040. /**
  134041. * Gets the skybox texture created by the helper.
  134042. */
  134043. get skyboxTexture(): Nullable<BaseTexture>;
  134044. private _skyboxMaterial;
  134045. /**
  134046. * Gets the skybox material created by the helper.
  134047. */
  134048. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134049. private _ground;
  134050. /**
  134051. * Gets the ground mesh created by the helper.
  134052. */
  134053. get ground(): Nullable<Mesh>;
  134054. private _groundTexture;
  134055. /**
  134056. * Gets the ground texture created by the helper.
  134057. */
  134058. get groundTexture(): Nullable<BaseTexture>;
  134059. private _groundMirror;
  134060. /**
  134061. * Gets the ground mirror created by the helper.
  134062. */
  134063. get groundMirror(): Nullable<MirrorTexture>;
  134064. /**
  134065. * Gets the ground mirror render list to helps pushing the meshes
  134066. * you wish in the ground reflection.
  134067. */
  134068. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134069. private _groundMaterial;
  134070. /**
  134071. * Gets the ground material created by the helper.
  134072. */
  134073. get groundMaterial(): Nullable<BackgroundMaterial>;
  134074. /**
  134075. * Stores the creation options.
  134076. */
  134077. private readonly _scene;
  134078. private _options;
  134079. /**
  134080. * This observable will be notified with any error during the creation of the environment,
  134081. * mainly texture creation errors.
  134082. */
  134083. onErrorObservable: Observable<{
  134084. message?: string;
  134085. exception?: any;
  134086. }>;
  134087. /**
  134088. * constructor
  134089. * @param options Defines the options we want to customize the helper
  134090. * @param scene The scene to add the material to
  134091. */
  134092. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134093. /**
  134094. * Updates the background according to the new options
  134095. * @param options
  134096. */
  134097. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134098. /**
  134099. * Sets the primary color of all the available elements.
  134100. * @param color the main color to affect to the ground and the background
  134101. */
  134102. setMainColor(color: Color3): void;
  134103. /**
  134104. * Setup the image processing according to the specified options.
  134105. */
  134106. private _setupImageProcessing;
  134107. /**
  134108. * Setup the environment texture according to the specified options.
  134109. */
  134110. private _setupEnvironmentTexture;
  134111. /**
  134112. * Setup the background according to the specified options.
  134113. */
  134114. private _setupBackground;
  134115. /**
  134116. * Get the scene sizes according to the setup.
  134117. */
  134118. private _getSceneSize;
  134119. /**
  134120. * Setup the ground according to the specified options.
  134121. */
  134122. private _setupGround;
  134123. /**
  134124. * Setup the ground material according to the specified options.
  134125. */
  134126. private _setupGroundMaterial;
  134127. /**
  134128. * Setup the ground diffuse texture according to the specified options.
  134129. */
  134130. private _setupGroundDiffuseTexture;
  134131. /**
  134132. * Setup the ground mirror texture according to the specified options.
  134133. */
  134134. private _setupGroundMirrorTexture;
  134135. /**
  134136. * Setup the ground to receive the mirror texture.
  134137. */
  134138. private _setupMirrorInGroundMaterial;
  134139. /**
  134140. * Setup the skybox according to the specified options.
  134141. */
  134142. private _setupSkybox;
  134143. /**
  134144. * Setup the skybox material according to the specified options.
  134145. */
  134146. private _setupSkyboxMaterial;
  134147. /**
  134148. * Setup the skybox reflection texture according to the specified options.
  134149. */
  134150. private _setupSkyboxReflectionTexture;
  134151. private _errorHandler;
  134152. /**
  134153. * Dispose all the elements created by the Helper.
  134154. */
  134155. dispose(): void;
  134156. }
  134157. }
  134158. declare module BABYLON {
  134159. /**
  134160. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134161. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134162. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134163. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134164. */
  134165. export class PhotoDome extends TransformNode {
  134166. /**
  134167. * Define the image as a Monoscopic panoramic 360 image.
  134168. */
  134169. static readonly MODE_MONOSCOPIC: number;
  134170. /**
  134171. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134172. */
  134173. static readonly MODE_TOPBOTTOM: number;
  134174. /**
  134175. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134176. */
  134177. static readonly MODE_SIDEBYSIDE: number;
  134178. private _useDirectMapping;
  134179. /**
  134180. * The texture being displayed on the sphere
  134181. */
  134182. protected _photoTexture: Texture;
  134183. /**
  134184. * Gets or sets the texture being displayed on the sphere
  134185. */
  134186. get photoTexture(): Texture;
  134187. set photoTexture(value: Texture);
  134188. /**
  134189. * Observable raised when an error occured while loading the 360 image
  134190. */
  134191. onLoadErrorObservable: Observable<string>;
  134192. /**
  134193. * The skybox material
  134194. */
  134195. protected _material: BackgroundMaterial;
  134196. /**
  134197. * The surface used for the skybox
  134198. */
  134199. protected _mesh: Mesh;
  134200. /**
  134201. * Gets the mesh used for the skybox.
  134202. */
  134203. get mesh(): Mesh;
  134204. /**
  134205. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134206. * Also see the options.resolution property.
  134207. */
  134208. get fovMultiplier(): number;
  134209. set fovMultiplier(value: number);
  134210. private _imageMode;
  134211. /**
  134212. * Gets or set the current video mode for the video. It can be:
  134213. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  134214. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134215. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134216. */
  134217. get imageMode(): number;
  134218. set imageMode(value: number);
  134219. /**
  134220. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  134221. * @param name Element's name, child elements will append suffixes for their own names.
  134222. * @param urlsOfPhoto defines the url of the photo to display
  134223. * @param options defines an object containing optional or exposed sub element properties
  134224. * @param onError defines a callback called when an error occured while loading the texture
  134225. */
  134226. constructor(name: string, urlOfPhoto: string, options: {
  134227. resolution?: number;
  134228. size?: number;
  134229. useDirectMapping?: boolean;
  134230. faceForward?: boolean;
  134231. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134232. private _onBeforeCameraRenderObserver;
  134233. private _changeImageMode;
  134234. /**
  134235. * Releases resources associated with this node.
  134236. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134237. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134238. */
  134239. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134240. }
  134241. }
  134242. declare module BABYLON {
  134243. /**
  134244. * Class used to host RGBD texture specific utilities
  134245. */
  134246. export class RGBDTextureTools {
  134247. /**
  134248. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134249. * @param texture the texture to expand.
  134250. */
  134251. static ExpandRGBDTexture(texture: Texture): void;
  134252. }
  134253. }
  134254. declare module BABYLON {
  134255. /**
  134256. * Class used to host texture specific utilities
  134257. */
  134258. export class BRDFTextureTools {
  134259. /**
  134260. * Prevents texture cache collision
  134261. */
  134262. private static _instanceNumber;
  134263. /**
  134264. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134265. * @param scene defines the hosting scene
  134266. * @returns the environment BRDF texture
  134267. */
  134268. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134269. private static _environmentBRDFBase64Texture;
  134270. }
  134271. }
  134272. declare module BABYLON {
  134273. /**
  134274. * @hidden
  134275. */
  134276. export interface IMaterialClearCoatDefines {
  134277. CLEARCOAT: boolean;
  134278. CLEARCOAT_DEFAULTIOR: boolean;
  134279. CLEARCOAT_TEXTURE: boolean;
  134280. CLEARCOAT_TEXTUREDIRECTUV: number;
  134281. CLEARCOAT_BUMP: boolean;
  134282. CLEARCOAT_BUMPDIRECTUV: number;
  134283. CLEARCOAT_TINT: boolean;
  134284. CLEARCOAT_TINT_TEXTURE: boolean;
  134285. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134286. /** @hidden */
  134287. _areTexturesDirty: boolean;
  134288. }
  134289. /**
  134290. * Define the code related to the clear coat parameters of the pbr material.
  134291. */
  134292. export class PBRClearCoatConfiguration {
  134293. /**
  134294. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134295. * The default fits with a polyurethane material.
  134296. */
  134297. private static readonly _DefaultIndexOfRefraction;
  134298. private _isEnabled;
  134299. /**
  134300. * Defines if the clear coat is enabled in the material.
  134301. */
  134302. isEnabled: boolean;
  134303. /**
  134304. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134305. */
  134306. intensity: number;
  134307. /**
  134308. * Defines the clear coat layer roughness.
  134309. */
  134310. roughness: number;
  134311. private _indexOfRefraction;
  134312. /**
  134313. * Defines the index of refraction of the clear coat.
  134314. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134315. * The default fits with a polyurethane material.
  134316. * Changing the default value is more performance intensive.
  134317. */
  134318. indexOfRefraction: number;
  134319. private _texture;
  134320. /**
  134321. * Stores the clear coat values in a texture.
  134322. */
  134323. texture: Nullable<BaseTexture>;
  134324. private _bumpTexture;
  134325. /**
  134326. * Define the clear coat specific bump texture.
  134327. */
  134328. bumpTexture: Nullable<BaseTexture>;
  134329. private _isTintEnabled;
  134330. /**
  134331. * Defines if the clear coat tint is enabled in the material.
  134332. */
  134333. isTintEnabled: boolean;
  134334. /**
  134335. * Defines the clear coat tint of the material.
  134336. * This is only use if tint is enabled
  134337. */
  134338. tintColor: Color3;
  134339. /**
  134340. * Defines the distance at which the tint color should be found in the
  134341. * clear coat media.
  134342. * This is only use if tint is enabled
  134343. */
  134344. tintColorAtDistance: number;
  134345. /**
  134346. * Defines the clear coat layer thickness.
  134347. * This is only use if tint is enabled
  134348. */
  134349. tintThickness: number;
  134350. private _tintTexture;
  134351. /**
  134352. * Stores the clear tint values in a texture.
  134353. * rgb is tint
  134354. * a is a thickness factor
  134355. */
  134356. tintTexture: Nullable<BaseTexture>;
  134357. /** @hidden */
  134358. private _internalMarkAllSubMeshesAsTexturesDirty;
  134359. /** @hidden */
  134360. _markAllSubMeshesAsTexturesDirty(): void;
  134361. /**
  134362. * Instantiate a new istance of clear coat configuration.
  134363. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134364. */
  134365. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134366. /**
  134367. * Gets wehter the submesh is ready to be used or not.
  134368. * @param defines the list of "defines" to update.
  134369. * @param scene defines the scene the material belongs to.
  134370. * @param engine defines the engine the material belongs to.
  134371. * @param disableBumpMap defines wether the material disables bump or not.
  134372. * @returns - boolean indicating that the submesh is ready or not.
  134373. */
  134374. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  134375. /**
  134376. * Checks to see if a texture is used in the material.
  134377. * @param defines the list of "defines" to update.
  134378. * @param scene defines the scene to the material belongs to.
  134379. */
  134380. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  134381. /**
  134382. * Binds the material data.
  134383. * @param uniformBuffer defines the Uniform buffer to fill in.
  134384. * @param scene defines the scene the material belongs to.
  134385. * @param engine defines the engine the material belongs to.
  134386. * @param disableBumpMap defines wether the material disables bump or not.
  134387. * @param isFrozen defines wether the material is frozen or not.
  134388. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134389. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134390. */
  134391. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  134392. /**
  134393. * Checks to see if a texture is used in the material.
  134394. * @param texture - Base texture to use.
  134395. * @returns - Boolean specifying if a texture is used in the material.
  134396. */
  134397. hasTexture(texture: BaseTexture): boolean;
  134398. /**
  134399. * Returns an array of the actively used textures.
  134400. * @param activeTextures Array of BaseTextures
  134401. */
  134402. getActiveTextures(activeTextures: BaseTexture[]): void;
  134403. /**
  134404. * Returns the animatable textures.
  134405. * @param animatables Array of animatable textures.
  134406. */
  134407. getAnimatables(animatables: IAnimatable[]): void;
  134408. /**
  134409. * Disposes the resources of the material.
  134410. * @param forceDisposeTextures - Forces the disposal of all textures.
  134411. */
  134412. dispose(forceDisposeTextures?: boolean): void;
  134413. /**
  134414. * Get the current class name of the texture useful for serialization or dynamic coding.
  134415. * @returns "PBRClearCoatConfiguration"
  134416. */
  134417. getClassName(): string;
  134418. /**
  134419. * Add fallbacks to the effect fallbacks list.
  134420. * @param defines defines the Base texture to use.
  134421. * @param fallbacks defines the current fallback list.
  134422. * @param currentRank defines the current fallback rank.
  134423. * @returns the new fallback rank.
  134424. */
  134425. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134426. /**
  134427. * Add the required uniforms to the current list.
  134428. * @param uniforms defines the current uniform list.
  134429. */
  134430. static AddUniforms(uniforms: string[]): void;
  134431. /**
  134432. * Add the required samplers to the current list.
  134433. * @param samplers defines the current sampler list.
  134434. */
  134435. static AddSamplers(samplers: string[]): void;
  134436. /**
  134437. * Add the required uniforms to the current buffer.
  134438. * @param uniformBuffer defines the current uniform buffer.
  134439. */
  134440. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134441. /**
  134442. * Makes a duplicate of the current configuration into another one.
  134443. * @param clearCoatConfiguration define the config where to copy the info
  134444. */
  134445. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  134446. /**
  134447. * Serializes this clear coat configuration.
  134448. * @returns - An object with the serialized config.
  134449. */
  134450. serialize(): any;
  134451. /**
  134452. * Parses a anisotropy Configuration from a serialized object.
  134453. * @param source - Serialized object.
  134454. * @param scene Defines the scene we are parsing for
  134455. * @param rootUrl Defines the rootUrl to load from
  134456. */
  134457. parse(source: any, scene: Scene, rootUrl: string): void;
  134458. }
  134459. }
  134460. declare module BABYLON {
  134461. /**
  134462. * @hidden
  134463. */
  134464. export interface IMaterialAnisotropicDefines {
  134465. ANISOTROPIC: boolean;
  134466. ANISOTROPIC_TEXTURE: boolean;
  134467. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134468. MAINUV1: boolean;
  134469. _areTexturesDirty: boolean;
  134470. _needUVs: boolean;
  134471. }
  134472. /**
  134473. * Define the code related to the anisotropic parameters of the pbr material.
  134474. */
  134475. export class PBRAnisotropicConfiguration {
  134476. private _isEnabled;
  134477. /**
  134478. * Defines if the anisotropy is enabled in the material.
  134479. */
  134480. isEnabled: boolean;
  134481. /**
  134482. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  134483. */
  134484. intensity: number;
  134485. /**
  134486. * Defines if the effect is along the tangents, bitangents or in between.
  134487. * By default, the effect is "strectching" the highlights along the tangents.
  134488. */
  134489. direction: Vector2;
  134490. private _texture;
  134491. /**
  134492. * Stores the anisotropy values in a texture.
  134493. * rg is direction (like normal from -1 to 1)
  134494. * b is a intensity
  134495. */
  134496. texture: Nullable<BaseTexture>;
  134497. /** @hidden */
  134498. private _internalMarkAllSubMeshesAsTexturesDirty;
  134499. /** @hidden */
  134500. _markAllSubMeshesAsTexturesDirty(): void;
  134501. /**
  134502. * Instantiate a new istance of anisotropy configuration.
  134503. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134504. */
  134505. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134506. /**
  134507. * Specifies that the submesh is ready to be used.
  134508. * @param defines the list of "defines" to update.
  134509. * @param scene defines the scene the material belongs to.
  134510. * @returns - boolean indicating that the submesh is ready or not.
  134511. */
  134512. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  134513. /**
  134514. * Checks to see if a texture is used in the material.
  134515. * @param defines the list of "defines" to update.
  134516. * @param mesh the mesh we are preparing the defines for.
  134517. * @param scene defines the scene the material belongs to.
  134518. */
  134519. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  134520. /**
  134521. * Binds the material data.
  134522. * @param uniformBuffer defines the Uniform buffer to fill in.
  134523. * @param scene defines the scene the material belongs to.
  134524. * @param isFrozen defines wether the material is frozen or not.
  134525. */
  134526. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  134527. /**
  134528. * Checks to see if a texture is used in the material.
  134529. * @param texture - Base texture to use.
  134530. * @returns - Boolean specifying if a texture is used in the material.
  134531. */
  134532. hasTexture(texture: BaseTexture): boolean;
  134533. /**
  134534. * Returns an array of the actively used textures.
  134535. * @param activeTextures Array of BaseTextures
  134536. */
  134537. getActiveTextures(activeTextures: BaseTexture[]): void;
  134538. /**
  134539. * Returns the animatable textures.
  134540. * @param animatables Array of animatable textures.
  134541. */
  134542. getAnimatables(animatables: IAnimatable[]): void;
  134543. /**
  134544. * Disposes the resources of the material.
  134545. * @param forceDisposeTextures - Forces the disposal of all textures.
  134546. */
  134547. dispose(forceDisposeTextures?: boolean): void;
  134548. /**
  134549. * Get the current class name of the texture useful for serialization or dynamic coding.
  134550. * @returns "PBRAnisotropicConfiguration"
  134551. */
  134552. getClassName(): string;
  134553. /**
  134554. * Add fallbacks to the effect fallbacks list.
  134555. * @param defines defines the Base texture to use.
  134556. * @param fallbacks defines the current fallback list.
  134557. * @param currentRank defines the current fallback rank.
  134558. * @returns the new fallback rank.
  134559. */
  134560. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134561. /**
  134562. * Add the required uniforms to the current list.
  134563. * @param uniforms defines the current uniform list.
  134564. */
  134565. static AddUniforms(uniforms: string[]): void;
  134566. /**
  134567. * Add the required uniforms to the current buffer.
  134568. * @param uniformBuffer defines the current uniform buffer.
  134569. */
  134570. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134571. /**
  134572. * Add the required samplers to the current list.
  134573. * @param samplers defines the current sampler list.
  134574. */
  134575. static AddSamplers(samplers: string[]): void;
  134576. /**
  134577. * Makes a duplicate of the current configuration into another one.
  134578. * @param anisotropicConfiguration define the config where to copy the info
  134579. */
  134580. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  134581. /**
  134582. * Serializes this anisotropy configuration.
  134583. * @returns - An object with the serialized config.
  134584. */
  134585. serialize(): any;
  134586. /**
  134587. * Parses a anisotropy Configuration from a serialized object.
  134588. * @param source - Serialized object.
  134589. * @param scene Defines the scene we are parsing for
  134590. * @param rootUrl Defines the rootUrl to load from
  134591. */
  134592. parse(source: any, scene: Scene, rootUrl: string): void;
  134593. }
  134594. }
  134595. declare module BABYLON {
  134596. /**
  134597. * @hidden
  134598. */
  134599. export interface IMaterialBRDFDefines {
  134600. BRDF_V_HEIGHT_CORRELATED: boolean;
  134601. MS_BRDF_ENERGY_CONSERVATION: boolean;
  134602. SPHERICAL_HARMONICS: boolean;
  134603. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  134604. /** @hidden */
  134605. _areMiscDirty: boolean;
  134606. }
  134607. /**
  134608. * Define the code related to the BRDF parameters of the pbr material.
  134609. */
  134610. export class PBRBRDFConfiguration {
  134611. /**
  134612. * Default value used for the energy conservation.
  134613. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  134614. */
  134615. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  134616. /**
  134617. * Default value used for the Smith Visibility Height Correlated mode.
  134618. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  134619. */
  134620. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  134621. /**
  134622. * Default value used for the IBL diffuse part.
  134623. * This can help switching back to the polynomials mode globally which is a tiny bit
  134624. * less GPU intensive at the drawback of a lower quality.
  134625. */
  134626. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  134627. /**
  134628. * Default value used for activating energy conservation for the specular workflow.
  134629. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  134630. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  134631. */
  134632. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  134633. private _useEnergyConservation;
  134634. /**
  134635. * Defines if the material uses energy conservation.
  134636. */
  134637. useEnergyConservation: boolean;
  134638. private _useSmithVisibilityHeightCorrelated;
  134639. /**
  134640. * LEGACY Mode set to false
  134641. * Defines if the material uses height smith correlated visibility term.
  134642. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  134643. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  134644. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  134645. * Not relying on height correlated will also disable energy conservation.
  134646. */
  134647. useSmithVisibilityHeightCorrelated: boolean;
  134648. private _useSphericalHarmonics;
  134649. /**
  134650. * LEGACY Mode set to false
  134651. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  134652. * diffuse part of the IBL.
  134653. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  134654. * to the ground truth.
  134655. */
  134656. useSphericalHarmonics: boolean;
  134657. private _useSpecularGlossinessInputEnergyConservation;
  134658. /**
  134659. * Defines if the material uses energy conservation, when the specular workflow is active.
  134660. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  134661. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  134662. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  134663. */
  134664. useSpecularGlossinessInputEnergyConservation: boolean;
  134665. /** @hidden */
  134666. private _internalMarkAllSubMeshesAsMiscDirty;
  134667. /** @hidden */
  134668. _markAllSubMeshesAsMiscDirty(): void;
  134669. /**
  134670. * Instantiate a new istance of clear coat configuration.
  134671. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  134672. */
  134673. constructor(markAllSubMeshesAsMiscDirty: () => void);
  134674. /**
  134675. * Checks to see if a texture is used in the material.
  134676. * @param defines the list of "defines" to update.
  134677. */
  134678. prepareDefines(defines: IMaterialBRDFDefines): void;
  134679. /**
  134680. * Get the current class name of the texture useful for serialization or dynamic coding.
  134681. * @returns "PBRClearCoatConfiguration"
  134682. */
  134683. getClassName(): string;
  134684. /**
  134685. * Makes a duplicate of the current configuration into another one.
  134686. * @param brdfConfiguration define the config where to copy the info
  134687. */
  134688. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  134689. /**
  134690. * Serializes this BRDF configuration.
  134691. * @returns - An object with the serialized config.
  134692. */
  134693. serialize(): any;
  134694. /**
  134695. * Parses a anisotropy Configuration from a serialized object.
  134696. * @param source - Serialized object.
  134697. * @param scene Defines the scene we are parsing for
  134698. * @param rootUrl Defines the rootUrl to load from
  134699. */
  134700. parse(source: any, scene: Scene, rootUrl: string): void;
  134701. }
  134702. }
  134703. declare module BABYLON {
  134704. /**
  134705. * @hidden
  134706. */
  134707. export interface IMaterialSheenDefines {
  134708. SHEEN: boolean;
  134709. SHEEN_TEXTURE: boolean;
  134710. SHEEN_TEXTUREDIRECTUV: number;
  134711. SHEEN_LINKWITHALBEDO: boolean;
  134712. SHEEN_ROUGHNESS: boolean;
  134713. SHEEN_ALBEDOSCALING: boolean;
  134714. /** @hidden */
  134715. _areTexturesDirty: boolean;
  134716. }
  134717. /**
  134718. * Define the code related to the Sheen parameters of the pbr material.
  134719. */
  134720. export class PBRSheenConfiguration {
  134721. private _isEnabled;
  134722. /**
  134723. * Defines if the material uses sheen.
  134724. */
  134725. isEnabled: boolean;
  134726. private _linkSheenWithAlbedo;
  134727. /**
  134728. * Defines if the sheen is linked to the sheen color.
  134729. */
  134730. linkSheenWithAlbedo: boolean;
  134731. /**
  134732. * Defines the sheen intensity.
  134733. */
  134734. intensity: number;
  134735. /**
  134736. * Defines the sheen color.
  134737. */
  134738. color: Color3;
  134739. private _texture;
  134740. /**
  134741. * Stores the sheen tint values in a texture.
  134742. * rgb is tint
  134743. * a is a intensity or roughness if roughness has been defined
  134744. */
  134745. texture: Nullable<BaseTexture>;
  134746. private _roughness;
  134747. /**
  134748. * Defines the sheen roughness.
  134749. * It is not taken into account if linkSheenWithAlbedo is true.
  134750. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  134751. */
  134752. roughness: Nullable<number>;
  134753. private _albedoScaling;
  134754. /**
  134755. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  134756. * It allows the strength of the sheen effect to not depend on the base color of the material,
  134757. * making it easier to setup and tweak the effect
  134758. */
  134759. albedoScaling: boolean;
  134760. /** @hidden */
  134761. private _internalMarkAllSubMeshesAsTexturesDirty;
  134762. /** @hidden */
  134763. _markAllSubMeshesAsTexturesDirty(): void;
  134764. /**
  134765. * Instantiate a new istance of clear coat configuration.
  134766. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134767. */
  134768. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134769. /**
  134770. * Specifies that the submesh is ready to be used.
  134771. * @param defines the list of "defines" to update.
  134772. * @param scene defines the scene the material belongs to.
  134773. * @returns - boolean indicating that the submesh is ready or not.
  134774. */
  134775. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  134776. /**
  134777. * Checks to see if a texture is used in the material.
  134778. * @param defines the list of "defines" to update.
  134779. * @param scene defines the scene the material belongs to.
  134780. */
  134781. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  134782. /**
  134783. * Binds the material data.
  134784. * @param uniformBuffer defines the Uniform buffer to fill in.
  134785. * @param scene defines the scene the material belongs to.
  134786. * @param isFrozen defines wether the material is frozen or not.
  134787. */
  134788. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  134789. /**
  134790. * Checks to see if a texture is used in the material.
  134791. * @param texture - Base texture to use.
  134792. * @returns - Boolean specifying if a texture is used in the material.
  134793. */
  134794. hasTexture(texture: BaseTexture): boolean;
  134795. /**
  134796. * Returns an array of the actively used textures.
  134797. * @param activeTextures Array of BaseTextures
  134798. */
  134799. getActiveTextures(activeTextures: BaseTexture[]): void;
  134800. /**
  134801. * Returns the animatable textures.
  134802. * @param animatables Array of animatable textures.
  134803. */
  134804. getAnimatables(animatables: IAnimatable[]): void;
  134805. /**
  134806. * Disposes the resources of the material.
  134807. * @param forceDisposeTextures - Forces the disposal of all textures.
  134808. */
  134809. dispose(forceDisposeTextures?: boolean): void;
  134810. /**
  134811. * Get the current class name of the texture useful for serialization or dynamic coding.
  134812. * @returns "PBRSheenConfiguration"
  134813. */
  134814. getClassName(): string;
  134815. /**
  134816. * Add fallbacks to the effect fallbacks list.
  134817. * @param defines defines the Base texture to use.
  134818. * @param fallbacks defines the current fallback list.
  134819. * @param currentRank defines the current fallback rank.
  134820. * @returns the new fallback rank.
  134821. */
  134822. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134823. /**
  134824. * Add the required uniforms to the current list.
  134825. * @param uniforms defines the current uniform list.
  134826. */
  134827. static AddUniforms(uniforms: string[]): void;
  134828. /**
  134829. * Add the required uniforms to the current buffer.
  134830. * @param uniformBuffer defines the current uniform buffer.
  134831. */
  134832. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134833. /**
  134834. * Add the required samplers to the current list.
  134835. * @param samplers defines the current sampler list.
  134836. */
  134837. static AddSamplers(samplers: string[]): void;
  134838. /**
  134839. * Makes a duplicate of the current configuration into another one.
  134840. * @param sheenConfiguration define the config where to copy the info
  134841. */
  134842. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  134843. /**
  134844. * Serializes this BRDF configuration.
  134845. * @returns - An object with the serialized config.
  134846. */
  134847. serialize(): any;
  134848. /**
  134849. * Parses a anisotropy Configuration from a serialized object.
  134850. * @param source - Serialized object.
  134851. * @param scene Defines the scene we are parsing for
  134852. * @param rootUrl Defines the rootUrl to load from
  134853. */
  134854. parse(source: any, scene: Scene, rootUrl: string): void;
  134855. }
  134856. }
  134857. declare module BABYLON {
  134858. /**
  134859. * @hidden
  134860. */
  134861. export interface IMaterialSubSurfaceDefines {
  134862. SUBSURFACE: boolean;
  134863. SS_REFRACTION: boolean;
  134864. SS_TRANSLUCENCY: boolean;
  134865. SS_SCATTERING: boolean;
  134866. SS_THICKNESSANDMASK_TEXTURE: boolean;
  134867. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  134868. SS_REFRACTIONMAP_3D: boolean;
  134869. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  134870. SS_LODINREFRACTIONALPHA: boolean;
  134871. SS_GAMMAREFRACTION: boolean;
  134872. SS_RGBDREFRACTION: boolean;
  134873. SS_LINEARSPECULARREFRACTION: boolean;
  134874. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  134875. SS_ALBEDOFORREFRACTIONTINT: boolean;
  134876. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  134877. /** @hidden */
  134878. _areTexturesDirty: boolean;
  134879. }
  134880. /**
  134881. * Define the code related to the sub surface parameters of the pbr material.
  134882. */
  134883. export class PBRSubSurfaceConfiguration {
  134884. private _isRefractionEnabled;
  134885. /**
  134886. * Defines if the refraction is enabled in the material.
  134887. */
  134888. isRefractionEnabled: boolean;
  134889. private _isTranslucencyEnabled;
  134890. /**
  134891. * Defines if the translucency is enabled in the material.
  134892. */
  134893. isTranslucencyEnabled: boolean;
  134894. private _isScatteringEnabled;
  134895. /**
  134896. * Defines if the sub surface scattering is enabled in the material.
  134897. */
  134898. isScatteringEnabled: boolean;
  134899. private _scatteringDiffusionProfileIndex;
  134900. /**
  134901. * Diffusion profile for subsurface scattering.
  134902. * Useful for better scattering in the skins or foliages.
  134903. */
  134904. get scatteringDiffusionProfile(): Nullable<Color3>;
  134905. set scatteringDiffusionProfile(c: Nullable<Color3>);
  134906. /**
  134907. * Defines the refraction intensity of the material.
  134908. * The refraction when enabled replaces the Diffuse part of the material.
  134909. * The intensity helps transitionning between diffuse and refraction.
  134910. */
  134911. refractionIntensity: number;
  134912. /**
  134913. * Defines the translucency intensity of the material.
  134914. * When translucency has been enabled, this defines how much of the "translucency"
  134915. * is addded to the diffuse part of the material.
  134916. */
  134917. translucencyIntensity: number;
  134918. /**
  134919. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  134920. */
  134921. useAlbedoToTintRefraction: boolean;
  134922. private _thicknessTexture;
  134923. /**
  134924. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  134925. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  134926. * 0 would mean minimumThickness
  134927. * 1 would mean maximumThickness
  134928. * The other channels might be use as a mask to vary the different effects intensity.
  134929. */
  134930. thicknessTexture: Nullable<BaseTexture>;
  134931. private _refractionTexture;
  134932. /**
  134933. * Defines the texture to use for refraction.
  134934. */
  134935. refractionTexture: Nullable<BaseTexture>;
  134936. private _indexOfRefraction;
  134937. /**
  134938. * Index of refraction of the material base layer.
  134939. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  134940. *
  134941. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  134942. *
  134943. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  134944. */
  134945. indexOfRefraction: number;
  134946. private _volumeIndexOfRefraction;
  134947. /**
  134948. * Index of refraction of the material's volume.
  134949. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  134950. *
  134951. * This ONLY impacts refraction. If not provided or given a non-valid value,
  134952. * the volume will use the same IOR as the surface.
  134953. */
  134954. get volumeIndexOfRefraction(): number;
  134955. set volumeIndexOfRefraction(value: number);
  134956. private _invertRefractionY;
  134957. /**
  134958. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  134959. */
  134960. invertRefractionY: boolean;
  134961. private _linkRefractionWithTransparency;
  134962. /**
  134963. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  134964. * Materials half opaque for instance using refraction could benefit from this control.
  134965. */
  134966. linkRefractionWithTransparency: boolean;
  134967. /**
  134968. * Defines the minimum thickness stored in the thickness map.
  134969. * If no thickness map is defined, this value will be used to simulate thickness.
  134970. */
  134971. minimumThickness: number;
  134972. /**
  134973. * Defines the maximum thickness stored in the thickness map.
  134974. */
  134975. maximumThickness: number;
  134976. /**
  134977. * Defines the volume tint of the material.
  134978. * This is used for both translucency and scattering.
  134979. */
  134980. tintColor: Color3;
  134981. /**
  134982. * Defines the distance at which the tint color should be found in the media.
  134983. * This is used for refraction only.
  134984. */
  134985. tintColorAtDistance: number;
  134986. /**
  134987. * Defines how far each channel transmit through the media.
  134988. * It is defined as a color to simplify it selection.
  134989. */
  134990. diffusionDistance: Color3;
  134991. private _useMaskFromThicknessTexture;
  134992. /**
  134993. * Stores the intensity of the different subsurface effects in the thickness texture.
  134994. * * the green channel is the translucency intensity.
  134995. * * the blue channel is the scattering intensity.
  134996. * * the alpha channel is the refraction intensity.
  134997. */
  134998. useMaskFromThicknessTexture: boolean;
  134999. private _scene;
  135000. /** @hidden */
  135001. private _internalMarkAllSubMeshesAsTexturesDirty;
  135002. private _internalMarkScenePrePassDirty;
  135003. /** @hidden */
  135004. _markAllSubMeshesAsTexturesDirty(): void;
  135005. /** @hidden */
  135006. _markScenePrePassDirty(): void;
  135007. /**
  135008. * Instantiate a new istance of sub surface configuration.
  135009. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135010. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135011. * @param scene The scene
  135012. */
  135013. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135014. /**
  135015. * Gets wehter the submesh is ready to be used or not.
  135016. * @param defines the list of "defines" to update.
  135017. * @param scene defines the scene the material belongs to.
  135018. * @returns - boolean indicating that the submesh is ready or not.
  135019. */
  135020. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135021. /**
  135022. * Checks to see if a texture is used in the material.
  135023. * @param defines the list of "defines" to update.
  135024. * @param scene defines the scene to the material belongs to.
  135025. */
  135026. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135027. /**
  135028. * Binds the material data.
  135029. * @param uniformBuffer defines the Uniform buffer to fill in.
  135030. * @param scene defines the scene the material belongs to.
  135031. * @param engine defines the engine the material belongs to.
  135032. * @param isFrozen defines whether the material is frozen or not.
  135033. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135034. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135035. */
  135036. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135037. /**
  135038. * Unbinds the material from the mesh.
  135039. * @param activeEffect defines the effect that should be unbound from.
  135040. * @returns true if unbound, otherwise false
  135041. */
  135042. unbind(activeEffect: Effect): boolean;
  135043. /**
  135044. * Returns the texture used for refraction or null if none is used.
  135045. * @param scene defines the scene the material belongs to.
  135046. * @returns - Refraction texture if present. If no refraction texture and refraction
  135047. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135048. */
  135049. private _getRefractionTexture;
  135050. /**
  135051. * Returns true if alpha blending should be disabled.
  135052. */
  135053. get disableAlphaBlending(): boolean;
  135054. /**
  135055. * Fills the list of render target textures.
  135056. * @param renderTargets the list of render targets to update
  135057. */
  135058. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135059. /**
  135060. * Checks to see if a texture is used in the material.
  135061. * @param texture - Base texture to use.
  135062. * @returns - Boolean specifying if a texture is used in the material.
  135063. */
  135064. hasTexture(texture: BaseTexture): boolean;
  135065. /**
  135066. * Gets a boolean indicating that current material needs to register RTT
  135067. * @returns true if this uses a render target otherwise false.
  135068. */
  135069. hasRenderTargetTextures(): boolean;
  135070. /**
  135071. * Returns an array of the actively used textures.
  135072. * @param activeTextures Array of BaseTextures
  135073. */
  135074. getActiveTextures(activeTextures: BaseTexture[]): void;
  135075. /**
  135076. * Returns the animatable textures.
  135077. * @param animatables Array of animatable textures.
  135078. */
  135079. getAnimatables(animatables: IAnimatable[]): void;
  135080. /**
  135081. * Disposes the resources of the material.
  135082. * @param forceDisposeTextures - Forces the disposal of all textures.
  135083. */
  135084. dispose(forceDisposeTextures?: boolean): void;
  135085. /**
  135086. * Get the current class name of the texture useful for serialization or dynamic coding.
  135087. * @returns "PBRSubSurfaceConfiguration"
  135088. */
  135089. getClassName(): string;
  135090. /**
  135091. * Add fallbacks to the effect fallbacks list.
  135092. * @param defines defines the Base texture to use.
  135093. * @param fallbacks defines the current fallback list.
  135094. * @param currentRank defines the current fallback rank.
  135095. * @returns the new fallback rank.
  135096. */
  135097. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135098. /**
  135099. * Add the required uniforms to the current list.
  135100. * @param uniforms defines the current uniform list.
  135101. */
  135102. static AddUniforms(uniforms: string[]): void;
  135103. /**
  135104. * Add the required samplers to the current list.
  135105. * @param samplers defines the current sampler list.
  135106. */
  135107. static AddSamplers(samplers: string[]): void;
  135108. /**
  135109. * Add the required uniforms to the current buffer.
  135110. * @param uniformBuffer defines the current uniform buffer.
  135111. */
  135112. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135113. /**
  135114. * Makes a duplicate of the current configuration into another one.
  135115. * @param configuration define the config where to copy the info
  135116. */
  135117. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135118. /**
  135119. * Serializes this Sub Surface configuration.
  135120. * @returns - An object with the serialized config.
  135121. */
  135122. serialize(): any;
  135123. /**
  135124. * Parses a anisotropy Configuration from a serialized object.
  135125. * @param source - Serialized object.
  135126. * @param scene Defines the scene we are parsing for
  135127. * @param rootUrl Defines the rootUrl to load from
  135128. */
  135129. parse(source: any, scene: Scene, rootUrl: string): void;
  135130. }
  135131. }
  135132. declare module BABYLON {
  135133. /** @hidden */
  135134. export var pbrFragmentDeclaration: {
  135135. name: string;
  135136. shader: string;
  135137. };
  135138. }
  135139. declare module BABYLON {
  135140. /** @hidden */
  135141. export var pbrUboDeclaration: {
  135142. name: string;
  135143. shader: string;
  135144. };
  135145. }
  135146. declare module BABYLON {
  135147. /** @hidden */
  135148. export var pbrFragmentExtraDeclaration: {
  135149. name: string;
  135150. shader: string;
  135151. };
  135152. }
  135153. declare module BABYLON {
  135154. /** @hidden */
  135155. export var pbrFragmentSamplersDeclaration: {
  135156. name: string;
  135157. shader: string;
  135158. };
  135159. }
  135160. declare module BABYLON {
  135161. /** @hidden */
  135162. export var importanceSampling: {
  135163. name: string;
  135164. shader: string;
  135165. };
  135166. }
  135167. declare module BABYLON {
  135168. /** @hidden */
  135169. export var pbrHelperFunctions: {
  135170. name: string;
  135171. shader: string;
  135172. };
  135173. }
  135174. declare module BABYLON {
  135175. /** @hidden */
  135176. export var harmonicsFunctions: {
  135177. name: string;
  135178. shader: string;
  135179. };
  135180. }
  135181. declare module BABYLON {
  135182. /** @hidden */
  135183. export var pbrDirectLightingSetupFunctions: {
  135184. name: string;
  135185. shader: string;
  135186. };
  135187. }
  135188. declare module BABYLON {
  135189. /** @hidden */
  135190. export var pbrDirectLightingFalloffFunctions: {
  135191. name: string;
  135192. shader: string;
  135193. };
  135194. }
  135195. declare module BABYLON {
  135196. /** @hidden */
  135197. export var pbrBRDFFunctions: {
  135198. name: string;
  135199. shader: string;
  135200. };
  135201. }
  135202. declare module BABYLON {
  135203. /** @hidden */
  135204. export var hdrFilteringFunctions: {
  135205. name: string;
  135206. shader: string;
  135207. };
  135208. }
  135209. declare module BABYLON {
  135210. /** @hidden */
  135211. export var pbrDirectLightingFunctions: {
  135212. name: string;
  135213. shader: string;
  135214. };
  135215. }
  135216. declare module BABYLON {
  135217. /** @hidden */
  135218. export var pbrIBLFunctions: {
  135219. name: string;
  135220. shader: string;
  135221. };
  135222. }
  135223. declare module BABYLON {
  135224. /** @hidden */
  135225. export var pbrBlockAlbedoOpacity: {
  135226. name: string;
  135227. shader: string;
  135228. };
  135229. }
  135230. declare module BABYLON {
  135231. /** @hidden */
  135232. export var pbrBlockReflectivity: {
  135233. name: string;
  135234. shader: string;
  135235. };
  135236. }
  135237. declare module BABYLON {
  135238. /** @hidden */
  135239. export var pbrBlockAmbientOcclusion: {
  135240. name: string;
  135241. shader: string;
  135242. };
  135243. }
  135244. declare module BABYLON {
  135245. /** @hidden */
  135246. export var pbrBlockAlphaFresnel: {
  135247. name: string;
  135248. shader: string;
  135249. };
  135250. }
  135251. declare module BABYLON {
  135252. /** @hidden */
  135253. export var pbrBlockAnisotropic: {
  135254. name: string;
  135255. shader: string;
  135256. };
  135257. }
  135258. declare module BABYLON {
  135259. /** @hidden */
  135260. export var pbrBlockReflection: {
  135261. name: string;
  135262. shader: string;
  135263. };
  135264. }
  135265. declare module BABYLON {
  135266. /** @hidden */
  135267. export var pbrBlockSheen: {
  135268. name: string;
  135269. shader: string;
  135270. };
  135271. }
  135272. declare module BABYLON {
  135273. /** @hidden */
  135274. export var pbrBlockClearcoat: {
  135275. name: string;
  135276. shader: string;
  135277. };
  135278. }
  135279. declare module BABYLON {
  135280. /** @hidden */
  135281. export var pbrBlockSubSurface: {
  135282. name: string;
  135283. shader: string;
  135284. };
  135285. }
  135286. declare module BABYLON {
  135287. /** @hidden */
  135288. export var pbrBlockNormalGeometric: {
  135289. name: string;
  135290. shader: string;
  135291. };
  135292. }
  135293. declare module BABYLON {
  135294. /** @hidden */
  135295. export var pbrBlockNormalFinal: {
  135296. name: string;
  135297. shader: string;
  135298. };
  135299. }
  135300. declare module BABYLON {
  135301. /** @hidden */
  135302. export var pbrBlockLightmapInit: {
  135303. name: string;
  135304. shader: string;
  135305. };
  135306. }
  135307. declare module BABYLON {
  135308. /** @hidden */
  135309. export var pbrBlockGeometryInfo: {
  135310. name: string;
  135311. shader: string;
  135312. };
  135313. }
  135314. declare module BABYLON {
  135315. /** @hidden */
  135316. export var pbrBlockReflectance0: {
  135317. name: string;
  135318. shader: string;
  135319. };
  135320. }
  135321. declare module BABYLON {
  135322. /** @hidden */
  135323. export var pbrBlockReflectance: {
  135324. name: string;
  135325. shader: string;
  135326. };
  135327. }
  135328. declare module BABYLON {
  135329. /** @hidden */
  135330. export var pbrBlockDirectLighting: {
  135331. name: string;
  135332. shader: string;
  135333. };
  135334. }
  135335. declare module BABYLON {
  135336. /** @hidden */
  135337. export var pbrBlockFinalLitComponents: {
  135338. name: string;
  135339. shader: string;
  135340. };
  135341. }
  135342. declare module BABYLON {
  135343. /** @hidden */
  135344. export var pbrBlockFinalUnlitComponents: {
  135345. name: string;
  135346. shader: string;
  135347. };
  135348. }
  135349. declare module BABYLON {
  135350. /** @hidden */
  135351. export var pbrBlockFinalColorComposition: {
  135352. name: string;
  135353. shader: string;
  135354. };
  135355. }
  135356. declare module BABYLON {
  135357. /** @hidden */
  135358. export var pbrBlockImageProcessing: {
  135359. name: string;
  135360. shader: string;
  135361. };
  135362. }
  135363. declare module BABYLON {
  135364. /** @hidden */
  135365. export var pbrDebug: {
  135366. name: string;
  135367. shader: string;
  135368. };
  135369. }
  135370. declare module BABYLON {
  135371. /** @hidden */
  135372. export var pbrPixelShader: {
  135373. name: string;
  135374. shader: string;
  135375. };
  135376. }
  135377. declare module BABYLON {
  135378. /** @hidden */
  135379. export var pbrVertexDeclaration: {
  135380. name: string;
  135381. shader: string;
  135382. };
  135383. }
  135384. declare module BABYLON {
  135385. /** @hidden */
  135386. export var pbrVertexShader: {
  135387. name: string;
  135388. shader: string;
  135389. };
  135390. }
  135391. declare module BABYLON {
  135392. /**
  135393. * Manages the defines for the PBR Material.
  135394. * @hidden
  135395. */
  135396. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  135397. PBR: boolean;
  135398. NUM_SAMPLES: string;
  135399. REALTIME_FILTERING: boolean;
  135400. MAINUV1: boolean;
  135401. MAINUV2: boolean;
  135402. UV1: boolean;
  135403. UV2: boolean;
  135404. ALBEDO: boolean;
  135405. GAMMAALBEDO: boolean;
  135406. ALBEDODIRECTUV: number;
  135407. VERTEXCOLOR: boolean;
  135408. DETAIL: boolean;
  135409. DETAILDIRECTUV: number;
  135410. DETAIL_NORMALBLENDMETHOD: number;
  135411. AMBIENT: boolean;
  135412. AMBIENTDIRECTUV: number;
  135413. AMBIENTINGRAYSCALE: boolean;
  135414. OPACITY: boolean;
  135415. VERTEXALPHA: boolean;
  135416. OPACITYDIRECTUV: number;
  135417. OPACITYRGB: boolean;
  135418. ALPHATEST: boolean;
  135419. DEPTHPREPASS: boolean;
  135420. ALPHABLEND: boolean;
  135421. ALPHAFROMALBEDO: boolean;
  135422. ALPHATESTVALUE: string;
  135423. SPECULAROVERALPHA: boolean;
  135424. RADIANCEOVERALPHA: boolean;
  135425. ALPHAFRESNEL: boolean;
  135426. LINEARALPHAFRESNEL: boolean;
  135427. PREMULTIPLYALPHA: boolean;
  135428. EMISSIVE: boolean;
  135429. EMISSIVEDIRECTUV: number;
  135430. REFLECTIVITY: boolean;
  135431. REFLECTIVITYDIRECTUV: number;
  135432. SPECULARTERM: boolean;
  135433. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  135434. MICROSURFACEAUTOMATIC: boolean;
  135435. LODBASEDMICROSFURACE: boolean;
  135436. MICROSURFACEMAP: boolean;
  135437. MICROSURFACEMAPDIRECTUV: number;
  135438. METALLICWORKFLOW: boolean;
  135439. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  135440. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  135441. METALLNESSSTOREINMETALMAPBLUE: boolean;
  135442. AOSTOREINMETALMAPRED: boolean;
  135443. METALLIC_REFLECTANCE: boolean;
  135444. METALLIC_REFLECTANCEDIRECTUV: number;
  135445. ENVIRONMENTBRDF: boolean;
  135446. ENVIRONMENTBRDF_RGBD: boolean;
  135447. NORMAL: boolean;
  135448. TANGENT: boolean;
  135449. BUMP: boolean;
  135450. BUMPDIRECTUV: number;
  135451. OBJECTSPACE_NORMALMAP: boolean;
  135452. PARALLAX: boolean;
  135453. PARALLAXOCCLUSION: boolean;
  135454. NORMALXYSCALE: boolean;
  135455. LIGHTMAP: boolean;
  135456. LIGHTMAPDIRECTUV: number;
  135457. USELIGHTMAPASSHADOWMAP: boolean;
  135458. GAMMALIGHTMAP: boolean;
  135459. RGBDLIGHTMAP: boolean;
  135460. REFLECTION: boolean;
  135461. REFLECTIONMAP_3D: boolean;
  135462. REFLECTIONMAP_SPHERICAL: boolean;
  135463. REFLECTIONMAP_PLANAR: boolean;
  135464. REFLECTIONMAP_CUBIC: boolean;
  135465. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  135466. REFLECTIONMAP_PROJECTION: boolean;
  135467. REFLECTIONMAP_SKYBOX: boolean;
  135468. REFLECTIONMAP_EXPLICIT: boolean;
  135469. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  135470. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  135471. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  135472. INVERTCUBICMAP: boolean;
  135473. USESPHERICALFROMREFLECTIONMAP: boolean;
  135474. USEIRRADIANCEMAP: boolean;
  135475. SPHERICAL_HARMONICS: boolean;
  135476. USESPHERICALINVERTEX: boolean;
  135477. REFLECTIONMAP_OPPOSITEZ: boolean;
  135478. LODINREFLECTIONALPHA: boolean;
  135479. GAMMAREFLECTION: boolean;
  135480. RGBDREFLECTION: boolean;
  135481. LINEARSPECULARREFLECTION: boolean;
  135482. RADIANCEOCCLUSION: boolean;
  135483. HORIZONOCCLUSION: boolean;
  135484. INSTANCES: boolean;
  135485. THIN_INSTANCES: boolean;
  135486. PREPASS: boolean;
  135487. SCENE_MRT_COUNT: number;
  135488. NUM_BONE_INFLUENCERS: number;
  135489. BonesPerMesh: number;
  135490. BONETEXTURE: boolean;
  135491. NONUNIFORMSCALING: boolean;
  135492. MORPHTARGETS: boolean;
  135493. MORPHTARGETS_NORMAL: boolean;
  135494. MORPHTARGETS_TANGENT: boolean;
  135495. MORPHTARGETS_UV: boolean;
  135496. NUM_MORPH_INFLUENCERS: number;
  135497. IMAGEPROCESSING: boolean;
  135498. VIGNETTE: boolean;
  135499. VIGNETTEBLENDMODEMULTIPLY: boolean;
  135500. VIGNETTEBLENDMODEOPAQUE: boolean;
  135501. TONEMAPPING: boolean;
  135502. TONEMAPPING_ACES: boolean;
  135503. CONTRAST: boolean;
  135504. COLORCURVES: boolean;
  135505. COLORGRADING: boolean;
  135506. COLORGRADING3D: boolean;
  135507. SAMPLER3DGREENDEPTH: boolean;
  135508. SAMPLER3DBGRMAP: boolean;
  135509. IMAGEPROCESSINGPOSTPROCESS: boolean;
  135510. EXPOSURE: boolean;
  135511. MULTIVIEW: boolean;
  135512. USEPHYSICALLIGHTFALLOFF: boolean;
  135513. USEGLTFLIGHTFALLOFF: boolean;
  135514. TWOSIDEDLIGHTING: boolean;
  135515. SHADOWFLOAT: boolean;
  135516. CLIPPLANE: boolean;
  135517. CLIPPLANE2: boolean;
  135518. CLIPPLANE3: boolean;
  135519. CLIPPLANE4: boolean;
  135520. CLIPPLANE5: boolean;
  135521. CLIPPLANE6: boolean;
  135522. POINTSIZE: boolean;
  135523. FOG: boolean;
  135524. LOGARITHMICDEPTH: boolean;
  135525. FORCENORMALFORWARD: boolean;
  135526. SPECULARAA: boolean;
  135527. CLEARCOAT: boolean;
  135528. CLEARCOAT_DEFAULTIOR: boolean;
  135529. CLEARCOAT_TEXTURE: boolean;
  135530. CLEARCOAT_TEXTUREDIRECTUV: number;
  135531. CLEARCOAT_BUMP: boolean;
  135532. CLEARCOAT_BUMPDIRECTUV: number;
  135533. CLEARCOAT_TINT: boolean;
  135534. CLEARCOAT_TINT_TEXTURE: boolean;
  135535. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  135536. ANISOTROPIC: boolean;
  135537. ANISOTROPIC_TEXTURE: boolean;
  135538. ANISOTROPIC_TEXTUREDIRECTUV: number;
  135539. BRDF_V_HEIGHT_CORRELATED: boolean;
  135540. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135541. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135542. SHEEN: boolean;
  135543. SHEEN_TEXTURE: boolean;
  135544. SHEEN_TEXTUREDIRECTUV: number;
  135545. SHEEN_LINKWITHALBEDO: boolean;
  135546. SHEEN_ROUGHNESS: boolean;
  135547. SHEEN_ALBEDOSCALING: boolean;
  135548. SUBSURFACE: boolean;
  135549. SS_REFRACTION: boolean;
  135550. SS_TRANSLUCENCY: boolean;
  135551. SS_SCATTERING: boolean;
  135552. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135553. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135554. SS_REFRACTIONMAP_3D: boolean;
  135555. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135556. SS_LODINREFRACTIONALPHA: boolean;
  135557. SS_GAMMAREFRACTION: boolean;
  135558. SS_RGBDREFRACTION: boolean;
  135559. SS_LINEARSPECULARREFRACTION: boolean;
  135560. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135561. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135562. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135563. UNLIT: boolean;
  135564. DEBUGMODE: number;
  135565. /**
  135566. * Initializes the PBR Material defines.
  135567. */
  135568. constructor();
  135569. /**
  135570. * Resets the PBR Material defines.
  135571. */
  135572. reset(): void;
  135573. }
  135574. /**
  135575. * The Physically based material base class of BJS.
  135576. *
  135577. * This offers the main features of a standard PBR material.
  135578. * For more information, please refer to the documentation :
  135579. * https://doc.babylonjs.com/how_to/physically_based_rendering
  135580. */
  135581. export abstract class PBRBaseMaterial extends PushMaterial {
  135582. /**
  135583. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  135584. */
  135585. static readonly PBRMATERIAL_OPAQUE: number;
  135586. /**
  135587. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  135588. */
  135589. static readonly PBRMATERIAL_ALPHATEST: number;
  135590. /**
  135591. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  135592. */
  135593. static readonly PBRMATERIAL_ALPHABLEND: number;
  135594. /**
  135595. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  135596. * They are also discarded below the alpha cutoff threshold to improve performances.
  135597. */
  135598. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  135599. /**
  135600. * Defines the default value of how much AO map is occluding the analytical lights
  135601. * (point spot...).
  135602. */
  135603. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  135604. /**
  135605. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  135606. */
  135607. static readonly LIGHTFALLOFF_PHYSICAL: number;
  135608. /**
  135609. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  135610. * to enhance interoperability with other engines.
  135611. */
  135612. static readonly LIGHTFALLOFF_GLTF: number;
  135613. /**
  135614. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  135615. * to enhance interoperability with other materials.
  135616. */
  135617. static readonly LIGHTFALLOFF_STANDARD: number;
  135618. /**
  135619. * Intensity of the direct lights e.g. the four lights available in your scene.
  135620. * This impacts both the direct diffuse and specular highlights.
  135621. */
  135622. protected _directIntensity: number;
  135623. /**
  135624. * Intensity of the emissive part of the material.
  135625. * This helps controlling the emissive effect without modifying the emissive color.
  135626. */
  135627. protected _emissiveIntensity: number;
  135628. /**
  135629. * Intensity of the environment e.g. how much the environment will light the object
  135630. * either through harmonics for rough material or through the refelction for shiny ones.
  135631. */
  135632. protected _environmentIntensity: number;
  135633. /**
  135634. * This is a special control allowing the reduction of the specular highlights coming from the
  135635. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  135636. */
  135637. protected _specularIntensity: number;
  135638. /**
  135639. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  135640. */
  135641. private _lightingInfos;
  135642. /**
  135643. * Debug Control allowing disabling the bump map on this material.
  135644. */
  135645. protected _disableBumpMap: boolean;
  135646. /**
  135647. * AKA Diffuse Texture in standard nomenclature.
  135648. */
  135649. protected _albedoTexture: Nullable<BaseTexture>;
  135650. /**
  135651. * AKA Occlusion Texture in other nomenclature.
  135652. */
  135653. protected _ambientTexture: Nullable<BaseTexture>;
  135654. /**
  135655. * AKA Occlusion Texture Intensity in other nomenclature.
  135656. */
  135657. protected _ambientTextureStrength: number;
  135658. /**
  135659. * Defines how much the AO map is occluding the analytical lights (point spot...).
  135660. * 1 means it completely occludes it
  135661. * 0 mean it has no impact
  135662. */
  135663. protected _ambientTextureImpactOnAnalyticalLights: number;
  135664. /**
  135665. * Stores the alpha values in a texture.
  135666. */
  135667. protected _opacityTexture: Nullable<BaseTexture>;
  135668. /**
  135669. * Stores the reflection values in a texture.
  135670. */
  135671. protected _reflectionTexture: Nullable<BaseTexture>;
  135672. /**
  135673. * Stores the emissive values in a texture.
  135674. */
  135675. protected _emissiveTexture: Nullable<BaseTexture>;
  135676. /**
  135677. * AKA Specular texture in other nomenclature.
  135678. */
  135679. protected _reflectivityTexture: Nullable<BaseTexture>;
  135680. /**
  135681. * Used to switch from specular/glossiness to metallic/roughness workflow.
  135682. */
  135683. protected _metallicTexture: Nullable<BaseTexture>;
  135684. /**
  135685. * Specifies the metallic scalar of the metallic/roughness workflow.
  135686. * Can also be used to scale the metalness values of the metallic texture.
  135687. */
  135688. protected _metallic: Nullable<number>;
  135689. /**
  135690. * Specifies the roughness scalar of the metallic/roughness workflow.
  135691. * Can also be used to scale the roughness values of the metallic texture.
  135692. */
  135693. protected _roughness: Nullable<number>;
  135694. /**
  135695. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  135696. * By default the indexOfrefraction is used to compute F0;
  135697. *
  135698. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  135699. *
  135700. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  135701. * F90 = metallicReflectanceColor;
  135702. */
  135703. protected _metallicF0Factor: number;
  135704. /**
  135705. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  135706. * By default the F90 is always 1;
  135707. *
  135708. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  135709. *
  135710. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  135711. * F90 = metallicReflectanceColor;
  135712. */
  135713. protected _metallicReflectanceColor: Color3;
  135714. /**
  135715. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  135716. * This is multiply against the scalar values defined in the material.
  135717. */
  135718. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  135719. /**
  135720. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  135721. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  135722. */
  135723. protected _microSurfaceTexture: Nullable<BaseTexture>;
  135724. /**
  135725. * Stores surface normal data used to displace a mesh in a texture.
  135726. */
  135727. protected _bumpTexture: Nullable<BaseTexture>;
  135728. /**
  135729. * Stores the pre-calculated light information of a mesh in a texture.
  135730. */
  135731. protected _lightmapTexture: Nullable<BaseTexture>;
  135732. /**
  135733. * The color of a material in ambient lighting.
  135734. */
  135735. protected _ambientColor: Color3;
  135736. /**
  135737. * AKA Diffuse Color in other nomenclature.
  135738. */
  135739. protected _albedoColor: Color3;
  135740. /**
  135741. * AKA Specular Color in other nomenclature.
  135742. */
  135743. protected _reflectivityColor: Color3;
  135744. /**
  135745. * The color applied when light is reflected from a material.
  135746. */
  135747. protected _reflectionColor: Color3;
  135748. /**
  135749. * The color applied when light is emitted from a material.
  135750. */
  135751. protected _emissiveColor: Color3;
  135752. /**
  135753. * AKA Glossiness in other nomenclature.
  135754. */
  135755. protected _microSurface: number;
  135756. /**
  135757. * Specifies that the material will use the light map as a show map.
  135758. */
  135759. protected _useLightmapAsShadowmap: boolean;
  135760. /**
  135761. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  135762. * makes the reflect vector face the model (under horizon).
  135763. */
  135764. protected _useHorizonOcclusion: boolean;
  135765. /**
  135766. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  135767. * too much the area relying on ambient texture to define their ambient occlusion.
  135768. */
  135769. protected _useRadianceOcclusion: boolean;
  135770. /**
  135771. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  135772. */
  135773. protected _useAlphaFromAlbedoTexture: boolean;
  135774. /**
  135775. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  135776. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  135777. */
  135778. protected _useSpecularOverAlpha: boolean;
  135779. /**
  135780. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  135781. */
  135782. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  135783. /**
  135784. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  135785. */
  135786. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  135787. /**
  135788. * Specifies if the metallic texture contains the roughness information in its green channel.
  135789. */
  135790. protected _useRoughnessFromMetallicTextureGreen: boolean;
  135791. /**
  135792. * Specifies if the metallic texture contains the metallness information in its blue channel.
  135793. */
  135794. protected _useMetallnessFromMetallicTextureBlue: boolean;
  135795. /**
  135796. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  135797. */
  135798. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  135799. /**
  135800. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  135801. */
  135802. protected _useAmbientInGrayScale: boolean;
  135803. /**
  135804. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  135805. * The material will try to infer what glossiness each pixel should be.
  135806. */
  135807. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  135808. /**
  135809. * Defines the falloff type used in this material.
  135810. * It by default is Physical.
  135811. */
  135812. protected _lightFalloff: number;
  135813. /**
  135814. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  135815. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  135816. */
  135817. protected _useRadianceOverAlpha: boolean;
  135818. /**
  135819. * Allows using an object space normal map (instead of tangent space).
  135820. */
  135821. protected _useObjectSpaceNormalMap: boolean;
  135822. /**
  135823. * Allows using the bump map in parallax mode.
  135824. */
  135825. protected _useParallax: boolean;
  135826. /**
  135827. * Allows using the bump map in parallax occlusion mode.
  135828. */
  135829. protected _useParallaxOcclusion: boolean;
  135830. /**
  135831. * Controls the scale bias of the parallax mode.
  135832. */
  135833. protected _parallaxScaleBias: number;
  135834. /**
  135835. * If sets to true, disables all the lights affecting the material.
  135836. */
  135837. protected _disableLighting: boolean;
  135838. /**
  135839. * Number of Simultaneous lights allowed on the material.
  135840. */
  135841. protected _maxSimultaneousLights: number;
  135842. /**
  135843. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  135844. */
  135845. protected _invertNormalMapX: boolean;
  135846. /**
  135847. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  135848. */
  135849. protected _invertNormalMapY: boolean;
  135850. /**
  135851. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  135852. */
  135853. protected _twoSidedLighting: boolean;
  135854. /**
  135855. * Defines the alpha limits in alpha test mode.
  135856. */
  135857. protected _alphaCutOff: number;
  135858. /**
  135859. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  135860. */
  135861. protected _forceAlphaTest: boolean;
  135862. /**
  135863. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  135864. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  135865. */
  135866. protected _useAlphaFresnel: boolean;
  135867. /**
  135868. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  135869. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  135870. */
  135871. protected _useLinearAlphaFresnel: boolean;
  135872. /**
  135873. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  135874. * from cos thetav and roughness:
  135875. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  135876. */
  135877. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  135878. /**
  135879. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  135880. */
  135881. protected _forceIrradianceInFragment: boolean;
  135882. private _realTimeFiltering;
  135883. /**
  135884. * Enables realtime filtering on the texture.
  135885. */
  135886. get realTimeFiltering(): boolean;
  135887. set realTimeFiltering(b: boolean);
  135888. private _realTimeFilteringQuality;
  135889. /**
  135890. * Quality switch for realtime filtering
  135891. */
  135892. get realTimeFilteringQuality(): number;
  135893. set realTimeFilteringQuality(n: number);
  135894. /**
  135895. * Can this material render to several textures at once
  135896. */
  135897. get canRenderToMRT(): boolean;
  135898. /**
  135899. * Force normal to face away from face.
  135900. */
  135901. protected _forceNormalForward: boolean;
  135902. /**
  135903. * Enables specular anti aliasing in the PBR shader.
  135904. * It will both interacts on the Geometry for analytical and IBL lighting.
  135905. * It also prefilter the roughness map based on the bump values.
  135906. */
  135907. protected _enableSpecularAntiAliasing: boolean;
  135908. /**
  135909. * Default configuration related to image processing available in the PBR Material.
  135910. */
  135911. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  135912. /**
  135913. * Keep track of the image processing observer to allow dispose and replace.
  135914. */
  135915. private _imageProcessingObserver;
  135916. /**
  135917. * Attaches a new image processing configuration to the PBR Material.
  135918. * @param configuration
  135919. */
  135920. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  135921. /**
  135922. * Stores the available render targets.
  135923. */
  135924. private _renderTargets;
  135925. /**
  135926. * Sets the global ambient color for the material used in lighting calculations.
  135927. */
  135928. private _globalAmbientColor;
  135929. /**
  135930. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  135931. */
  135932. private _useLogarithmicDepth;
  135933. /**
  135934. * If set to true, no lighting calculations will be applied.
  135935. */
  135936. private _unlit;
  135937. private _debugMode;
  135938. /**
  135939. * @hidden
  135940. * This is reserved for the inspector.
  135941. * Defines the material debug mode.
  135942. * It helps seeing only some components of the material while troubleshooting.
  135943. */
  135944. debugMode: number;
  135945. /**
  135946. * @hidden
  135947. * This is reserved for the inspector.
  135948. * Specify from where on screen the debug mode should start.
  135949. * The value goes from -1 (full screen) to 1 (not visible)
  135950. * It helps with side by side comparison against the final render
  135951. * This defaults to -1
  135952. */
  135953. private debugLimit;
  135954. /**
  135955. * @hidden
  135956. * This is reserved for the inspector.
  135957. * As the default viewing range might not be enough (if the ambient is really small for instance)
  135958. * You can use the factor to better multiply the final value.
  135959. */
  135960. private debugFactor;
  135961. /**
  135962. * Defines the clear coat layer parameters for the material.
  135963. */
  135964. readonly clearCoat: PBRClearCoatConfiguration;
  135965. /**
  135966. * Defines the anisotropic parameters for the material.
  135967. */
  135968. readonly anisotropy: PBRAnisotropicConfiguration;
  135969. /**
  135970. * Defines the BRDF parameters for the material.
  135971. */
  135972. readonly brdf: PBRBRDFConfiguration;
  135973. /**
  135974. * Defines the Sheen parameters for the material.
  135975. */
  135976. readonly sheen: PBRSheenConfiguration;
  135977. /**
  135978. * Defines the SubSurface parameters for the material.
  135979. */
  135980. readonly subSurface: PBRSubSurfaceConfiguration;
  135981. /**
  135982. * Defines the detail map parameters for the material.
  135983. */
  135984. readonly detailMap: DetailMapConfiguration;
  135985. protected _rebuildInParallel: boolean;
  135986. /**
  135987. * Instantiates a new PBRMaterial instance.
  135988. *
  135989. * @param name The material name
  135990. * @param scene The scene the material will be use in.
  135991. */
  135992. constructor(name: string, scene: Scene);
  135993. /**
  135994. * Gets a boolean indicating that current material needs to register RTT
  135995. */
  135996. get hasRenderTargetTextures(): boolean;
  135997. /**
  135998. * Gets the name of the material class.
  135999. */
  136000. getClassName(): string;
  136001. /**
  136002. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136003. */
  136004. get useLogarithmicDepth(): boolean;
  136005. /**
  136006. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136007. */
  136008. set useLogarithmicDepth(value: boolean);
  136009. /**
  136010. * Returns true if alpha blending should be disabled.
  136011. */
  136012. protected get _disableAlphaBlending(): boolean;
  136013. /**
  136014. * Specifies whether or not this material should be rendered in alpha blend mode.
  136015. */
  136016. needAlphaBlending(): boolean;
  136017. /**
  136018. * Specifies whether or not this material should be rendered in alpha test mode.
  136019. */
  136020. needAlphaTesting(): boolean;
  136021. /**
  136022. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136023. */
  136024. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136025. /**
  136026. * Gets the texture used for the alpha test.
  136027. */
  136028. getAlphaTestTexture(): Nullable<BaseTexture>;
  136029. /**
  136030. * Specifies that the submesh is ready to be used.
  136031. * @param mesh - BJS mesh.
  136032. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136033. * @param useInstances - Specifies that instances should be used.
  136034. * @returns - boolean indicating that the submesh is ready or not.
  136035. */
  136036. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136037. /**
  136038. * Specifies if the material uses metallic roughness workflow.
  136039. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136040. */
  136041. isMetallicWorkflow(): boolean;
  136042. private _prepareEffect;
  136043. private _prepareDefines;
  136044. /**
  136045. * Force shader compilation
  136046. */
  136047. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136048. /**
  136049. * Initializes the uniform buffer layout for the shader.
  136050. */
  136051. buildUniformLayout(): void;
  136052. /**
  136053. * Unbinds the material from the mesh
  136054. */
  136055. unbind(): void;
  136056. /**
  136057. * Binds the submesh data.
  136058. * @param world - The world matrix.
  136059. * @param mesh - The BJS mesh.
  136060. * @param subMesh - A submesh of the BJS mesh.
  136061. */
  136062. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136063. /**
  136064. * Returns the animatable textures.
  136065. * @returns - Array of animatable textures.
  136066. */
  136067. getAnimatables(): IAnimatable[];
  136068. /**
  136069. * Returns the texture used for reflections.
  136070. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136071. */
  136072. private _getReflectionTexture;
  136073. /**
  136074. * Returns an array of the actively used textures.
  136075. * @returns - Array of BaseTextures
  136076. */
  136077. getActiveTextures(): BaseTexture[];
  136078. /**
  136079. * Checks to see if a texture is used in the material.
  136080. * @param texture - Base texture to use.
  136081. * @returns - Boolean specifying if a texture is used in the material.
  136082. */
  136083. hasTexture(texture: BaseTexture): boolean;
  136084. /**
  136085. * Sets the required values to the prepass renderer.
  136086. * @param prePassRenderer defines the prepass renderer to setup
  136087. */
  136088. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136089. /**
  136090. * Disposes the resources of the material.
  136091. * @param forceDisposeEffect - Forces the disposal of effects.
  136092. * @param forceDisposeTextures - Forces the disposal of all textures.
  136093. */
  136094. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136095. }
  136096. }
  136097. declare module BABYLON {
  136098. /**
  136099. * The Physically based material of BJS.
  136100. *
  136101. * This offers the main features of a standard PBR material.
  136102. * For more information, please refer to the documentation :
  136103. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136104. */
  136105. export class PBRMaterial extends PBRBaseMaterial {
  136106. /**
  136107. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136108. */
  136109. static readonly PBRMATERIAL_OPAQUE: number;
  136110. /**
  136111. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136112. */
  136113. static readonly PBRMATERIAL_ALPHATEST: number;
  136114. /**
  136115. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136116. */
  136117. static readonly PBRMATERIAL_ALPHABLEND: number;
  136118. /**
  136119. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136120. * They are also discarded below the alpha cutoff threshold to improve performances.
  136121. */
  136122. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136123. /**
  136124. * Defines the default value of how much AO map is occluding the analytical lights
  136125. * (point spot...).
  136126. */
  136127. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136128. /**
  136129. * Intensity of the direct lights e.g. the four lights available in your scene.
  136130. * This impacts both the direct diffuse and specular highlights.
  136131. */
  136132. directIntensity: number;
  136133. /**
  136134. * Intensity of the emissive part of the material.
  136135. * This helps controlling the emissive effect without modifying the emissive color.
  136136. */
  136137. emissiveIntensity: number;
  136138. /**
  136139. * Intensity of the environment e.g. how much the environment will light the object
  136140. * either through harmonics for rough material or through the refelction for shiny ones.
  136141. */
  136142. environmentIntensity: number;
  136143. /**
  136144. * This is a special control allowing the reduction of the specular highlights coming from the
  136145. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136146. */
  136147. specularIntensity: number;
  136148. /**
  136149. * Debug Control allowing disabling the bump map on this material.
  136150. */
  136151. disableBumpMap: boolean;
  136152. /**
  136153. * AKA Diffuse Texture in standard nomenclature.
  136154. */
  136155. albedoTexture: BaseTexture;
  136156. /**
  136157. * AKA Occlusion Texture in other nomenclature.
  136158. */
  136159. ambientTexture: BaseTexture;
  136160. /**
  136161. * AKA Occlusion Texture Intensity in other nomenclature.
  136162. */
  136163. ambientTextureStrength: number;
  136164. /**
  136165. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136166. * 1 means it completely occludes it
  136167. * 0 mean it has no impact
  136168. */
  136169. ambientTextureImpactOnAnalyticalLights: number;
  136170. /**
  136171. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136172. */
  136173. opacityTexture: BaseTexture;
  136174. /**
  136175. * Stores the reflection values in a texture.
  136176. */
  136177. reflectionTexture: Nullable<BaseTexture>;
  136178. /**
  136179. * Stores the emissive values in a texture.
  136180. */
  136181. emissiveTexture: BaseTexture;
  136182. /**
  136183. * AKA Specular texture in other nomenclature.
  136184. */
  136185. reflectivityTexture: BaseTexture;
  136186. /**
  136187. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136188. */
  136189. metallicTexture: BaseTexture;
  136190. /**
  136191. * Specifies the metallic scalar of the metallic/roughness workflow.
  136192. * Can also be used to scale the metalness values of the metallic texture.
  136193. */
  136194. metallic: Nullable<number>;
  136195. /**
  136196. * Specifies the roughness scalar of the metallic/roughness workflow.
  136197. * Can also be used to scale the roughness values of the metallic texture.
  136198. */
  136199. roughness: Nullable<number>;
  136200. /**
  136201. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136202. * By default the indexOfrefraction is used to compute F0;
  136203. *
  136204. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136205. *
  136206. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136207. * F90 = metallicReflectanceColor;
  136208. */
  136209. metallicF0Factor: number;
  136210. /**
  136211. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136212. * By default the F90 is always 1;
  136213. *
  136214. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136215. *
  136216. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136217. * F90 = metallicReflectanceColor;
  136218. */
  136219. metallicReflectanceColor: Color3;
  136220. /**
  136221. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136222. * This is multiply against the scalar values defined in the material.
  136223. */
  136224. metallicReflectanceTexture: Nullable<BaseTexture>;
  136225. /**
  136226. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136227. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136228. */
  136229. microSurfaceTexture: BaseTexture;
  136230. /**
  136231. * Stores surface normal data used to displace a mesh in a texture.
  136232. */
  136233. bumpTexture: BaseTexture;
  136234. /**
  136235. * Stores the pre-calculated light information of a mesh in a texture.
  136236. */
  136237. lightmapTexture: BaseTexture;
  136238. /**
  136239. * Stores the refracted light information in a texture.
  136240. */
  136241. get refractionTexture(): Nullable<BaseTexture>;
  136242. set refractionTexture(value: Nullable<BaseTexture>);
  136243. /**
  136244. * The color of a material in ambient lighting.
  136245. */
  136246. ambientColor: Color3;
  136247. /**
  136248. * AKA Diffuse Color in other nomenclature.
  136249. */
  136250. albedoColor: Color3;
  136251. /**
  136252. * AKA Specular Color in other nomenclature.
  136253. */
  136254. reflectivityColor: Color3;
  136255. /**
  136256. * The color reflected from the material.
  136257. */
  136258. reflectionColor: Color3;
  136259. /**
  136260. * The color emitted from the material.
  136261. */
  136262. emissiveColor: Color3;
  136263. /**
  136264. * AKA Glossiness in other nomenclature.
  136265. */
  136266. microSurface: number;
  136267. /**
  136268. * Index of refraction of the material base layer.
  136269. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136270. *
  136271. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136272. *
  136273. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136274. */
  136275. get indexOfRefraction(): number;
  136276. set indexOfRefraction(value: number);
  136277. /**
  136278. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136279. */
  136280. get invertRefractionY(): boolean;
  136281. set invertRefractionY(value: boolean);
  136282. /**
  136283. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136284. * Materials half opaque for instance using refraction could benefit from this control.
  136285. */
  136286. get linkRefractionWithTransparency(): boolean;
  136287. set linkRefractionWithTransparency(value: boolean);
  136288. /**
  136289. * If true, the light map contains occlusion information instead of lighting info.
  136290. */
  136291. useLightmapAsShadowmap: boolean;
  136292. /**
  136293. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136294. */
  136295. useAlphaFromAlbedoTexture: boolean;
  136296. /**
  136297. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136298. */
  136299. forceAlphaTest: boolean;
  136300. /**
  136301. * Defines the alpha limits in alpha test mode.
  136302. */
  136303. alphaCutOff: number;
  136304. /**
  136305. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136306. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136307. */
  136308. useSpecularOverAlpha: boolean;
  136309. /**
  136310. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136311. */
  136312. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136313. /**
  136314. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136315. */
  136316. useRoughnessFromMetallicTextureAlpha: boolean;
  136317. /**
  136318. * Specifies if the metallic texture contains the roughness information in its green channel.
  136319. */
  136320. useRoughnessFromMetallicTextureGreen: boolean;
  136321. /**
  136322. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136323. */
  136324. useMetallnessFromMetallicTextureBlue: boolean;
  136325. /**
  136326. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136327. */
  136328. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136329. /**
  136330. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136331. */
  136332. useAmbientInGrayScale: boolean;
  136333. /**
  136334. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136335. * The material will try to infer what glossiness each pixel should be.
  136336. */
  136337. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136338. /**
  136339. * BJS is using an harcoded light falloff based on a manually sets up range.
  136340. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136341. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136342. */
  136343. get usePhysicalLightFalloff(): boolean;
  136344. /**
  136345. * BJS is using an harcoded light falloff based on a manually sets up range.
  136346. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136347. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136348. */
  136349. set usePhysicalLightFalloff(value: boolean);
  136350. /**
  136351. * In order to support the falloff compatibility with gltf, a special mode has been added
  136352. * to reproduce the gltf light falloff.
  136353. */
  136354. get useGLTFLightFalloff(): boolean;
  136355. /**
  136356. * In order to support the falloff compatibility with gltf, a special mode has been added
  136357. * to reproduce the gltf light falloff.
  136358. */
  136359. set useGLTFLightFalloff(value: boolean);
  136360. /**
  136361. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136362. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136363. */
  136364. useRadianceOverAlpha: boolean;
  136365. /**
  136366. * Allows using an object space normal map (instead of tangent space).
  136367. */
  136368. useObjectSpaceNormalMap: boolean;
  136369. /**
  136370. * Allows using the bump map in parallax mode.
  136371. */
  136372. useParallax: boolean;
  136373. /**
  136374. * Allows using the bump map in parallax occlusion mode.
  136375. */
  136376. useParallaxOcclusion: boolean;
  136377. /**
  136378. * Controls the scale bias of the parallax mode.
  136379. */
  136380. parallaxScaleBias: number;
  136381. /**
  136382. * If sets to true, disables all the lights affecting the material.
  136383. */
  136384. disableLighting: boolean;
  136385. /**
  136386. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136387. */
  136388. forceIrradianceInFragment: boolean;
  136389. /**
  136390. * Number of Simultaneous lights allowed on the material.
  136391. */
  136392. maxSimultaneousLights: number;
  136393. /**
  136394. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  136395. */
  136396. invertNormalMapX: boolean;
  136397. /**
  136398. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  136399. */
  136400. invertNormalMapY: boolean;
  136401. /**
  136402. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136403. */
  136404. twoSidedLighting: boolean;
  136405. /**
  136406. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136407. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136408. */
  136409. useAlphaFresnel: boolean;
  136410. /**
  136411. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136412. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136413. */
  136414. useLinearAlphaFresnel: boolean;
  136415. /**
  136416. * Let user defines the brdf lookup texture used for IBL.
  136417. * A default 8bit version is embedded but you could point at :
  136418. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  136419. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  136420. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  136421. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  136422. */
  136423. environmentBRDFTexture: Nullable<BaseTexture>;
  136424. /**
  136425. * Force normal to face away from face.
  136426. */
  136427. forceNormalForward: boolean;
  136428. /**
  136429. * Enables specular anti aliasing in the PBR shader.
  136430. * It will both interacts on the Geometry for analytical and IBL lighting.
  136431. * It also prefilter the roughness map based on the bump values.
  136432. */
  136433. enableSpecularAntiAliasing: boolean;
  136434. /**
  136435. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136436. * makes the reflect vector face the model (under horizon).
  136437. */
  136438. useHorizonOcclusion: boolean;
  136439. /**
  136440. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136441. * too much the area relying on ambient texture to define their ambient occlusion.
  136442. */
  136443. useRadianceOcclusion: boolean;
  136444. /**
  136445. * If set to true, no lighting calculations will be applied.
  136446. */
  136447. unlit: boolean;
  136448. /**
  136449. * Gets the image processing configuration used either in this material.
  136450. */
  136451. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  136452. /**
  136453. * Sets the Default image processing configuration used either in the this material.
  136454. *
  136455. * If sets to null, the scene one is in use.
  136456. */
  136457. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  136458. /**
  136459. * Gets wether the color curves effect is enabled.
  136460. */
  136461. get cameraColorCurvesEnabled(): boolean;
  136462. /**
  136463. * Sets wether the color curves effect is enabled.
  136464. */
  136465. set cameraColorCurvesEnabled(value: boolean);
  136466. /**
  136467. * Gets wether the color grading effect is enabled.
  136468. */
  136469. get cameraColorGradingEnabled(): boolean;
  136470. /**
  136471. * Gets wether the color grading effect is enabled.
  136472. */
  136473. set cameraColorGradingEnabled(value: boolean);
  136474. /**
  136475. * Gets wether tonemapping is enabled or not.
  136476. */
  136477. get cameraToneMappingEnabled(): boolean;
  136478. /**
  136479. * Sets wether tonemapping is enabled or not
  136480. */
  136481. set cameraToneMappingEnabled(value: boolean);
  136482. /**
  136483. * The camera exposure used on this material.
  136484. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136485. * This corresponds to a photographic exposure.
  136486. */
  136487. get cameraExposure(): number;
  136488. /**
  136489. * The camera exposure used on this material.
  136490. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136491. * This corresponds to a photographic exposure.
  136492. */
  136493. set cameraExposure(value: number);
  136494. /**
  136495. * Gets The camera contrast used on this material.
  136496. */
  136497. get cameraContrast(): number;
  136498. /**
  136499. * Sets The camera contrast used on this material.
  136500. */
  136501. set cameraContrast(value: number);
  136502. /**
  136503. * Gets the Color Grading 2D Lookup Texture.
  136504. */
  136505. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  136506. /**
  136507. * Sets the Color Grading 2D Lookup Texture.
  136508. */
  136509. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  136510. /**
  136511. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136512. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136513. * 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;
  136514. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136515. */
  136516. get cameraColorCurves(): Nullable<ColorCurves>;
  136517. /**
  136518. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136519. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136520. * 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;
  136521. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136522. */
  136523. set cameraColorCurves(value: Nullable<ColorCurves>);
  136524. /**
  136525. * Instantiates a new PBRMaterial instance.
  136526. *
  136527. * @param name The material name
  136528. * @param scene The scene the material will be use in.
  136529. */
  136530. constructor(name: string, scene: Scene);
  136531. /**
  136532. * Returns the name of this material class.
  136533. */
  136534. getClassName(): string;
  136535. /**
  136536. * Makes a duplicate of the current material.
  136537. * @param name - name to use for the new material.
  136538. */
  136539. clone(name: string): PBRMaterial;
  136540. /**
  136541. * Serializes this PBR Material.
  136542. * @returns - An object with the serialized material.
  136543. */
  136544. serialize(): any;
  136545. /**
  136546. * Parses a PBR Material from a serialized object.
  136547. * @param source - Serialized object.
  136548. * @param scene - BJS scene instance.
  136549. * @param rootUrl - url for the scene object
  136550. * @returns - PBRMaterial
  136551. */
  136552. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  136553. }
  136554. }
  136555. declare module BABYLON {
  136556. /**
  136557. * Direct draw surface info
  136558. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  136559. */
  136560. export interface DDSInfo {
  136561. /**
  136562. * Width of the texture
  136563. */
  136564. width: number;
  136565. /**
  136566. * Width of the texture
  136567. */
  136568. height: number;
  136569. /**
  136570. * Number of Mipmaps for the texture
  136571. * @see https://en.wikipedia.org/wiki/Mipmap
  136572. */
  136573. mipmapCount: number;
  136574. /**
  136575. * If the textures format is a known fourCC format
  136576. * @see https://www.fourcc.org/
  136577. */
  136578. isFourCC: boolean;
  136579. /**
  136580. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  136581. */
  136582. isRGB: boolean;
  136583. /**
  136584. * If the texture is a lumincance format
  136585. */
  136586. isLuminance: boolean;
  136587. /**
  136588. * If this is a cube texture
  136589. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  136590. */
  136591. isCube: boolean;
  136592. /**
  136593. * If the texture is a compressed format eg. FOURCC_DXT1
  136594. */
  136595. isCompressed: boolean;
  136596. /**
  136597. * The dxgiFormat of the texture
  136598. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  136599. */
  136600. dxgiFormat: number;
  136601. /**
  136602. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  136603. */
  136604. textureType: number;
  136605. /**
  136606. * Sphericle polynomial created for the dds texture
  136607. */
  136608. sphericalPolynomial?: SphericalPolynomial;
  136609. }
  136610. /**
  136611. * Class used to provide DDS decompression tools
  136612. */
  136613. export class DDSTools {
  136614. /**
  136615. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  136616. */
  136617. static StoreLODInAlphaChannel: boolean;
  136618. /**
  136619. * Gets DDS information from an array buffer
  136620. * @param data defines the array buffer view to read data from
  136621. * @returns the DDS information
  136622. */
  136623. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  136624. private static _FloatView;
  136625. private static _Int32View;
  136626. private static _ToHalfFloat;
  136627. private static _FromHalfFloat;
  136628. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  136629. private static _GetHalfFloatRGBAArrayBuffer;
  136630. private static _GetFloatRGBAArrayBuffer;
  136631. private static _GetFloatAsUIntRGBAArrayBuffer;
  136632. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  136633. private static _GetRGBAArrayBuffer;
  136634. private static _ExtractLongWordOrder;
  136635. private static _GetRGBArrayBuffer;
  136636. private static _GetLuminanceArrayBuffer;
  136637. /**
  136638. * Uploads DDS Levels to a Babylon Texture
  136639. * @hidden
  136640. */
  136641. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  136642. }
  136643. interface ThinEngine {
  136644. /**
  136645. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  136646. * @param rootUrl defines the url where the file to load is located
  136647. * @param scene defines the current scene
  136648. * @param lodScale defines scale to apply to the mip map selection
  136649. * @param lodOffset defines offset to apply to the mip map selection
  136650. * @param onLoad defines an optional callback raised when the texture is loaded
  136651. * @param onError defines an optional callback raised if there is an issue to load the texture
  136652. * @param format defines the format of the data
  136653. * @param forcedExtension defines the extension to use to pick the right loader
  136654. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  136655. * @returns the cube texture as an InternalTexture
  136656. */
  136657. 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;
  136658. }
  136659. }
  136660. declare module BABYLON {
  136661. /**
  136662. * Implementation of the DDS Texture Loader.
  136663. * @hidden
  136664. */
  136665. export class _DDSTextureLoader implements IInternalTextureLoader {
  136666. /**
  136667. * Defines wether the loader supports cascade loading the different faces.
  136668. */
  136669. readonly supportCascades: boolean;
  136670. /**
  136671. * This returns if the loader support the current file information.
  136672. * @param extension defines the file extension of the file being loaded
  136673. * @returns true if the loader can load the specified file
  136674. */
  136675. canLoad(extension: string): boolean;
  136676. /**
  136677. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  136678. * @param data contains the texture data
  136679. * @param texture defines the BabylonJS internal texture
  136680. * @param createPolynomials will be true if polynomials have been requested
  136681. * @param onLoad defines the callback to trigger once the texture is ready
  136682. * @param onError defines the callback to trigger in case of error
  136683. */
  136684. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  136685. /**
  136686. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  136687. * @param data contains the texture data
  136688. * @param texture defines the BabylonJS internal texture
  136689. * @param callback defines the method to call once ready to upload
  136690. */
  136691. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  136692. }
  136693. }
  136694. declare module BABYLON {
  136695. /**
  136696. * Implementation of the ENV Texture Loader.
  136697. * @hidden
  136698. */
  136699. export class _ENVTextureLoader implements IInternalTextureLoader {
  136700. /**
  136701. * Defines wether the loader supports cascade loading the different faces.
  136702. */
  136703. readonly supportCascades: boolean;
  136704. /**
  136705. * This returns if the loader support the current file information.
  136706. * @param extension defines the file extension of the file being loaded
  136707. * @returns true if the loader can load the specified file
  136708. */
  136709. canLoad(extension: string): boolean;
  136710. /**
  136711. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  136712. * @param data contains the texture data
  136713. * @param texture defines the BabylonJS internal texture
  136714. * @param createPolynomials will be true if polynomials have been requested
  136715. * @param onLoad defines the callback to trigger once the texture is ready
  136716. * @param onError defines the callback to trigger in case of error
  136717. */
  136718. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  136719. /**
  136720. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  136721. * @param data contains the texture data
  136722. * @param texture defines the BabylonJS internal texture
  136723. * @param callback defines the method to call once ready to upload
  136724. */
  136725. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  136726. }
  136727. }
  136728. declare module BABYLON {
  136729. /**
  136730. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  136731. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  136732. */
  136733. export class KhronosTextureContainer {
  136734. /** contents of the KTX container file */
  136735. data: ArrayBufferView;
  136736. private static HEADER_LEN;
  136737. private static COMPRESSED_2D;
  136738. private static COMPRESSED_3D;
  136739. private static TEX_2D;
  136740. private static TEX_3D;
  136741. /**
  136742. * Gets the openGL type
  136743. */
  136744. glType: number;
  136745. /**
  136746. * Gets the openGL type size
  136747. */
  136748. glTypeSize: number;
  136749. /**
  136750. * Gets the openGL format
  136751. */
  136752. glFormat: number;
  136753. /**
  136754. * Gets the openGL internal format
  136755. */
  136756. glInternalFormat: number;
  136757. /**
  136758. * Gets the base internal format
  136759. */
  136760. glBaseInternalFormat: number;
  136761. /**
  136762. * Gets image width in pixel
  136763. */
  136764. pixelWidth: number;
  136765. /**
  136766. * Gets image height in pixel
  136767. */
  136768. pixelHeight: number;
  136769. /**
  136770. * Gets image depth in pixels
  136771. */
  136772. pixelDepth: number;
  136773. /**
  136774. * Gets the number of array elements
  136775. */
  136776. numberOfArrayElements: number;
  136777. /**
  136778. * Gets the number of faces
  136779. */
  136780. numberOfFaces: number;
  136781. /**
  136782. * Gets the number of mipmap levels
  136783. */
  136784. numberOfMipmapLevels: number;
  136785. /**
  136786. * Gets the bytes of key value data
  136787. */
  136788. bytesOfKeyValueData: number;
  136789. /**
  136790. * Gets the load type
  136791. */
  136792. loadType: number;
  136793. /**
  136794. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  136795. */
  136796. isInvalid: boolean;
  136797. /**
  136798. * Creates a new KhronosTextureContainer
  136799. * @param data contents of the KTX container file
  136800. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  136801. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  136802. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  136803. */
  136804. constructor(
  136805. /** contents of the KTX container file */
  136806. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  136807. /**
  136808. * Uploads KTX content to a Babylon Texture.
  136809. * It is assumed that the texture has already been created & is currently bound
  136810. * @hidden
  136811. */
  136812. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  136813. private _upload2DCompressedLevels;
  136814. /**
  136815. * Checks if the given data starts with a KTX file identifier.
  136816. * @param data the data to check
  136817. * @returns true if the data is a KTX file or false otherwise
  136818. */
  136819. static IsValid(data: ArrayBufferView): boolean;
  136820. }
  136821. }
  136822. declare module BABYLON {
  136823. /**
  136824. * Class for loading KTX2 files
  136825. * !!! Experimental Extension Subject to Changes !!!
  136826. * @hidden
  136827. */
  136828. export class KhronosTextureContainer2 {
  136829. private static _ModulePromise;
  136830. private static _TranscodeFormat;
  136831. constructor(engine: ThinEngine);
  136832. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  136833. private _determineTranscodeFormat;
  136834. /**
  136835. * Checks if the given data starts with a KTX2 file identifier.
  136836. * @param data the data to check
  136837. * @returns true if the data is a KTX2 file or false otherwise
  136838. */
  136839. static IsValid(data: ArrayBufferView): boolean;
  136840. }
  136841. }
  136842. declare module BABYLON {
  136843. /**
  136844. * Implementation of the KTX Texture Loader.
  136845. * @hidden
  136846. */
  136847. export class _KTXTextureLoader implements IInternalTextureLoader {
  136848. /**
  136849. * Defines wether the loader supports cascade loading the different faces.
  136850. */
  136851. readonly supportCascades: boolean;
  136852. /**
  136853. * This returns if the loader support the current file information.
  136854. * @param extension defines the file extension of the file being loaded
  136855. * @param mimeType defines the optional mime type of the file being loaded
  136856. * @returns true if the loader can load the specified file
  136857. */
  136858. canLoad(extension: string, mimeType?: string): boolean;
  136859. /**
  136860. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  136861. * @param data contains the texture data
  136862. * @param texture defines the BabylonJS internal texture
  136863. * @param createPolynomials will be true if polynomials have been requested
  136864. * @param onLoad defines the callback to trigger once the texture is ready
  136865. * @param onError defines the callback to trigger in case of error
  136866. */
  136867. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  136868. /**
  136869. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  136870. * @param data contains the texture data
  136871. * @param texture defines the BabylonJS internal texture
  136872. * @param callback defines the method to call once ready to upload
  136873. */
  136874. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  136875. }
  136876. }
  136877. declare module BABYLON {
  136878. /** @hidden */
  136879. export var _forceSceneHelpersToBundle: boolean;
  136880. interface Scene {
  136881. /**
  136882. * Creates a default light for the scene.
  136883. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  136884. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  136885. */
  136886. createDefaultLight(replace?: boolean): void;
  136887. /**
  136888. * Creates a default camera for the scene.
  136889. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  136890. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  136891. * @param replace has default false, when true replaces the active camera in the scene
  136892. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  136893. */
  136894. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  136895. /**
  136896. * Creates a default camera and a default light.
  136897. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  136898. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  136899. * @param replace has the default false, when true replaces the active camera/light in the scene
  136900. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  136901. */
  136902. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  136903. /**
  136904. * Creates a new sky box
  136905. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  136906. * @param environmentTexture defines the texture to use as environment texture
  136907. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  136908. * @param scale defines the overall scale of the skybox
  136909. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  136910. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  136911. * @returns a new mesh holding the sky box
  136912. */
  136913. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  136914. /**
  136915. * Creates a new environment
  136916. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  136917. * @param options defines the options you can use to configure the environment
  136918. * @returns the new EnvironmentHelper
  136919. */
  136920. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  136921. /**
  136922. * Creates a new VREXperienceHelper
  136923. * @see https://doc.babylonjs.com/how_to/webvr_helper
  136924. * @param webVROptions defines the options used to create the new VREXperienceHelper
  136925. * @returns a new VREXperienceHelper
  136926. */
  136927. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  136928. /**
  136929. * Creates a new WebXRDefaultExperience
  136930. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  136931. * @param options experience options
  136932. * @returns a promise for a new WebXRDefaultExperience
  136933. */
  136934. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  136935. }
  136936. }
  136937. declare module BABYLON {
  136938. /**
  136939. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  136940. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  136941. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  136942. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  136943. */
  136944. export class VideoDome extends TransformNode {
  136945. /**
  136946. * Define the video source as a Monoscopic panoramic 360 video.
  136947. */
  136948. static readonly MODE_MONOSCOPIC: number;
  136949. /**
  136950. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  136951. */
  136952. static readonly MODE_TOPBOTTOM: number;
  136953. /**
  136954. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  136955. */
  136956. static readonly MODE_SIDEBYSIDE: number;
  136957. private _halfDome;
  136958. private _useDirectMapping;
  136959. /**
  136960. * The video texture being displayed on the sphere
  136961. */
  136962. protected _videoTexture: VideoTexture;
  136963. /**
  136964. * Gets the video texture being displayed on the sphere
  136965. */
  136966. get videoTexture(): VideoTexture;
  136967. /**
  136968. * The skybox material
  136969. */
  136970. protected _material: BackgroundMaterial;
  136971. /**
  136972. * The surface used for the video dome
  136973. */
  136974. protected _mesh: Mesh;
  136975. /**
  136976. * Gets the mesh used for the video dome.
  136977. */
  136978. get mesh(): Mesh;
  136979. /**
  136980. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  136981. */
  136982. private _halfDomeMask;
  136983. /**
  136984. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  136985. * Also see the options.resolution property.
  136986. */
  136987. get fovMultiplier(): number;
  136988. set fovMultiplier(value: number);
  136989. private _videoMode;
  136990. /**
  136991. * Gets or set the current video mode for the video. It can be:
  136992. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  136993. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  136994. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  136995. */
  136996. get videoMode(): number;
  136997. set videoMode(value: number);
  136998. /**
  136999. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  137000. *
  137001. */
  137002. get halfDome(): boolean;
  137003. /**
  137004. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  137005. */
  137006. set halfDome(enabled: boolean);
  137007. /**
  137008. * Oberserver used in Stereoscopic VR Mode.
  137009. */
  137010. private _onBeforeCameraRenderObserver;
  137011. /**
  137012. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  137013. * @param name Element's name, child elements will append suffixes for their own names.
  137014. * @param urlsOrVideo defines the url(s) or the video element to use
  137015. * @param options An object containing optional or exposed sub element properties
  137016. */
  137017. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  137018. resolution?: number;
  137019. clickToPlay?: boolean;
  137020. autoPlay?: boolean;
  137021. loop?: boolean;
  137022. size?: number;
  137023. poster?: string;
  137024. faceForward?: boolean;
  137025. useDirectMapping?: boolean;
  137026. halfDomeMode?: boolean;
  137027. }, scene: Scene);
  137028. private _changeVideoMode;
  137029. /**
  137030. * Releases resources associated with this node.
  137031. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  137032. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  137033. */
  137034. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  137035. }
  137036. }
  137037. declare module BABYLON {
  137038. /**
  137039. * This class can be used to get instrumentation data from a Babylon engine
  137040. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137041. */
  137042. export class EngineInstrumentation implements IDisposable {
  137043. /**
  137044. * Define the instrumented engine.
  137045. */
  137046. engine: Engine;
  137047. private _captureGPUFrameTime;
  137048. private _gpuFrameTimeToken;
  137049. private _gpuFrameTime;
  137050. private _captureShaderCompilationTime;
  137051. private _shaderCompilationTime;
  137052. private _onBeginFrameObserver;
  137053. private _onEndFrameObserver;
  137054. private _onBeforeShaderCompilationObserver;
  137055. private _onAfterShaderCompilationObserver;
  137056. /**
  137057. * Gets the perf counter used for GPU frame time
  137058. */
  137059. get gpuFrameTimeCounter(): PerfCounter;
  137060. /**
  137061. * Gets the GPU frame time capture status
  137062. */
  137063. get captureGPUFrameTime(): boolean;
  137064. /**
  137065. * Enable or disable the GPU frame time capture
  137066. */
  137067. set captureGPUFrameTime(value: boolean);
  137068. /**
  137069. * Gets the perf counter used for shader compilation time
  137070. */
  137071. get shaderCompilationTimeCounter(): PerfCounter;
  137072. /**
  137073. * Gets the shader compilation time capture status
  137074. */
  137075. get captureShaderCompilationTime(): boolean;
  137076. /**
  137077. * Enable or disable the shader compilation time capture
  137078. */
  137079. set captureShaderCompilationTime(value: boolean);
  137080. /**
  137081. * Instantiates a new engine instrumentation.
  137082. * This class can be used to get instrumentation data from a Babylon engine
  137083. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137084. * @param engine Defines the engine to instrument
  137085. */
  137086. constructor(
  137087. /**
  137088. * Define the instrumented engine.
  137089. */
  137090. engine: Engine);
  137091. /**
  137092. * Dispose and release associated resources.
  137093. */
  137094. dispose(): void;
  137095. }
  137096. }
  137097. declare module BABYLON {
  137098. /**
  137099. * This class can be used to get instrumentation data from a Babylon engine
  137100. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137101. */
  137102. export class SceneInstrumentation implements IDisposable {
  137103. /**
  137104. * Defines the scene to instrument
  137105. */
  137106. scene: Scene;
  137107. private _captureActiveMeshesEvaluationTime;
  137108. private _activeMeshesEvaluationTime;
  137109. private _captureRenderTargetsRenderTime;
  137110. private _renderTargetsRenderTime;
  137111. private _captureFrameTime;
  137112. private _frameTime;
  137113. private _captureRenderTime;
  137114. private _renderTime;
  137115. private _captureInterFrameTime;
  137116. private _interFrameTime;
  137117. private _captureParticlesRenderTime;
  137118. private _particlesRenderTime;
  137119. private _captureSpritesRenderTime;
  137120. private _spritesRenderTime;
  137121. private _capturePhysicsTime;
  137122. private _physicsTime;
  137123. private _captureAnimationsTime;
  137124. private _animationsTime;
  137125. private _captureCameraRenderTime;
  137126. private _cameraRenderTime;
  137127. private _onBeforeActiveMeshesEvaluationObserver;
  137128. private _onAfterActiveMeshesEvaluationObserver;
  137129. private _onBeforeRenderTargetsRenderObserver;
  137130. private _onAfterRenderTargetsRenderObserver;
  137131. private _onAfterRenderObserver;
  137132. private _onBeforeDrawPhaseObserver;
  137133. private _onAfterDrawPhaseObserver;
  137134. private _onBeforeAnimationsObserver;
  137135. private _onBeforeParticlesRenderingObserver;
  137136. private _onAfterParticlesRenderingObserver;
  137137. private _onBeforeSpritesRenderingObserver;
  137138. private _onAfterSpritesRenderingObserver;
  137139. private _onBeforePhysicsObserver;
  137140. private _onAfterPhysicsObserver;
  137141. private _onAfterAnimationsObserver;
  137142. private _onBeforeCameraRenderObserver;
  137143. private _onAfterCameraRenderObserver;
  137144. /**
  137145. * Gets the perf counter used for active meshes evaluation time
  137146. */
  137147. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137148. /**
  137149. * Gets the active meshes evaluation time capture status
  137150. */
  137151. get captureActiveMeshesEvaluationTime(): boolean;
  137152. /**
  137153. * Enable or disable the active meshes evaluation time capture
  137154. */
  137155. set captureActiveMeshesEvaluationTime(value: boolean);
  137156. /**
  137157. * Gets the perf counter used for render targets render time
  137158. */
  137159. get renderTargetsRenderTimeCounter(): PerfCounter;
  137160. /**
  137161. * Gets the render targets render time capture status
  137162. */
  137163. get captureRenderTargetsRenderTime(): boolean;
  137164. /**
  137165. * Enable or disable the render targets render time capture
  137166. */
  137167. set captureRenderTargetsRenderTime(value: boolean);
  137168. /**
  137169. * Gets the perf counter used for particles render time
  137170. */
  137171. get particlesRenderTimeCounter(): PerfCounter;
  137172. /**
  137173. * Gets the particles render time capture status
  137174. */
  137175. get captureParticlesRenderTime(): boolean;
  137176. /**
  137177. * Enable or disable the particles render time capture
  137178. */
  137179. set captureParticlesRenderTime(value: boolean);
  137180. /**
  137181. * Gets the perf counter used for sprites render time
  137182. */
  137183. get spritesRenderTimeCounter(): PerfCounter;
  137184. /**
  137185. * Gets the sprites render time capture status
  137186. */
  137187. get captureSpritesRenderTime(): boolean;
  137188. /**
  137189. * Enable or disable the sprites render time capture
  137190. */
  137191. set captureSpritesRenderTime(value: boolean);
  137192. /**
  137193. * Gets the perf counter used for physics time
  137194. */
  137195. get physicsTimeCounter(): PerfCounter;
  137196. /**
  137197. * Gets the physics time capture status
  137198. */
  137199. get capturePhysicsTime(): boolean;
  137200. /**
  137201. * Enable or disable the physics time capture
  137202. */
  137203. set capturePhysicsTime(value: boolean);
  137204. /**
  137205. * Gets the perf counter used for animations time
  137206. */
  137207. get animationsTimeCounter(): PerfCounter;
  137208. /**
  137209. * Gets the animations time capture status
  137210. */
  137211. get captureAnimationsTime(): boolean;
  137212. /**
  137213. * Enable or disable the animations time capture
  137214. */
  137215. set captureAnimationsTime(value: boolean);
  137216. /**
  137217. * Gets the perf counter used for frame time capture
  137218. */
  137219. get frameTimeCounter(): PerfCounter;
  137220. /**
  137221. * Gets the frame time capture status
  137222. */
  137223. get captureFrameTime(): boolean;
  137224. /**
  137225. * Enable or disable the frame time capture
  137226. */
  137227. set captureFrameTime(value: boolean);
  137228. /**
  137229. * Gets the perf counter used for inter-frames time capture
  137230. */
  137231. get interFrameTimeCounter(): PerfCounter;
  137232. /**
  137233. * Gets the inter-frames time capture status
  137234. */
  137235. get captureInterFrameTime(): boolean;
  137236. /**
  137237. * Enable or disable the inter-frames time capture
  137238. */
  137239. set captureInterFrameTime(value: boolean);
  137240. /**
  137241. * Gets the perf counter used for render time capture
  137242. */
  137243. get renderTimeCounter(): PerfCounter;
  137244. /**
  137245. * Gets the render time capture status
  137246. */
  137247. get captureRenderTime(): boolean;
  137248. /**
  137249. * Enable or disable the render time capture
  137250. */
  137251. set captureRenderTime(value: boolean);
  137252. /**
  137253. * Gets the perf counter used for camera render time capture
  137254. */
  137255. get cameraRenderTimeCounter(): PerfCounter;
  137256. /**
  137257. * Gets the camera render time capture status
  137258. */
  137259. get captureCameraRenderTime(): boolean;
  137260. /**
  137261. * Enable or disable the camera render time capture
  137262. */
  137263. set captureCameraRenderTime(value: boolean);
  137264. /**
  137265. * Gets the perf counter used for draw calls
  137266. */
  137267. get drawCallsCounter(): PerfCounter;
  137268. /**
  137269. * Instantiates a new scene instrumentation.
  137270. * This class can be used to get instrumentation data from a Babylon engine
  137271. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137272. * @param scene Defines the scene to instrument
  137273. */
  137274. constructor(
  137275. /**
  137276. * Defines the scene to instrument
  137277. */
  137278. scene: Scene);
  137279. /**
  137280. * Dispose and release associated resources.
  137281. */
  137282. dispose(): void;
  137283. }
  137284. }
  137285. declare module BABYLON {
  137286. /** @hidden */
  137287. export var glowMapGenerationPixelShader: {
  137288. name: string;
  137289. shader: string;
  137290. };
  137291. }
  137292. declare module BABYLON {
  137293. /** @hidden */
  137294. export var glowMapGenerationVertexShader: {
  137295. name: string;
  137296. shader: string;
  137297. };
  137298. }
  137299. declare module BABYLON {
  137300. /**
  137301. * Effect layer options. This helps customizing the behaviour
  137302. * of the effect layer.
  137303. */
  137304. export interface IEffectLayerOptions {
  137305. /**
  137306. * Multiplication factor apply to the canvas size to compute the render target size
  137307. * used to generated the objects (the smaller the faster).
  137308. */
  137309. mainTextureRatio: number;
  137310. /**
  137311. * Enforces a fixed size texture to ensure effect stability across devices.
  137312. */
  137313. mainTextureFixedSize?: number;
  137314. /**
  137315. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137316. */
  137317. alphaBlendingMode: number;
  137318. /**
  137319. * The camera attached to the layer.
  137320. */
  137321. camera: Nullable<Camera>;
  137322. /**
  137323. * The rendering group to draw the layer in.
  137324. */
  137325. renderingGroupId: number;
  137326. }
  137327. /**
  137328. * The effect layer Helps adding post process effect blended with the main pass.
  137329. *
  137330. * This can be for instance use to generate glow or higlight effects on the scene.
  137331. *
  137332. * The effect layer class can not be used directly and is intented to inherited from to be
  137333. * customized per effects.
  137334. */
  137335. export abstract class EffectLayer {
  137336. private _vertexBuffers;
  137337. private _indexBuffer;
  137338. private _cachedDefines;
  137339. private _effectLayerMapGenerationEffect;
  137340. private _effectLayerOptions;
  137341. private _mergeEffect;
  137342. protected _scene: Scene;
  137343. protected _engine: Engine;
  137344. protected _maxSize: number;
  137345. protected _mainTextureDesiredSize: ISize;
  137346. protected _mainTexture: RenderTargetTexture;
  137347. protected _shouldRender: boolean;
  137348. protected _postProcesses: PostProcess[];
  137349. protected _textures: BaseTexture[];
  137350. protected _emissiveTextureAndColor: {
  137351. texture: Nullable<BaseTexture>;
  137352. color: Color4;
  137353. };
  137354. /**
  137355. * The name of the layer
  137356. */
  137357. name: string;
  137358. /**
  137359. * The clear color of the texture used to generate the glow map.
  137360. */
  137361. neutralColor: Color4;
  137362. /**
  137363. * Specifies whether the highlight layer is enabled or not.
  137364. */
  137365. isEnabled: boolean;
  137366. /**
  137367. * Gets the camera attached to the layer.
  137368. */
  137369. get camera(): Nullable<Camera>;
  137370. /**
  137371. * Gets the rendering group id the layer should render in.
  137372. */
  137373. get renderingGroupId(): number;
  137374. set renderingGroupId(renderingGroupId: number);
  137375. /**
  137376. * An event triggered when the effect layer has been disposed.
  137377. */
  137378. onDisposeObservable: Observable<EffectLayer>;
  137379. /**
  137380. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137381. */
  137382. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137383. /**
  137384. * An event triggered when the generated texture is being merged in the scene.
  137385. */
  137386. onBeforeComposeObservable: Observable<EffectLayer>;
  137387. /**
  137388. * An event triggered when the mesh is rendered into the effect render target.
  137389. */
  137390. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137391. /**
  137392. * An event triggered after the mesh has been rendered into the effect render target.
  137393. */
  137394. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137395. /**
  137396. * An event triggered when the generated texture has been merged in the scene.
  137397. */
  137398. onAfterComposeObservable: Observable<EffectLayer>;
  137399. /**
  137400. * An event triggered when the efffect layer changes its size.
  137401. */
  137402. onSizeChangedObservable: Observable<EffectLayer>;
  137403. /** @hidden */
  137404. static _SceneComponentInitialization: (scene: Scene) => void;
  137405. /**
  137406. * Instantiates a new effect Layer and references it in the scene.
  137407. * @param name The name of the layer
  137408. * @param scene The scene to use the layer in
  137409. */
  137410. constructor(
  137411. /** The Friendly of the effect in the scene */
  137412. name: string, scene: Scene);
  137413. /**
  137414. * Get the effect name of the layer.
  137415. * @return The effect name
  137416. */
  137417. abstract getEffectName(): string;
  137418. /**
  137419. * Checks for the readiness of the element composing the layer.
  137420. * @param subMesh the mesh to check for
  137421. * @param useInstances specify whether or not to use instances to render the mesh
  137422. * @return true if ready otherwise, false
  137423. */
  137424. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137425. /**
  137426. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137427. * @returns true if the effect requires stencil during the main canvas render pass.
  137428. */
  137429. abstract needStencil(): boolean;
  137430. /**
  137431. * Create the merge effect. This is the shader use to blit the information back
  137432. * to the main canvas at the end of the scene rendering.
  137433. * @returns The effect containing the shader used to merge the effect on the main canvas
  137434. */
  137435. protected abstract _createMergeEffect(): Effect;
  137436. /**
  137437. * Creates the render target textures and post processes used in the effect layer.
  137438. */
  137439. protected abstract _createTextureAndPostProcesses(): void;
  137440. /**
  137441. * Implementation specific of rendering the generating effect on the main canvas.
  137442. * @param effect The effect used to render through
  137443. */
  137444. protected abstract _internalRender(effect: Effect): void;
  137445. /**
  137446. * Sets the required values for both the emissive texture and and the main color.
  137447. */
  137448. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137449. /**
  137450. * Free any resources and references associated to a mesh.
  137451. * Internal use
  137452. * @param mesh The mesh to free.
  137453. */
  137454. abstract _disposeMesh(mesh: Mesh): void;
  137455. /**
  137456. * Serializes this layer (Glow or Highlight for example)
  137457. * @returns a serialized layer object
  137458. */
  137459. abstract serialize?(): any;
  137460. /**
  137461. * Initializes the effect layer with the required options.
  137462. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  137463. */
  137464. protected _init(options: Partial<IEffectLayerOptions>): void;
  137465. /**
  137466. * Generates the index buffer of the full screen quad blending to the main canvas.
  137467. */
  137468. private _generateIndexBuffer;
  137469. /**
  137470. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  137471. */
  137472. private _generateVertexBuffer;
  137473. /**
  137474. * Sets the main texture desired size which is the closest power of two
  137475. * of the engine canvas size.
  137476. */
  137477. private _setMainTextureSize;
  137478. /**
  137479. * Creates the main texture for the effect layer.
  137480. */
  137481. protected _createMainTexture(): void;
  137482. /**
  137483. * Adds specific effects defines.
  137484. * @param defines The defines to add specifics to.
  137485. */
  137486. protected _addCustomEffectDefines(defines: string[]): void;
  137487. /**
  137488. * Checks for the readiness of the element composing the layer.
  137489. * @param subMesh the mesh to check for
  137490. * @param useInstances specify whether or not to use instances to render the mesh
  137491. * @param emissiveTexture the associated emissive texture used to generate the glow
  137492. * @return true if ready otherwise, false
  137493. */
  137494. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  137495. /**
  137496. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  137497. */
  137498. render(): void;
  137499. /**
  137500. * Determine if a given mesh will be used in the current effect.
  137501. * @param mesh mesh to test
  137502. * @returns true if the mesh will be used
  137503. */
  137504. hasMesh(mesh: AbstractMesh): boolean;
  137505. /**
  137506. * Returns true if the layer contains information to display, otherwise false.
  137507. * @returns true if the glow layer should be rendered
  137508. */
  137509. shouldRender(): boolean;
  137510. /**
  137511. * Returns true if the mesh should render, otherwise false.
  137512. * @param mesh The mesh to render
  137513. * @returns true if it should render otherwise false
  137514. */
  137515. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  137516. /**
  137517. * Returns true if the mesh can be rendered, otherwise false.
  137518. * @param mesh The mesh to render
  137519. * @param material The material used on the mesh
  137520. * @returns true if it can be rendered otherwise false
  137521. */
  137522. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137523. /**
  137524. * Returns true if the mesh should render, otherwise false.
  137525. * @param mesh The mesh to render
  137526. * @returns true if it should render otherwise false
  137527. */
  137528. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  137529. /**
  137530. * Renders the submesh passed in parameter to the generation map.
  137531. */
  137532. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  137533. /**
  137534. * Defines whether the current material of the mesh should be use to render the effect.
  137535. * @param mesh defines the current mesh to render
  137536. */
  137537. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137538. /**
  137539. * Rebuild the required buffers.
  137540. * @hidden Internal use only.
  137541. */
  137542. _rebuild(): void;
  137543. /**
  137544. * Dispose only the render target textures and post process.
  137545. */
  137546. private _disposeTextureAndPostProcesses;
  137547. /**
  137548. * Dispose the highlight layer and free resources.
  137549. */
  137550. dispose(): void;
  137551. /**
  137552. * Gets the class name of the effect layer
  137553. * @returns the string with the class name of the effect layer
  137554. */
  137555. getClassName(): string;
  137556. /**
  137557. * Creates an effect layer from parsed effect layer data
  137558. * @param parsedEffectLayer defines effect layer data
  137559. * @param scene defines the current scene
  137560. * @param rootUrl defines the root URL containing the effect layer information
  137561. * @returns a parsed effect Layer
  137562. */
  137563. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  137564. }
  137565. }
  137566. declare module BABYLON {
  137567. interface AbstractScene {
  137568. /**
  137569. * The list of effect layers (highlights/glow) added to the scene
  137570. * @see https://doc.babylonjs.com/how_to/highlight_layer
  137571. * @see https://doc.babylonjs.com/how_to/glow_layer
  137572. */
  137573. effectLayers: Array<EffectLayer>;
  137574. /**
  137575. * Removes the given effect layer from this scene.
  137576. * @param toRemove defines the effect layer to remove
  137577. * @returns the index of the removed effect layer
  137578. */
  137579. removeEffectLayer(toRemove: EffectLayer): number;
  137580. /**
  137581. * Adds the given effect layer to this scene
  137582. * @param newEffectLayer defines the effect layer to add
  137583. */
  137584. addEffectLayer(newEffectLayer: EffectLayer): void;
  137585. }
  137586. /**
  137587. * Defines the layer scene component responsible to manage any effect layers
  137588. * in a given scene.
  137589. */
  137590. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  137591. /**
  137592. * The component name helpfull to identify the component in the list of scene components.
  137593. */
  137594. readonly name: string;
  137595. /**
  137596. * The scene the component belongs to.
  137597. */
  137598. scene: Scene;
  137599. private _engine;
  137600. private _renderEffects;
  137601. private _needStencil;
  137602. private _previousStencilState;
  137603. /**
  137604. * Creates a new instance of the component for the given scene
  137605. * @param scene Defines the scene to register the component in
  137606. */
  137607. constructor(scene: Scene);
  137608. /**
  137609. * Registers the component in a given scene
  137610. */
  137611. register(): void;
  137612. /**
  137613. * Rebuilds the elements related to this component in case of
  137614. * context lost for instance.
  137615. */
  137616. rebuild(): void;
  137617. /**
  137618. * Serializes the component data to the specified json object
  137619. * @param serializationObject The object to serialize to
  137620. */
  137621. serialize(serializationObject: any): void;
  137622. /**
  137623. * Adds all the elements from the container to the scene
  137624. * @param container the container holding the elements
  137625. */
  137626. addFromContainer(container: AbstractScene): void;
  137627. /**
  137628. * Removes all the elements in the container from the scene
  137629. * @param container contains the elements to remove
  137630. * @param dispose if the removed element should be disposed (default: false)
  137631. */
  137632. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  137633. /**
  137634. * Disposes the component and the associated ressources.
  137635. */
  137636. dispose(): void;
  137637. private _isReadyForMesh;
  137638. private _renderMainTexture;
  137639. private _setStencil;
  137640. private _setStencilBack;
  137641. private _draw;
  137642. private _drawCamera;
  137643. private _drawRenderingGroup;
  137644. }
  137645. }
  137646. declare module BABYLON {
  137647. /** @hidden */
  137648. export var glowMapMergePixelShader: {
  137649. name: string;
  137650. shader: string;
  137651. };
  137652. }
  137653. declare module BABYLON {
  137654. /** @hidden */
  137655. export var glowMapMergeVertexShader: {
  137656. name: string;
  137657. shader: string;
  137658. };
  137659. }
  137660. declare module BABYLON {
  137661. interface AbstractScene {
  137662. /**
  137663. * Return a the first highlight layer of the scene with a given name.
  137664. * @param name The name of the highlight layer to look for.
  137665. * @return The highlight layer if found otherwise null.
  137666. */
  137667. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  137668. }
  137669. /**
  137670. * Glow layer options. This helps customizing the behaviour
  137671. * of the glow layer.
  137672. */
  137673. export interface IGlowLayerOptions {
  137674. /**
  137675. * Multiplication factor apply to the canvas size to compute the render target size
  137676. * used to generated the glowing objects (the smaller the faster).
  137677. */
  137678. mainTextureRatio: number;
  137679. /**
  137680. * Enforces a fixed size texture to ensure resize independant blur.
  137681. */
  137682. mainTextureFixedSize?: number;
  137683. /**
  137684. * How big is the kernel of the blur texture.
  137685. */
  137686. blurKernelSize: number;
  137687. /**
  137688. * The camera attached to the layer.
  137689. */
  137690. camera: Nullable<Camera>;
  137691. /**
  137692. * Enable MSAA by chosing the number of samples.
  137693. */
  137694. mainTextureSamples?: number;
  137695. /**
  137696. * The rendering group to draw the layer in.
  137697. */
  137698. renderingGroupId: number;
  137699. }
  137700. /**
  137701. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  137702. *
  137703. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  137704. *
  137705. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  137706. */
  137707. export class GlowLayer extends EffectLayer {
  137708. /**
  137709. * Effect Name of the layer.
  137710. */
  137711. static readonly EffectName: string;
  137712. /**
  137713. * The default blur kernel size used for the glow.
  137714. */
  137715. static DefaultBlurKernelSize: number;
  137716. /**
  137717. * The default texture size ratio used for the glow.
  137718. */
  137719. static DefaultTextureRatio: number;
  137720. /**
  137721. * Sets the kernel size of the blur.
  137722. */
  137723. set blurKernelSize(value: number);
  137724. /**
  137725. * Gets the kernel size of the blur.
  137726. */
  137727. get blurKernelSize(): number;
  137728. /**
  137729. * Sets the glow intensity.
  137730. */
  137731. set intensity(value: number);
  137732. /**
  137733. * Gets the glow intensity.
  137734. */
  137735. get intensity(): number;
  137736. private _options;
  137737. private _intensity;
  137738. private _horizontalBlurPostprocess1;
  137739. private _verticalBlurPostprocess1;
  137740. private _horizontalBlurPostprocess2;
  137741. private _verticalBlurPostprocess2;
  137742. private _blurTexture1;
  137743. private _blurTexture2;
  137744. private _postProcesses1;
  137745. private _postProcesses2;
  137746. private _includedOnlyMeshes;
  137747. private _excludedMeshes;
  137748. private _meshesUsingTheirOwnMaterials;
  137749. /**
  137750. * Callback used to let the user override the color selection on a per mesh basis
  137751. */
  137752. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  137753. /**
  137754. * Callback used to let the user override the texture selection on a per mesh basis
  137755. */
  137756. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  137757. /**
  137758. * Instantiates a new glow Layer and references it to the scene.
  137759. * @param name The name of the layer
  137760. * @param scene The scene to use the layer in
  137761. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  137762. */
  137763. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  137764. /**
  137765. * Get the effect name of the layer.
  137766. * @return The effect name
  137767. */
  137768. getEffectName(): string;
  137769. /**
  137770. * Create the merge effect. This is the shader use to blit the information back
  137771. * to the main canvas at the end of the scene rendering.
  137772. */
  137773. protected _createMergeEffect(): Effect;
  137774. /**
  137775. * Creates the render target textures and post processes used in the glow layer.
  137776. */
  137777. protected _createTextureAndPostProcesses(): void;
  137778. /**
  137779. * Checks for the readiness of the element composing the layer.
  137780. * @param subMesh the mesh to check for
  137781. * @param useInstances specify wether or not to use instances to render the mesh
  137782. * @param emissiveTexture the associated emissive texture used to generate the glow
  137783. * @return true if ready otherwise, false
  137784. */
  137785. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137786. /**
  137787. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137788. */
  137789. needStencil(): boolean;
  137790. /**
  137791. * Returns true if the mesh can be rendered, otherwise false.
  137792. * @param mesh The mesh to render
  137793. * @param material The material used on the mesh
  137794. * @returns true if it can be rendered otherwise false
  137795. */
  137796. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137797. /**
  137798. * Implementation specific of rendering the generating effect on the main canvas.
  137799. * @param effect The effect used to render through
  137800. */
  137801. protected _internalRender(effect: Effect): void;
  137802. /**
  137803. * Sets the required values for both the emissive texture and and the main color.
  137804. */
  137805. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137806. /**
  137807. * Returns true if the mesh should render, otherwise false.
  137808. * @param mesh The mesh to render
  137809. * @returns true if it should render otherwise false
  137810. */
  137811. protected _shouldRenderMesh(mesh: Mesh): boolean;
  137812. /**
  137813. * Adds specific effects defines.
  137814. * @param defines The defines to add specifics to.
  137815. */
  137816. protected _addCustomEffectDefines(defines: string[]): void;
  137817. /**
  137818. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  137819. * @param mesh The mesh to exclude from the glow layer
  137820. */
  137821. addExcludedMesh(mesh: Mesh): void;
  137822. /**
  137823. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  137824. * @param mesh The mesh to remove
  137825. */
  137826. removeExcludedMesh(mesh: Mesh): void;
  137827. /**
  137828. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  137829. * @param mesh The mesh to include in the glow layer
  137830. */
  137831. addIncludedOnlyMesh(mesh: Mesh): void;
  137832. /**
  137833. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  137834. * @param mesh The mesh to remove
  137835. */
  137836. removeIncludedOnlyMesh(mesh: Mesh): void;
  137837. /**
  137838. * Determine if a given mesh will be used in the glow layer
  137839. * @param mesh The mesh to test
  137840. * @returns true if the mesh will be highlighted by the current glow layer
  137841. */
  137842. hasMesh(mesh: AbstractMesh): boolean;
  137843. /**
  137844. * Defines whether the current material of the mesh should be use to render the effect.
  137845. * @param mesh defines the current mesh to render
  137846. */
  137847. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137848. /**
  137849. * Add a mesh to be rendered through its own material and not with emissive only.
  137850. * @param mesh The mesh for which we need to use its material
  137851. */
  137852. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  137853. /**
  137854. * Remove a mesh from being rendered through its own material and not with emissive only.
  137855. * @param mesh The mesh for which we need to not use its material
  137856. */
  137857. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  137858. /**
  137859. * Free any resources and references associated to a mesh.
  137860. * Internal use
  137861. * @param mesh The mesh to free.
  137862. * @hidden
  137863. */
  137864. _disposeMesh(mesh: Mesh): void;
  137865. /**
  137866. * Gets the class name of the effect layer
  137867. * @returns the string with the class name of the effect layer
  137868. */
  137869. getClassName(): string;
  137870. /**
  137871. * Serializes this glow layer
  137872. * @returns a serialized glow layer object
  137873. */
  137874. serialize(): any;
  137875. /**
  137876. * Creates a Glow Layer from parsed glow layer data
  137877. * @param parsedGlowLayer defines glow layer data
  137878. * @param scene defines the current scene
  137879. * @param rootUrl defines the root URL containing the glow layer information
  137880. * @returns a parsed Glow Layer
  137881. */
  137882. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  137883. }
  137884. }
  137885. declare module BABYLON {
  137886. /** @hidden */
  137887. export var glowBlurPostProcessPixelShader: {
  137888. name: string;
  137889. shader: string;
  137890. };
  137891. }
  137892. declare module BABYLON {
  137893. interface AbstractScene {
  137894. /**
  137895. * Return a the first highlight layer of the scene with a given name.
  137896. * @param name The name of the highlight layer to look for.
  137897. * @return The highlight layer if found otherwise null.
  137898. */
  137899. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  137900. }
  137901. /**
  137902. * Highlight layer options. This helps customizing the behaviour
  137903. * of the highlight layer.
  137904. */
  137905. export interface IHighlightLayerOptions {
  137906. /**
  137907. * Multiplication factor apply to the canvas size to compute the render target size
  137908. * used to generated the glowing objects (the smaller the faster).
  137909. */
  137910. mainTextureRatio: number;
  137911. /**
  137912. * Enforces a fixed size texture to ensure resize independant blur.
  137913. */
  137914. mainTextureFixedSize?: number;
  137915. /**
  137916. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  137917. * of the picture to blur (the smaller the faster).
  137918. */
  137919. blurTextureSizeRatio: number;
  137920. /**
  137921. * How big in texel of the blur texture is the vertical blur.
  137922. */
  137923. blurVerticalSize: number;
  137924. /**
  137925. * How big in texel of the blur texture is the horizontal blur.
  137926. */
  137927. blurHorizontalSize: number;
  137928. /**
  137929. * Alpha blending mode used to apply the blur. Default is combine.
  137930. */
  137931. alphaBlendingMode: number;
  137932. /**
  137933. * The camera attached to the layer.
  137934. */
  137935. camera: Nullable<Camera>;
  137936. /**
  137937. * Should we display highlight as a solid stroke?
  137938. */
  137939. isStroke?: boolean;
  137940. /**
  137941. * The rendering group to draw the layer in.
  137942. */
  137943. renderingGroupId: number;
  137944. }
  137945. /**
  137946. * The highlight layer Helps adding a glow effect around a mesh.
  137947. *
  137948. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  137949. * glowy meshes to your scene.
  137950. *
  137951. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  137952. */
  137953. export class HighlightLayer extends EffectLayer {
  137954. name: string;
  137955. /**
  137956. * Effect Name of the highlight layer.
  137957. */
  137958. static readonly EffectName: string;
  137959. /**
  137960. * The neutral color used during the preparation of the glow effect.
  137961. * This is black by default as the blend operation is a blend operation.
  137962. */
  137963. static NeutralColor: Color4;
  137964. /**
  137965. * Stencil value used for glowing meshes.
  137966. */
  137967. static GlowingMeshStencilReference: number;
  137968. /**
  137969. * Stencil value used for the other meshes in the scene.
  137970. */
  137971. static NormalMeshStencilReference: number;
  137972. /**
  137973. * Specifies whether or not the inner glow is ACTIVE in the layer.
  137974. */
  137975. innerGlow: boolean;
  137976. /**
  137977. * Specifies whether or not the outer glow is ACTIVE in the layer.
  137978. */
  137979. outerGlow: boolean;
  137980. /**
  137981. * Specifies the horizontal size of the blur.
  137982. */
  137983. set blurHorizontalSize(value: number);
  137984. /**
  137985. * Specifies the vertical size of the blur.
  137986. */
  137987. set blurVerticalSize(value: number);
  137988. /**
  137989. * Gets the horizontal size of the blur.
  137990. */
  137991. get blurHorizontalSize(): number;
  137992. /**
  137993. * Gets the vertical size of the blur.
  137994. */
  137995. get blurVerticalSize(): number;
  137996. /**
  137997. * An event triggered when the highlight layer is being blurred.
  137998. */
  137999. onBeforeBlurObservable: Observable<HighlightLayer>;
  138000. /**
  138001. * An event triggered when the highlight layer has been blurred.
  138002. */
  138003. onAfterBlurObservable: Observable<HighlightLayer>;
  138004. private _instanceGlowingMeshStencilReference;
  138005. private _options;
  138006. private _downSamplePostprocess;
  138007. private _horizontalBlurPostprocess;
  138008. private _verticalBlurPostprocess;
  138009. private _blurTexture;
  138010. private _meshes;
  138011. private _excludedMeshes;
  138012. /**
  138013. * Instantiates a new highlight Layer and references it to the scene..
  138014. * @param name The name of the layer
  138015. * @param scene The scene to use the layer in
  138016. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138017. */
  138018. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138019. /**
  138020. * Get the effect name of the layer.
  138021. * @return The effect name
  138022. */
  138023. getEffectName(): string;
  138024. /**
  138025. * Create the merge effect. This is the shader use to blit the information back
  138026. * to the main canvas at the end of the scene rendering.
  138027. */
  138028. protected _createMergeEffect(): Effect;
  138029. /**
  138030. * Creates the render target textures and post processes used in the highlight layer.
  138031. */
  138032. protected _createTextureAndPostProcesses(): void;
  138033. /**
  138034. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138035. */
  138036. needStencil(): boolean;
  138037. /**
  138038. * Checks for the readiness of the element composing the layer.
  138039. * @param subMesh the mesh to check for
  138040. * @param useInstances specify wether or not to use instances to render the mesh
  138041. * @param emissiveTexture the associated emissive texture used to generate the glow
  138042. * @return true if ready otherwise, false
  138043. */
  138044. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138045. /**
  138046. * Implementation specific of rendering the generating effect on the main canvas.
  138047. * @param effect The effect used to render through
  138048. */
  138049. protected _internalRender(effect: Effect): void;
  138050. /**
  138051. * Returns true if the layer contains information to display, otherwise false.
  138052. */
  138053. shouldRender(): boolean;
  138054. /**
  138055. * Returns true if the mesh should render, otherwise false.
  138056. * @param mesh The mesh to render
  138057. * @returns true if it should render otherwise false
  138058. */
  138059. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138060. /**
  138061. * Returns true if the mesh can be rendered, otherwise false.
  138062. * @param mesh The mesh to render
  138063. * @param material The material used on the mesh
  138064. * @returns true if it can be rendered otherwise false
  138065. */
  138066. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138067. /**
  138068. * Adds specific effects defines.
  138069. * @param defines The defines to add specifics to.
  138070. */
  138071. protected _addCustomEffectDefines(defines: string[]): void;
  138072. /**
  138073. * Sets the required values for both the emissive texture and and the main color.
  138074. */
  138075. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138076. /**
  138077. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138078. * @param mesh The mesh to exclude from the highlight layer
  138079. */
  138080. addExcludedMesh(mesh: Mesh): void;
  138081. /**
  138082. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138083. * @param mesh The mesh to highlight
  138084. */
  138085. removeExcludedMesh(mesh: Mesh): void;
  138086. /**
  138087. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138088. * @param mesh mesh to test
  138089. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138090. */
  138091. hasMesh(mesh: AbstractMesh): boolean;
  138092. /**
  138093. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138094. * @param mesh The mesh to highlight
  138095. * @param color The color of the highlight
  138096. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138097. */
  138098. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138099. /**
  138100. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138101. * @param mesh The mesh to highlight
  138102. */
  138103. removeMesh(mesh: Mesh): void;
  138104. /**
  138105. * Remove all the meshes currently referenced in the highlight layer
  138106. */
  138107. removeAllMeshes(): void;
  138108. /**
  138109. * Force the stencil to the normal expected value for none glowing parts
  138110. */
  138111. private _defaultStencilReference;
  138112. /**
  138113. * Free any resources and references associated to a mesh.
  138114. * Internal use
  138115. * @param mesh The mesh to free.
  138116. * @hidden
  138117. */
  138118. _disposeMesh(mesh: Mesh): void;
  138119. /**
  138120. * Dispose the highlight layer and free resources.
  138121. */
  138122. dispose(): void;
  138123. /**
  138124. * Gets the class name of the effect layer
  138125. * @returns the string with the class name of the effect layer
  138126. */
  138127. getClassName(): string;
  138128. /**
  138129. * Serializes this Highlight layer
  138130. * @returns a serialized Highlight layer object
  138131. */
  138132. serialize(): any;
  138133. /**
  138134. * Creates a Highlight layer from parsed Highlight layer data
  138135. * @param parsedHightlightLayer defines the Highlight layer data
  138136. * @param scene defines the current scene
  138137. * @param rootUrl defines the root URL containing the Highlight layer information
  138138. * @returns a parsed Highlight layer
  138139. */
  138140. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138141. }
  138142. }
  138143. declare module BABYLON {
  138144. interface AbstractScene {
  138145. /**
  138146. * The list of layers (background and foreground) of the scene
  138147. */
  138148. layers: Array<Layer>;
  138149. }
  138150. /**
  138151. * Defines the layer scene component responsible to manage any layers
  138152. * in a given scene.
  138153. */
  138154. export class LayerSceneComponent implements ISceneComponent {
  138155. /**
  138156. * The component name helpfull to identify the component in the list of scene components.
  138157. */
  138158. readonly name: string;
  138159. /**
  138160. * The scene the component belongs to.
  138161. */
  138162. scene: Scene;
  138163. private _engine;
  138164. /**
  138165. * Creates a new instance of the component for the given scene
  138166. * @param scene Defines the scene to register the component in
  138167. */
  138168. constructor(scene: Scene);
  138169. /**
  138170. * Registers the component in a given scene
  138171. */
  138172. register(): void;
  138173. /**
  138174. * Rebuilds the elements related to this component in case of
  138175. * context lost for instance.
  138176. */
  138177. rebuild(): void;
  138178. /**
  138179. * Disposes the component and the associated ressources.
  138180. */
  138181. dispose(): void;
  138182. private _draw;
  138183. private _drawCameraPredicate;
  138184. private _drawCameraBackground;
  138185. private _drawCameraForeground;
  138186. private _drawRenderTargetPredicate;
  138187. private _drawRenderTargetBackground;
  138188. private _drawRenderTargetForeground;
  138189. /**
  138190. * Adds all the elements from the container to the scene
  138191. * @param container the container holding the elements
  138192. */
  138193. addFromContainer(container: AbstractScene): void;
  138194. /**
  138195. * Removes all the elements in the container from the scene
  138196. * @param container contains the elements to remove
  138197. * @param dispose if the removed element should be disposed (default: false)
  138198. */
  138199. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138200. }
  138201. }
  138202. declare module BABYLON {
  138203. /** @hidden */
  138204. export var layerPixelShader: {
  138205. name: string;
  138206. shader: string;
  138207. };
  138208. }
  138209. declare module BABYLON {
  138210. /** @hidden */
  138211. export var layerVertexShader: {
  138212. name: string;
  138213. shader: string;
  138214. };
  138215. }
  138216. declare module BABYLON {
  138217. /**
  138218. * This represents a full screen 2d layer.
  138219. * This can be useful to display a picture in the background of your scene for instance.
  138220. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138221. */
  138222. export class Layer {
  138223. /**
  138224. * Define the name of the layer.
  138225. */
  138226. name: string;
  138227. /**
  138228. * Define the texture the layer should display.
  138229. */
  138230. texture: Nullable<Texture>;
  138231. /**
  138232. * Is the layer in background or foreground.
  138233. */
  138234. isBackground: boolean;
  138235. /**
  138236. * Define the color of the layer (instead of texture).
  138237. */
  138238. color: Color4;
  138239. /**
  138240. * Define the scale of the layer in order to zoom in out of the texture.
  138241. */
  138242. scale: Vector2;
  138243. /**
  138244. * Define an offset for the layer in order to shift the texture.
  138245. */
  138246. offset: Vector2;
  138247. /**
  138248. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138249. */
  138250. alphaBlendingMode: number;
  138251. /**
  138252. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138253. * Alpha test will not mix with the background color in case of transparency.
  138254. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138255. */
  138256. alphaTest: boolean;
  138257. /**
  138258. * Define a mask to restrict the layer to only some of the scene cameras.
  138259. */
  138260. layerMask: number;
  138261. /**
  138262. * Define the list of render target the layer is visible into.
  138263. */
  138264. renderTargetTextures: RenderTargetTexture[];
  138265. /**
  138266. * Define if the layer is only used in renderTarget or if it also
  138267. * renders in the main frame buffer of the canvas.
  138268. */
  138269. renderOnlyInRenderTargetTextures: boolean;
  138270. private _scene;
  138271. private _vertexBuffers;
  138272. private _indexBuffer;
  138273. private _effect;
  138274. private _previousDefines;
  138275. /**
  138276. * An event triggered when the layer is disposed.
  138277. */
  138278. onDisposeObservable: Observable<Layer>;
  138279. private _onDisposeObserver;
  138280. /**
  138281. * Back compatibility with callback before the onDisposeObservable existed.
  138282. * The set callback will be triggered when the layer has been disposed.
  138283. */
  138284. set onDispose(callback: () => void);
  138285. /**
  138286. * An event triggered before rendering the scene
  138287. */
  138288. onBeforeRenderObservable: Observable<Layer>;
  138289. private _onBeforeRenderObserver;
  138290. /**
  138291. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138292. * The set callback will be triggered just before rendering the layer.
  138293. */
  138294. set onBeforeRender(callback: () => void);
  138295. /**
  138296. * An event triggered after rendering the scene
  138297. */
  138298. onAfterRenderObservable: Observable<Layer>;
  138299. private _onAfterRenderObserver;
  138300. /**
  138301. * Back compatibility with callback before the onAfterRenderObservable existed.
  138302. * The set callback will be triggered just after rendering the layer.
  138303. */
  138304. set onAfterRender(callback: () => void);
  138305. /**
  138306. * Instantiates a new layer.
  138307. * This represents a full screen 2d layer.
  138308. * This can be useful to display a picture in the background of your scene for instance.
  138309. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138310. * @param name Define the name of the layer in the scene
  138311. * @param imgUrl Define the url of the texture to display in the layer
  138312. * @param scene Define the scene the layer belongs to
  138313. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138314. * @param color Defines a color for the layer
  138315. */
  138316. constructor(
  138317. /**
  138318. * Define the name of the layer.
  138319. */
  138320. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138321. private _createIndexBuffer;
  138322. /** @hidden */
  138323. _rebuild(): void;
  138324. /**
  138325. * Renders the layer in the scene.
  138326. */
  138327. render(): void;
  138328. /**
  138329. * Disposes and releases the associated ressources.
  138330. */
  138331. dispose(): void;
  138332. }
  138333. }
  138334. declare module BABYLON {
  138335. /** @hidden */
  138336. export var lensFlarePixelShader: {
  138337. name: string;
  138338. shader: string;
  138339. };
  138340. }
  138341. declare module BABYLON {
  138342. /** @hidden */
  138343. export var lensFlareVertexShader: {
  138344. name: string;
  138345. shader: string;
  138346. };
  138347. }
  138348. declare module BABYLON {
  138349. /**
  138350. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138351. * It is usually composed of several `lensFlare`.
  138352. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138353. */
  138354. export class LensFlareSystem {
  138355. /**
  138356. * Define the name of the lens flare system
  138357. */
  138358. name: string;
  138359. /**
  138360. * List of lens flares used in this system.
  138361. */
  138362. lensFlares: LensFlare[];
  138363. /**
  138364. * Define a limit from the border the lens flare can be visible.
  138365. */
  138366. borderLimit: number;
  138367. /**
  138368. * Define a viewport border we do not want to see the lens flare in.
  138369. */
  138370. viewportBorder: number;
  138371. /**
  138372. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138373. */
  138374. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138375. /**
  138376. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138377. */
  138378. layerMask: number;
  138379. /**
  138380. * Define the id of the lens flare system in the scene.
  138381. * (equal to name by default)
  138382. */
  138383. id: string;
  138384. private _scene;
  138385. private _emitter;
  138386. private _vertexBuffers;
  138387. private _indexBuffer;
  138388. private _effect;
  138389. private _positionX;
  138390. private _positionY;
  138391. private _isEnabled;
  138392. /** @hidden */
  138393. static _SceneComponentInitialization: (scene: Scene) => void;
  138394. /**
  138395. * Instantiates a lens flare system.
  138396. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138397. * It is usually composed of several `lensFlare`.
  138398. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138399. * @param name Define the name of the lens flare system in the scene
  138400. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138401. * @param scene Define the scene the lens flare system belongs to
  138402. */
  138403. constructor(
  138404. /**
  138405. * Define the name of the lens flare system
  138406. */
  138407. name: string, emitter: any, scene: Scene);
  138408. /**
  138409. * Define if the lens flare system is enabled.
  138410. */
  138411. get isEnabled(): boolean;
  138412. set isEnabled(value: boolean);
  138413. /**
  138414. * Get the scene the effects belongs to.
  138415. * @returns the scene holding the lens flare system
  138416. */
  138417. getScene(): Scene;
  138418. /**
  138419. * Get the emitter of the lens flare system.
  138420. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138421. * @returns the emitter of the lens flare system
  138422. */
  138423. getEmitter(): any;
  138424. /**
  138425. * Set the emitter of the lens flare system.
  138426. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138427. * @param newEmitter Define the new emitter of the system
  138428. */
  138429. setEmitter(newEmitter: any): void;
  138430. /**
  138431. * Get the lens flare system emitter position.
  138432. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  138433. * @returns the position
  138434. */
  138435. getEmitterPosition(): Vector3;
  138436. /**
  138437. * @hidden
  138438. */
  138439. computeEffectivePosition(globalViewport: Viewport): boolean;
  138440. /** @hidden */
  138441. _isVisible(): boolean;
  138442. /**
  138443. * @hidden
  138444. */
  138445. render(): boolean;
  138446. /**
  138447. * Dispose and release the lens flare with its associated resources.
  138448. */
  138449. dispose(): void;
  138450. /**
  138451. * Parse a lens flare system from a JSON repressentation
  138452. * @param parsedLensFlareSystem Define the JSON to parse
  138453. * @param scene Define the scene the parsed system should be instantiated in
  138454. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  138455. * @returns the parsed system
  138456. */
  138457. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  138458. /**
  138459. * Serialize the current Lens Flare System into a JSON representation.
  138460. * @returns the serialized JSON
  138461. */
  138462. serialize(): any;
  138463. }
  138464. }
  138465. declare module BABYLON {
  138466. /**
  138467. * This represents one of the lens effect in a `lensFlareSystem`.
  138468. * It controls one of the indiviual texture used in the effect.
  138469. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138470. */
  138471. export class LensFlare {
  138472. /**
  138473. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138474. */
  138475. size: number;
  138476. /**
  138477. * 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.
  138478. */
  138479. position: number;
  138480. /**
  138481. * Define the lens color.
  138482. */
  138483. color: Color3;
  138484. /**
  138485. * Define the lens texture.
  138486. */
  138487. texture: Nullable<Texture>;
  138488. /**
  138489. * Define the alpha mode to render this particular lens.
  138490. */
  138491. alphaMode: number;
  138492. private _system;
  138493. /**
  138494. * Creates a new Lens Flare.
  138495. * This represents one of the lens effect in a `lensFlareSystem`.
  138496. * It controls one of the indiviual texture used in the effect.
  138497. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138498. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  138499. * @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.
  138500. * @param color Define the lens color
  138501. * @param imgUrl Define the lens texture url
  138502. * @param system Define the `lensFlareSystem` this flare is part of
  138503. * @returns The newly created Lens Flare
  138504. */
  138505. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  138506. /**
  138507. * Instantiates a new Lens Flare.
  138508. * This represents one of the lens effect in a `lensFlareSystem`.
  138509. * It controls one of the indiviual texture used in the effect.
  138510. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138511. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  138512. * @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.
  138513. * @param color Define the lens color
  138514. * @param imgUrl Define the lens texture url
  138515. * @param system Define the `lensFlareSystem` this flare is part of
  138516. */
  138517. constructor(
  138518. /**
  138519. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138520. */
  138521. size: number,
  138522. /**
  138523. * 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.
  138524. */
  138525. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  138526. /**
  138527. * Dispose and release the lens flare with its associated resources.
  138528. */
  138529. dispose(): void;
  138530. }
  138531. }
  138532. declare module BABYLON {
  138533. interface AbstractScene {
  138534. /**
  138535. * The list of lens flare system added to the scene
  138536. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138537. */
  138538. lensFlareSystems: Array<LensFlareSystem>;
  138539. /**
  138540. * Removes the given lens flare system from this scene.
  138541. * @param toRemove The lens flare system to remove
  138542. * @returns The index of the removed lens flare system
  138543. */
  138544. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  138545. /**
  138546. * Adds the given lens flare system to this scene
  138547. * @param newLensFlareSystem The lens flare system to add
  138548. */
  138549. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  138550. /**
  138551. * Gets a lens flare system using its name
  138552. * @param name defines the name to look for
  138553. * @returns the lens flare system or null if not found
  138554. */
  138555. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  138556. /**
  138557. * Gets a lens flare system using its id
  138558. * @param id defines the id to look for
  138559. * @returns the lens flare system or null if not found
  138560. */
  138561. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  138562. }
  138563. /**
  138564. * Defines the lens flare scene component responsible to manage any lens flares
  138565. * in a given scene.
  138566. */
  138567. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  138568. /**
  138569. * The component name helpfull to identify the component in the list of scene components.
  138570. */
  138571. readonly name: string;
  138572. /**
  138573. * The scene the component belongs to.
  138574. */
  138575. scene: Scene;
  138576. /**
  138577. * Creates a new instance of the component for the given scene
  138578. * @param scene Defines the scene to register the component in
  138579. */
  138580. constructor(scene: Scene);
  138581. /**
  138582. * Registers the component in a given scene
  138583. */
  138584. register(): void;
  138585. /**
  138586. * Rebuilds the elements related to this component in case of
  138587. * context lost for instance.
  138588. */
  138589. rebuild(): void;
  138590. /**
  138591. * Adds all the elements from the container to the scene
  138592. * @param container the container holding the elements
  138593. */
  138594. addFromContainer(container: AbstractScene): void;
  138595. /**
  138596. * Removes all the elements in the container from the scene
  138597. * @param container contains the elements to remove
  138598. * @param dispose if the removed element should be disposed (default: false)
  138599. */
  138600. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138601. /**
  138602. * Serializes the component data to the specified json object
  138603. * @param serializationObject The object to serialize to
  138604. */
  138605. serialize(serializationObject: any): void;
  138606. /**
  138607. * Disposes the component and the associated ressources.
  138608. */
  138609. dispose(): void;
  138610. private _draw;
  138611. }
  138612. }
  138613. declare module BABYLON {
  138614. /** @hidden */
  138615. export var depthPixelShader: {
  138616. name: string;
  138617. shader: string;
  138618. };
  138619. }
  138620. declare module BABYLON {
  138621. /** @hidden */
  138622. export var depthVertexShader: {
  138623. name: string;
  138624. shader: string;
  138625. };
  138626. }
  138627. declare module BABYLON {
  138628. /**
  138629. * This represents a depth renderer in Babylon.
  138630. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  138631. */
  138632. export class DepthRenderer {
  138633. private _scene;
  138634. private _depthMap;
  138635. private _effect;
  138636. private readonly _storeNonLinearDepth;
  138637. private readonly _clearColor;
  138638. /** Get if the depth renderer is using packed depth or not */
  138639. readonly isPacked: boolean;
  138640. private _cachedDefines;
  138641. private _camera;
  138642. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  138643. enabled: boolean;
  138644. /**
  138645. * Specifiess that the depth renderer will only be used within
  138646. * the camera it is created for.
  138647. * This can help forcing its rendering during the camera processing.
  138648. */
  138649. useOnlyInActiveCamera: boolean;
  138650. /** @hidden */
  138651. static _SceneComponentInitialization: (scene: Scene) => void;
  138652. /**
  138653. * Instantiates a depth renderer
  138654. * @param scene The scene the renderer belongs to
  138655. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  138656. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  138657. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  138658. */
  138659. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  138660. /**
  138661. * Creates the depth rendering effect and checks if the effect is ready.
  138662. * @param subMesh The submesh to be used to render the depth map of
  138663. * @param useInstances If multiple world instances should be used
  138664. * @returns if the depth renderer is ready to render the depth map
  138665. */
  138666. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138667. /**
  138668. * Gets the texture which the depth map will be written to.
  138669. * @returns The depth map texture
  138670. */
  138671. getDepthMap(): RenderTargetTexture;
  138672. /**
  138673. * Disposes of the depth renderer.
  138674. */
  138675. dispose(): void;
  138676. }
  138677. }
  138678. declare module BABYLON {
  138679. /** @hidden */
  138680. export var minmaxReduxPixelShader: {
  138681. name: string;
  138682. shader: string;
  138683. };
  138684. }
  138685. declare module BABYLON {
  138686. /**
  138687. * This class computes a min/max reduction from a texture: it means it computes the minimum
  138688. * and maximum values from all values of the texture.
  138689. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  138690. * The source values are read from the red channel of the texture.
  138691. */
  138692. export class MinMaxReducer {
  138693. /**
  138694. * Observable triggered when the computation has been performed
  138695. */
  138696. onAfterReductionPerformed: Observable<{
  138697. min: number;
  138698. max: number;
  138699. }>;
  138700. protected _camera: Camera;
  138701. protected _sourceTexture: Nullable<RenderTargetTexture>;
  138702. protected _reductionSteps: Nullable<Array<PostProcess>>;
  138703. protected _postProcessManager: PostProcessManager;
  138704. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  138705. protected _forceFullscreenViewport: boolean;
  138706. /**
  138707. * Creates a min/max reducer
  138708. * @param camera The camera to use for the post processes
  138709. */
  138710. constructor(camera: Camera);
  138711. /**
  138712. * Gets the texture used to read the values from.
  138713. */
  138714. get sourceTexture(): Nullable<RenderTargetTexture>;
  138715. /**
  138716. * Sets the source texture to read the values from.
  138717. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  138718. * because in such textures '1' value must not be taken into account to compute the maximum
  138719. * as this value is used to clear the texture.
  138720. * Note that the computation is not activated by calling this function, you must call activate() for that!
  138721. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  138722. * @param depthRedux Indicates if the texture is a depth texture or not
  138723. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  138724. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  138725. */
  138726. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  138727. /**
  138728. * Defines the refresh rate of the computation.
  138729. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  138730. */
  138731. get refreshRate(): number;
  138732. set refreshRate(value: number);
  138733. protected _activated: boolean;
  138734. /**
  138735. * Gets the activation status of the reducer
  138736. */
  138737. get activated(): boolean;
  138738. /**
  138739. * Activates the reduction computation.
  138740. * When activated, the observers registered in onAfterReductionPerformed are
  138741. * called after the compuation is performed
  138742. */
  138743. activate(): void;
  138744. /**
  138745. * Deactivates the reduction computation.
  138746. */
  138747. deactivate(): void;
  138748. /**
  138749. * Disposes the min/max reducer
  138750. * @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.
  138751. */
  138752. dispose(disposeAll?: boolean): void;
  138753. }
  138754. }
  138755. declare module BABYLON {
  138756. /**
  138757. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  138758. */
  138759. export class DepthReducer extends MinMaxReducer {
  138760. private _depthRenderer;
  138761. private _depthRendererId;
  138762. /**
  138763. * Gets the depth renderer used for the computation.
  138764. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  138765. */
  138766. get depthRenderer(): Nullable<DepthRenderer>;
  138767. /**
  138768. * Creates a depth reducer
  138769. * @param camera The camera used to render the depth texture
  138770. */
  138771. constructor(camera: Camera);
  138772. /**
  138773. * Sets the depth renderer to use to generate the depth map
  138774. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  138775. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  138776. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  138777. */
  138778. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  138779. /** @hidden */
  138780. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  138781. /**
  138782. * Activates the reduction computation.
  138783. * When activated, the observers registered in onAfterReductionPerformed are
  138784. * called after the compuation is performed
  138785. */
  138786. activate(): void;
  138787. /**
  138788. * Deactivates the reduction computation.
  138789. */
  138790. deactivate(): void;
  138791. /**
  138792. * Disposes the depth reducer
  138793. * @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.
  138794. */
  138795. dispose(disposeAll?: boolean): void;
  138796. }
  138797. }
  138798. declare module BABYLON {
  138799. /**
  138800. * A CSM implementation allowing casting shadows on large scenes.
  138801. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  138802. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  138803. */
  138804. export class CascadedShadowGenerator extends ShadowGenerator {
  138805. private static readonly frustumCornersNDCSpace;
  138806. /**
  138807. * Name of the CSM class
  138808. */
  138809. static CLASSNAME: string;
  138810. /**
  138811. * Defines the default number of cascades used by the CSM.
  138812. */
  138813. static readonly DEFAULT_CASCADES_COUNT: number;
  138814. /**
  138815. * Defines the minimum number of cascades used by the CSM.
  138816. */
  138817. static readonly MIN_CASCADES_COUNT: number;
  138818. /**
  138819. * Defines the maximum number of cascades used by the CSM.
  138820. */
  138821. static readonly MAX_CASCADES_COUNT: number;
  138822. protected _validateFilter(filter: number): number;
  138823. /**
  138824. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  138825. */
  138826. penumbraDarkness: number;
  138827. private _numCascades;
  138828. /**
  138829. * Gets or set the number of cascades used by the CSM.
  138830. */
  138831. get numCascades(): number;
  138832. set numCascades(value: number);
  138833. /**
  138834. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  138835. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  138836. */
  138837. stabilizeCascades: boolean;
  138838. private _freezeShadowCastersBoundingInfo;
  138839. private _freezeShadowCastersBoundingInfoObservable;
  138840. /**
  138841. * Enables or disables the shadow casters bounding info computation.
  138842. * If your shadow casters don't move, you can disable this feature.
  138843. * If it is enabled, the bounding box computation is done every frame.
  138844. */
  138845. get freezeShadowCastersBoundingInfo(): boolean;
  138846. set freezeShadowCastersBoundingInfo(freeze: boolean);
  138847. private _scbiMin;
  138848. private _scbiMax;
  138849. protected _computeShadowCastersBoundingInfo(): void;
  138850. protected _shadowCastersBoundingInfo: BoundingInfo;
  138851. /**
  138852. * Gets or sets the shadow casters bounding info.
  138853. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  138854. * so that the system won't overwrite the bounds you provide
  138855. */
  138856. get shadowCastersBoundingInfo(): BoundingInfo;
  138857. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  138858. protected _breaksAreDirty: boolean;
  138859. protected _minDistance: number;
  138860. protected _maxDistance: number;
  138861. /**
  138862. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  138863. *
  138864. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  138865. * If you don't know these values, simply leave them to their defaults and don't call this function.
  138866. * @param min minimal distance for the breaks (default to 0.)
  138867. * @param max maximal distance for the breaks (default to 1.)
  138868. */
  138869. setMinMaxDistance(min: number, max: number): void;
  138870. /** Gets the minimal distance used in the cascade break computation */
  138871. get minDistance(): number;
  138872. /** Gets the maximal distance used in the cascade break computation */
  138873. get maxDistance(): number;
  138874. /**
  138875. * Gets the class name of that object
  138876. * @returns "CascadedShadowGenerator"
  138877. */
  138878. getClassName(): string;
  138879. private _cascadeMinExtents;
  138880. private _cascadeMaxExtents;
  138881. /**
  138882. * Gets a cascade minimum extents
  138883. * @param cascadeIndex index of the cascade
  138884. * @returns the minimum cascade extents
  138885. */
  138886. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  138887. /**
  138888. * Gets a cascade maximum extents
  138889. * @param cascadeIndex index of the cascade
  138890. * @returns the maximum cascade extents
  138891. */
  138892. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  138893. private _cascades;
  138894. private _currentLayer;
  138895. private _viewSpaceFrustumsZ;
  138896. private _viewMatrices;
  138897. private _projectionMatrices;
  138898. private _transformMatrices;
  138899. private _transformMatricesAsArray;
  138900. private _frustumLengths;
  138901. private _lightSizeUVCorrection;
  138902. private _depthCorrection;
  138903. private _frustumCornersWorldSpace;
  138904. private _frustumCenter;
  138905. private _shadowCameraPos;
  138906. private _shadowMaxZ;
  138907. /**
  138908. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  138909. * It defaults to camera.maxZ
  138910. */
  138911. get shadowMaxZ(): number;
  138912. /**
  138913. * Sets the shadow max z distance.
  138914. */
  138915. set shadowMaxZ(value: number);
  138916. protected _debug: boolean;
  138917. /**
  138918. * Gets or sets the debug flag.
  138919. * When enabled, the cascades are materialized by different colors on the screen.
  138920. */
  138921. get debug(): boolean;
  138922. set debug(dbg: boolean);
  138923. private _depthClamp;
  138924. /**
  138925. * Gets or sets the depth clamping value.
  138926. *
  138927. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  138928. * to account for the shadow casters far away.
  138929. *
  138930. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  138931. */
  138932. get depthClamp(): boolean;
  138933. set depthClamp(value: boolean);
  138934. private _cascadeBlendPercentage;
  138935. /**
  138936. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  138937. * It defaults to 0.1 (10% blending).
  138938. */
  138939. get cascadeBlendPercentage(): number;
  138940. set cascadeBlendPercentage(value: number);
  138941. private _lambda;
  138942. /**
  138943. * Gets or set the lambda parameter.
  138944. * This parameter is used to split the camera frustum and create the cascades.
  138945. * 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.
  138946. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  138947. */
  138948. get lambda(): number;
  138949. set lambda(value: number);
  138950. /**
  138951. * Gets the view matrix corresponding to a given cascade
  138952. * @param cascadeNum cascade to retrieve the view matrix from
  138953. * @returns the cascade view matrix
  138954. */
  138955. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  138956. /**
  138957. * Gets the projection matrix corresponding to a given cascade
  138958. * @param cascadeNum cascade to retrieve the projection matrix from
  138959. * @returns the cascade projection matrix
  138960. */
  138961. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  138962. /**
  138963. * Gets the transformation matrix corresponding to a given cascade
  138964. * @param cascadeNum cascade to retrieve the transformation matrix from
  138965. * @returns the cascade transformation matrix
  138966. */
  138967. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  138968. private _depthRenderer;
  138969. /**
  138970. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  138971. *
  138972. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  138973. *
  138974. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  138975. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  138976. * @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
  138977. */
  138978. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  138979. private _depthReducer;
  138980. private _autoCalcDepthBounds;
  138981. /**
  138982. * Gets or sets the autoCalcDepthBounds property.
  138983. *
  138984. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  138985. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  138986. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  138987. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  138988. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  138989. */
  138990. get autoCalcDepthBounds(): boolean;
  138991. set autoCalcDepthBounds(value: boolean);
  138992. /**
  138993. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  138994. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  138995. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  138996. * for setting the refresh rate on the renderer yourself!
  138997. */
  138998. get autoCalcDepthBoundsRefreshRate(): number;
  138999. set autoCalcDepthBoundsRefreshRate(value: number);
  139000. /**
  139001. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139002. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139003. * you change the camera near/far planes!
  139004. */
  139005. splitFrustum(): void;
  139006. private _splitFrustum;
  139007. private _computeMatrices;
  139008. private _computeFrustumInWorldSpace;
  139009. private _computeCascadeFrustum;
  139010. /**
  139011. * Support test.
  139012. */
  139013. static get IsSupported(): boolean;
  139014. /** @hidden */
  139015. static _SceneComponentInitialization: (scene: Scene) => void;
  139016. /**
  139017. * Creates a Cascaded Shadow Generator object.
  139018. * A ShadowGenerator is the required tool to use the shadows.
  139019. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139020. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139021. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139022. * @param light The directional light object generating the shadows.
  139023. * @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.
  139024. */
  139025. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139026. protected _initializeGenerator(): void;
  139027. protected _createTargetRenderTexture(): void;
  139028. protected _initializeShadowMap(): void;
  139029. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139030. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139031. /**
  139032. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139033. * @param defines Defines of the material we want to update
  139034. * @param lightIndex Index of the light in the enabled light list of the material
  139035. */
  139036. prepareDefines(defines: any, lightIndex: number): void;
  139037. /**
  139038. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139039. * defined in the generator but impacting the effect).
  139040. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139041. * @param effect The effect we are binfing the information for
  139042. */
  139043. bindShadowLight(lightIndex: string, effect: Effect): void;
  139044. /**
  139045. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139046. * (eq to view projection * shadow projection matrices)
  139047. * @returns The transform matrix used to create the shadow map
  139048. */
  139049. getTransformMatrix(): Matrix;
  139050. /**
  139051. * Disposes the ShadowGenerator.
  139052. * Returns nothing.
  139053. */
  139054. dispose(): void;
  139055. /**
  139056. * Serializes the shadow generator setup to a json object.
  139057. * @returns The serialized JSON object
  139058. */
  139059. serialize(): any;
  139060. /**
  139061. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139062. * @param parsedShadowGenerator The JSON object to parse
  139063. * @param scene The scene to create the shadow map for
  139064. * @returns The parsed shadow generator
  139065. */
  139066. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139067. }
  139068. }
  139069. declare module BABYLON {
  139070. /**
  139071. * Defines the shadow generator component responsible to manage any shadow generators
  139072. * in a given scene.
  139073. */
  139074. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139075. /**
  139076. * The component name helpfull to identify the component in the list of scene components.
  139077. */
  139078. readonly name: string;
  139079. /**
  139080. * The scene the component belongs to.
  139081. */
  139082. scene: Scene;
  139083. /**
  139084. * Creates a new instance of the component for the given scene
  139085. * @param scene Defines the scene to register the component in
  139086. */
  139087. constructor(scene: Scene);
  139088. /**
  139089. * Registers the component in a given scene
  139090. */
  139091. register(): void;
  139092. /**
  139093. * Rebuilds the elements related to this component in case of
  139094. * context lost for instance.
  139095. */
  139096. rebuild(): void;
  139097. /**
  139098. * Serializes the component data to the specified json object
  139099. * @param serializationObject The object to serialize to
  139100. */
  139101. serialize(serializationObject: any): void;
  139102. /**
  139103. * Adds all the elements from the container to the scene
  139104. * @param container the container holding the elements
  139105. */
  139106. addFromContainer(container: AbstractScene): void;
  139107. /**
  139108. * Removes all the elements in the container from the scene
  139109. * @param container contains the elements to remove
  139110. * @param dispose if the removed element should be disposed (default: false)
  139111. */
  139112. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139113. /**
  139114. * Rebuilds the elements related to this component in case of
  139115. * context lost for instance.
  139116. */
  139117. dispose(): void;
  139118. private _gatherRenderTargets;
  139119. }
  139120. }
  139121. declare module BABYLON {
  139122. /**
  139123. * A point light is a light defined by an unique point in world space.
  139124. * The light is emitted in every direction from this point.
  139125. * A good example of a point light is a standard light bulb.
  139126. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139127. */
  139128. export class PointLight extends ShadowLight {
  139129. private _shadowAngle;
  139130. /**
  139131. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139132. * This specifies what angle the shadow will use to be created.
  139133. *
  139134. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139135. */
  139136. get shadowAngle(): number;
  139137. /**
  139138. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139139. * This specifies what angle the shadow will use to be created.
  139140. *
  139141. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139142. */
  139143. set shadowAngle(value: number);
  139144. /**
  139145. * Gets the direction if it has been set.
  139146. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139147. */
  139148. get direction(): Vector3;
  139149. /**
  139150. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139151. */
  139152. set direction(value: Vector3);
  139153. /**
  139154. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139155. * A PointLight emits the light in every direction.
  139156. * It can cast shadows.
  139157. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139158. * ```javascript
  139159. * var pointLight = new PointLight("pl", camera.position, scene);
  139160. * ```
  139161. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139162. * @param name The light friendly name
  139163. * @param position The position of the point light in the scene
  139164. * @param scene The scene the lights belongs to
  139165. */
  139166. constructor(name: string, position: Vector3, scene: Scene);
  139167. /**
  139168. * Returns the string "PointLight"
  139169. * @returns the class name
  139170. */
  139171. getClassName(): string;
  139172. /**
  139173. * Returns the integer 0.
  139174. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139175. */
  139176. getTypeID(): number;
  139177. /**
  139178. * Specifies wether or not the shadowmap should be a cube texture.
  139179. * @returns true if the shadowmap needs to be a cube texture.
  139180. */
  139181. needCube(): boolean;
  139182. /**
  139183. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139184. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139185. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139186. */
  139187. getShadowDirection(faceIndex?: number): Vector3;
  139188. /**
  139189. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139190. * - fov = PI / 2
  139191. * - aspect ratio : 1.0
  139192. * - z-near and far equal to the active camera minZ and maxZ.
  139193. * Returns the PointLight.
  139194. */
  139195. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139196. protected _buildUniformLayout(): void;
  139197. /**
  139198. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139199. * @param effect The effect to update
  139200. * @param lightIndex The index of the light in the effect to update
  139201. * @returns The point light
  139202. */
  139203. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139204. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139205. /**
  139206. * Prepares the list of defines specific to the light type.
  139207. * @param defines the list of defines
  139208. * @param lightIndex defines the index of the light for the effect
  139209. */
  139210. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139211. }
  139212. }
  139213. declare module BABYLON {
  139214. /**
  139215. * Header information of HDR texture files.
  139216. */
  139217. export interface HDRInfo {
  139218. /**
  139219. * The height of the texture in pixels.
  139220. */
  139221. height: number;
  139222. /**
  139223. * The width of the texture in pixels.
  139224. */
  139225. width: number;
  139226. /**
  139227. * The index of the beginning of the data in the binary file.
  139228. */
  139229. dataPosition: number;
  139230. }
  139231. /**
  139232. * This groups tools to convert HDR texture to native colors array.
  139233. */
  139234. export class HDRTools {
  139235. private static Ldexp;
  139236. private static Rgbe2float;
  139237. private static readStringLine;
  139238. /**
  139239. * Reads header information from an RGBE texture stored in a native array.
  139240. * More information on this format are available here:
  139241. * https://en.wikipedia.org/wiki/RGBE_image_format
  139242. *
  139243. * @param uint8array The binary file stored in native array.
  139244. * @return The header information.
  139245. */
  139246. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139247. /**
  139248. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139249. * This RGBE texture needs to store the information as a panorama.
  139250. *
  139251. * More information on this format are available here:
  139252. * https://en.wikipedia.org/wiki/RGBE_image_format
  139253. *
  139254. * @param buffer The binary file stored in an array buffer.
  139255. * @param size The expected size of the extracted cubemap.
  139256. * @return The Cube Map information.
  139257. */
  139258. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139259. /**
  139260. * Returns the pixels data extracted from an RGBE texture.
  139261. * This pixels will be stored left to right up to down in the R G B order in one array.
  139262. *
  139263. * More information on this format are available here:
  139264. * https://en.wikipedia.org/wiki/RGBE_image_format
  139265. *
  139266. * @param uint8array The binary file stored in an array buffer.
  139267. * @param hdrInfo The header information of the file.
  139268. * @return The pixels data in RGB right to left up to down order.
  139269. */
  139270. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139271. private static RGBE_ReadPixels_RLE;
  139272. private static RGBE_ReadPixels_NOT_RLE;
  139273. }
  139274. }
  139275. declare module BABYLON {
  139276. /**
  139277. * Effect Render Options
  139278. */
  139279. export interface IEffectRendererOptions {
  139280. /**
  139281. * Defines the vertices positions.
  139282. */
  139283. positions?: number[];
  139284. /**
  139285. * Defines the indices.
  139286. */
  139287. indices?: number[];
  139288. }
  139289. /**
  139290. * Helper class to render one or more effects.
  139291. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139292. */
  139293. export class EffectRenderer {
  139294. private engine;
  139295. private static _DefaultOptions;
  139296. private _vertexBuffers;
  139297. private _indexBuffer;
  139298. private _fullscreenViewport;
  139299. /**
  139300. * Creates an effect renderer
  139301. * @param engine the engine to use for rendering
  139302. * @param options defines the options of the effect renderer
  139303. */
  139304. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139305. /**
  139306. * Sets the current viewport in normalized coordinates 0-1
  139307. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139308. */
  139309. setViewport(viewport?: Viewport): void;
  139310. /**
  139311. * Binds the embedded attributes buffer to the effect.
  139312. * @param effect Defines the effect to bind the attributes for
  139313. */
  139314. bindBuffers(effect: Effect): void;
  139315. /**
  139316. * Sets the current effect wrapper to use during draw.
  139317. * The effect needs to be ready before calling this api.
  139318. * This also sets the default full screen position attribute.
  139319. * @param effectWrapper Defines the effect to draw with
  139320. */
  139321. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139322. /**
  139323. * Restores engine states
  139324. */
  139325. restoreStates(): void;
  139326. /**
  139327. * Draws a full screen quad.
  139328. */
  139329. draw(): void;
  139330. private isRenderTargetTexture;
  139331. /**
  139332. * renders one or more effects to a specified texture
  139333. * @param effectWrapper the effect to renderer
  139334. * @param outputTexture texture to draw to, if null it will render to the screen.
  139335. */
  139336. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139337. /**
  139338. * Disposes of the effect renderer
  139339. */
  139340. dispose(): void;
  139341. }
  139342. /**
  139343. * Options to create an EffectWrapper
  139344. */
  139345. interface EffectWrapperCreationOptions {
  139346. /**
  139347. * Engine to use to create the effect
  139348. */
  139349. engine: ThinEngine;
  139350. /**
  139351. * Fragment shader for the effect
  139352. */
  139353. fragmentShader: string;
  139354. /**
  139355. * Use the shader store instead of direct source code
  139356. */
  139357. useShaderStore?: boolean;
  139358. /**
  139359. * Vertex shader for the effect
  139360. */
  139361. vertexShader?: string;
  139362. /**
  139363. * Attributes to use in the shader
  139364. */
  139365. attributeNames?: Array<string>;
  139366. /**
  139367. * Uniforms to use in the shader
  139368. */
  139369. uniformNames?: Array<string>;
  139370. /**
  139371. * Texture sampler names to use in the shader
  139372. */
  139373. samplerNames?: Array<string>;
  139374. /**
  139375. * Defines to use in the shader
  139376. */
  139377. defines?: Array<string>;
  139378. /**
  139379. * Callback when effect is compiled
  139380. */
  139381. onCompiled?: Nullable<(effect: Effect) => void>;
  139382. /**
  139383. * The friendly name of the effect displayed in Spector.
  139384. */
  139385. name?: string;
  139386. }
  139387. /**
  139388. * Wraps an effect to be used for rendering
  139389. */
  139390. export class EffectWrapper {
  139391. /**
  139392. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139393. */
  139394. onApplyObservable: Observable<{}>;
  139395. /**
  139396. * The underlying effect
  139397. */
  139398. effect: Effect;
  139399. /**
  139400. * Creates an effect to be renderer
  139401. * @param creationOptions options to create the effect
  139402. */
  139403. constructor(creationOptions: EffectWrapperCreationOptions);
  139404. /**
  139405. * Disposes of the effect wrapper
  139406. */
  139407. dispose(): void;
  139408. }
  139409. }
  139410. declare module BABYLON {
  139411. /** @hidden */
  139412. export var hdrFilteringVertexShader: {
  139413. name: string;
  139414. shader: string;
  139415. };
  139416. }
  139417. declare module BABYLON {
  139418. /** @hidden */
  139419. export var hdrFilteringPixelShader: {
  139420. name: string;
  139421. shader: string;
  139422. };
  139423. }
  139424. declare module BABYLON {
  139425. /**
  139426. * Options for texture filtering
  139427. */
  139428. interface IHDRFilteringOptions {
  139429. /**
  139430. * Scales pixel intensity for the input HDR map.
  139431. */
  139432. hdrScale?: number;
  139433. /**
  139434. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  139435. */
  139436. quality?: number;
  139437. }
  139438. /**
  139439. * Filters HDR maps to get correct renderings of PBR reflections
  139440. */
  139441. export class HDRFiltering {
  139442. private _engine;
  139443. private _effectRenderer;
  139444. private _effectWrapper;
  139445. private _lodGenerationOffset;
  139446. private _lodGenerationScale;
  139447. /**
  139448. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  139449. * you care about baking speed.
  139450. */
  139451. quality: number;
  139452. /**
  139453. * Scales pixel intensity for the input HDR map.
  139454. */
  139455. hdrScale: number;
  139456. /**
  139457. * Instantiates HDR filter for reflection maps
  139458. *
  139459. * @param engine Thin engine
  139460. * @param options Options
  139461. */
  139462. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  139463. private _createRenderTarget;
  139464. private _prefilterInternal;
  139465. private _createEffect;
  139466. /**
  139467. * Get a value indicating if the filter is ready to be used
  139468. * @param texture Texture to filter
  139469. * @returns true if the filter is ready
  139470. */
  139471. isReady(texture: BaseTexture): boolean;
  139472. /**
  139473. * Prefilters a cube texture to have mipmap levels representing roughness values.
  139474. * Prefiltering will be invoked at the end of next rendering pass.
  139475. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  139476. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  139477. * @param texture Texture to filter
  139478. * @param onFinished Callback when filtering is done
  139479. * @return Promise called when prefiltering is done
  139480. */
  139481. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  139482. }
  139483. }
  139484. declare module BABYLON {
  139485. /**
  139486. * This represents a texture coming from an HDR input.
  139487. *
  139488. * The only supported format is currently panorama picture stored in RGBE format.
  139489. * Example of such files can be found on HDRLib: http://hdrlib.com/
  139490. */
  139491. export class HDRCubeTexture extends BaseTexture {
  139492. private static _facesMapping;
  139493. private _generateHarmonics;
  139494. private _noMipmap;
  139495. private _prefilterOnLoad;
  139496. private _textureMatrix;
  139497. private _size;
  139498. private _onLoad;
  139499. private _onError;
  139500. /**
  139501. * The texture URL.
  139502. */
  139503. url: string;
  139504. /**
  139505. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  139506. */
  139507. coordinatesMode: number;
  139508. protected _isBlocking: boolean;
  139509. /**
  139510. * Sets wether or not the texture is blocking during loading.
  139511. */
  139512. set isBlocking(value: boolean);
  139513. /**
  139514. * Gets wether or not the texture is blocking during loading.
  139515. */
  139516. get isBlocking(): boolean;
  139517. protected _rotationY: number;
  139518. /**
  139519. * Sets texture matrix rotation angle around Y axis in radians.
  139520. */
  139521. set rotationY(value: number);
  139522. /**
  139523. * Gets texture matrix rotation angle around Y axis radians.
  139524. */
  139525. get rotationY(): number;
  139526. /**
  139527. * Gets or sets the center of the bounding box associated with the cube texture
  139528. * It must define where the camera used to render the texture was set
  139529. */
  139530. boundingBoxPosition: Vector3;
  139531. private _boundingBoxSize;
  139532. /**
  139533. * Gets or sets the size of the bounding box associated with the cube texture
  139534. * When defined, the cubemap will switch to local mode
  139535. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  139536. * @example https://www.babylonjs-playground.com/#RNASML
  139537. */
  139538. set boundingBoxSize(value: Vector3);
  139539. get boundingBoxSize(): Vector3;
  139540. /**
  139541. * Instantiates an HDRTexture from the following parameters.
  139542. *
  139543. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  139544. * @param sceneOrEngine The scene or engine the texture will be used in
  139545. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139546. * @param noMipmap Forces to not generate the mipmap if true
  139547. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  139548. * @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)
  139549. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  139550. */
  139551. 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>);
  139552. /**
  139553. * Get the current class name of the texture useful for serialization or dynamic coding.
  139554. * @returns "HDRCubeTexture"
  139555. */
  139556. getClassName(): string;
  139557. /**
  139558. * Occurs when the file is raw .hdr file.
  139559. */
  139560. private loadTexture;
  139561. clone(): HDRCubeTexture;
  139562. delayLoad(): void;
  139563. /**
  139564. * Get the texture reflection matrix used to rotate/transform the reflection.
  139565. * @returns the reflection matrix
  139566. */
  139567. getReflectionTextureMatrix(): Matrix;
  139568. /**
  139569. * Set the texture reflection matrix used to rotate/transform the reflection.
  139570. * @param value Define the reflection matrix to set
  139571. */
  139572. setReflectionTextureMatrix(value: Matrix): void;
  139573. /**
  139574. * Parses a JSON representation of an HDR Texture in order to create the texture
  139575. * @param parsedTexture Define the JSON representation
  139576. * @param scene Define the scene the texture should be created in
  139577. * @param rootUrl Define the root url in case we need to load relative dependencies
  139578. * @returns the newly created texture after parsing
  139579. */
  139580. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  139581. serialize(): any;
  139582. }
  139583. }
  139584. declare module BABYLON {
  139585. /**
  139586. * Class used to control physics engine
  139587. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  139588. */
  139589. export class PhysicsEngine implements IPhysicsEngine {
  139590. private _physicsPlugin;
  139591. /**
  139592. * Global value used to control the smallest number supported by the simulation
  139593. */
  139594. static Epsilon: number;
  139595. private _impostors;
  139596. private _joints;
  139597. private _subTimeStep;
  139598. /**
  139599. * Gets the gravity vector used by the simulation
  139600. */
  139601. gravity: Vector3;
  139602. /**
  139603. * Factory used to create the default physics plugin.
  139604. * @returns The default physics plugin
  139605. */
  139606. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  139607. /**
  139608. * Creates a new Physics Engine
  139609. * @param gravity defines the gravity vector used by the simulation
  139610. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  139611. */
  139612. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  139613. /**
  139614. * Sets the gravity vector used by the simulation
  139615. * @param gravity defines the gravity vector to use
  139616. */
  139617. setGravity(gravity: Vector3): void;
  139618. /**
  139619. * Set the time step of the physics engine.
  139620. * Default is 1/60.
  139621. * To slow it down, enter 1/600 for example.
  139622. * To speed it up, 1/30
  139623. * @param newTimeStep defines the new timestep to apply to this world.
  139624. */
  139625. setTimeStep(newTimeStep?: number): void;
  139626. /**
  139627. * Get the time step of the physics engine.
  139628. * @returns the current time step
  139629. */
  139630. getTimeStep(): number;
  139631. /**
  139632. * Set the sub time step of the physics engine.
  139633. * Default is 0 meaning there is no sub steps
  139634. * To increase physics resolution precision, set a small value (like 1 ms)
  139635. * @param subTimeStep defines the new sub timestep used for physics resolution.
  139636. */
  139637. setSubTimeStep(subTimeStep?: number): void;
  139638. /**
  139639. * Get the sub time step of the physics engine.
  139640. * @returns the current sub time step
  139641. */
  139642. getSubTimeStep(): number;
  139643. /**
  139644. * Release all resources
  139645. */
  139646. dispose(): void;
  139647. /**
  139648. * Gets the name of the current physics plugin
  139649. * @returns the name of the plugin
  139650. */
  139651. getPhysicsPluginName(): string;
  139652. /**
  139653. * Adding a new impostor for the impostor tracking.
  139654. * This will be done by the impostor itself.
  139655. * @param impostor the impostor to add
  139656. */
  139657. addImpostor(impostor: PhysicsImpostor): void;
  139658. /**
  139659. * Remove an impostor from the engine.
  139660. * This impostor and its mesh will not longer be updated by the physics engine.
  139661. * @param impostor the impostor to remove
  139662. */
  139663. removeImpostor(impostor: PhysicsImpostor): void;
  139664. /**
  139665. * Add a joint to the physics engine
  139666. * @param mainImpostor defines the main impostor to which the joint is added.
  139667. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  139668. * @param joint defines the joint that will connect both impostors.
  139669. */
  139670. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  139671. /**
  139672. * Removes a joint from the simulation
  139673. * @param mainImpostor defines the impostor used with the joint
  139674. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  139675. * @param joint defines the joint to remove
  139676. */
  139677. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  139678. /**
  139679. * Called by the scene. No need to call it.
  139680. * @param delta defines the timespam between frames
  139681. */
  139682. _step(delta: number): void;
  139683. /**
  139684. * Gets the current plugin used to run the simulation
  139685. * @returns current plugin
  139686. */
  139687. getPhysicsPlugin(): IPhysicsEnginePlugin;
  139688. /**
  139689. * Gets the list of physic impostors
  139690. * @returns an array of PhysicsImpostor
  139691. */
  139692. getImpostors(): Array<PhysicsImpostor>;
  139693. /**
  139694. * Gets the impostor for a physics enabled object
  139695. * @param object defines the object impersonated by the impostor
  139696. * @returns the PhysicsImpostor or null if not found
  139697. */
  139698. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  139699. /**
  139700. * Gets the impostor for a physics body object
  139701. * @param body defines physics body used by the impostor
  139702. * @returns the PhysicsImpostor or null if not found
  139703. */
  139704. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  139705. /**
  139706. * Does a raycast in the physics world
  139707. * @param from when should the ray start?
  139708. * @param to when should the ray end?
  139709. * @returns PhysicsRaycastResult
  139710. */
  139711. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  139712. }
  139713. }
  139714. declare module BABYLON {
  139715. /** @hidden */
  139716. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  139717. private _useDeltaForWorldStep;
  139718. world: any;
  139719. name: string;
  139720. private _physicsMaterials;
  139721. private _fixedTimeStep;
  139722. private _cannonRaycastResult;
  139723. private _raycastResult;
  139724. private _physicsBodysToRemoveAfterStep;
  139725. private _firstFrame;
  139726. BJSCANNON: any;
  139727. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  139728. setGravity(gravity: Vector3): void;
  139729. setTimeStep(timeStep: number): void;
  139730. getTimeStep(): number;
  139731. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  139732. private _removeMarkedPhysicsBodiesFromWorld;
  139733. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139734. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139735. generatePhysicsBody(impostor: PhysicsImpostor): void;
  139736. private _processChildMeshes;
  139737. removePhysicsBody(impostor: PhysicsImpostor): void;
  139738. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  139739. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  139740. private _addMaterial;
  139741. private _checkWithEpsilon;
  139742. private _createShape;
  139743. private _createHeightmap;
  139744. private _minus90X;
  139745. private _plus90X;
  139746. private _tmpPosition;
  139747. private _tmpDeltaPosition;
  139748. private _tmpUnityRotation;
  139749. private _updatePhysicsBodyTransformation;
  139750. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  139751. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  139752. isSupported(): boolean;
  139753. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139754. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139755. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139756. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139757. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  139758. getBodyMass(impostor: PhysicsImpostor): number;
  139759. getBodyFriction(impostor: PhysicsImpostor): number;
  139760. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  139761. getBodyRestitution(impostor: PhysicsImpostor): number;
  139762. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  139763. sleepBody(impostor: PhysicsImpostor): void;
  139764. wakeUpBody(impostor: PhysicsImpostor): void;
  139765. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  139766. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  139767. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  139768. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  139769. getRadius(impostor: PhysicsImpostor): number;
  139770. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  139771. dispose(): void;
  139772. private _extendNamespace;
  139773. /**
  139774. * Does a raycast in the physics world
  139775. * @param from when should the ray start?
  139776. * @param to when should the ray end?
  139777. * @returns PhysicsRaycastResult
  139778. */
  139779. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  139780. }
  139781. }
  139782. declare module BABYLON {
  139783. /** @hidden */
  139784. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  139785. private _useDeltaForWorldStep;
  139786. world: any;
  139787. name: string;
  139788. BJSOIMO: any;
  139789. private _raycastResult;
  139790. private _fixedTimeStep;
  139791. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  139792. setGravity(gravity: Vector3): void;
  139793. setTimeStep(timeStep: number): void;
  139794. getTimeStep(): number;
  139795. private _tmpImpostorsArray;
  139796. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  139797. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139798. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139799. generatePhysicsBody(impostor: PhysicsImpostor): void;
  139800. private _tmpPositionVector;
  139801. removePhysicsBody(impostor: PhysicsImpostor): void;
  139802. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  139803. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  139804. isSupported(): boolean;
  139805. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  139806. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  139807. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139808. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139809. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139810. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139811. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  139812. getBodyMass(impostor: PhysicsImpostor): number;
  139813. getBodyFriction(impostor: PhysicsImpostor): number;
  139814. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  139815. getBodyRestitution(impostor: PhysicsImpostor): number;
  139816. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  139817. sleepBody(impostor: PhysicsImpostor): void;
  139818. wakeUpBody(impostor: PhysicsImpostor): void;
  139819. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  139820. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  139821. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  139822. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  139823. getRadius(impostor: PhysicsImpostor): number;
  139824. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  139825. dispose(): void;
  139826. /**
  139827. * Does a raycast in the physics world
  139828. * @param from when should the ray start?
  139829. * @param to when should the ray end?
  139830. * @returns PhysicsRaycastResult
  139831. */
  139832. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  139833. }
  139834. }
  139835. declare module BABYLON {
  139836. /**
  139837. * AmmoJS Physics plugin
  139838. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  139839. * @see https://github.com/kripken/ammo.js/
  139840. */
  139841. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  139842. private _useDeltaForWorldStep;
  139843. /**
  139844. * Reference to the Ammo library
  139845. */
  139846. bjsAMMO: any;
  139847. /**
  139848. * Created ammoJS world which physics bodies are added to
  139849. */
  139850. world: any;
  139851. /**
  139852. * Name of the plugin
  139853. */
  139854. name: string;
  139855. private _timeStep;
  139856. private _fixedTimeStep;
  139857. private _maxSteps;
  139858. private _tmpQuaternion;
  139859. private _tmpAmmoTransform;
  139860. private _tmpAmmoQuaternion;
  139861. private _tmpAmmoConcreteContactResultCallback;
  139862. private _collisionConfiguration;
  139863. private _dispatcher;
  139864. private _overlappingPairCache;
  139865. private _solver;
  139866. private _softBodySolver;
  139867. private _tmpAmmoVectorA;
  139868. private _tmpAmmoVectorB;
  139869. private _tmpAmmoVectorC;
  139870. private _tmpAmmoVectorD;
  139871. private _tmpContactCallbackResult;
  139872. private _tmpAmmoVectorRCA;
  139873. private _tmpAmmoVectorRCB;
  139874. private _raycastResult;
  139875. private static readonly DISABLE_COLLISION_FLAG;
  139876. private static readonly KINEMATIC_FLAG;
  139877. private static readonly DISABLE_DEACTIVATION_FLAG;
  139878. /**
  139879. * Initializes the ammoJS plugin
  139880. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  139881. * @param ammoInjection can be used to inject your own ammo reference
  139882. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  139883. */
  139884. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  139885. /**
  139886. * Sets the gravity of the physics world (m/(s^2))
  139887. * @param gravity Gravity to set
  139888. */
  139889. setGravity(gravity: Vector3): void;
  139890. /**
  139891. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  139892. * @param timeStep timestep to use in seconds
  139893. */
  139894. setTimeStep(timeStep: number): void;
  139895. /**
  139896. * 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)
  139897. * @param fixedTimeStep fixedTimeStep to use in seconds
  139898. */
  139899. setFixedTimeStep(fixedTimeStep: number): void;
  139900. /**
  139901. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  139902. * @param maxSteps the maximum number of steps by the physics engine per frame
  139903. */
  139904. setMaxSteps(maxSteps: number): void;
  139905. /**
  139906. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  139907. * @returns the current timestep in seconds
  139908. */
  139909. getTimeStep(): number;
  139910. /**
  139911. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  139912. */
  139913. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  139914. private _isImpostorInContact;
  139915. private _isImpostorPairInContact;
  139916. private _stepSimulation;
  139917. /**
  139918. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  139919. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  139920. * After the step the babylon meshes are set to the position of the physics imposters
  139921. * @param delta amount of time to step forward
  139922. * @param impostors array of imposters to update before/after the step
  139923. */
  139924. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  139925. /**
  139926. * Update babylon mesh to match physics world object
  139927. * @param impostor imposter to match
  139928. */
  139929. private _afterSoftStep;
  139930. /**
  139931. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  139932. * @param impostor imposter to match
  139933. */
  139934. private _ropeStep;
  139935. /**
  139936. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  139937. * @param impostor imposter to match
  139938. */
  139939. private _softbodyOrClothStep;
  139940. private _tmpMatrix;
  139941. /**
  139942. * Applies an impulse on the imposter
  139943. * @param impostor imposter to apply impulse to
  139944. * @param force amount of force to be applied to the imposter
  139945. * @param contactPoint the location to apply the impulse on the imposter
  139946. */
  139947. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139948. /**
  139949. * Applies a force on the imposter
  139950. * @param impostor imposter to apply force
  139951. * @param force amount of force to be applied to the imposter
  139952. * @param contactPoint the location to apply the force on the imposter
  139953. */
  139954. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139955. /**
  139956. * Creates a physics body using the plugin
  139957. * @param impostor the imposter to create the physics body on
  139958. */
  139959. generatePhysicsBody(impostor: PhysicsImpostor): void;
  139960. /**
  139961. * Removes the physics body from the imposter and disposes of the body's memory
  139962. * @param impostor imposter to remove the physics body from
  139963. */
  139964. removePhysicsBody(impostor: PhysicsImpostor): void;
  139965. /**
  139966. * Generates a joint
  139967. * @param impostorJoint the imposter joint to create the joint with
  139968. */
  139969. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  139970. /**
  139971. * Removes a joint
  139972. * @param impostorJoint the imposter joint to remove the joint from
  139973. */
  139974. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  139975. private _addMeshVerts;
  139976. /**
  139977. * Initialise the soft body vertices to match its object's (mesh) vertices
  139978. * Softbody vertices (nodes) are in world space and to match this
  139979. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  139980. * @param impostor to create the softbody for
  139981. */
  139982. private _softVertexData;
  139983. /**
  139984. * Create an impostor's soft body
  139985. * @param impostor to create the softbody for
  139986. */
  139987. private _createSoftbody;
  139988. /**
  139989. * Create cloth for an impostor
  139990. * @param impostor to create the softbody for
  139991. */
  139992. private _createCloth;
  139993. /**
  139994. * Create rope for an impostor
  139995. * @param impostor to create the softbody for
  139996. */
  139997. private _createRope;
  139998. /**
  139999. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140000. * @param impostor to create the custom physics shape for
  140001. */
  140002. private _createCustom;
  140003. private _addHullVerts;
  140004. private _createShape;
  140005. /**
  140006. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140007. * @param impostor imposter containing the physics body and babylon object
  140008. */
  140009. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140010. /**
  140011. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140012. * @param impostor imposter containing the physics body and babylon object
  140013. * @param newPosition new position
  140014. * @param newRotation new rotation
  140015. */
  140016. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140017. /**
  140018. * If this plugin is supported
  140019. * @returns true if its supported
  140020. */
  140021. isSupported(): boolean;
  140022. /**
  140023. * Sets the linear velocity of the physics body
  140024. * @param impostor imposter to set the velocity on
  140025. * @param velocity velocity to set
  140026. */
  140027. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140028. /**
  140029. * Sets the angular velocity of the physics body
  140030. * @param impostor imposter to set the velocity on
  140031. * @param velocity velocity to set
  140032. */
  140033. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140034. /**
  140035. * gets the linear velocity
  140036. * @param impostor imposter to get linear velocity from
  140037. * @returns linear velocity
  140038. */
  140039. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140040. /**
  140041. * gets the angular velocity
  140042. * @param impostor imposter to get angular velocity from
  140043. * @returns angular velocity
  140044. */
  140045. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140046. /**
  140047. * Sets the mass of physics body
  140048. * @param impostor imposter to set the mass on
  140049. * @param mass mass to set
  140050. */
  140051. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140052. /**
  140053. * Gets the mass of the physics body
  140054. * @param impostor imposter to get the mass from
  140055. * @returns mass
  140056. */
  140057. getBodyMass(impostor: PhysicsImpostor): number;
  140058. /**
  140059. * Gets friction of the impostor
  140060. * @param impostor impostor to get friction from
  140061. * @returns friction value
  140062. */
  140063. getBodyFriction(impostor: PhysicsImpostor): number;
  140064. /**
  140065. * Sets friction of the impostor
  140066. * @param impostor impostor to set friction on
  140067. * @param friction friction value
  140068. */
  140069. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140070. /**
  140071. * Gets restitution of the impostor
  140072. * @param impostor impostor to get restitution from
  140073. * @returns restitution value
  140074. */
  140075. getBodyRestitution(impostor: PhysicsImpostor): number;
  140076. /**
  140077. * Sets resitution of the impostor
  140078. * @param impostor impostor to set resitution on
  140079. * @param restitution resitution value
  140080. */
  140081. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140082. /**
  140083. * Gets pressure inside the impostor
  140084. * @param impostor impostor to get pressure from
  140085. * @returns pressure value
  140086. */
  140087. getBodyPressure(impostor: PhysicsImpostor): number;
  140088. /**
  140089. * Sets pressure inside a soft body impostor
  140090. * Cloth and rope must remain 0 pressure
  140091. * @param impostor impostor to set pressure on
  140092. * @param pressure pressure value
  140093. */
  140094. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140095. /**
  140096. * Gets stiffness of the impostor
  140097. * @param impostor impostor to get stiffness from
  140098. * @returns pressure value
  140099. */
  140100. getBodyStiffness(impostor: PhysicsImpostor): number;
  140101. /**
  140102. * Sets stiffness of the impostor
  140103. * @param impostor impostor to set stiffness on
  140104. * @param stiffness stiffness value from 0 to 1
  140105. */
  140106. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140107. /**
  140108. * Gets velocityIterations of the impostor
  140109. * @param impostor impostor to get velocity iterations from
  140110. * @returns velocityIterations value
  140111. */
  140112. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140113. /**
  140114. * Sets velocityIterations of the impostor
  140115. * @param impostor impostor to set velocity iterations on
  140116. * @param velocityIterations velocityIterations value
  140117. */
  140118. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140119. /**
  140120. * Gets positionIterations of the impostor
  140121. * @param impostor impostor to get position iterations from
  140122. * @returns positionIterations value
  140123. */
  140124. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140125. /**
  140126. * Sets positionIterations of the impostor
  140127. * @param impostor impostor to set position on
  140128. * @param positionIterations positionIterations value
  140129. */
  140130. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140131. /**
  140132. * Append an anchor to a cloth object
  140133. * @param impostor is the cloth impostor to add anchor to
  140134. * @param otherImpostor is the rigid impostor to anchor to
  140135. * @param width ratio across width from 0 to 1
  140136. * @param height ratio up height from 0 to 1
  140137. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140138. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140139. */
  140140. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140141. /**
  140142. * Append an hook to a rope object
  140143. * @param impostor is the rope impostor to add hook to
  140144. * @param otherImpostor is the rigid impostor to hook to
  140145. * @param length ratio along the rope from 0 to 1
  140146. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140147. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140148. */
  140149. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140150. /**
  140151. * Sleeps the physics body and stops it from being active
  140152. * @param impostor impostor to sleep
  140153. */
  140154. sleepBody(impostor: PhysicsImpostor): void;
  140155. /**
  140156. * Activates the physics body
  140157. * @param impostor impostor to activate
  140158. */
  140159. wakeUpBody(impostor: PhysicsImpostor): void;
  140160. /**
  140161. * Updates the distance parameters of the joint
  140162. * @param joint joint to update
  140163. * @param maxDistance maximum distance of the joint
  140164. * @param minDistance minimum distance of the joint
  140165. */
  140166. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140167. /**
  140168. * Sets a motor on the joint
  140169. * @param joint joint to set motor on
  140170. * @param speed speed of the motor
  140171. * @param maxForce maximum force of the motor
  140172. * @param motorIndex index of the motor
  140173. */
  140174. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140175. /**
  140176. * Sets the motors limit
  140177. * @param joint joint to set limit on
  140178. * @param upperLimit upper limit
  140179. * @param lowerLimit lower limit
  140180. */
  140181. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140182. /**
  140183. * Syncs the position and rotation of a mesh with the impostor
  140184. * @param mesh mesh to sync
  140185. * @param impostor impostor to update the mesh with
  140186. */
  140187. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140188. /**
  140189. * Gets the radius of the impostor
  140190. * @param impostor impostor to get radius from
  140191. * @returns the radius
  140192. */
  140193. getRadius(impostor: PhysicsImpostor): number;
  140194. /**
  140195. * Gets the box size of the impostor
  140196. * @param impostor impostor to get box size from
  140197. * @param result the resulting box size
  140198. */
  140199. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140200. /**
  140201. * Disposes of the impostor
  140202. */
  140203. dispose(): void;
  140204. /**
  140205. * Does a raycast in the physics world
  140206. * @param from when should the ray start?
  140207. * @param to when should the ray end?
  140208. * @returns PhysicsRaycastResult
  140209. */
  140210. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140211. }
  140212. }
  140213. declare module BABYLON {
  140214. interface AbstractScene {
  140215. /**
  140216. * The list of reflection probes added to the scene
  140217. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140218. */
  140219. reflectionProbes: Array<ReflectionProbe>;
  140220. /**
  140221. * Removes the given reflection probe from this scene.
  140222. * @param toRemove The reflection probe to remove
  140223. * @returns The index of the removed reflection probe
  140224. */
  140225. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140226. /**
  140227. * Adds the given reflection probe to this scene.
  140228. * @param newReflectionProbe The reflection probe to add
  140229. */
  140230. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140231. }
  140232. /**
  140233. * Class used to generate realtime reflection / refraction cube textures
  140234. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140235. */
  140236. export class ReflectionProbe {
  140237. /** defines the name of the probe */
  140238. name: string;
  140239. private _scene;
  140240. private _renderTargetTexture;
  140241. private _projectionMatrix;
  140242. private _viewMatrix;
  140243. private _target;
  140244. private _add;
  140245. private _attachedMesh;
  140246. private _invertYAxis;
  140247. /** Gets or sets probe position (center of the cube map) */
  140248. position: Vector3;
  140249. /**
  140250. * Creates a new reflection probe
  140251. * @param name defines the name of the probe
  140252. * @param size defines the texture resolution (for each face)
  140253. * @param scene defines the hosting scene
  140254. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140255. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140256. */
  140257. constructor(
  140258. /** defines the name of the probe */
  140259. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140260. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140261. get samples(): number;
  140262. set samples(value: number);
  140263. /** Gets or sets the refresh rate to use (on every frame by default) */
  140264. get refreshRate(): number;
  140265. set refreshRate(value: number);
  140266. /**
  140267. * Gets the hosting scene
  140268. * @returns a Scene
  140269. */
  140270. getScene(): Scene;
  140271. /** Gets the internal CubeTexture used to render to */
  140272. get cubeTexture(): RenderTargetTexture;
  140273. /** Gets the list of meshes to render */
  140274. get renderList(): Nullable<AbstractMesh[]>;
  140275. /**
  140276. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140277. * @param mesh defines the mesh to attach to
  140278. */
  140279. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140280. /**
  140281. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140282. * @param renderingGroupId The rendering group id corresponding to its index
  140283. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140284. */
  140285. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140286. /**
  140287. * Clean all associated resources
  140288. */
  140289. dispose(): void;
  140290. /**
  140291. * Converts the reflection probe information to a readable string for debug purpose.
  140292. * @param fullDetails Supports for multiple levels of logging within scene loading
  140293. * @returns the human readable reflection probe info
  140294. */
  140295. toString(fullDetails?: boolean): string;
  140296. /**
  140297. * Get the class name of the relfection probe.
  140298. * @returns "ReflectionProbe"
  140299. */
  140300. getClassName(): string;
  140301. /**
  140302. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140303. * @returns The JSON representation of the texture
  140304. */
  140305. serialize(): any;
  140306. /**
  140307. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140308. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140309. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140310. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140311. * @returns The parsed reflection probe if successful
  140312. */
  140313. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140314. }
  140315. }
  140316. declare module BABYLON {
  140317. /** @hidden */
  140318. export var _BabylonLoaderRegistered: boolean;
  140319. /**
  140320. * Helps setting up some configuration for the babylon file loader.
  140321. */
  140322. export class BabylonFileLoaderConfiguration {
  140323. /**
  140324. * The loader does not allow injecting custom physix engine into the plugins.
  140325. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140326. * So you could set this variable to your engine import to make it work.
  140327. */
  140328. static LoaderInjectedPhysicsEngine: any;
  140329. }
  140330. }
  140331. declare module BABYLON {
  140332. /**
  140333. * The Physically based simple base material of BJS.
  140334. *
  140335. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140336. * It is used as the base class for both the specGloss and metalRough conventions.
  140337. */
  140338. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140339. /**
  140340. * Number of Simultaneous lights allowed on the material.
  140341. */
  140342. maxSimultaneousLights: number;
  140343. /**
  140344. * If sets to true, disables all the lights affecting the material.
  140345. */
  140346. disableLighting: boolean;
  140347. /**
  140348. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140349. */
  140350. environmentTexture: BaseTexture;
  140351. /**
  140352. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140353. */
  140354. invertNormalMapX: boolean;
  140355. /**
  140356. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140357. */
  140358. invertNormalMapY: boolean;
  140359. /**
  140360. * Normal map used in the model.
  140361. */
  140362. normalTexture: BaseTexture;
  140363. /**
  140364. * Emissivie color used to self-illuminate the model.
  140365. */
  140366. emissiveColor: Color3;
  140367. /**
  140368. * Emissivie texture used to self-illuminate the model.
  140369. */
  140370. emissiveTexture: BaseTexture;
  140371. /**
  140372. * Occlusion Channel Strenght.
  140373. */
  140374. occlusionStrength: number;
  140375. /**
  140376. * Occlusion Texture of the material (adding extra occlusion effects).
  140377. */
  140378. occlusionTexture: BaseTexture;
  140379. /**
  140380. * Defines the alpha limits in alpha test mode.
  140381. */
  140382. alphaCutOff: number;
  140383. /**
  140384. * Gets the current double sided mode.
  140385. */
  140386. get doubleSided(): boolean;
  140387. /**
  140388. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140389. */
  140390. set doubleSided(value: boolean);
  140391. /**
  140392. * Stores the pre-calculated light information of a mesh in a texture.
  140393. */
  140394. lightmapTexture: BaseTexture;
  140395. /**
  140396. * If true, the light map contains occlusion information instead of lighting info.
  140397. */
  140398. useLightmapAsShadowmap: boolean;
  140399. /**
  140400. * Instantiates a new PBRMaterial instance.
  140401. *
  140402. * @param name The material name
  140403. * @param scene The scene the material will be use in.
  140404. */
  140405. constructor(name: string, scene: Scene);
  140406. getClassName(): string;
  140407. }
  140408. }
  140409. declare module BABYLON {
  140410. /**
  140411. * The PBR material of BJS following the metal roughness convention.
  140412. *
  140413. * This fits to the PBR convention in the GLTF definition:
  140414. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  140415. */
  140416. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  140417. /**
  140418. * The base color has two different interpretations depending on the value of metalness.
  140419. * When the material is a metal, the base color is the specific measured reflectance value
  140420. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  140421. * of the material.
  140422. */
  140423. baseColor: Color3;
  140424. /**
  140425. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  140426. * well as opacity information in the alpha channel.
  140427. */
  140428. baseTexture: BaseTexture;
  140429. /**
  140430. * Specifies the metallic scalar value of the material.
  140431. * Can also be used to scale the metalness values of the metallic texture.
  140432. */
  140433. metallic: number;
  140434. /**
  140435. * Specifies the roughness scalar value of the material.
  140436. * Can also be used to scale the roughness values of the metallic texture.
  140437. */
  140438. roughness: number;
  140439. /**
  140440. * Texture containing both the metallic value in the B channel and the
  140441. * roughness value in the G channel to keep better precision.
  140442. */
  140443. metallicRoughnessTexture: BaseTexture;
  140444. /**
  140445. * Instantiates a new PBRMetalRoughnessMaterial instance.
  140446. *
  140447. * @param name The material name
  140448. * @param scene The scene the material will be use in.
  140449. */
  140450. constructor(name: string, scene: Scene);
  140451. /**
  140452. * Return the currrent class name of the material.
  140453. */
  140454. getClassName(): string;
  140455. /**
  140456. * Makes a duplicate of the current material.
  140457. * @param name - name to use for the new material.
  140458. */
  140459. clone(name: string): PBRMetallicRoughnessMaterial;
  140460. /**
  140461. * Serialize the material to a parsable JSON object.
  140462. */
  140463. serialize(): any;
  140464. /**
  140465. * Parses a JSON object correponding to the serialize function.
  140466. */
  140467. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  140468. }
  140469. }
  140470. declare module BABYLON {
  140471. /**
  140472. * The PBR material of BJS following the specular glossiness convention.
  140473. *
  140474. * This fits to the PBR convention in the GLTF definition:
  140475. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  140476. */
  140477. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  140478. /**
  140479. * Specifies the diffuse color of the material.
  140480. */
  140481. diffuseColor: Color3;
  140482. /**
  140483. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  140484. * channel.
  140485. */
  140486. diffuseTexture: BaseTexture;
  140487. /**
  140488. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  140489. */
  140490. specularColor: Color3;
  140491. /**
  140492. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  140493. */
  140494. glossiness: number;
  140495. /**
  140496. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  140497. */
  140498. specularGlossinessTexture: BaseTexture;
  140499. /**
  140500. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  140501. *
  140502. * @param name The material name
  140503. * @param scene The scene the material will be use in.
  140504. */
  140505. constructor(name: string, scene: Scene);
  140506. /**
  140507. * Return the currrent class name of the material.
  140508. */
  140509. getClassName(): string;
  140510. /**
  140511. * Makes a duplicate of the current material.
  140512. * @param name - name to use for the new material.
  140513. */
  140514. clone(name: string): PBRSpecularGlossinessMaterial;
  140515. /**
  140516. * Serialize the material to a parsable JSON object.
  140517. */
  140518. serialize(): any;
  140519. /**
  140520. * Parses a JSON object correponding to the serialize function.
  140521. */
  140522. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  140523. }
  140524. }
  140525. declare module BABYLON {
  140526. /**
  140527. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  140528. * It can help converting any input color in a desired output one. This can then be used to create effects
  140529. * from sepia, black and white to sixties or futuristic rendering...
  140530. *
  140531. * The only supported format is currently 3dl.
  140532. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  140533. */
  140534. export class ColorGradingTexture extends BaseTexture {
  140535. /**
  140536. * The texture URL.
  140537. */
  140538. url: string;
  140539. /**
  140540. * Empty line regex stored for GC.
  140541. */
  140542. private static _noneEmptyLineRegex;
  140543. private _textureMatrix;
  140544. private _onLoad;
  140545. /**
  140546. * Instantiates a ColorGradingTexture from the following parameters.
  140547. *
  140548. * @param url The location of the color gradind data (currently only supporting 3dl)
  140549. * @param sceneOrEngine The scene or engine the texture will be used in
  140550. * @param onLoad defines a callback triggered when the texture has been loaded
  140551. */
  140552. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  140553. /**
  140554. * Fires the onload event from the constructor if requested.
  140555. */
  140556. private _triggerOnLoad;
  140557. /**
  140558. * Returns the texture matrix used in most of the material.
  140559. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  140560. */
  140561. getTextureMatrix(): Matrix;
  140562. /**
  140563. * Occurs when the file being loaded is a .3dl LUT file.
  140564. */
  140565. private load3dlTexture;
  140566. /**
  140567. * Starts the loading process of the texture.
  140568. */
  140569. private loadTexture;
  140570. /**
  140571. * Clones the color gradind texture.
  140572. */
  140573. clone(): ColorGradingTexture;
  140574. /**
  140575. * Called during delayed load for textures.
  140576. */
  140577. delayLoad(): void;
  140578. /**
  140579. * Parses a color grading texture serialized by Babylon.
  140580. * @param parsedTexture The texture information being parsedTexture
  140581. * @param scene The scene to load the texture in
  140582. * @param rootUrl The root url of the data assets to load
  140583. * @return A color gradind texture
  140584. */
  140585. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  140586. /**
  140587. * Serializes the LUT texture to json format.
  140588. */
  140589. serialize(): any;
  140590. }
  140591. }
  140592. declare module BABYLON {
  140593. /**
  140594. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  140595. */
  140596. export class EquiRectangularCubeTexture extends BaseTexture {
  140597. /** The six faces of the cube. */
  140598. private static _FacesMapping;
  140599. private _noMipmap;
  140600. private _onLoad;
  140601. private _onError;
  140602. /** The size of the cubemap. */
  140603. private _size;
  140604. /** The buffer of the image. */
  140605. private _buffer;
  140606. /** The width of the input image. */
  140607. private _width;
  140608. /** The height of the input image. */
  140609. private _height;
  140610. /** The URL to the image. */
  140611. url: string;
  140612. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  140613. coordinatesMode: number;
  140614. /**
  140615. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  140616. * @param url The location of the image
  140617. * @param scene The scene the texture will be used in
  140618. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  140619. * @param noMipmap Forces to not generate the mipmap if true
  140620. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  140621. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  140622. * @param onLoad — defines a callback called when texture is loaded
  140623. * @param onError — defines a callback called if there is an error
  140624. */
  140625. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  140626. /**
  140627. * Load the image data, by putting the image on a canvas and extracting its buffer.
  140628. */
  140629. private loadImage;
  140630. /**
  140631. * Convert the image buffer into a cubemap and create a CubeTexture.
  140632. */
  140633. private loadTexture;
  140634. /**
  140635. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  140636. * @param buffer The ArrayBuffer that should be converted.
  140637. * @returns The buffer as Float32Array.
  140638. */
  140639. private getFloat32ArrayFromArrayBuffer;
  140640. /**
  140641. * Get the current class name of the texture useful for serialization or dynamic coding.
  140642. * @returns "EquiRectangularCubeTexture"
  140643. */
  140644. getClassName(): string;
  140645. /**
  140646. * Create a clone of the current EquiRectangularCubeTexture and return it.
  140647. * @returns A clone of the current EquiRectangularCubeTexture.
  140648. */
  140649. clone(): EquiRectangularCubeTexture;
  140650. }
  140651. }
  140652. declare module BABYLON {
  140653. /**
  140654. * Defines the options related to the creation of an HtmlElementTexture
  140655. */
  140656. export interface IHtmlElementTextureOptions {
  140657. /**
  140658. * Defines wether mip maps should be created or not.
  140659. */
  140660. generateMipMaps?: boolean;
  140661. /**
  140662. * Defines the sampling mode of the texture.
  140663. */
  140664. samplingMode?: number;
  140665. /**
  140666. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  140667. */
  140668. engine: Nullable<ThinEngine>;
  140669. /**
  140670. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  140671. */
  140672. scene: Nullable<Scene>;
  140673. }
  140674. /**
  140675. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  140676. * To be as efficient as possible depending on your constraints nothing aside the first upload
  140677. * is automatically managed.
  140678. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  140679. * in your application.
  140680. *
  140681. * As the update is not automatic, you need to call them manually.
  140682. */
  140683. export class HtmlElementTexture extends BaseTexture {
  140684. /**
  140685. * The texture URL.
  140686. */
  140687. element: HTMLVideoElement | HTMLCanvasElement;
  140688. private static readonly DefaultOptions;
  140689. private _textureMatrix;
  140690. private _isVideo;
  140691. private _generateMipMaps;
  140692. private _samplingMode;
  140693. /**
  140694. * Instantiates a HtmlElementTexture from the following parameters.
  140695. *
  140696. * @param name Defines the name of the texture
  140697. * @param element Defines the video or canvas the texture is filled with
  140698. * @param options Defines the other none mandatory texture creation options
  140699. */
  140700. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  140701. private _createInternalTexture;
  140702. /**
  140703. * Returns the texture matrix used in most of the material.
  140704. */
  140705. getTextureMatrix(): Matrix;
  140706. /**
  140707. * Updates the content of the texture.
  140708. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  140709. */
  140710. update(invertY?: Nullable<boolean>): void;
  140711. }
  140712. }
  140713. declare module BABYLON {
  140714. /**
  140715. * Based on jsTGALoader - Javascript loader for TGA file
  140716. * By Vincent Thibault
  140717. * @see http://blog.robrowser.com/javascript-tga-loader.html
  140718. */
  140719. export class TGATools {
  140720. private static _TYPE_INDEXED;
  140721. private static _TYPE_RGB;
  140722. private static _TYPE_GREY;
  140723. private static _TYPE_RLE_INDEXED;
  140724. private static _TYPE_RLE_RGB;
  140725. private static _TYPE_RLE_GREY;
  140726. private static _ORIGIN_MASK;
  140727. private static _ORIGIN_SHIFT;
  140728. private static _ORIGIN_BL;
  140729. private static _ORIGIN_BR;
  140730. private static _ORIGIN_UL;
  140731. private static _ORIGIN_UR;
  140732. /**
  140733. * Gets the header of a TGA file
  140734. * @param data defines the TGA data
  140735. * @returns the header
  140736. */
  140737. static GetTGAHeader(data: Uint8Array): any;
  140738. /**
  140739. * Uploads TGA content to a Babylon Texture
  140740. * @hidden
  140741. */
  140742. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  140743. /** @hidden */
  140744. 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;
  140745. /** @hidden */
  140746. 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;
  140747. /** @hidden */
  140748. 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;
  140749. /** @hidden */
  140750. 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;
  140751. /** @hidden */
  140752. 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;
  140753. /** @hidden */
  140754. 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;
  140755. }
  140756. }
  140757. declare module BABYLON {
  140758. /**
  140759. * Implementation of the TGA Texture Loader.
  140760. * @hidden
  140761. */
  140762. export class _TGATextureLoader implements IInternalTextureLoader {
  140763. /**
  140764. * Defines wether the loader supports cascade loading the different faces.
  140765. */
  140766. readonly supportCascades: boolean;
  140767. /**
  140768. * This returns if the loader support the current file information.
  140769. * @param extension defines the file extension of the file being loaded
  140770. * @returns true if the loader can load the specified file
  140771. */
  140772. canLoad(extension: string): boolean;
  140773. /**
  140774. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  140775. * @param data contains the texture data
  140776. * @param texture defines the BabylonJS internal texture
  140777. * @param createPolynomials will be true if polynomials have been requested
  140778. * @param onLoad defines the callback to trigger once the texture is ready
  140779. * @param onError defines the callback to trigger in case of error
  140780. */
  140781. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  140782. /**
  140783. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  140784. * @param data contains the texture data
  140785. * @param texture defines the BabylonJS internal texture
  140786. * @param callback defines the method to call once ready to upload
  140787. */
  140788. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  140789. }
  140790. }
  140791. declare module BABYLON {
  140792. /**
  140793. * Info about the .basis files
  140794. */
  140795. class BasisFileInfo {
  140796. /**
  140797. * If the file has alpha
  140798. */
  140799. hasAlpha: boolean;
  140800. /**
  140801. * Info about each image of the basis file
  140802. */
  140803. images: Array<{
  140804. levels: Array<{
  140805. width: number;
  140806. height: number;
  140807. transcodedPixels: ArrayBufferView;
  140808. }>;
  140809. }>;
  140810. }
  140811. /**
  140812. * Result of transcoding a basis file
  140813. */
  140814. class TranscodeResult {
  140815. /**
  140816. * Info about the .basis file
  140817. */
  140818. fileInfo: BasisFileInfo;
  140819. /**
  140820. * Format to use when loading the file
  140821. */
  140822. format: number;
  140823. }
  140824. /**
  140825. * Configuration options for the Basis transcoder
  140826. */
  140827. export class BasisTranscodeConfiguration {
  140828. /**
  140829. * Supported compression formats used to determine the supported output format of the transcoder
  140830. */
  140831. supportedCompressionFormats?: {
  140832. /**
  140833. * etc1 compression format
  140834. */
  140835. etc1?: boolean;
  140836. /**
  140837. * s3tc compression format
  140838. */
  140839. s3tc?: boolean;
  140840. /**
  140841. * pvrtc compression format
  140842. */
  140843. pvrtc?: boolean;
  140844. /**
  140845. * etc2 compression format
  140846. */
  140847. etc2?: boolean;
  140848. };
  140849. /**
  140850. * If mipmap levels should be loaded for transcoded images (Default: true)
  140851. */
  140852. loadMipmapLevels?: boolean;
  140853. /**
  140854. * Index of a single image to load (Default: all images)
  140855. */
  140856. loadSingleImage?: number;
  140857. }
  140858. /**
  140859. * Used to load .Basis files
  140860. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  140861. */
  140862. export class BasisTools {
  140863. private static _IgnoreSupportedFormats;
  140864. /**
  140865. * URL to use when loading the basis transcoder
  140866. */
  140867. static JSModuleURL: string;
  140868. /**
  140869. * URL to use when loading the wasm module for the transcoder
  140870. */
  140871. static WasmModuleURL: string;
  140872. /**
  140873. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  140874. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  140875. * @returns internal format corresponding to the Basis format
  140876. */
  140877. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  140878. private static _WorkerPromise;
  140879. private static _Worker;
  140880. private static _actionId;
  140881. private static _CreateWorkerAsync;
  140882. /**
  140883. * Transcodes a loaded image file to compressed pixel data
  140884. * @param data image data to transcode
  140885. * @param config configuration options for the transcoding
  140886. * @returns a promise resulting in the transcoded image
  140887. */
  140888. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  140889. /**
  140890. * Loads a texture from the transcode result
  140891. * @param texture texture load to
  140892. * @param transcodeResult the result of transcoding the basis file to load from
  140893. */
  140894. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  140895. }
  140896. }
  140897. declare module BABYLON {
  140898. /**
  140899. * Loader for .basis file format
  140900. */
  140901. export class _BasisTextureLoader implements IInternalTextureLoader {
  140902. /**
  140903. * Defines whether the loader supports cascade loading the different faces.
  140904. */
  140905. readonly supportCascades: boolean;
  140906. /**
  140907. * This returns if the loader support the current file information.
  140908. * @param extension defines the file extension of the file being loaded
  140909. * @returns true if the loader can load the specified file
  140910. */
  140911. canLoad(extension: string): boolean;
  140912. /**
  140913. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  140914. * @param data contains the texture data
  140915. * @param texture defines the BabylonJS internal texture
  140916. * @param createPolynomials will be true if polynomials have been requested
  140917. * @param onLoad defines the callback to trigger once the texture is ready
  140918. * @param onError defines the callback to trigger in case of error
  140919. */
  140920. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  140921. /**
  140922. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  140923. * @param data contains the texture data
  140924. * @param texture defines the BabylonJS internal texture
  140925. * @param callback defines the method to call once ready to upload
  140926. */
  140927. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  140928. }
  140929. }
  140930. declare module BABYLON {
  140931. /**
  140932. * Defines the basic options interface of a TexturePacker Frame
  140933. */
  140934. export interface ITexturePackerFrame {
  140935. /**
  140936. * The frame ID
  140937. */
  140938. id: number;
  140939. /**
  140940. * The frames Scale
  140941. */
  140942. scale: Vector2;
  140943. /**
  140944. * The Frames offset
  140945. */
  140946. offset: Vector2;
  140947. }
  140948. /**
  140949. * This is a support class for frame Data on texture packer sets.
  140950. */
  140951. export class TexturePackerFrame implements ITexturePackerFrame {
  140952. /**
  140953. * The frame ID
  140954. */
  140955. id: number;
  140956. /**
  140957. * The frames Scale
  140958. */
  140959. scale: Vector2;
  140960. /**
  140961. * The Frames offset
  140962. */
  140963. offset: Vector2;
  140964. /**
  140965. * Initializes a texture package frame.
  140966. * @param id The numerical frame identifier
  140967. * @param scale Scalar Vector2 for UV frame
  140968. * @param offset Vector2 for the frame position in UV units.
  140969. * @returns TexturePackerFrame
  140970. */
  140971. constructor(id: number, scale: Vector2, offset: Vector2);
  140972. }
  140973. }
  140974. declare module BABYLON {
  140975. /**
  140976. * Defines the basic options interface of a TexturePacker
  140977. */
  140978. export interface ITexturePackerOptions {
  140979. /**
  140980. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  140981. */
  140982. map?: string[];
  140983. /**
  140984. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  140985. */
  140986. uvsIn?: string;
  140987. /**
  140988. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  140989. */
  140990. uvsOut?: string;
  140991. /**
  140992. * number representing the layout style. Defaults to LAYOUT_STRIP
  140993. */
  140994. layout?: number;
  140995. /**
  140996. * number of columns if using custom column count layout(2). This defaults to 4.
  140997. */
  140998. colnum?: number;
  140999. /**
  141000. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141001. */
  141002. updateInputMeshes?: boolean;
  141003. /**
  141004. * boolean flag to dispose all the source textures. Defaults to true.
  141005. */
  141006. disposeSources?: boolean;
  141007. /**
  141008. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141009. */
  141010. fillBlanks?: boolean;
  141011. /**
  141012. * string value representing the context fill style color. Defaults to 'black'.
  141013. */
  141014. customFillColor?: string;
  141015. /**
  141016. * Width and Height Value of each Frame in the TexturePacker Sets
  141017. */
  141018. frameSize?: number;
  141019. /**
  141020. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141021. */
  141022. paddingRatio?: number;
  141023. /**
  141024. * Number that declares the fill method for the padding gutter.
  141025. */
  141026. paddingMode?: number;
  141027. /**
  141028. * If in SUBUV_COLOR padding mode what color to use.
  141029. */
  141030. paddingColor?: Color3 | Color4;
  141031. }
  141032. /**
  141033. * Defines the basic interface of a TexturePacker JSON File
  141034. */
  141035. export interface ITexturePackerJSON {
  141036. /**
  141037. * The frame ID
  141038. */
  141039. name: string;
  141040. /**
  141041. * The base64 channel data
  141042. */
  141043. sets: any;
  141044. /**
  141045. * The options of the Packer
  141046. */
  141047. options: ITexturePackerOptions;
  141048. /**
  141049. * The frame data of the Packer
  141050. */
  141051. frames: Array<number>;
  141052. }
  141053. /**
  141054. * This is a support class that generates a series of packed texture sets.
  141055. * @see https://doc.babylonjs.com/babylon101/materials
  141056. */
  141057. export class TexturePacker {
  141058. /** Packer Layout Constant 0 */
  141059. static readonly LAYOUT_STRIP: number;
  141060. /** Packer Layout Constant 1 */
  141061. static readonly LAYOUT_POWER2: number;
  141062. /** Packer Layout Constant 2 */
  141063. static readonly LAYOUT_COLNUM: number;
  141064. /** Packer Layout Constant 0 */
  141065. static readonly SUBUV_WRAP: number;
  141066. /** Packer Layout Constant 1 */
  141067. static readonly SUBUV_EXTEND: number;
  141068. /** Packer Layout Constant 2 */
  141069. static readonly SUBUV_COLOR: number;
  141070. /** The Name of the Texture Package */
  141071. name: string;
  141072. /** The scene scope of the TexturePacker */
  141073. scene: Scene;
  141074. /** The Meshes to target */
  141075. meshes: AbstractMesh[];
  141076. /** Arguments passed with the Constructor */
  141077. options: ITexturePackerOptions;
  141078. /** The promise that is started upon initialization */
  141079. promise: Nullable<Promise<TexturePacker | string>>;
  141080. /** The Container object for the channel sets that are generated */
  141081. sets: object;
  141082. /** The Container array for the frames that are generated */
  141083. frames: TexturePackerFrame[];
  141084. /** The expected number of textures the system is parsing. */
  141085. private _expecting;
  141086. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141087. private _paddingValue;
  141088. /**
  141089. * Initializes a texture package series from an array of meshes or a single mesh.
  141090. * @param name The name of the package
  141091. * @param meshes The target meshes to compose the package from
  141092. * @param options The arguments that texture packer should follow while building.
  141093. * @param scene The scene which the textures are scoped to.
  141094. * @returns TexturePacker
  141095. */
  141096. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141097. /**
  141098. * Starts the package process
  141099. * @param resolve The promises resolution function
  141100. * @returns TexturePacker
  141101. */
  141102. private _createFrames;
  141103. /**
  141104. * Calculates the Size of the Channel Sets
  141105. * @returns Vector2
  141106. */
  141107. private _calculateSize;
  141108. /**
  141109. * Calculates the UV data for the frames.
  141110. * @param baseSize the base frameSize
  141111. * @param padding the base frame padding
  141112. * @param dtSize size of the Dynamic Texture for that channel
  141113. * @param dtUnits is 1/dtSize
  141114. * @param update flag to update the input meshes
  141115. */
  141116. private _calculateMeshUVFrames;
  141117. /**
  141118. * Calculates the frames Offset.
  141119. * @param index of the frame
  141120. * @returns Vector2
  141121. */
  141122. private _getFrameOffset;
  141123. /**
  141124. * Updates a Mesh to the frame data
  141125. * @param mesh that is the target
  141126. * @param frameID or the frame index
  141127. */
  141128. private _updateMeshUV;
  141129. /**
  141130. * Updates a Meshes materials to use the texture packer channels
  141131. * @param m is the mesh to target
  141132. * @param force all channels on the packer to be set.
  141133. */
  141134. private _updateTextureReferences;
  141135. /**
  141136. * Public method to set a Mesh to a frame
  141137. * @param m that is the target
  141138. * @param frameID or the frame index
  141139. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141140. */
  141141. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141142. /**
  141143. * Starts the async promise to compile the texture packer.
  141144. * @returns Promise<void>
  141145. */
  141146. processAsync(): Promise<void>;
  141147. /**
  141148. * Disposes all textures associated with this packer
  141149. */
  141150. dispose(): void;
  141151. /**
  141152. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141153. * @param imageType is the image type to use.
  141154. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141155. */
  141156. download(imageType?: string, quality?: number): void;
  141157. /**
  141158. * Public method to load a texturePacker JSON file.
  141159. * @param data of the JSON file in string format.
  141160. */
  141161. updateFromJSON(data: string): void;
  141162. }
  141163. }
  141164. declare module BABYLON {
  141165. /**
  141166. * 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.
  141167. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141168. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141169. */
  141170. export class CustomProceduralTexture extends ProceduralTexture {
  141171. private _animate;
  141172. private _time;
  141173. private _config;
  141174. private _texturePath;
  141175. /**
  141176. * Instantiates a new Custom Procedural Texture.
  141177. * 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.
  141178. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141179. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141180. * @param name Define the name of the texture
  141181. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141182. * @param size Define the size of the texture to create
  141183. * @param scene Define the scene the texture belongs to
  141184. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141185. * @param generateMipMaps Define if the texture should creates mip maps or not
  141186. */
  141187. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141188. private _loadJson;
  141189. /**
  141190. * Is the texture ready to be used ? (rendered at least once)
  141191. * @returns true if ready, otherwise, false.
  141192. */
  141193. isReady(): boolean;
  141194. /**
  141195. * Render the texture to its associated render target.
  141196. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141197. */
  141198. render(useCameraPostProcess?: boolean): void;
  141199. /**
  141200. * Update the list of dependant textures samplers in the shader.
  141201. */
  141202. updateTextures(): void;
  141203. /**
  141204. * Update the uniform values of the procedural texture in the shader.
  141205. */
  141206. updateShaderUniforms(): void;
  141207. /**
  141208. * Define if the texture animates or not.
  141209. */
  141210. get animate(): boolean;
  141211. set animate(value: boolean);
  141212. }
  141213. }
  141214. declare module BABYLON {
  141215. /** @hidden */
  141216. export var noisePixelShader: {
  141217. name: string;
  141218. shader: string;
  141219. };
  141220. }
  141221. declare module BABYLON {
  141222. /**
  141223. * Class used to generate noise procedural textures
  141224. */
  141225. export class NoiseProceduralTexture extends ProceduralTexture {
  141226. private _time;
  141227. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141228. brightness: number;
  141229. /** Defines the number of octaves to process */
  141230. octaves: number;
  141231. /** Defines the level of persistence (0.8 by default) */
  141232. persistence: number;
  141233. /** Gets or sets animation speed factor (default is 1) */
  141234. animationSpeedFactor: number;
  141235. /**
  141236. * Creates a new NoiseProceduralTexture
  141237. * @param name defines the name fo the texture
  141238. * @param size defines the size of the texture (default is 256)
  141239. * @param scene defines the hosting scene
  141240. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141241. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141242. */
  141243. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141244. private _updateShaderUniforms;
  141245. protected _getDefines(): string;
  141246. /** Generate the current state of the procedural texture */
  141247. render(useCameraPostProcess?: boolean): void;
  141248. /**
  141249. * Serializes this noise procedural texture
  141250. * @returns a serialized noise procedural texture object
  141251. */
  141252. serialize(): any;
  141253. /**
  141254. * Clone the texture.
  141255. * @returns the cloned texture
  141256. */
  141257. clone(): NoiseProceduralTexture;
  141258. /**
  141259. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141260. * @param parsedTexture defines parsed texture data
  141261. * @param scene defines the current scene
  141262. * @param rootUrl defines the root URL containing noise procedural texture information
  141263. * @returns a parsed NoiseProceduralTexture
  141264. */
  141265. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141266. }
  141267. }
  141268. declare module BABYLON {
  141269. /**
  141270. * Raw cube texture where the raw buffers are passed in
  141271. */
  141272. export class RawCubeTexture extends CubeTexture {
  141273. /**
  141274. * Creates a cube texture where the raw buffers are passed in.
  141275. * @param scene defines the scene the texture is attached to
  141276. * @param data defines the array of data to use to create each face
  141277. * @param size defines the size of the textures
  141278. * @param format defines the format of the data
  141279. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141280. * @param generateMipMaps defines if the engine should generate the mip levels
  141281. * @param invertY defines if data must be stored with Y axis inverted
  141282. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141283. * @param compression defines the compression used (null by default)
  141284. */
  141285. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141286. /**
  141287. * Updates the raw cube texture.
  141288. * @param data defines the data to store
  141289. * @param format defines the data format
  141290. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141291. * @param invertY defines if data must be stored with Y axis inverted
  141292. * @param compression defines the compression used (null by default)
  141293. * @param level defines which level of the texture to update
  141294. */
  141295. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141296. /**
  141297. * Updates a raw cube texture with RGBD encoded data.
  141298. * @param data defines the array of data [mipmap][face] to use to create each face
  141299. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141300. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141301. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141302. * @returns a promsie that resolves when the operation is complete
  141303. */
  141304. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141305. /**
  141306. * Clones the raw cube texture.
  141307. * @return a new cube texture
  141308. */
  141309. clone(): CubeTexture;
  141310. /** @hidden */
  141311. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141312. }
  141313. }
  141314. declare module BABYLON {
  141315. /**
  141316. * Class used to store 2D array textures containing user data
  141317. */
  141318. export class RawTexture2DArray extends Texture {
  141319. /** Gets or sets the texture format to use */
  141320. format: number;
  141321. /**
  141322. * Create a new RawTexture2DArray
  141323. * @param data defines the data of the texture
  141324. * @param width defines the width of the texture
  141325. * @param height defines the height of the texture
  141326. * @param depth defines the number of layers of the texture
  141327. * @param format defines the texture format to use
  141328. * @param scene defines the hosting scene
  141329. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141330. * @param invertY defines if texture must be stored with Y axis inverted
  141331. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141332. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141333. */
  141334. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141335. /** Gets or sets the texture format to use */
  141336. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141337. /**
  141338. * Update the texture with new data
  141339. * @param data defines the data to store in the texture
  141340. */
  141341. update(data: ArrayBufferView): void;
  141342. }
  141343. }
  141344. declare module BABYLON {
  141345. /**
  141346. * Class used to store 3D textures containing user data
  141347. */
  141348. export class RawTexture3D extends Texture {
  141349. /** Gets or sets the texture format to use */
  141350. format: number;
  141351. /**
  141352. * Create a new RawTexture3D
  141353. * @param data defines the data of the texture
  141354. * @param width defines the width of the texture
  141355. * @param height defines the height of the texture
  141356. * @param depth defines the depth of the texture
  141357. * @param format defines the texture format to use
  141358. * @param scene defines the hosting scene
  141359. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141360. * @param invertY defines if texture must be stored with Y axis inverted
  141361. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141362. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141363. */
  141364. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141365. /** Gets or sets the texture format to use */
  141366. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141367. /**
  141368. * Update the texture with new data
  141369. * @param data defines the data to store in the texture
  141370. */
  141371. update(data: ArrayBufferView): void;
  141372. }
  141373. }
  141374. declare module BABYLON {
  141375. /**
  141376. * Creates a refraction texture used by refraction channel of the standard material.
  141377. * It is like a mirror but to see through a material.
  141378. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141379. */
  141380. export class RefractionTexture extends RenderTargetTexture {
  141381. /**
  141382. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141383. * 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.
  141384. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141385. */
  141386. refractionPlane: Plane;
  141387. /**
  141388. * Define how deep under the surface we should see.
  141389. */
  141390. depth: number;
  141391. /**
  141392. * Creates a refraction texture used by refraction channel of the standard material.
  141393. * It is like a mirror but to see through a material.
  141394. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141395. * @param name Define the texture name
  141396. * @param size Define the size of the underlying texture
  141397. * @param scene Define the scene the refraction belongs to
  141398. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141399. */
  141400. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141401. /**
  141402. * Clone the refraction texture.
  141403. * @returns the cloned texture
  141404. */
  141405. clone(): RefractionTexture;
  141406. /**
  141407. * Serialize the texture to a JSON representation you could use in Parse later on
  141408. * @returns the serialized JSON representation
  141409. */
  141410. serialize(): any;
  141411. }
  141412. }
  141413. declare module BABYLON {
  141414. /**
  141415. * Block used to add support for vertex skinning (bones)
  141416. */
  141417. export class BonesBlock extends NodeMaterialBlock {
  141418. /**
  141419. * Creates a new BonesBlock
  141420. * @param name defines the block name
  141421. */
  141422. constructor(name: string);
  141423. /**
  141424. * Initialize the block and prepare the context for build
  141425. * @param state defines the state that will be used for the build
  141426. */
  141427. initialize(state: NodeMaterialBuildState): void;
  141428. /**
  141429. * Gets the current class name
  141430. * @returns the class name
  141431. */
  141432. getClassName(): string;
  141433. /**
  141434. * Gets the matrix indices input component
  141435. */
  141436. get matricesIndices(): NodeMaterialConnectionPoint;
  141437. /**
  141438. * Gets the matrix weights input component
  141439. */
  141440. get matricesWeights(): NodeMaterialConnectionPoint;
  141441. /**
  141442. * Gets the extra matrix indices input component
  141443. */
  141444. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  141445. /**
  141446. * Gets the extra matrix weights input component
  141447. */
  141448. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  141449. /**
  141450. * Gets the world input component
  141451. */
  141452. get world(): NodeMaterialConnectionPoint;
  141453. /**
  141454. * Gets the output component
  141455. */
  141456. get output(): NodeMaterialConnectionPoint;
  141457. autoConfigure(material: NodeMaterial): void;
  141458. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  141459. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141460. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141461. protected _buildBlock(state: NodeMaterialBuildState): this;
  141462. }
  141463. }
  141464. declare module BABYLON {
  141465. /**
  141466. * Block used to add support for instances
  141467. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  141468. */
  141469. export class InstancesBlock extends NodeMaterialBlock {
  141470. /**
  141471. * Creates a new InstancesBlock
  141472. * @param name defines the block name
  141473. */
  141474. constructor(name: string);
  141475. /**
  141476. * Gets the current class name
  141477. * @returns the class name
  141478. */
  141479. getClassName(): string;
  141480. /**
  141481. * Gets the first world row input component
  141482. */
  141483. get world0(): NodeMaterialConnectionPoint;
  141484. /**
  141485. * Gets the second world row input component
  141486. */
  141487. get world1(): NodeMaterialConnectionPoint;
  141488. /**
  141489. * Gets the third world row input component
  141490. */
  141491. get world2(): NodeMaterialConnectionPoint;
  141492. /**
  141493. * Gets the forth world row input component
  141494. */
  141495. get world3(): NodeMaterialConnectionPoint;
  141496. /**
  141497. * Gets the world input component
  141498. */
  141499. get world(): NodeMaterialConnectionPoint;
  141500. /**
  141501. * Gets the output component
  141502. */
  141503. get output(): NodeMaterialConnectionPoint;
  141504. /**
  141505. * Gets the isntanceID component
  141506. */
  141507. get instanceID(): NodeMaterialConnectionPoint;
  141508. autoConfigure(material: NodeMaterial): void;
  141509. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  141510. protected _buildBlock(state: NodeMaterialBuildState): this;
  141511. }
  141512. }
  141513. declare module BABYLON {
  141514. /**
  141515. * Block used to add morph targets support to vertex shader
  141516. */
  141517. export class MorphTargetsBlock extends NodeMaterialBlock {
  141518. private _repeatableContentAnchor;
  141519. /**
  141520. * Create a new MorphTargetsBlock
  141521. * @param name defines the block name
  141522. */
  141523. constructor(name: string);
  141524. /**
  141525. * Gets the current class name
  141526. * @returns the class name
  141527. */
  141528. getClassName(): string;
  141529. /**
  141530. * Gets the position input component
  141531. */
  141532. get position(): NodeMaterialConnectionPoint;
  141533. /**
  141534. * Gets the normal input component
  141535. */
  141536. get normal(): NodeMaterialConnectionPoint;
  141537. /**
  141538. * Gets the tangent input component
  141539. */
  141540. get tangent(): NodeMaterialConnectionPoint;
  141541. /**
  141542. * Gets the tangent input component
  141543. */
  141544. get uv(): NodeMaterialConnectionPoint;
  141545. /**
  141546. * Gets the position output component
  141547. */
  141548. get positionOutput(): NodeMaterialConnectionPoint;
  141549. /**
  141550. * Gets the normal output component
  141551. */
  141552. get normalOutput(): NodeMaterialConnectionPoint;
  141553. /**
  141554. * Gets the tangent output component
  141555. */
  141556. get tangentOutput(): NodeMaterialConnectionPoint;
  141557. /**
  141558. * Gets the tangent output component
  141559. */
  141560. get uvOutput(): NodeMaterialConnectionPoint;
  141561. initialize(state: NodeMaterialBuildState): void;
  141562. autoConfigure(material: NodeMaterial): void;
  141563. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141564. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141565. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  141566. protected _buildBlock(state: NodeMaterialBuildState): this;
  141567. }
  141568. }
  141569. declare module BABYLON {
  141570. /**
  141571. * Block used to get data information from a light
  141572. */
  141573. export class LightInformationBlock extends NodeMaterialBlock {
  141574. private _lightDataUniformName;
  141575. private _lightColorUniformName;
  141576. private _lightTypeDefineName;
  141577. /**
  141578. * Gets or sets the light associated with this block
  141579. */
  141580. light: Nullable<Light>;
  141581. /**
  141582. * Creates a new LightInformationBlock
  141583. * @param name defines the block name
  141584. */
  141585. constructor(name: string);
  141586. /**
  141587. * Gets the current class name
  141588. * @returns the class name
  141589. */
  141590. getClassName(): string;
  141591. /**
  141592. * Gets the world position input component
  141593. */
  141594. get worldPosition(): NodeMaterialConnectionPoint;
  141595. /**
  141596. * Gets the direction output component
  141597. */
  141598. get direction(): NodeMaterialConnectionPoint;
  141599. /**
  141600. * Gets the direction output component
  141601. */
  141602. get color(): NodeMaterialConnectionPoint;
  141603. /**
  141604. * Gets the direction output component
  141605. */
  141606. get intensity(): NodeMaterialConnectionPoint;
  141607. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141608. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141609. protected _buildBlock(state: NodeMaterialBuildState): this;
  141610. serialize(): any;
  141611. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141612. }
  141613. }
  141614. declare module BABYLON {
  141615. /**
  141616. * Block used to add image processing support to fragment shader
  141617. */
  141618. export class ImageProcessingBlock extends NodeMaterialBlock {
  141619. /**
  141620. * Create a new ImageProcessingBlock
  141621. * @param name defines the block name
  141622. */
  141623. constructor(name: string);
  141624. /**
  141625. * Gets the current class name
  141626. * @returns the class name
  141627. */
  141628. getClassName(): string;
  141629. /**
  141630. * Gets the color input component
  141631. */
  141632. get color(): NodeMaterialConnectionPoint;
  141633. /**
  141634. * Gets the output component
  141635. */
  141636. get output(): NodeMaterialConnectionPoint;
  141637. /**
  141638. * Initialize the block and prepare the context for build
  141639. * @param state defines the state that will be used for the build
  141640. */
  141641. initialize(state: NodeMaterialBuildState): void;
  141642. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  141643. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141644. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141645. protected _buildBlock(state: NodeMaterialBuildState): this;
  141646. }
  141647. }
  141648. declare module BABYLON {
  141649. /**
  141650. * Block used to pertub normals based on a normal map
  141651. */
  141652. export class PerturbNormalBlock extends NodeMaterialBlock {
  141653. private _tangentSpaceParameterName;
  141654. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  141655. invertX: boolean;
  141656. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  141657. invertY: boolean;
  141658. /**
  141659. * Create a new PerturbNormalBlock
  141660. * @param name defines the block name
  141661. */
  141662. constructor(name: string);
  141663. /**
  141664. * Gets the current class name
  141665. * @returns the class name
  141666. */
  141667. getClassName(): string;
  141668. /**
  141669. * Gets the world position input component
  141670. */
  141671. get worldPosition(): NodeMaterialConnectionPoint;
  141672. /**
  141673. * Gets the world normal input component
  141674. */
  141675. get worldNormal(): NodeMaterialConnectionPoint;
  141676. /**
  141677. * Gets the world tangent input component
  141678. */
  141679. get worldTangent(): NodeMaterialConnectionPoint;
  141680. /**
  141681. * Gets the uv input component
  141682. */
  141683. get uv(): NodeMaterialConnectionPoint;
  141684. /**
  141685. * Gets the normal map color input component
  141686. */
  141687. get normalMapColor(): NodeMaterialConnectionPoint;
  141688. /**
  141689. * Gets the strength input component
  141690. */
  141691. get strength(): NodeMaterialConnectionPoint;
  141692. /**
  141693. * Gets the output component
  141694. */
  141695. get output(): NodeMaterialConnectionPoint;
  141696. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141697. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141698. autoConfigure(material: NodeMaterial): void;
  141699. protected _buildBlock(state: NodeMaterialBuildState): this;
  141700. protected _dumpPropertiesCode(): string;
  141701. serialize(): any;
  141702. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141703. }
  141704. }
  141705. declare module BABYLON {
  141706. /**
  141707. * Block used to discard a pixel if a value is smaller than a cutoff
  141708. */
  141709. export class DiscardBlock extends NodeMaterialBlock {
  141710. /**
  141711. * Create a new DiscardBlock
  141712. * @param name defines the block name
  141713. */
  141714. constructor(name: string);
  141715. /**
  141716. * Gets the current class name
  141717. * @returns the class name
  141718. */
  141719. getClassName(): string;
  141720. /**
  141721. * Gets the color input component
  141722. */
  141723. get value(): NodeMaterialConnectionPoint;
  141724. /**
  141725. * Gets the cutoff input component
  141726. */
  141727. get cutoff(): NodeMaterialConnectionPoint;
  141728. protected _buildBlock(state: NodeMaterialBuildState): this;
  141729. }
  141730. }
  141731. declare module BABYLON {
  141732. /**
  141733. * Block used to test if the fragment shader is front facing
  141734. */
  141735. export class FrontFacingBlock extends NodeMaterialBlock {
  141736. /**
  141737. * Creates a new FrontFacingBlock
  141738. * @param name defines the block name
  141739. */
  141740. constructor(name: string);
  141741. /**
  141742. * Gets the current class name
  141743. * @returns the class name
  141744. */
  141745. getClassName(): string;
  141746. /**
  141747. * Gets the output component
  141748. */
  141749. get output(): NodeMaterialConnectionPoint;
  141750. protected _buildBlock(state: NodeMaterialBuildState): this;
  141751. }
  141752. }
  141753. declare module BABYLON {
  141754. /**
  141755. * Block used to get the derivative value on x and y of a given input
  141756. */
  141757. export class DerivativeBlock extends NodeMaterialBlock {
  141758. /**
  141759. * Create a new DerivativeBlock
  141760. * @param name defines the block name
  141761. */
  141762. constructor(name: string);
  141763. /**
  141764. * Gets the current class name
  141765. * @returns the class name
  141766. */
  141767. getClassName(): string;
  141768. /**
  141769. * Gets the input component
  141770. */
  141771. get input(): NodeMaterialConnectionPoint;
  141772. /**
  141773. * Gets the derivative output on x
  141774. */
  141775. get dx(): NodeMaterialConnectionPoint;
  141776. /**
  141777. * Gets the derivative output on y
  141778. */
  141779. get dy(): NodeMaterialConnectionPoint;
  141780. protected _buildBlock(state: NodeMaterialBuildState): this;
  141781. }
  141782. }
  141783. declare module BABYLON {
  141784. /**
  141785. * Block used to make gl_FragCoord available
  141786. */
  141787. export class FragCoordBlock extends NodeMaterialBlock {
  141788. /**
  141789. * Creates a new FragCoordBlock
  141790. * @param name defines the block name
  141791. */
  141792. constructor(name: string);
  141793. /**
  141794. * Gets the current class name
  141795. * @returns the class name
  141796. */
  141797. getClassName(): string;
  141798. /**
  141799. * Gets the xy component
  141800. */
  141801. get xy(): NodeMaterialConnectionPoint;
  141802. /**
  141803. * Gets the xyz component
  141804. */
  141805. get xyz(): NodeMaterialConnectionPoint;
  141806. /**
  141807. * Gets the xyzw component
  141808. */
  141809. get xyzw(): NodeMaterialConnectionPoint;
  141810. /**
  141811. * Gets the x component
  141812. */
  141813. get x(): NodeMaterialConnectionPoint;
  141814. /**
  141815. * Gets the y component
  141816. */
  141817. get y(): NodeMaterialConnectionPoint;
  141818. /**
  141819. * Gets the z component
  141820. */
  141821. get z(): NodeMaterialConnectionPoint;
  141822. /**
  141823. * Gets the w component
  141824. */
  141825. get output(): NodeMaterialConnectionPoint;
  141826. protected writeOutputs(state: NodeMaterialBuildState): string;
  141827. protected _buildBlock(state: NodeMaterialBuildState): this;
  141828. }
  141829. }
  141830. declare module BABYLON {
  141831. /**
  141832. * Block used to get the screen sizes
  141833. */
  141834. export class ScreenSizeBlock extends NodeMaterialBlock {
  141835. private _varName;
  141836. private _scene;
  141837. /**
  141838. * Creates a new ScreenSizeBlock
  141839. * @param name defines the block name
  141840. */
  141841. constructor(name: string);
  141842. /**
  141843. * Gets the current class name
  141844. * @returns the class name
  141845. */
  141846. getClassName(): string;
  141847. /**
  141848. * Gets the xy component
  141849. */
  141850. get xy(): NodeMaterialConnectionPoint;
  141851. /**
  141852. * Gets the x component
  141853. */
  141854. get x(): NodeMaterialConnectionPoint;
  141855. /**
  141856. * Gets the y component
  141857. */
  141858. get y(): NodeMaterialConnectionPoint;
  141859. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141860. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  141861. protected _buildBlock(state: NodeMaterialBuildState): this;
  141862. }
  141863. }
  141864. declare module BABYLON {
  141865. /**
  141866. * Block used to add support for scene fog
  141867. */
  141868. export class FogBlock extends NodeMaterialBlock {
  141869. private _fogDistanceName;
  141870. private _fogParameters;
  141871. /**
  141872. * Create a new FogBlock
  141873. * @param name defines the block name
  141874. */
  141875. constructor(name: string);
  141876. /**
  141877. * Gets the current class name
  141878. * @returns the class name
  141879. */
  141880. getClassName(): string;
  141881. /**
  141882. * Gets the world position input component
  141883. */
  141884. get worldPosition(): NodeMaterialConnectionPoint;
  141885. /**
  141886. * Gets the view input component
  141887. */
  141888. get view(): NodeMaterialConnectionPoint;
  141889. /**
  141890. * Gets the color input component
  141891. */
  141892. get input(): NodeMaterialConnectionPoint;
  141893. /**
  141894. * Gets the fog color input component
  141895. */
  141896. get fogColor(): NodeMaterialConnectionPoint;
  141897. /**
  141898. * Gets the output component
  141899. */
  141900. get output(): NodeMaterialConnectionPoint;
  141901. autoConfigure(material: NodeMaterial): void;
  141902. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141903. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141904. protected _buildBlock(state: NodeMaterialBuildState): this;
  141905. }
  141906. }
  141907. declare module BABYLON {
  141908. /**
  141909. * Block used to add light in the fragment shader
  141910. */
  141911. export class LightBlock extends NodeMaterialBlock {
  141912. private _lightId;
  141913. /**
  141914. * Gets or sets the light associated with this block
  141915. */
  141916. light: Nullable<Light>;
  141917. /**
  141918. * Create a new LightBlock
  141919. * @param name defines the block name
  141920. */
  141921. constructor(name: string);
  141922. /**
  141923. * Gets the current class name
  141924. * @returns the class name
  141925. */
  141926. getClassName(): string;
  141927. /**
  141928. * Gets the world position input component
  141929. */
  141930. get worldPosition(): NodeMaterialConnectionPoint;
  141931. /**
  141932. * Gets the world normal input component
  141933. */
  141934. get worldNormal(): NodeMaterialConnectionPoint;
  141935. /**
  141936. * Gets the camera (or eye) position component
  141937. */
  141938. get cameraPosition(): NodeMaterialConnectionPoint;
  141939. /**
  141940. * Gets the glossiness component
  141941. */
  141942. get glossiness(): NodeMaterialConnectionPoint;
  141943. /**
  141944. * Gets the glossinness power component
  141945. */
  141946. get glossPower(): NodeMaterialConnectionPoint;
  141947. /**
  141948. * Gets the diffuse color component
  141949. */
  141950. get diffuseColor(): NodeMaterialConnectionPoint;
  141951. /**
  141952. * Gets the specular color component
  141953. */
  141954. get specularColor(): NodeMaterialConnectionPoint;
  141955. /**
  141956. * Gets the diffuse output component
  141957. */
  141958. get diffuseOutput(): NodeMaterialConnectionPoint;
  141959. /**
  141960. * Gets the specular output component
  141961. */
  141962. get specularOutput(): NodeMaterialConnectionPoint;
  141963. /**
  141964. * Gets the shadow output component
  141965. */
  141966. get shadow(): NodeMaterialConnectionPoint;
  141967. autoConfigure(material: NodeMaterial): void;
  141968. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141969. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  141970. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141971. private _injectVertexCode;
  141972. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  141973. serialize(): any;
  141974. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141975. }
  141976. }
  141977. declare module BABYLON {
  141978. /**
  141979. * Block used to read a reflection texture from a sampler
  141980. */
  141981. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  141982. /**
  141983. * Create a new ReflectionTextureBlock
  141984. * @param name defines the block name
  141985. */
  141986. constructor(name: string);
  141987. /**
  141988. * Gets the current class name
  141989. * @returns the class name
  141990. */
  141991. getClassName(): string;
  141992. /**
  141993. * Gets the world position input component
  141994. */
  141995. get position(): NodeMaterialConnectionPoint;
  141996. /**
  141997. * Gets the world position input component
  141998. */
  141999. get worldPosition(): NodeMaterialConnectionPoint;
  142000. /**
  142001. * Gets the world normal input component
  142002. */
  142003. get worldNormal(): NodeMaterialConnectionPoint;
  142004. /**
  142005. * Gets the world input component
  142006. */
  142007. get world(): NodeMaterialConnectionPoint;
  142008. /**
  142009. * Gets the camera (or eye) position component
  142010. */
  142011. get cameraPosition(): NodeMaterialConnectionPoint;
  142012. /**
  142013. * Gets the view input component
  142014. */
  142015. get view(): NodeMaterialConnectionPoint;
  142016. /**
  142017. * Gets the rgb output component
  142018. */
  142019. get rgb(): NodeMaterialConnectionPoint;
  142020. /**
  142021. * Gets the rgba output component
  142022. */
  142023. get rgba(): NodeMaterialConnectionPoint;
  142024. /**
  142025. * Gets the r output component
  142026. */
  142027. get r(): NodeMaterialConnectionPoint;
  142028. /**
  142029. * Gets the g output component
  142030. */
  142031. get g(): NodeMaterialConnectionPoint;
  142032. /**
  142033. * Gets the b output component
  142034. */
  142035. get b(): NodeMaterialConnectionPoint;
  142036. /**
  142037. * Gets the a output component
  142038. */
  142039. get a(): NodeMaterialConnectionPoint;
  142040. autoConfigure(material: NodeMaterial): void;
  142041. protected _buildBlock(state: NodeMaterialBuildState): this;
  142042. }
  142043. }
  142044. declare module BABYLON {
  142045. /**
  142046. * Block used to add 2 vectors
  142047. */
  142048. export class AddBlock extends NodeMaterialBlock {
  142049. /**
  142050. * Creates a new AddBlock
  142051. * @param name defines the block name
  142052. */
  142053. constructor(name: string);
  142054. /**
  142055. * Gets the current class name
  142056. * @returns the class name
  142057. */
  142058. getClassName(): string;
  142059. /**
  142060. * Gets the left operand input component
  142061. */
  142062. get left(): NodeMaterialConnectionPoint;
  142063. /**
  142064. * Gets the right operand input component
  142065. */
  142066. get right(): NodeMaterialConnectionPoint;
  142067. /**
  142068. * Gets the output component
  142069. */
  142070. get output(): NodeMaterialConnectionPoint;
  142071. protected _buildBlock(state: NodeMaterialBuildState): this;
  142072. }
  142073. }
  142074. declare module BABYLON {
  142075. /**
  142076. * Block used to scale a vector by a float
  142077. */
  142078. export class ScaleBlock extends NodeMaterialBlock {
  142079. /**
  142080. * Creates a new ScaleBlock
  142081. * @param name defines the block name
  142082. */
  142083. constructor(name: string);
  142084. /**
  142085. * Gets the current class name
  142086. * @returns the class name
  142087. */
  142088. getClassName(): string;
  142089. /**
  142090. * Gets the input component
  142091. */
  142092. get input(): NodeMaterialConnectionPoint;
  142093. /**
  142094. * Gets the factor input component
  142095. */
  142096. get factor(): NodeMaterialConnectionPoint;
  142097. /**
  142098. * Gets the output component
  142099. */
  142100. get output(): NodeMaterialConnectionPoint;
  142101. protected _buildBlock(state: NodeMaterialBuildState): this;
  142102. }
  142103. }
  142104. declare module BABYLON {
  142105. /**
  142106. * Block used to clamp a float
  142107. */
  142108. export class ClampBlock extends NodeMaterialBlock {
  142109. /** Gets or sets the minimum range */
  142110. minimum: number;
  142111. /** Gets or sets the maximum range */
  142112. maximum: number;
  142113. /**
  142114. * Creates a new ClampBlock
  142115. * @param name defines the block name
  142116. */
  142117. constructor(name: string);
  142118. /**
  142119. * Gets the current class name
  142120. * @returns the class name
  142121. */
  142122. getClassName(): string;
  142123. /**
  142124. * Gets the value input component
  142125. */
  142126. get value(): NodeMaterialConnectionPoint;
  142127. /**
  142128. * Gets the output component
  142129. */
  142130. get output(): NodeMaterialConnectionPoint;
  142131. protected _buildBlock(state: NodeMaterialBuildState): this;
  142132. protected _dumpPropertiesCode(): string;
  142133. serialize(): any;
  142134. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142135. }
  142136. }
  142137. declare module BABYLON {
  142138. /**
  142139. * Block used to apply a cross product between 2 vectors
  142140. */
  142141. export class CrossBlock extends NodeMaterialBlock {
  142142. /**
  142143. * Creates a new CrossBlock
  142144. * @param name defines the block name
  142145. */
  142146. constructor(name: string);
  142147. /**
  142148. * Gets the current class name
  142149. * @returns the class name
  142150. */
  142151. getClassName(): string;
  142152. /**
  142153. * Gets the left operand input component
  142154. */
  142155. get left(): NodeMaterialConnectionPoint;
  142156. /**
  142157. * Gets the right operand input component
  142158. */
  142159. get right(): NodeMaterialConnectionPoint;
  142160. /**
  142161. * Gets the output component
  142162. */
  142163. get output(): NodeMaterialConnectionPoint;
  142164. protected _buildBlock(state: NodeMaterialBuildState): this;
  142165. }
  142166. }
  142167. declare module BABYLON {
  142168. /**
  142169. * Block used to apply a dot product between 2 vectors
  142170. */
  142171. export class DotBlock extends NodeMaterialBlock {
  142172. /**
  142173. * Creates a new DotBlock
  142174. * @param name defines the block name
  142175. */
  142176. constructor(name: string);
  142177. /**
  142178. * Gets the current class name
  142179. * @returns the class name
  142180. */
  142181. getClassName(): string;
  142182. /**
  142183. * Gets the left operand input component
  142184. */
  142185. get left(): NodeMaterialConnectionPoint;
  142186. /**
  142187. * Gets the right operand input component
  142188. */
  142189. get right(): NodeMaterialConnectionPoint;
  142190. /**
  142191. * Gets the output component
  142192. */
  142193. get output(): NodeMaterialConnectionPoint;
  142194. protected _buildBlock(state: NodeMaterialBuildState): this;
  142195. }
  142196. }
  142197. declare module BABYLON {
  142198. /**
  142199. * Block used to normalize a vector
  142200. */
  142201. export class NormalizeBlock extends NodeMaterialBlock {
  142202. /**
  142203. * Creates a new NormalizeBlock
  142204. * @param name defines the block name
  142205. */
  142206. constructor(name: string);
  142207. /**
  142208. * Gets the current class name
  142209. * @returns the class name
  142210. */
  142211. getClassName(): string;
  142212. /**
  142213. * Gets the input component
  142214. */
  142215. get input(): NodeMaterialConnectionPoint;
  142216. /**
  142217. * Gets the output component
  142218. */
  142219. get output(): NodeMaterialConnectionPoint;
  142220. protected _buildBlock(state: NodeMaterialBuildState): this;
  142221. }
  142222. }
  142223. declare module BABYLON {
  142224. /**
  142225. * Operations supported by the Trigonometry block
  142226. */
  142227. export enum TrigonometryBlockOperations {
  142228. /** Cos */
  142229. Cos = 0,
  142230. /** Sin */
  142231. Sin = 1,
  142232. /** Abs */
  142233. Abs = 2,
  142234. /** Exp */
  142235. Exp = 3,
  142236. /** Exp2 */
  142237. Exp2 = 4,
  142238. /** Round */
  142239. Round = 5,
  142240. /** Floor */
  142241. Floor = 6,
  142242. /** Ceiling */
  142243. Ceiling = 7,
  142244. /** Square root */
  142245. Sqrt = 8,
  142246. /** Log */
  142247. Log = 9,
  142248. /** Tangent */
  142249. Tan = 10,
  142250. /** Arc tangent */
  142251. ArcTan = 11,
  142252. /** Arc cosinus */
  142253. ArcCos = 12,
  142254. /** Arc sinus */
  142255. ArcSin = 13,
  142256. /** Fraction */
  142257. Fract = 14,
  142258. /** Sign */
  142259. Sign = 15,
  142260. /** To radians (from degrees) */
  142261. Radians = 16,
  142262. /** To degrees (from radians) */
  142263. Degrees = 17
  142264. }
  142265. /**
  142266. * Block used to apply trigonometry operation to floats
  142267. */
  142268. export class TrigonometryBlock extends NodeMaterialBlock {
  142269. /**
  142270. * Gets or sets the operation applied by the block
  142271. */
  142272. operation: TrigonometryBlockOperations;
  142273. /**
  142274. * Creates a new TrigonometryBlock
  142275. * @param name defines the block name
  142276. */
  142277. constructor(name: string);
  142278. /**
  142279. * Gets the current class name
  142280. * @returns the class name
  142281. */
  142282. getClassName(): string;
  142283. /**
  142284. * Gets the input component
  142285. */
  142286. get input(): NodeMaterialConnectionPoint;
  142287. /**
  142288. * Gets the output component
  142289. */
  142290. get output(): NodeMaterialConnectionPoint;
  142291. protected _buildBlock(state: NodeMaterialBuildState): this;
  142292. serialize(): any;
  142293. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142294. protected _dumpPropertiesCode(): string;
  142295. }
  142296. }
  142297. declare module BABYLON {
  142298. /**
  142299. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142300. */
  142301. export class ColorMergerBlock extends NodeMaterialBlock {
  142302. /**
  142303. * Create a new ColorMergerBlock
  142304. * @param name defines the block name
  142305. */
  142306. constructor(name: string);
  142307. /**
  142308. * Gets the current class name
  142309. * @returns the class name
  142310. */
  142311. getClassName(): string;
  142312. /**
  142313. * Gets the rgb component (input)
  142314. */
  142315. get rgbIn(): NodeMaterialConnectionPoint;
  142316. /**
  142317. * Gets the r component (input)
  142318. */
  142319. get r(): NodeMaterialConnectionPoint;
  142320. /**
  142321. * Gets the g component (input)
  142322. */
  142323. get g(): NodeMaterialConnectionPoint;
  142324. /**
  142325. * Gets the b component (input)
  142326. */
  142327. get b(): NodeMaterialConnectionPoint;
  142328. /**
  142329. * Gets the a component (input)
  142330. */
  142331. get a(): NodeMaterialConnectionPoint;
  142332. /**
  142333. * Gets the rgba component (output)
  142334. */
  142335. get rgba(): NodeMaterialConnectionPoint;
  142336. /**
  142337. * Gets the rgb component (output)
  142338. */
  142339. get rgbOut(): NodeMaterialConnectionPoint;
  142340. /**
  142341. * Gets the rgb component (output)
  142342. * @deprecated Please use rgbOut instead.
  142343. */
  142344. get rgb(): NodeMaterialConnectionPoint;
  142345. protected _buildBlock(state: NodeMaterialBuildState): this;
  142346. }
  142347. }
  142348. declare module BABYLON {
  142349. /**
  142350. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142351. */
  142352. export class VectorSplitterBlock extends NodeMaterialBlock {
  142353. /**
  142354. * Create a new VectorSplitterBlock
  142355. * @param name defines the block name
  142356. */
  142357. constructor(name: string);
  142358. /**
  142359. * Gets the current class name
  142360. * @returns the class name
  142361. */
  142362. getClassName(): string;
  142363. /**
  142364. * Gets the xyzw component (input)
  142365. */
  142366. get xyzw(): NodeMaterialConnectionPoint;
  142367. /**
  142368. * Gets the xyz component (input)
  142369. */
  142370. get xyzIn(): NodeMaterialConnectionPoint;
  142371. /**
  142372. * Gets the xy component (input)
  142373. */
  142374. get xyIn(): NodeMaterialConnectionPoint;
  142375. /**
  142376. * Gets the xyz component (output)
  142377. */
  142378. get xyzOut(): NodeMaterialConnectionPoint;
  142379. /**
  142380. * Gets the xy component (output)
  142381. */
  142382. get xyOut(): NodeMaterialConnectionPoint;
  142383. /**
  142384. * Gets the x component (output)
  142385. */
  142386. get x(): NodeMaterialConnectionPoint;
  142387. /**
  142388. * Gets the y component (output)
  142389. */
  142390. get y(): NodeMaterialConnectionPoint;
  142391. /**
  142392. * Gets the z component (output)
  142393. */
  142394. get z(): NodeMaterialConnectionPoint;
  142395. /**
  142396. * Gets the w component (output)
  142397. */
  142398. get w(): NodeMaterialConnectionPoint;
  142399. protected _inputRename(name: string): string;
  142400. protected _outputRename(name: string): string;
  142401. protected _buildBlock(state: NodeMaterialBuildState): this;
  142402. }
  142403. }
  142404. declare module BABYLON {
  142405. /**
  142406. * Block used to lerp between 2 values
  142407. */
  142408. export class LerpBlock extends NodeMaterialBlock {
  142409. /**
  142410. * Creates a new LerpBlock
  142411. * @param name defines the block name
  142412. */
  142413. constructor(name: string);
  142414. /**
  142415. * Gets the current class name
  142416. * @returns the class name
  142417. */
  142418. getClassName(): string;
  142419. /**
  142420. * Gets the left operand input component
  142421. */
  142422. get left(): NodeMaterialConnectionPoint;
  142423. /**
  142424. * Gets the right operand input component
  142425. */
  142426. get right(): NodeMaterialConnectionPoint;
  142427. /**
  142428. * Gets the gradient operand input component
  142429. */
  142430. get gradient(): NodeMaterialConnectionPoint;
  142431. /**
  142432. * Gets the output component
  142433. */
  142434. get output(): NodeMaterialConnectionPoint;
  142435. protected _buildBlock(state: NodeMaterialBuildState): this;
  142436. }
  142437. }
  142438. declare module BABYLON {
  142439. /**
  142440. * Block used to divide 2 vectors
  142441. */
  142442. export class DivideBlock extends NodeMaterialBlock {
  142443. /**
  142444. * Creates a new DivideBlock
  142445. * @param name defines the block name
  142446. */
  142447. constructor(name: string);
  142448. /**
  142449. * Gets the current class name
  142450. * @returns the class name
  142451. */
  142452. getClassName(): string;
  142453. /**
  142454. * Gets the left operand input component
  142455. */
  142456. get left(): NodeMaterialConnectionPoint;
  142457. /**
  142458. * Gets the right operand input component
  142459. */
  142460. get right(): NodeMaterialConnectionPoint;
  142461. /**
  142462. * Gets the output component
  142463. */
  142464. get output(): NodeMaterialConnectionPoint;
  142465. protected _buildBlock(state: NodeMaterialBuildState): this;
  142466. }
  142467. }
  142468. declare module BABYLON {
  142469. /**
  142470. * Block used to subtract 2 vectors
  142471. */
  142472. export class SubtractBlock extends NodeMaterialBlock {
  142473. /**
  142474. * Creates a new SubtractBlock
  142475. * @param name defines the block name
  142476. */
  142477. constructor(name: string);
  142478. /**
  142479. * Gets the current class name
  142480. * @returns the class name
  142481. */
  142482. getClassName(): string;
  142483. /**
  142484. * Gets the left operand input component
  142485. */
  142486. get left(): NodeMaterialConnectionPoint;
  142487. /**
  142488. * Gets the right operand input component
  142489. */
  142490. get right(): NodeMaterialConnectionPoint;
  142491. /**
  142492. * Gets the output component
  142493. */
  142494. get output(): NodeMaterialConnectionPoint;
  142495. protected _buildBlock(state: NodeMaterialBuildState): this;
  142496. }
  142497. }
  142498. declare module BABYLON {
  142499. /**
  142500. * Block used to step a value
  142501. */
  142502. export class StepBlock extends NodeMaterialBlock {
  142503. /**
  142504. * Creates a new StepBlock
  142505. * @param name defines the block name
  142506. */
  142507. constructor(name: string);
  142508. /**
  142509. * Gets the current class name
  142510. * @returns the class name
  142511. */
  142512. getClassName(): string;
  142513. /**
  142514. * Gets the value operand input component
  142515. */
  142516. get value(): NodeMaterialConnectionPoint;
  142517. /**
  142518. * Gets the edge operand input component
  142519. */
  142520. get edge(): NodeMaterialConnectionPoint;
  142521. /**
  142522. * Gets the output component
  142523. */
  142524. get output(): NodeMaterialConnectionPoint;
  142525. protected _buildBlock(state: NodeMaterialBuildState): this;
  142526. }
  142527. }
  142528. declare module BABYLON {
  142529. /**
  142530. * Block used to get the opposite (1 - x) of a value
  142531. */
  142532. export class OneMinusBlock extends NodeMaterialBlock {
  142533. /**
  142534. * Creates a new OneMinusBlock
  142535. * @param name defines the block name
  142536. */
  142537. constructor(name: string);
  142538. /**
  142539. * Gets the current class name
  142540. * @returns the class name
  142541. */
  142542. getClassName(): string;
  142543. /**
  142544. * Gets the input component
  142545. */
  142546. get input(): NodeMaterialConnectionPoint;
  142547. /**
  142548. * Gets the output component
  142549. */
  142550. get output(): NodeMaterialConnectionPoint;
  142551. protected _buildBlock(state: NodeMaterialBuildState): this;
  142552. }
  142553. }
  142554. declare module BABYLON {
  142555. /**
  142556. * Block used to get the view direction
  142557. */
  142558. export class ViewDirectionBlock extends NodeMaterialBlock {
  142559. /**
  142560. * Creates a new ViewDirectionBlock
  142561. * @param name defines the block name
  142562. */
  142563. constructor(name: string);
  142564. /**
  142565. * Gets the current class name
  142566. * @returns the class name
  142567. */
  142568. getClassName(): string;
  142569. /**
  142570. * Gets the world position component
  142571. */
  142572. get worldPosition(): NodeMaterialConnectionPoint;
  142573. /**
  142574. * Gets the camera position component
  142575. */
  142576. get cameraPosition(): NodeMaterialConnectionPoint;
  142577. /**
  142578. * Gets the output component
  142579. */
  142580. get output(): NodeMaterialConnectionPoint;
  142581. autoConfigure(material: NodeMaterial): void;
  142582. protected _buildBlock(state: NodeMaterialBuildState): this;
  142583. }
  142584. }
  142585. declare module BABYLON {
  142586. /**
  142587. * Block used to compute fresnel value
  142588. */
  142589. export class FresnelBlock extends NodeMaterialBlock {
  142590. /**
  142591. * Create a new FresnelBlock
  142592. * @param name defines the block name
  142593. */
  142594. constructor(name: string);
  142595. /**
  142596. * Gets the current class name
  142597. * @returns the class name
  142598. */
  142599. getClassName(): string;
  142600. /**
  142601. * Gets the world normal input component
  142602. */
  142603. get worldNormal(): NodeMaterialConnectionPoint;
  142604. /**
  142605. * Gets the view direction input component
  142606. */
  142607. get viewDirection(): NodeMaterialConnectionPoint;
  142608. /**
  142609. * Gets the bias input component
  142610. */
  142611. get bias(): NodeMaterialConnectionPoint;
  142612. /**
  142613. * Gets the camera (or eye) position component
  142614. */
  142615. get power(): NodeMaterialConnectionPoint;
  142616. /**
  142617. * Gets the fresnel output component
  142618. */
  142619. get fresnel(): NodeMaterialConnectionPoint;
  142620. autoConfigure(material: NodeMaterial): void;
  142621. protected _buildBlock(state: NodeMaterialBuildState): this;
  142622. }
  142623. }
  142624. declare module BABYLON {
  142625. /**
  142626. * Block used to get the max of 2 values
  142627. */
  142628. export class MaxBlock extends NodeMaterialBlock {
  142629. /**
  142630. * Creates a new MaxBlock
  142631. * @param name defines the block name
  142632. */
  142633. constructor(name: string);
  142634. /**
  142635. * Gets the current class name
  142636. * @returns the class name
  142637. */
  142638. getClassName(): string;
  142639. /**
  142640. * Gets the left operand input component
  142641. */
  142642. get left(): NodeMaterialConnectionPoint;
  142643. /**
  142644. * Gets the right operand input component
  142645. */
  142646. get right(): NodeMaterialConnectionPoint;
  142647. /**
  142648. * Gets the output component
  142649. */
  142650. get output(): NodeMaterialConnectionPoint;
  142651. protected _buildBlock(state: NodeMaterialBuildState): this;
  142652. }
  142653. }
  142654. declare module BABYLON {
  142655. /**
  142656. * Block used to get the min of 2 values
  142657. */
  142658. export class MinBlock extends NodeMaterialBlock {
  142659. /**
  142660. * Creates a new MinBlock
  142661. * @param name defines the block name
  142662. */
  142663. constructor(name: string);
  142664. /**
  142665. * Gets the current class name
  142666. * @returns the class name
  142667. */
  142668. getClassName(): string;
  142669. /**
  142670. * Gets the left operand input component
  142671. */
  142672. get left(): NodeMaterialConnectionPoint;
  142673. /**
  142674. * Gets the right operand input component
  142675. */
  142676. get right(): NodeMaterialConnectionPoint;
  142677. /**
  142678. * Gets the output component
  142679. */
  142680. get output(): NodeMaterialConnectionPoint;
  142681. protected _buildBlock(state: NodeMaterialBuildState): this;
  142682. }
  142683. }
  142684. declare module BABYLON {
  142685. /**
  142686. * Block used to get the distance between 2 values
  142687. */
  142688. export class DistanceBlock extends NodeMaterialBlock {
  142689. /**
  142690. * Creates a new DistanceBlock
  142691. * @param name defines the block name
  142692. */
  142693. constructor(name: string);
  142694. /**
  142695. * Gets the current class name
  142696. * @returns the class name
  142697. */
  142698. getClassName(): string;
  142699. /**
  142700. * Gets the left operand input component
  142701. */
  142702. get left(): NodeMaterialConnectionPoint;
  142703. /**
  142704. * Gets the right operand input component
  142705. */
  142706. get right(): NodeMaterialConnectionPoint;
  142707. /**
  142708. * Gets the output component
  142709. */
  142710. get output(): NodeMaterialConnectionPoint;
  142711. protected _buildBlock(state: NodeMaterialBuildState): this;
  142712. }
  142713. }
  142714. declare module BABYLON {
  142715. /**
  142716. * Block used to get the length of a vector
  142717. */
  142718. export class LengthBlock extends NodeMaterialBlock {
  142719. /**
  142720. * Creates a new LengthBlock
  142721. * @param name defines the block name
  142722. */
  142723. constructor(name: string);
  142724. /**
  142725. * Gets the current class name
  142726. * @returns the class name
  142727. */
  142728. getClassName(): string;
  142729. /**
  142730. * Gets the value input component
  142731. */
  142732. get value(): NodeMaterialConnectionPoint;
  142733. /**
  142734. * Gets the output component
  142735. */
  142736. get output(): NodeMaterialConnectionPoint;
  142737. protected _buildBlock(state: NodeMaterialBuildState): this;
  142738. }
  142739. }
  142740. declare module BABYLON {
  142741. /**
  142742. * Block used to get negative version of a value (i.e. x * -1)
  142743. */
  142744. export class NegateBlock extends NodeMaterialBlock {
  142745. /**
  142746. * Creates a new NegateBlock
  142747. * @param name defines the block name
  142748. */
  142749. constructor(name: string);
  142750. /**
  142751. * Gets the current class name
  142752. * @returns the class name
  142753. */
  142754. getClassName(): string;
  142755. /**
  142756. * Gets the value input component
  142757. */
  142758. get value(): NodeMaterialConnectionPoint;
  142759. /**
  142760. * Gets the output component
  142761. */
  142762. get output(): NodeMaterialConnectionPoint;
  142763. protected _buildBlock(state: NodeMaterialBuildState): this;
  142764. }
  142765. }
  142766. declare module BABYLON {
  142767. /**
  142768. * Block used to get the value of the first parameter raised to the power of the second
  142769. */
  142770. export class PowBlock extends NodeMaterialBlock {
  142771. /**
  142772. * Creates a new PowBlock
  142773. * @param name defines the block name
  142774. */
  142775. constructor(name: string);
  142776. /**
  142777. * Gets the current class name
  142778. * @returns the class name
  142779. */
  142780. getClassName(): string;
  142781. /**
  142782. * Gets the value operand input component
  142783. */
  142784. get value(): NodeMaterialConnectionPoint;
  142785. /**
  142786. * Gets the power operand input component
  142787. */
  142788. get power(): NodeMaterialConnectionPoint;
  142789. /**
  142790. * Gets the output component
  142791. */
  142792. get output(): NodeMaterialConnectionPoint;
  142793. protected _buildBlock(state: NodeMaterialBuildState): this;
  142794. }
  142795. }
  142796. declare module BABYLON {
  142797. /**
  142798. * Block used to get a random number
  142799. */
  142800. export class RandomNumberBlock extends NodeMaterialBlock {
  142801. /**
  142802. * Creates a new RandomNumberBlock
  142803. * @param name defines the block name
  142804. */
  142805. constructor(name: string);
  142806. /**
  142807. * Gets the current class name
  142808. * @returns the class name
  142809. */
  142810. getClassName(): string;
  142811. /**
  142812. * Gets the seed input component
  142813. */
  142814. get seed(): NodeMaterialConnectionPoint;
  142815. /**
  142816. * Gets the output component
  142817. */
  142818. get output(): NodeMaterialConnectionPoint;
  142819. protected _buildBlock(state: NodeMaterialBuildState): this;
  142820. }
  142821. }
  142822. declare module BABYLON {
  142823. /**
  142824. * Block used to compute arc tangent of 2 values
  142825. */
  142826. export class ArcTan2Block extends NodeMaterialBlock {
  142827. /**
  142828. * Creates a new ArcTan2Block
  142829. * @param name defines the block name
  142830. */
  142831. constructor(name: string);
  142832. /**
  142833. * Gets the current class name
  142834. * @returns the class name
  142835. */
  142836. getClassName(): string;
  142837. /**
  142838. * Gets the x operand input component
  142839. */
  142840. get x(): NodeMaterialConnectionPoint;
  142841. /**
  142842. * Gets the y operand input component
  142843. */
  142844. get y(): NodeMaterialConnectionPoint;
  142845. /**
  142846. * Gets the output component
  142847. */
  142848. get output(): NodeMaterialConnectionPoint;
  142849. protected _buildBlock(state: NodeMaterialBuildState): this;
  142850. }
  142851. }
  142852. declare module BABYLON {
  142853. /**
  142854. * Block used to smooth step a value
  142855. */
  142856. export class SmoothStepBlock extends NodeMaterialBlock {
  142857. /**
  142858. * Creates a new SmoothStepBlock
  142859. * @param name defines the block name
  142860. */
  142861. constructor(name: string);
  142862. /**
  142863. * Gets the current class name
  142864. * @returns the class name
  142865. */
  142866. getClassName(): string;
  142867. /**
  142868. * Gets the value operand input component
  142869. */
  142870. get value(): NodeMaterialConnectionPoint;
  142871. /**
  142872. * Gets the first edge operand input component
  142873. */
  142874. get edge0(): NodeMaterialConnectionPoint;
  142875. /**
  142876. * Gets the second edge operand input component
  142877. */
  142878. get edge1(): NodeMaterialConnectionPoint;
  142879. /**
  142880. * Gets the output component
  142881. */
  142882. get output(): NodeMaterialConnectionPoint;
  142883. protected _buildBlock(state: NodeMaterialBuildState): this;
  142884. }
  142885. }
  142886. declare module BABYLON {
  142887. /**
  142888. * Block used to get the reciprocal (1 / x) of a value
  142889. */
  142890. export class ReciprocalBlock extends NodeMaterialBlock {
  142891. /**
  142892. * Creates a new ReciprocalBlock
  142893. * @param name defines the block name
  142894. */
  142895. constructor(name: string);
  142896. /**
  142897. * Gets the current class name
  142898. * @returns the class name
  142899. */
  142900. getClassName(): string;
  142901. /**
  142902. * Gets the input component
  142903. */
  142904. get input(): NodeMaterialConnectionPoint;
  142905. /**
  142906. * Gets the output component
  142907. */
  142908. get output(): NodeMaterialConnectionPoint;
  142909. protected _buildBlock(state: NodeMaterialBuildState): this;
  142910. }
  142911. }
  142912. declare module BABYLON {
  142913. /**
  142914. * Block used to replace a color by another one
  142915. */
  142916. export class ReplaceColorBlock extends NodeMaterialBlock {
  142917. /**
  142918. * Creates a new ReplaceColorBlock
  142919. * @param name defines the block name
  142920. */
  142921. constructor(name: string);
  142922. /**
  142923. * Gets the current class name
  142924. * @returns the class name
  142925. */
  142926. getClassName(): string;
  142927. /**
  142928. * Gets the value input component
  142929. */
  142930. get value(): NodeMaterialConnectionPoint;
  142931. /**
  142932. * Gets the reference input component
  142933. */
  142934. get reference(): NodeMaterialConnectionPoint;
  142935. /**
  142936. * Gets the distance input component
  142937. */
  142938. get distance(): NodeMaterialConnectionPoint;
  142939. /**
  142940. * Gets the replacement input component
  142941. */
  142942. get replacement(): NodeMaterialConnectionPoint;
  142943. /**
  142944. * Gets the output component
  142945. */
  142946. get output(): NodeMaterialConnectionPoint;
  142947. protected _buildBlock(state: NodeMaterialBuildState): this;
  142948. }
  142949. }
  142950. declare module BABYLON {
  142951. /**
  142952. * Block used to posterize a value
  142953. * @see https://en.wikipedia.org/wiki/Posterization
  142954. */
  142955. export class PosterizeBlock extends NodeMaterialBlock {
  142956. /**
  142957. * Creates a new PosterizeBlock
  142958. * @param name defines the block name
  142959. */
  142960. constructor(name: string);
  142961. /**
  142962. * Gets the current class name
  142963. * @returns the class name
  142964. */
  142965. getClassName(): string;
  142966. /**
  142967. * Gets the value input component
  142968. */
  142969. get value(): NodeMaterialConnectionPoint;
  142970. /**
  142971. * Gets the steps input component
  142972. */
  142973. get steps(): NodeMaterialConnectionPoint;
  142974. /**
  142975. * Gets the output component
  142976. */
  142977. get output(): NodeMaterialConnectionPoint;
  142978. protected _buildBlock(state: NodeMaterialBuildState): this;
  142979. }
  142980. }
  142981. declare module BABYLON {
  142982. /**
  142983. * Operations supported by the Wave block
  142984. */
  142985. export enum WaveBlockKind {
  142986. /** SawTooth */
  142987. SawTooth = 0,
  142988. /** Square */
  142989. Square = 1,
  142990. /** Triangle */
  142991. Triangle = 2
  142992. }
  142993. /**
  142994. * Block used to apply wave operation to floats
  142995. */
  142996. export class WaveBlock extends NodeMaterialBlock {
  142997. /**
  142998. * Gets or sets the kibnd of wave to be applied by the block
  142999. */
  143000. kind: WaveBlockKind;
  143001. /**
  143002. * Creates a new WaveBlock
  143003. * @param name defines the block name
  143004. */
  143005. constructor(name: string);
  143006. /**
  143007. * Gets the current class name
  143008. * @returns the class name
  143009. */
  143010. getClassName(): string;
  143011. /**
  143012. * Gets the input component
  143013. */
  143014. get input(): NodeMaterialConnectionPoint;
  143015. /**
  143016. * Gets the output component
  143017. */
  143018. get output(): NodeMaterialConnectionPoint;
  143019. protected _buildBlock(state: NodeMaterialBuildState): this;
  143020. serialize(): any;
  143021. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143022. }
  143023. }
  143024. declare module BABYLON {
  143025. /**
  143026. * Class used to store a color step for the GradientBlock
  143027. */
  143028. export class GradientBlockColorStep {
  143029. /**
  143030. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143031. */
  143032. step: number;
  143033. /**
  143034. * Gets or sets the color associated with this step
  143035. */
  143036. color: Color3;
  143037. /**
  143038. * Creates a new GradientBlockColorStep
  143039. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143040. * @param color defines the color associated with this step
  143041. */
  143042. constructor(
  143043. /**
  143044. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143045. */
  143046. step: number,
  143047. /**
  143048. * Gets or sets the color associated with this step
  143049. */
  143050. color: Color3);
  143051. }
  143052. /**
  143053. * Block used to return a color from a gradient based on an input value between 0 and 1
  143054. */
  143055. export class GradientBlock extends NodeMaterialBlock {
  143056. /**
  143057. * Gets or sets the list of color steps
  143058. */
  143059. colorSteps: GradientBlockColorStep[];
  143060. /**
  143061. * Creates a new GradientBlock
  143062. * @param name defines the block name
  143063. */
  143064. constructor(name: string);
  143065. /**
  143066. * Gets the current class name
  143067. * @returns the class name
  143068. */
  143069. getClassName(): string;
  143070. /**
  143071. * Gets the gradient input component
  143072. */
  143073. get gradient(): NodeMaterialConnectionPoint;
  143074. /**
  143075. * Gets the output component
  143076. */
  143077. get output(): NodeMaterialConnectionPoint;
  143078. private _writeColorConstant;
  143079. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143080. serialize(): any;
  143081. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143082. protected _dumpPropertiesCode(): string;
  143083. }
  143084. }
  143085. declare module BABYLON {
  143086. /**
  143087. * Block used to normalize lerp between 2 values
  143088. */
  143089. export class NLerpBlock extends NodeMaterialBlock {
  143090. /**
  143091. * Creates a new NLerpBlock
  143092. * @param name defines the block name
  143093. */
  143094. constructor(name: string);
  143095. /**
  143096. * Gets the current class name
  143097. * @returns the class name
  143098. */
  143099. getClassName(): string;
  143100. /**
  143101. * Gets the left operand input component
  143102. */
  143103. get left(): NodeMaterialConnectionPoint;
  143104. /**
  143105. * Gets the right operand input component
  143106. */
  143107. get right(): NodeMaterialConnectionPoint;
  143108. /**
  143109. * Gets the gradient operand input component
  143110. */
  143111. get gradient(): NodeMaterialConnectionPoint;
  143112. /**
  143113. * Gets the output component
  143114. */
  143115. get output(): NodeMaterialConnectionPoint;
  143116. protected _buildBlock(state: NodeMaterialBuildState): this;
  143117. }
  143118. }
  143119. declare module BABYLON {
  143120. /**
  143121. * block used to Generate a Worley Noise 3D Noise Pattern
  143122. */
  143123. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143124. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143125. manhattanDistance: boolean;
  143126. /**
  143127. * Creates a new WorleyNoise3DBlock
  143128. * @param name defines the block name
  143129. */
  143130. constructor(name: string);
  143131. /**
  143132. * Gets the current class name
  143133. * @returns the class name
  143134. */
  143135. getClassName(): string;
  143136. /**
  143137. * Gets the seed input component
  143138. */
  143139. get seed(): NodeMaterialConnectionPoint;
  143140. /**
  143141. * Gets the jitter input component
  143142. */
  143143. get jitter(): NodeMaterialConnectionPoint;
  143144. /**
  143145. * Gets the output component
  143146. */
  143147. get output(): NodeMaterialConnectionPoint;
  143148. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143149. /**
  143150. * Exposes the properties to the UI?
  143151. */
  143152. protected _dumpPropertiesCode(): string;
  143153. /**
  143154. * Exposes the properties to the Seralize?
  143155. */
  143156. serialize(): any;
  143157. /**
  143158. * Exposes the properties to the deseralize?
  143159. */
  143160. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143161. }
  143162. }
  143163. declare module BABYLON {
  143164. /**
  143165. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143166. */
  143167. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143168. /**
  143169. * Creates a new SimplexPerlin3DBlock
  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 seed operand input component
  143180. */
  143181. get seed(): NodeMaterialConnectionPoint;
  143182. /**
  143183. * Gets the output component
  143184. */
  143185. get output(): NodeMaterialConnectionPoint;
  143186. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143187. }
  143188. }
  143189. declare module BABYLON {
  143190. /**
  143191. * Block used to blend normals
  143192. */
  143193. export class NormalBlendBlock extends NodeMaterialBlock {
  143194. /**
  143195. * Creates a new NormalBlendBlock
  143196. * @param name defines the block name
  143197. */
  143198. constructor(name: string);
  143199. /**
  143200. * Gets the current class name
  143201. * @returns the class name
  143202. */
  143203. getClassName(): string;
  143204. /**
  143205. * Gets the first input component
  143206. */
  143207. get normalMap0(): NodeMaterialConnectionPoint;
  143208. /**
  143209. * Gets the second input component
  143210. */
  143211. get normalMap1(): 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 rotate a 2d vector by a given angle
  143222. */
  143223. export class Rotate2dBlock extends NodeMaterialBlock {
  143224. /**
  143225. * Creates a new Rotate2dBlock
  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 input vector
  143236. */
  143237. get input(): NodeMaterialConnectionPoint;
  143238. /**
  143239. * Gets the input angle
  143240. */
  143241. get angle(): 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 get the reflected vector from a direction and a normal
  143253. */
  143254. export class ReflectBlock extends NodeMaterialBlock {
  143255. /**
  143256. * Creates a new ReflectBlock
  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 incident component
  143267. */
  143268. get incident(): NodeMaterialConnectionPoint;
  143269. /**
  143270. * Gets the normal component
  143271. */
  143272. get normal(): NodeMaterialConnectionPoint;
  143273. /**
  143274. * Gets the output component
  143275. */
  143276. get output(): NodeMaterialConnectionPoint;
  143277. protected _buildBlock(state: NodeMaterialBuildState): this;
  143278. }
  143279. }
  143280. declare module BABYLON {
  143281. /**
  143282. * Block used to get the refracted vector from a direction and a normal
  143283. */
  143284. export class RefractBlock extends NodeMaterialBlock {
  143285. /**
  143286. * Creates a new RefractBlock
  143287. * @param name defines the block name
  143288. */
  143289. constructor(name: string);
  143290. /**
  143291. * Gets the current class name
  143292. * @returns the class name
  143293. */
  143294. getClassName(): string;
  143295. /**
  143296. * Gets the incident component
  143297. */
  143298. get incident(): NodeMaterialConnectionPoint;
  143299. /**
  143300. * Gets the normal component
  143301. */
  143302. get normal(): NodeMaterialConnectionPoint;
  143303. /**
  143304. * Gets the index of refraction component
  143305. */
  143306. get ior(): NodeMaterialConnectionPoint;
  143307. /**
  143308. * Gets the output component
  143309. */
  143310. get output(): NodeMaterialConnectionPoint;
  143311. protected _buildBlock(state: NodeMaterialBuildState): this;
  143312. }
  143313. }
  143314. declare module BABYLON {
  143315. /**
  143316. * Block used to desaturate a color
  143317. */
  143318. export class DesaturateBlock extends NodeMaterialBlock {
  143319. /**
  143320. * Creates a new DesaturateBlock
  143321. * @param name defines the block name
  143322. */
  143323. constructor(name: string);
  143324. /**
  143325. * Gets the current class name
  143326. * @returns the class name
  143327. */
  143328. getClassName(): string;
  143329. /**
  143330. * Gets the color operand input component
  143331. */
  143332. get color(): NodeMaterialConnectionPoint;
  143333. /**
  143334. * Gets the level operand input component
  143335. */
  143336. get level(): NodeMaterialConnectionPoint;
  143337. /**
  143338. * Gets the output component
  143339. */
  143340. get output(): NodeMaterialConnectionPoint;
  143341. protected _buildBlock(state: NodeMaterialBuildState): this;
  143342. }
  143343. }
  143344. declare module BABYLON {
  143345. /**
  143346. * Block used to implement the ambient occlusion module of the PBR material
  143347. */
  143348. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143349. /**
  143350. * Create a new AmbientOcclusionBlock
  143351. * @param name defines the block name
  143352. */
  143353. constructor(name: string);
  143354. /**
  143355. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143356. */
  143357. useAmbientInGrayScale: boolean;
  143358. /**
  143359. * Initialize the block and prepare the context for build
  143360. * @param state defines the state that will be used for the build
  143361. */
  143362. initialize(state: NodeMaterialBuildState): void;
  143363. /**
  143364. * Gets the current class name
  143365. * @returns the class name
  143366. */
  143367. getClassName(): string;
  143368. /**
  143369. * Gets the texture input component
  143370. */
  143371. get texture(): NodeMaterialConnectionPoint;
  143372. /**
  143373. * Gets the texture intensity component
  143374. */
  143375. get intensity(): NodeMaterialConnectionPoint;
  143376. /**
  143377. * Gets the direct light intensity input component
  143378. */
  143379. get directLightIntensity(): NodeMaterialConnectionPoint;
  143380. /**
  143381. * Gets the ambient occlusion object output component
  143382. */
  143383. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143384. /**
  143385. * Gets the main code of the block (fragment side)
  143386. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143387. * @returns the shader code
  143388. */
  143389. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143390. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143391. protected _buildBlock(state: NodeMaterialBuildState): this;
  143392. protected _dumpPropertiesCode(): string;
  143393. serialize(): any;
  143394. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143395. }
  143396. }
  143397. declare module BABYLON {
  143398. /**
  143399. * Block used to implement the reflection module of the PBR material
  143400. */
  143401. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143402. /** @hidden */
  143403. _defineLODReflectionAlpha: string;
  143404. /** @hidden */
  143405. _defineLinearSpecularReflection: string;
  143406. private _vEnvironmentIrradianceName;
  143407. /** @hidden */
  143408. _vReflectionMicrosurfaceInfosName: string;
  143409. /** @hidden */
  143410. _vReflectionInfosName: string;
  143411. /** @hidden */
  143412. _vReflectionFilteringInfoName: string;
  143413. private _scene;
  143414. /**
  143415. * The three properties below are set by the main PBR block prior to calling methods of this class.
  143416. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143417. * It's less burden on the user side in the editor part.
  143418. */
  143419. /** @hidden */
  143420. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143421. /** @hidden */
  143422. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143423. /** @hidden */
  143424. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  143425. /**
  143426. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  143427. * diffuse part of the IBL.
  143428. */
  143429. useSphericalHarmonics: boolean;
  143430. /**
  143431. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  143432. */
  143433. forceIrradianceInFragment: boolean;
  143434. /**
  143435. * Create a new ReflectionBlock
  143436. * @param name defines the block name
  143437. */
  143438. constructor(name: string);
  143439. /**
  143440. * Gets the current class name
  143441. * @returns the class name
  143442. */
  143443. getClassName(): string;
  143444. /**
  143445. * Gets the position input component
  143446. */
  143447. get position(): NodeMaterialConnectionPoint;
  143448. /**
  143449. * Gets the world position input component
  143450. */
  143451. get worldPosition(): NodeMaterialConnectionPoint;
  143452. /**
  143453. * Gets the world normal input component
  143454. */
  143455. get worldNormal(): NodeMaterialConnectionPoint;
  143456. /**
  143457. * Gets the world input component
  143458. */
  143459. get world(): NodeMaterialConnectionPoint;
  143460. /**
  143461. * Gets the camera (or eye) position component
  143462. */
  143463. get cameraPosition(): NodeMaterialConnectionPoint;
  143464. /**
  143465. * Gets the view input component
  143466. */
  143467. get view(): NodeMaterialConnectionPoint;
  143468. /**
  143469. * Gets the color input component
  143470. */
  143471. get color(): NodeMaterialConnectionPoint;
  143472. /**
  143473. * Gets the reflection object output component
  143474. */
  143475. get reflection(): NodeMaterialConnectionPoint;
  143476. /**
  143477. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  143478. */
  143479. get hasTexture(): boolean;
  143480. /**
  143481. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  143482. */
  143483. get reflectionColor(): string;
  143484. protected _getTexture(): Nullable<BaseTexture>;
  143485. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143486. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143487. /**
  143488. * Gets the code to inject in the vertex shader
  143489. * @param state current state of the node material building
  143490. * @returns the shader code
  143491. */
  143492. handleVertexSide(state: NodeMaterialBuildState): string;
  143493. /**
  143494. * Gets the main code of the block (fragment side)
  143495. * @param state current state of the node material building
  143496. * @param normalVarName name of the existing variable corresponding to the normal
  143497. * @returns the shader code
  143498. */
  143499. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  143500. protected _buildBlock(state: NodeMaterialBuildState): this;
  143501. protected _dumpPropertiesCode(): string;
  143502. serialize(): any;
  143503. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143504. }
  143505. }
  143506. declare module BABYLON {
  143507. /**
  143508. * Block used to implement the sheen module of the PBR material
  143509. */
  143510. export class SheenBlock extends NodeMaterialBlock {
  143511. /**
  143512. * Create a new SheenBlock
  143513. * @param name defines the block name
  143514. */
  143515. constructor(name: string);
  143516. /**
  143517. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  143518. * It allows the strength of the sheen effect to not depend on the base color of the material,
  143519. * making it easier to setup and tweak the effect
  143520. */
  143521. albedoScaling: boolean;
  143522. /**
  143523. * Defines if the sheen is linked to the sheen color.
  143524. */
  143525. linkSheenWithAlbedo: boolean;
  143526. /**
  143527. * Initialize the block and prepare the context for build
  143528. * @param state defines the state that will be used for the build
  143529. */
  143530. initialize(state: NodeMaterialBuildState): void;
  143531. /**
  143532. * Gets the current class name
  143533. * @returns the class name
  143534. */
  143535. getClassName(): string;
  143536. /**
  143537. * Gets the intensity input component
  143538. */
  143539. get intensity(): NodeMaterialConnectionPoint;
  143540. /**
  143541. * Gets the color input component
  143542. */
  143543. get color(): NodeMaterialConnectionPoint;
  143544. /**
  143545. * Gets the roughness input component
  143546. */
  143547. get roughness(): NodeMaterialConnectionPoint;
  143548. /**
  143549. * Gets the sheen object output component
  143550. */
  143551. get sheen(): NodeMaterialConnectionPoint;
  143552. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143553. /**
  143554. * Gets the main code of the block (fragment side)
  143555. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143556. * @returns the shader code
  143557. */
  143558. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  143559. protected _buildBlock(state: NodeMaterialBuildState): this;
  143560. protected _dumpPropertiesCode(): string;
  143561. serialize(): any;
  143562. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143563. }
  143564. }
  143565. declare module BABYLON {
  143566. /**
  143567. * Block used to implement the reflectivity module of the PBR material
  143568. */
  143569. export class ReflectivityBlock extends NodeMaterialBlock {
  143570. private _metallicReflectanceColor;
  143571. private _metallicF0Factor;
  143572. /** @hidden */
  143573. _vMetallicReflectanceFactorsName: string;
  143574. /**
  143575. * The property below is set by the main PBR block prior to calling methods of this class.
  143576. */
  143577. /** @hidden */
  143578. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  143579. /**
  143580. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  143581. */
  143582. useAmbientOcclusionFromMetallicTextureRed: boolean;
  143583. /**
  143584. * Specifies if the metallic texture contains the metallness information in its blue channel.
  143585. */
  143586. useMetallnessFromMetallicTextureBlue: boolean;
  143587. /**
  143588. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  143589. */
  143590. useRoughnessFromMetallicTextureAlpha: boolean;
  143591. /**
  143592. * Specifies if the metallic texture contains the roughness information in its green channel.
  143593. */
  143594. useRoughnessFromMetallicTextureGreen: boolean;
  143595. /**
  143596. * Create a new ReflectivityBlock
  143597. * @param name defines the block name
  143598. */
  143599. constructor(name: string);
  143600. /**
  143601. * Initialize the block and prepare the context for build
  143602. * @param state defines the state that will be used for the build
  143603. */
  143604. initialize(state: NodeMaterialBuildState): void;
  143605. /**
  143606. * Gets the current class name
  143607. * @returns the class name
  143608. */
  143609. getClassName(): string;
  143610. /**
  143611. * Gets the metallic input component
  143612. */
  143613. get metallic(): NodeMaterialConnectionPoint;
  143614. /**
  143615. * Gets the roughness input component
  143616. */
  143617. get roughness(): NodeMaterialConnectionPoint;
  143618. /**
  143619. * Gets the texture input component
  143620. */
  143621. get texture(): NodeMaterialConnectionPoint;
  143622. /**
  143623. * Gets the reflectivity object output component
  143624. */
  143625. get reflectivity(): NodeMaterialConnectionPoint;
  143626. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143627. /**
  143628. * Gets the main code of the block (fragment side)
  143629. * @param state current state of the node material building
  143630. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  143631. * @returns the shader code
  143632. */
  143633. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  143634. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143635. protected _buildBlock(state: NodeMaterialBuildState): this;
  143636. protected _dumpPropertiesCode(): string;
  143637. serialize(): any;
  143638. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143639. }
  143640. }
  143641. declare module BABYLON {
  143642. /**
  143643. * Block used to implement the anisotropy module of the PBR material
  143644. */
  143645. export class AnisotropyBlock extends NodeMaterialBlock {
  143646. /**
  143647. * The two properties below are set by the main PBR block prior to calling methods of this class.
  143648. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143649. * It's less burden on the user side in the editor part.
  143650. */
  143651. /** @hidden */
  143652. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143653. /** @hidden */
  143654. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143655. /**
  143656. * Create a new AnisotropyBlock
  143657. * @param name defines the block name
  143658. */
  143659. constructor(name: string);
  143660. /**
  143661. * Initialize the block and prepare the context for build
  143662. * @param state defines the state that will be used for the build
  143663. */
  143664. initialize(state: NodeMaterialBuildState): void;
  143665. /**
  143666. * Gets the current class name
  143667. * @returns the class name
  143668. */
  143669. getClassName(): string;
  143670. /**
  143671. * Gets the intensity input component
  143672. */
  143673. get intensity(): NodeMaterialConnectionPoint;
  143674. /**
  143675. * Gets the direction input component
  143676. */
  143677. get direction(): NodeMaterialConnectionPoint;
  143678. /**
  143679. * Gets the texture input component
  143680. */
  143681. get texture(): NodeMaterialConnectionPoint;
  143682. /**
  143683. * Gets the uv input component
  143684. */
  143685. get uv(): NodeMaterialConnectionPoint;
  143686. /**
  143687. * Gets the worldTangent input component
  143688. */
  143689. get worldTangent(): NodeMaterialConnectionPoint;
  143690. /**
  143691. * Gets the anisotropy object output component
  143692. */
  143693. get anisotropy(): NodeMaterialConnectionPoint;
  143694. private _generateTBNSpace;
  143695. /**
  143696. * Gets the main code of the block (fragment side)
  143697. * @param state current state of the node material building
  143698. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  143699. * @returns the shader code
  143700. */
  143701. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  143702. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143703. protected _buildBlock(state: NodeMaterialBuildState): this;
  143704. }
  143705. }
  143706. declare module BABYLON {
  143707. /**
  143708. * Block used to implement the clear coat module of the PBR material
  143709. */
  143710. export class ClearCoatBlock extends NodeMaterialBlock {
  143711. private _scene;
  143712. /**
  143713. * Create a new ClearCoatBlock
  143714. * @param name defines the block name
  143715. */
  143716. constructor(name: string);
  143717. /**
  143718. * Initialize the block and prepare the context for build
  143719. * @param state defines the state that will be used for the build
  143720. */
  143721. initialize(state: NodeMaterialBuildState): void;
  143722. /**
  143723. * Gets the current class name
  143724. * @returns the class name
  143725. */
  143726. getClassName(): string;
  143727. /**
  143728. * Gets the intensity input component
  143729. */
  143730. get intensity(): NodeMaterialConnectionPoint;
  143731. /**
  143732. * Gets the roughness input component
  143733. */
  143734. get roughness(): NodeMaterialConnectionPoint;
  143735. /**
  143736. * Gets the ior input component
  143737. */
  143738. get ior(): NodeMaterialConnectionPoint;
  143739. /**
  143740. * Gets the texture input component
  143741. */
  143742. get texture(): NodeMaterialConnectionPoint;
  143743. /**
  143744. * Gets the bump texture input component
  143745. */
  143746. get bumpTexture(): NodeMaterialConnectionPoint;
  143747. /**
  143748. * Gets the uv input component
  143749. */
  143750. get uv(): NodeMaterialConnectionPoint;
  143751. /**
  143752. * Gets the tint color input component
  143753. */
  143754. get tintColor(): NodeMaterialConnectionPoint;
  143755. /**
  143756. * Gets the tint "at distance" input component
  143757. */
  143758. get tintAtDistance(): NodeMaterialConnectionPoint;
  143759. /**
  143760. * Gets the tint thickness input component
  143761. */
  143762. get tintThickness(): NodeMaterialConnectionPoint;
  143763. /**
  143764. * Gets the world tangent input component
  143765. */
  143766. get worldTangent(): NodeMaterialConnectionPoint;
  143767. /**
  143768. * Gets the clear coat object output component
  143769. */
  143770. get clearcoat(): NodeMaterialConnectionPoint;
  143771. autoConfigure(material: NodeMaterial): void;
  143772. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143773. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143774. private _generateTBNSpace;
  143775. /**
  143776. * Gets the main code of the block (fragment side)
  143777. * @param state current state of the node material building
  143778. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  143779. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143780. * @param worldPosVarName name of the variable holding the world position
  143781. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  143782. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  143783. * @param worldNormalVarName name of the variable holding the world normal
  143784. * @returns the shader code
  143785. */
  143786. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  143787. protected _buildBlock(state: NodeMaterialBuildState): this;
  143788. }
  143789. }
  143790. declare module BABYLON {
  143791. /**
  143792. * Block used to implement the sub surface module of the PBR material
  143793. */
  143794. export class SubSurfaceBlock extends NodeMaterialBlock {
  143795. /**
  143796. * Create a new SubSurfaceBlock
  143797. * @param name defines the block name
  143798. */
  143799. constructor(name: string);
  143800. /**
  143801. * Stores the intensity of the different subsurface effects in the thickness texture.
  143802. * * the green channel is the translucency intensity.
  143803. * * the blue channel is the scattering intensity.
  143804. * * the alpha channel is the refraction intensity.
  143805. */
  143806. useMaskFromThicknessTexture: boolean;
  143807. /**
  143808. * Initialize the block and prepare the context for build
  143809. * @param state defines the state that will be used for the build
  143810. */
  143811. initialize(state: NodeMaterialBuildState): void;
  143812. /**
  143813. * Gets the current class name
  143814. * @returns the class name
  143815. */
  143816. getClassName(): string;
  143817. /**
  143818. * Gets the min thickness input component
  143819. */
  143820. get minThickness(): NodeMaterialConnectionPoint;
  143821. /**
  143822. * Gets the max thickness input component
  143823. */
  143824. get maxThickness(): NodeMaterialConnectionPoint;
  143825. /**
  143826. * Gets the thickness texture component
  143827. */
  143828. get thicknessTexture(): NodeMaterialConnectionPoint;
  143829. /**
  143830. * Gets the tint color input component
  143831. */
  143832. get tintColor(): NodeMaterialConnectionPoint;
  143833. /**
  143834. * Gets the translucency intensity input component
  143835. */
  143836. get translucencyIntensity(): NodeMaterialConnectionPoint;
  143837. /**
  143838. * Gets the translucency diffusion distance input component
  143839. */
  143840. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  143841. /**
  143842. * Gets the refraction object parameters
  143843. */
  143844. get refraction(): NodeMaterialConnectionPoint;
  143845. /**
  143846. * Gets the sub surface object output component
  143847. */
  143848. get subsurface(): NodeMaterialConnectionPoint;
  143849. autoConfigure(material: NodeMaterial): void;
  143850. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143851. /**
  143852. * Gets the main code of the block (fragment side)
  143853. * @param state current state of the node material building
  143854. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  143855. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143856. * @param worldPosVarName name of the variable holding the world position
  143857. * @returns the shader code
  143858. */
  143859. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  143860. protected _buildBlock(state: NodeMaterialBuildState): this;
  143861. }
  143862. }
  143863. declare module BABYLON {
  143864. /**
  143865. * Block used to implement the PBR metallic/roughness model
  143866. */
  143867. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  143868. /**
  143869. * Gets or sets the light associated with this block
  143870. */
  143871. light: Nullable<Light>;
  143872. private _lightId;
  143873. private _scene;
  143874. private _environmentBRDFTexture;
  143875. private _environmentBrdfSamplerName;
  143876. private _vNormalWName;
  143877. private _invertNormalName;
  143878. /**
  143879. * Create a new ReflectionBlock
  143880. * @param name defines the block name
  143881. */
  143882. constructor(name: string);
  143883. /**
  143884. * Intensity of the direct lights e.g. the four lights available in your scene.
  143885. * This impacts both the direct diffuse and specular highlights.
  143886. */
  143887. directIntensity: number;
  143888. /**
  143889. * Intensity of the environment e.g. how much the environment will light the object
  143890. * either through harmonics for rough material or through the refelction for shiny ones.
  143891. */
  143892. environmentIntensity: number;
  143893. /**
  143894. * This is a special control allowing the reduction of the specular highlights coming from the
  143895. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  143896. */
  143897. specularIntensity: number;
  143898. /**
  143899. * Defines the falloff type used in this material.
  143900. * It by default is Physical.
  143901. */
  143902. lightFalloff: number;
  143903. /**
  143904. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  143905. */
  143906. useAlphaFromAlbedoTexture: boolean;
  143907. /**
  143908. * Specifies that alpha test should be used
  143909. */
  143910. useAlphaTest: boolean;
  143911. /**
  143912. * Defines the alpha limits in alpha test mode.
  143913. */
  143914. alphaTestCutoff: number;
  143915. /**
  143916. * Specifies that alpha blending should be used
  143917. */
  143918. useAlphaBlending: boolean;
  143919. /**
  143920. * Defines if the alpha value should be determined via the rgb values.
  143921. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  143922. */
  143923. opacityRGB: boolean;
  143924. /**
  143925. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  143926. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  143927. */
  143928. useRadianceOverAlpha: boolean;
  143929. /**
  143930. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  143931. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  143932. */
  143933. useSpecularOverAlpha: boolean;
  143934. /**
  143935. * Enables specular anti aliasing in the PBR shader.
  143936. * It will both interacts on the Geometry for analytical and IBL lighting.
  143937. * It also prefilter the roughness map based on the bump values.
  143938. */
  143939. enableSpecularAntiAliasing: boolean;
  143940. /**
  143941. * Enables realtime filtering on the texture.
  143942. */
  143943. realTimeFiltering: boolean;
  143944. /**
  143945. * Quality switch for realtime filtering
  143946. */
  143947. realTimeFilteringQuality: number;
  143948. /**
  143949. * Defines if the material uses energy conservation.
  143950. */
  143951. useEnergyConservation: boolean;
  143952. /**
  143953. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  143954. * too much the area relying on ambient texture to define their ambient occlusion.
  143955. */
  143956. useRadianceOcclusion: boolean;
  143957. /**
  143958. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  143959. * makes the reflect vector face the model (under horizon).
  143960. */
  143961. useHorizonOcclusion: boolean;
  143962. /**
  143963. * If set to true, no lighting calculations will be applied.
  143964. */
  143965. unlit: boolean;
  143966. /**
  143967. * Force normal to face away from face.
  143968. */
  143969. forceNormalForward: boolean;
  143970. /**
  143971. * Defines the material debug mode.
  143972. * It helps seeing only some components of the material while troubleshooting.
  143973. */
  143974. debugMode: number;
  143975. /**
  143976. * Specify from where on screen the debug mode should start.
  143977. * The value goes from -1 (full screen) to 1 (not visible)
  143978. * It helps with side by side comparison against the final render
  143979. * This defaults to 0
  143980. */
  143981. debugLimit: number;
  143982. /**
  143983. * As the default viewing range might not be enough (if the ambient is really small for instance)
  143984. * You can use the factor to better multiply the final value.
  143985. */
  143986. debugFactor: number;
  143987. /**
  143988. * Initialize the block and prepare the context for build
  143989. * @param state defines the state that will be used for the build
  143990. */
  143991. initialize(state: NodeMaterialBuildState): void;
  143992. /**
  143993. * Gets the current class name
  143994. * @returns the class name
  143995. */
  143996. getClassName(): string;
  143997. /**
  143998. * Gets the world position input component
  143999. */
  144000. get worldPosition(): NodeMaterialConnectionPoint;
  144001. /**
  144002. * Gets the world normal input component
  144003. */
  144004. get worldNormal(): NodeMaterialConnectionPoint;
  144005. /**
  144006. * Gets the perturbed normal input component
  144007. */
  144008. get perturbedNormal(): NodeMaterialConnectionPoint;
  144009. /**
  144010. * Gets the camera position input component
  144011. */
  144012. get cameraPosition(): NodeMaterialConnectionPoint;
  144013. /**
  144014. * Gets the base color input component
  144015. */
  144016. get baseColor(): NodeMaterialConnectionPoint;
  144017. /**
  144018. * Gets the opacity texture input component
  144019. */
  144020. get opacityTexture(): NodeMaterialConnectionPoint;
  144021. /**
  144022. * Gets the ambient color input component
  144023. */
  144024. get ambientColor(): NodeMaterialConnectionPoint;
  144025. /**
  144026. * Gets the reflectivity object parameters
  144027. */
  144028. get reflectivity(): NodeMaterialConnectionPoint;
  144029. /**
  144030. * Gets the ambient occlusion object parameters
  144031. */
  144032. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144033. /**
  144034. * Gets the reflection object parameters
  144035. */
  144036. get reflection(): NodeMaterialConnectionPoint;
  144037. /**
  144038. * Gets the sheen object parameters
  144039. */
  144040. get sheen(): NodeMaterialConnectionPoint;
  144041. /**
  144042. * Gets the clear coat object parameters
  144043. */
  144044. get clearcoat(): NodeMaterialConnectionPoint;
  144045. /**
  144046. * Gets the sub surface object parameters
  144047. */
  144048. get subsurface(): NodeMaterialConnectionPoint;
  144049. /**
  144050. * Gets the anisotropy object parameters
  144051. */
  144052. get anisotropy(): NodeMaterialConnectionPoint;
  144053. /**
  144054. * Gets the ambient output component
  144055. */
  144056. get ambient(): NodeMaterialConnectionPoint;
  144057. /**
  144058. * Gets the diffuse output component
  144059. */
  144060. get diffuse(): NodeMaterialConnectionPoint;
  144061. /**
  144062. * Gets the specular output component
  144063. */
  144064. get specular(): NodeMaterialConnectionPoint;
  144065. /**
  144066. * Gets the sheen output component
  144067. */
  144068. get sheenDir(): NodeMaterialConnectionPoint;
  144069. /**
  144070. * Gets the clear coat output component
  144071. */
  144072. get clearcoatDir(): NodeMaterialConnectionPoint;
  144073. /**
  144074. * Gets the indirect diffuse output component
  144075. */
  144076. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144077. /**
  144078. * Gets the indirect specular output component
  144079. */
  144080. get specularIndirect(): NodeMaterialConnectionPoint;
  144081. /**
  144082. * Gets the indirect sheen output component
  144083. */
  144084. get sheenIndirect(): NodeMaterialConnectionPoint;
  144085. /**
  144086. * Gets the indirect clear coat output component
  144087. */
  144088. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144089. /**
  144090. * Gets the refraction output component
  144091. */
  144092. get refraction(): NodeMaterialConnectionPoint;
  144093. /**
  144094. * Gets the global lighting output component
  144095. */
  144096. get lighting(): NodeMaterialConnectionPoint;
  144097. /**
  144098. * Gets the shadow output component
  144099. */
  144100. get shadow(): NodeMaterialConnectionPoint;
  144101. /**
  144102. * Gets the alpha output component
  144103. */
  144104. get alpha(): NodeMaterialConnectionPoint;
  144105. autoConfigure(material: NodeMaterial): void;
  144106. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144107. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144108. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144109. private _injectVertexCode;
  144110. /**
  144111. * Gets the code corresponding to the albedo/opacity module
  144112. * @returns the shader code
  144113. */
  144114. getAlbedoOpacityCode(): string;
  144115. protected _buildBlock(state: NodeMaterialBuildState): this;
  144116. protected _dumpPropertiesCode(): string;
  144117. serialize(): any;
  144118. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144119. }
  144120. }
  144121. declare module BABYLON {
  144122. /**
  144123. * Block used to compute value of one parameter modulo another
  144124. */
  144125. export class ModBlock extends NodeMaterialBlock {
  144126. /**
  144127. * Creates a new ModBlock
  144128. * @param name defines the block name
  144129. */
  144130. constructor(name: string);
  144131. /**
  144132. * Gets the current class name
  144133. * @returns the class name
  144134. */
  144135. getClassName(): string;
  144136. /**
  144137. * Gets the left operand input component
  144138. */
  144139. get left(): NodeMaterialConnectionPoint;
  144140. /**
  144141. * Gets the right operand input component
  144142. */
  144143. get right(): NodeMaterialConnectionPoint;
  144144. /**
  144145. * Gets the output component
  144146. */
  144147. get output(): NodeMaterialConnectionPoint;
  144148. protected _buildBlock(state: NodeMaterialBuildState): this;
  144149. }
  144150. }
  144151. declare module BABYLON {
  144152. /**
  144153. * Helper class to push actions to a pool of workers.
  144154. */
  144155. export class WorkerPool implements IDisposable {
  144156. private _workerInfos;
  144157. private _pendingActions;
  144158. /**
  144159. * Constructor
  144160. * @param workers Array of workers to use for actions
  144161. */
  144162. constructor(workers: Array<Worker>);
  144163. /**
  144164. * Terminates all workers and clears any pending actions.
  144165. */
  144166. dispose(): void;
  144167. /**
  144168. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144169. * pended until a worker has completed its action.
  144170. * @param action The action to perform. Call onComplete when the action is complete.
  144171. */
  144172. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144173. private _execute;
  144174. }
  144175. }
  144176. declare module BABYLON {
  144177. /**
  144178. * Configuration for Draco compression
  144179. */
  144180. export interface IDracoCompressionConfiguration {
  144181. /**
  144182. * Configuration for the decoder.
  144183. */
  144184. decoder: {
  144185. /**
  144186. * The url to the WebAssembly module.
  144187. */
  144188. wasmUrl?: string;
  144189. /**
  144190. * The url to the WebAssembly binary.
  144191. */
  144192. wasmBinaryUrl?: string;
  144193. /**
  144194. * The url to the fallback JavaScript module.
  144195. */
  144196. fallbackUrl?: string;
  144197. };
  144198. }
  144199. /**
  144200. * Draco compression (https://google.github.io/draco/)
  144201. *
  144202. * This class wraps the Draco module.
  144203. *
  144204. * **Encoder**
  144205. *
  144206. * The encoder is not currently implemented.
  144207. *
  144208. * **Decoder**
  144209. *
  144210. * 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.
  144211. *
  144212. * To update the configuration, use the following code:
  144213. * ```javascript
  144214. * DracoCompression.Configuration = {
  144215. * decoder: {
  144216. * wasmUrl: "<url to the WebAssembly library>",
  144217. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144218. * fallbackUrl: "<url to the fallback JavaScript library>",
  144219. * }
  144220. * };
  144221. * ```
  144222. *
  144223. * 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.
  144224. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144225. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144226. *
  144227. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144228. * ```javascript
  144229. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144230. * ```
  144231. *
  144232. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144233. */
  144234. export class DracoCompression implements IDisposable {
  144235. private _workerPoolPromise?;
  144236. private _decoderModulePromise?;
  144237. /**
  144238. * The configuration. Defaults to the following urls:
  144239. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144240. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144241. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144242. */
  144243. static Configuration: IDracoCompressionConfiguration;
  144244. /**
  144245. * Returns true if the decoder configuration is available.
  144246. */
  144247. static get DecoderAvailable(): boolean;
  144248. /**
  144249. * Default number of workers to create when creating the draco compression object.
  144250. */
  144251. static DefaultNumWorkers: number;
  144252. private static GetDefaultNumWorkers;
  144253. private static _Default;
  144254. /**
  144255. * Default instance for the draco compression object.
  144256. */
  144257. static get Default(): DracoCompression;
  144258. /**
  144259. * Constructor
  144260. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144261. */
  144262. constructor(numWorkers?: number);
  144263. /**
  144264. * Stop all async operations and release resources.
  144265. */
  144266. dispose(): void;
  144267. /**
  144268. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144269. * @returns a promise that resolves when ready
  144270. */
  144271. whenReadyAsync(): Promise<void>;
  144272. /**
  144273. * Decode Draco compressed mesh data to vertex data.
  144274. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144275. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144276. * @returns A promise that resolves with the decoded vertex data
  144277. */
  144278. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144279. [kind: string]: number;
  144280. }): Promise<VertexData>;
  144281. }
  144282. }
  144283. declare module BABYLON {
  144284. /**
  144285. * Class for building Constructive Solid Geometry
  144286. */
  144287. export class CSG {
  144288. private polygons;
  144289. /**
  144290. * The world matrix
  144291. */
  144292. matrix: Matrix;
  144293. /**
  144294. * Stores the position
  144295. */
  144296. position: Vector3;
  144297. /**
  144298. * Stores the rotation
  144299. */
  144300. rotation: Vector3;
  144301. /**
  144302. * Stores the rotation quaternion
  144303. */
  144304. rotationQuaternion: Nullable<Quaternion>;
  144305. /**
  144306. * Stores the scaling vector
  144307. */
  144308. scaling: Vector3;
  144309. /**
  144310. * Convert the Mesh to CSG
  144311. * @param mesh The Mesh to convert to CSG
  144312. * @returns A new CSG from the Mesh
  144313. */
  144314. static FromMesh(mesh: Mesh): CSG;
  144315. /**
  144316. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144317. * @param polygons Polygons used to construct a CSG solid
  144318. */
  144319. private static FromPolygons;
  144320. /**
  144321. * Clones, or makes a deep copy, of the CSG
  144322. * @returns A new CSG
  144323. */
  144324. clone(): CSG;
  144325. /**
  144326. * Unions this CSG with another CSG
  144327. * @param csg The CSG to union against this CSG
  144328. * @returns The unioned CSG
  144329. */
  144330. union(csg: CSG): CSG;
  144331. /**
  144332. * Unions this CSG with another CSG in place
  144333. * @param csg The CSG to union against this CSG
  144334. */
  144335. unionInPlace(csg: CSG): void;
  144336. /**
  144337. * Subtracts this CSG with another CSG
  144338. * @param csg The CSG to subtract against this CSG
  144339. * @returns A new CSG
  144340. */
  144341. subtract(csg: CSG): CSG;
  144342. /**
  144343. * Subtracts this CSG with another CSG in place
  144344. * @param csg The CSG to subtact against this CSG
  144345. */
  144346. subtractInPlace(csg: CSG): void;
  144347. /**
  144348. * Intersect this CSG with another CSG
  144349. * @param csg The CSG to intersect against this CSG
  144350. * @returns A new CSG
  144351. */
  144352. intersect(csg: CSG): CSG;
  144353. /**
  144354. * Intersects this CSG with another CSG in place
  144355. * @param csg The CSG to intersect against this CSG
  144356. */
  144357. intersectInPlace(csg: CSG): void;
  144358. /**
  144359. * Return a new CSG solid with solid and empty space switched. This solid is
  144360. * not modified.
  144361. * @returns A new CSG solid with solid and empty space switched
  144362. */
  144363. inverse(): CSG;
  144364. /**
  144365. * Inverses the CSG in place
  144366. */
  144367. inverseInPlace(): void;
  144368. /**
  144369. * This is used to keep meshes transformations so they can be restored
  144370. * when we build back a Babylon Mesh
  144371. * NB : All CSG operations are performed in world coordinates
  144372. * @param csg The CSG to copy the transform attributes from
  144373. * @returns This CSG
  144374. */
  144375. copyTransformAttributes(csg: CSG): CSG;
  144376. /**
  144377. * Build Raw mesh from CSG
  144378. * Coordinates here are in world space
  144379. * @param name The name of the mesh geometry
  144380. * @param scene The Scene
  144381. * @param keepSubMeshes Specifies if the submeshes should be kept
  144382. * @returns A new Mesh
  144383. */
  144384. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144385. /**
  144386. * Build Mesh from CSG taking material and transforms into account
  144387. * @param name The name of the Mesh
  144388. * @param material The material of the Mesh
  144389. * @param scene The Scene
  144390. * @param keepSubMeshes Specifies if submeshes should be kept
  144391. * @returns The new Mesh
  144392. */
  144393. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144394. }
  144395. }
  144396. declare module BABYLON {
  144397. /**
  144398. * Class used to create a trail following a mesh
  144399. */
  144400. export class TrailMesh extends Mesh {
  144401. private _generator;
  144402. private _autoStart;
  144403. private _running;
  144404. private _diameter;
  144405. private _length;
  144406. private _sectionPolygonPointsCount;
  144407. private _sectionVectors;
  144408. private _sectionNormalVectors;
  144409. private _beforeRenderObserver;
  144410. /**
  144411. * @constructor
  144412. * @param name The value used by scene.getMeshByName() to do a lookup.
  144413. * @param generator The mesh or transform node to generate a trail.
  144414. * @param scene The scene to add this mesh to.
  144415. * @param diameter Diameter of trailing mesh. Default is 1.
  144416. * @param length Length of trailing mesh. Default is 60.
  144417. * @param autoStart Automatically start trailing mesh. Default true.
  144418. */
  144419. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  144420. /**
  144421. * "TrailMesh"
  144422. * @returns "TrailMesh"
  144423. */
  144424. getClassName(): string;
  144425. private _createMesh;
  144426. /**
  144427. * Start trailing mesh.
  144428. */
  144429. start(): void;
  144430. /**
  144431. * Stop trailing mesh.
  144432. */
  144433. stop(): void;
  144434. /**
  144435. * Update trailing mesh geometry.
  144436. */
  144437. update(): void;
  144438. /**
  144439. * Returns a new TrailMesh object.
  144440. * @param name is a string, the name given to the new mesh
  144441. * @param newGenerator use new generator object for cloned trail mesh
  144442. * @returns a new mesh
  144443. */
  144444. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  144445. /**
  144446. * Serializes this trail mesh
  144447. * @param serializationObject object to write serialization to
  144448. */
  144449. serialize(serializationObject: any): void;
  144450. /**
  144451. * Parses a serialized trail mesh
  144452. * @param parsedMesh the serialized mesh
  144453. * @param scene the scene to create the trail mesh in
  144454. * @returns the created trail mesh
  144455. */
  144456. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  144457. }
  144458. }
  144459. declare module BABYLON {
  144460. /**
  144461. * Class containing static functions to help procedurally build meshes
  144462. */
  144463. export class TiledBoxBuilder {
  144464. /**
  144465. * Creates a box mesh
  144466. * 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)
  144467. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144468. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144469. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144470. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144471. * @param name defines the name of the mesh
  144472. * @param options defines the options used to create the mesh
  144473. * @param scene defines the hosting scene
  144474. * @returns the box mesh
  144475. */
  144476. static CreateTiledBox(name: string, options: {
  144477. pattern?: number;
  144478. width?: number;
  144479. height?: number;
  144480. depth?: number;
  144481. tileSize?: number;
  144482. tileWidth?: number;
  144483. tileHeight?: number;
  144484. alignHorizontal?: number;
  144485. alignVertical?: number;
  144486. faceUV?: Vector4[];
  144487. faceColors?: Color4[];
  144488. sideOrientation?: number;
  144489. updatable?: boolean;
  144490. }, scene?: Nullable<Scene>): Mesh;
  144491. }
  144492. }
  144493. declare module BABYLON {
  144494. /**
  144495. * Class containing static functions to help procedurally build meshes
  144496. */
  144497. export class TorusKnotBuilder {
  144498. /**
  144499. * Creates a torus knot mesh
  144500. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144501. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144502. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144503. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144504. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144505. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144506. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144507. * @param name defines the name of the mesh
  144508. * @param options defines the options used to create the mesh
  144509. * @param scene defines the hosting scene
  144510. * @returns the torus knot mesh
  144511. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144512. */
  144513. static CreateTorusKnot(name: string, options: {
  144514. radius?: number;
  144515. tube?: number;
  144516. radialSegments?: number;
  144517. tubularSegments?: number;
  144518. p?: number;
  144519. q?: number;
  144520. updatable?: boolean;
  144521. sideOrientation?: number;
  144522. frontUVs?: Vector4;
  144523. backUVs?: Vector4;
  144524. }, scene: any): Mesh;
  144525. }
  144526. }
  144527. declare module BABYLON {
  144528. /**
  144529. * Polygon
  144530. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  144531. */
  144532. export class Polygon {
  144533. /**
  144534. * Creates a rectangle
  144535. * @param xmin bottom X coord
  144536. * @param ymin bottom Y coord
  144537. * @param xmax top X coord
  144538. * @param ymax top Y coord
  144539. * @returns points that make the resulting rectation
  144540. */
  144541. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  144542. /**
  144543. * Creates a circle
  144544. * @param radius radius of circle
  144545. * @param cx scale in x
  144546. * @param cy scale in y
  144547. * @param numberOfSides number of sides that make up the circle
  144548. * @returns points that make the resulting circle
  144549. */
  144550. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  144551. /**
  144552. * Creates a polygon from input string
  144553. * @param input Input polygon data
  144554. * @returns the parsed points
  144555. */
  144556. static Parse(input: string): Vector2[];
  144557. /**
  144558. * Starts building a polygon from x and y coordinates
  144559. * @param x x coordinate
  144560. * @param y y coordinate
  144561. * @returns the started path2
  144562. */
  144563. static StartingAt(x: number, y: number): Path2;
  144564. }
  144565. /**
  144566. * Builds a polygon
  144567. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  144568. */
  144569. export class PolygonMeshBuilder {
  144570. private _points;
  144571. private _outlinepoints;
  144572. private _holes;
  144573. private _name;
  144574. private _scene;
  144575. private _epoints;
  144576. private _eholes;
  144577. private _addToepoint;
  144578. /**
  144579. * Babylon reference to the earcut plugin.
  144580. */
  144581. bjsEarcut: any;
  144582. /**
  144583. * Creates a PolygonMeshBuilder
  144584. * @param name name of the builder
  144585. * @param contours Path of the polygon
  144586. * @param scene scene to add to when creating the mesh
  144587. * @param earcutInjection can be used to inject your own earcut reference
  144588. */
  144589. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  144590. /**
  144591. * Adds a whole within the polygon
  144592. * @param hole Array of points defining the hole
  144593. * @returns this
  144594. */
  144595. addHole(hole: Vector2[]): PolygonMeshBuilder;
  144596. /**
  144597. * Creates the polygon
  144598. * @param updatable If the mesh should be updatable
  144599. * @param depth The depth of the mesh created
  144600. * @returns the created mesh
  144601. */
  144602. build(updatable?: boolean, depth?: number): Mesh;
  144603. /**
  144604. * Creates the polygon
  144605. * @param depth The depth of the mesh created
  144606. * @returns the created VertexData
  144607. */
  144608. buildVertexData(depth?: number): VertexData;
  144609. /**
  144610. * Adds a side to the polygon
  144611. * @param positions points that make the polygon
  144612. * @param normals normals of the polygon
  144613. * @param uvs uvs of the polygon
  144614. * @param indices indices of the polygon
  144615. * @param bounds bounds of the polygon
  144616. * @param points points of the polygon
  144617. * @param depth depth of the polygon
  144618. * @param flip flip of the polygon
  144619. */
  144620. private addSide;
  144621. }
  144622. }
  144623. declare module BABYLON {
  144624. /**
  144625. * Class containing static functions to help procedurally build meshes
  144626. */
  144627. export class PolygonBuilder {
  144628. /**
  144629. * Creates a polygon mesh
  144630. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  144631. * * 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
  144632. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  144633. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144634. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  144635. * * Remember you can only change the shape positions, not their number when updating a polygon
  144636. * @param name defines the name of the mesh
  144637. * @param options defines the options used to create the mesh
  144638. * @param scene defines the hosting scene
  144639. * @param earcutInjection can be used to inject your own earcut reference
  144640. * @returns the polygon mesh
  144641. */
  144642. static CreatePolygon(name: string, options: {
  144643. shape: Vector3[];
  144644. holes?: Vector3[][];
  144645. depth?: number;
  144646. faceUV?: Vector4[];
  144647. faceColors?: Color4[];
  144648. updatable?: boolean;
  144649. sideOrientation?: number;
  144650. frontUVs?: Vector4;
  144651. backUVs?: Vector4;
  144652. wrap?: boolean;
  144653. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  144654. /**
  144655. * Creates an extruded polygon mesh, with depth in the Y direction.
  144656. * * 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)
  144657. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144658. * @param name defines the name of the mesh
  144659. * @param options defines the options used to create the mesh
  144660. * @param scene defines the hosting scene
  144661. * @param earcutInjection can be used to inject your own earcut reference
  144662. * @returns the polygon mesh
  144663. */
  144664. static ExtrudePolygon(name: string, options: {
  144665. shape: Vector3[];
  144666. holes?: Vector3[][];
  144667. depth?: number;
  144668. faceUV?: Vector4[];
  144669. faceColors?: Color4[];
  144670. updatable?: boolean;
  144671. sideOrientation?: number;
  144672. frontUVs?: Vector4;
  144673. backUVs?: Vector4;
  144674. wrap?: boolean;
  144675. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  144676. }
  144677. }
  144678. declare module BABYLON {
  144679. /**
  144680. * Class containing static functions to help procedurally build meshes
  144681. */
  144682. export class LatheBuilder {
  144683. /**
  144684. * Creates lathe mesh.
  144685. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  144686. * * 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
  144687. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  144688. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  144689. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  144690. * * 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
  144691. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  144692. * * 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
  144693. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144694. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144695. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144696. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144697. * @param name defines the name of the mesh
  144698. * @param options defines the options used to create the mesh
  144699. * @param scene defines the hosting scene
  144700. * @returns the lathe mesh
  144701. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  144702. */
  144703. static CreateLathe(name: string, options: {
  144704. shape: Vector3[];
  144705. radius?: number;
  144706. tessellation?: number;
  144707. clip?: number;
  144708. arc?: number;
  144709. closed?: boolean;
  144710. updatable?: boolean;
  144711. sideOrientation?: number;
  144712. frontUVs?: Vector4;
  144713. backUVs?: Vector4;
  144714. cap?: number;
  144715. invertUV?: boolean;
  144716. }, scene?: Nullable<Scene>): Mesh;
  144717. }
  144718. }
  144719. declare module BABYLON {
  144720. /**
  144721. * Class containing static functions to help procedurally build meshes
  144722. */
  144723. export class TiledPlaneBuilder {
  144724. /**
  144725. * Creates a tiled plane mesh
  144726. * * The parameter `pattern` will, depending on value, do nothing or
  144727. * * * flip (reflect about central vertical) alternate tiles across and up
  144728. * * * flip every tile on alternate rows
  144729. * * * rotate (180 degs) alternate tiles across and up
  144730. * * * rotate every tile on alternate rows
  144731. * * * flip and rotate alternate tiles across and up
  144732. * * * flip and rotate every tile on alternate rows
  144733. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  144734. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  144735. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144736. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  144737. * * 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)
  144738. * * 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)
  144739. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  144740. * @param name defines the name of the mesh
  144741. * @param options defines the options used to create the mesh
  144742. * @param scene defines the hosting scene
  144743. * @returns the box mesh
  144744. */
  144745. static CreateTiledPlane(name: string, options: {
  144746. pattern?: number;
  144747. tileSize?: number;
  144748. tileWidth?: number;
  144749. tileHeight?: number;
  144750. size?: number;
  144751. width?: number;
  144752. height?: number;
  144753. alignHorizontal?: number;
  144754. alignVertical?: number;
  144755. sideOrientation?: number;
  144756. frontUVs?: Vector4;
  144757. backUVs?: Vector4;
  144758. updatable?: boolean;
  144759. }, scene?: Nullable<Scene>): Mesh;
  144760. }
  144761. }
  144762. declare module BABYLON {
  144763. /**
  144764. * Class containing static functions to help procedurally build meshes
  144765. */
  144766. export class TubeBuilder {
  144767. /**
  144768. * Creates a tube mesh.
  144769. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  144770. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  144771. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  144772. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  144773. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  144774. * * 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)
  144775. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  144776. * * 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
  144777. * * 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
  144778. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144779. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144780. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144781. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144782. * @param name defines the name of the mesh
  144783. * @param options defines the options used to create the mesh
  144784. * @param scene defines the hosting scene
  144785. * @returns the tube mesh
  144786. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144787. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  144788. */
  144789. static CreateTube(name: string, options: {
  144790. path: Vector3[];
  144791. radius?: number;
  144792. tessellation?: number;
  144793. radiusFunction?: {
  144794. (i: number, distance: number): number;
  144795. };
  144796. cap?: number;
  144797. arc?: number;
  144798. updatable?: boolean;
  144799. sideOrientation?: number;
  144800. frontUVs?: Vector4;
  144801. backUVs?: Vector4;
  144802. instance?: Mesh;
  144803. invertUV?: boolean;
  144804. }, scene?: Nullable<Scene>): Mesh;
  144805. }
  144806. }
  144807. declare module BABYLON {
  144808. /**
  144809. * Class containing static functions to help procedurally build meshes
  144810. */
  144811. export class IcoSphereBuilder {
  144812. /**
  144813. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  144814. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  144815. * * 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`)
  144816. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  144817. * * 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
  144818. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144819. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144820. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144821. * @param name defines the name of the mesh
  144822. * @param options defines the options used to create the mesh
  144823. * @param scene defines the hosting scene
  144824. * @returns the icosahedron mesh
  144825. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  144826. */
  144827. static CreateIcoSphere(name: string, options: {
  144828. radius?: number;
  144829. radiusX?: number;
  144830. radiusY?: number;
  144831. radiusZ?: number;
  144832. flat?: boolean;
  144833. subdivisions?: number;
  144834. sideOrientation?: number;
  144835. frontUVs?: Vector4;
  144836. backUVs?: Vector4;
  144837. updatable?: boolean;
  144838. }, scene?: Nullable<Scene>): Mesh;
  144839. }
  144840. }
  144841. declare module BABYLON {
  144842. /**
  144843. * Class containing static functions to help procedurally build meshes
  144844. */
  144845. export class DecalBuilder {
  144846. /**
  144847. * Creates a decal mesh.
  144848. * 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
  144849. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  144850. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  144851. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  144852. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  144853. * @param name defines the name of the mesh
  144854. * @param sourceMesh defines the mesh where the decal must be applied
  144855. * @param options defines the options used to create the mesh
  144856. * @param scene defines the hosting scene
  144857. * @returns the decal mesh
  144858. * @see https://doc.babylonjs.com/how_to/decals
  144859. */
  144860. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  144861. position?: Vector3;
  144862. normal?: Vector3;
  144863. size?: Vector3;
  144864. angle?: number;
  144865. }): Mesh;
  144866. }
  144867. }
  144868. declare module BABYLON {
  144869. /**
  144870. * Class containing static functions to help procedurally build meshes
  144871. */
  144872. export class MeshBuilder {
  144873. /**
  144874. * Creates a box mesh
  144875. * * The parameter `size` sets the size (float) of each box side (default 1)
  144876. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  144877. * * 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)
  144878. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144879. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144880. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144881. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144882. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  144883. * @param name defines the name of the mesh
  144884. * @param options defines the options used to create the mesh
  144885. * @param scene defines the hosting scene
  144886. * @returns the box mesh
  144887. */
  144888. static CreateBox(name: string, options: {
  144889. size?: number;
  144890. width?: number;
  144891. height?: number;
  144892. depth?: number;
  144893. faceUV?: Vector4[];
  144894. faceColors?: Color4[];
  144895. sideOrientation?: number;
  144896. frontUVs?: Vector4;
  144897. backUVs?: Vector4;
  144898. wrap?: boolean;
  144899. topBaseAt?: number;
  144900. bottomBaseAt?: number;
  144901. updatable?: boolean;
  144902. }, scene?: Nullable<Scene>): Mesh;
  144903. /**
  144904. * Creates a tiled box mesh
  144905. * * faceTiles sets the pattern, tile size and number of tiles for a face
  144906. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144907. * @param name defines the name of the mesh
  144908. * @param options defines the options used to create the mesh
  144909. * @param scene defines the hosting scene
  144910. * @returns the tiled box mesh
  144911. */
  144912. static CreateTiledBox(name: string, options: {
  144913. pattern?: number;
  144914. size?: number;
  144915. width?: number;
  144916. height?: number;
  144917. depth: number;
  144918. tileSize?: number;
  144919. tileWidth?: number;
  144920. tileHeight?: number;
  144921. faceUV?: Vector4[];
  144922. faceColors?: Color4[];
  144923. alignHorizontal?: number;
  144924. alignVertical?: number;
  144925. sideOrientation?: number;
  144926. updatable?: boolean;
  144927. }, scene?: Nullable<Scene>): Mesh;
  144928. /**
  144929. * Creates a sphere mesh
  144930. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  144931. * * 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`)
  144932. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  144933. * * 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
  144934. * * 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)
  144935. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144936. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144937. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144938. * @param name defines the name of the mesh
  144939. * @param options defines the options used to create the mesh
  144940. * @param scene defines the hosting scene
  144941. * @returns the sphere mesh
  144942. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  144943. */
  144944. static CreateSphere(name: string, options: {
  144945. segments?: number;
  144946. diameter?: number;
  144947. diameterX?: number;
  144948. diameterY?: number;
  144949. diameterZ?: number;
  144950. arc?: number;
  144951. slice?: number;
  144952. sideOrientation?: number;
  144953. frontUVs?: Vector4;
  144954. backUVs?: Vector4;
  144955. updatable?: boolean;
  144956. }, scene?: Nullable<Scene>): Mesh;
  144957. /**
  144958. * Creates a plane polygonal mesh. By default, this is a disc
  144959. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  144960. * * 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
  144961. * * 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
  144962. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144963. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144964. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144965. * @param name defines the name of the mesh
  144966. * @param options defines the options used to create the mesh
  144967. * @param scene defines the hosting scene
  144968. * @returns the plane polygonal mesh
  144969. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  144970. */
  144971. static CreateDisc(name: string, options: {
  144972. radius?: number;
  144973. tessellation?: number;
  144974. arc?: number;
  144975. updatable?: boolean;
  144976. sideOrientation?: number;
  144977. frontUVs?: Vector4;
  144978. backUVs?: Vector4;
  144979. }, scene?: Nullable<Scene>): Mesh;
  144980. /**
  144981. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  144982. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  144983. * * 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`)
  144984. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  144985. * * 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
  144986. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144987. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144988. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144989. * @param name defines the name of the mesh
  144990. * @param options defines the options used to create the mesh
  144991. * @param scene defines the hosting scene
  144992. * @returns the icosahedron mesh
  144993. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  144994. */
  144995. static CreateIcoSphere(name: string, options: {
  144996. radius?: number;
  144997. radiusX?: number;
  144998. radiusY?: number;
  144999. radiusZ?: number;
  145000. flat?: boolean;
  145001. subdivisions?: number;
  145002. sideOrientation?: number;
  145003. frontUVs?: Vector4;
  145004. backUVs?: Vector4;
  145005. updatable?: boolean;
  145006. }, scene?: Nullable<Scene>): Mesh;
  145007. /**
  145008. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145009. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145010. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145011. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145012. * * 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
  145013. * * 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
  145014. * * 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
  145015. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145016. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145017. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145018. * * 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
  145019. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145020. * * 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
  145021. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145022. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145023. * @param name defines the name of the mesh
  145024. * @param options defines the options used to create the mesh
  145025. * @param scene defines the hosting scene
  145026. * @returns the ribbon mesh
  145027. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145028. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145029. */
  145030. static CreateRibbon(name: string, options: {
  145031. pathArray: Vector3[][];
  145032. closeArray?: boolean;
  145033. closePath?: boolean;
  145034. offset?: number;
  145035. updatable?: boolean;
  145036. sideOrientation?: number;
  145037. frontUVs?: Vector4;
  145038. backUVs?: Vector4;
  145039. instance?: Mesh;
  145040. invertUV?: boolean;
  145041. uvs?: Vector2[];
  145042. colors?: Color4[];
  145043. }, scene?: Nullable<Scene>): Mesh;
  145044. /**
  145045. * Creates a cylinder or a cone mesh
  145046. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145047. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145048. * * 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.
  145049. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145050. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145051. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145052. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145053. * * 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).
  145054. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145055. * * 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).
  145056. * * 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
  145057. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145058. * * 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
  145059. * * 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.
  145060. * * If `enclose` is false, a ring surface is one element.
  145061. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145062. * * 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
  145063. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145064. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145065. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145066. * @param name defines the name of the mesh
  145067. * @param options defines the options used to create the mesh
  145068. * @param scene defines the hosting scene
  145069. * @returns the cylinder mesh
  145070. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145071. */
  145072. static CreateCylinder(name: string, options: {
  145073. height?: number;
  145074. diameterTop?: number;
  145075. diameterBottom?: number;
  145076. diameter?: number;
  145077. tessellation?: number;
  145078. subdivisions?: number;
  145079. arc?: number;
  145080. faceColors?: Color4[];
  145081. faceUV?: Vector4[];
  145082. updatable?: boolean;
  145083. hasRings?: boolean;
  145084. enclose?: boolean;
  145085. cap?: number;
  145086. sideOrientation?: number;
  145087. frontUVs?: Vector4;
  145088. backUVs?: Vector4;
  145089. }, scene?: Nullable<Scene>): Mesh;
  145090. /**
  145091. * Creates a torus mesh
  145092. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145093. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145094. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145095. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145096. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145097. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145098. * @param name defines the name of the mesh
  145099. * @param options defines the options used to create the mesh
  145100. * @param scene defines the hosting scene
  145101. * @returns the torus mesh
  145102. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145103. */
  145104. static CreateTorus(name: string, options: {
  145105. diameter?: number;
  145106. thickness?: number;
  145107. tessellation?: number;
  145108. updatable?: boolean;
  145109. sideOrientation?: number;
  145110. frontUVs?: Vector4;
  145111. backUVs?: Vector4;
  145112. }, scene?: Nullable<Scene>): Mesh;
  145113. /**
  145114. * Creates a torus knot mesh
  145115. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145116. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145117. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145118. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145119. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145120. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145121. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145122. * @param name defines the name of the mesh
  145123. * @param options defines the options used to create the mesh
  145124. * @param scene defines the hosting scene
  145125. * @returns the torus knot mesh
  145126. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145127. */
  145128. static CreateTorusKnot(name: string, options: {
  145129. radius?: number;
  145130. tube?: number;
  145131. radialSegments?: number;
  145132. tubularSegments?: number;
  145133. p?: number;
  145134. q?: number;
  145135. updatable?: boolean;
  145136. sideOrientation?: number;
  145137. frontUVs?: Vector4;
  145138. backUVs?: Vector4;
  145139. }, scene?: Nullable<Scene>): Mesh;
  145140. /**
  145141. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145142. * * 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
  145143. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145144. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145145. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145146. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145147. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145148. * * 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
  145149. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145150. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145151. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145152. * @param name defines the name of the new line system
  145153. * @param options defines the options used to create the line system
  145154. * @param scene defines the hosting scene
  145155. * @returns a new line system mesh
  145156. */
  145157. static CreateLineSystem(name: string, options: {
  145158. lines: Vector3[][];
  145159. updatable?: boolean;
  145160. instance?: Nullable<LinesMesh>;
  145161. colors?: Nullable<Color4[][]>;
  145162. useVertexAlpha?: boolean;
  145163. }, scene: Nullable<Scene>): LinesMesh;
  145164. /**
  145165. * Creates a line mesh
  145166. * 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
  145167. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145168. * * The parameter `points` is an array successive Vector3
  145169. * * 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
  145170. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145171. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145172. * * When updating an instance, remember that only point positions can change, not the number of points
  145173. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145174. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145175. * @param name defines the name of the new line system
  145176. * @param options defines the options used to create the line system
  145177. * @param scene defines the hosting scene
  145178. * @returns a new line mesh
  145179. */
  145180. static CreateLines(name: string, options: {
  145181. points: Vector3[];
  145182. updatable?: boolean;
  145183. instance?: Nullable<LinesMesh>;
  145184. colors?: Color4[];
  145185. useVertexAlpha?: boolean;
  145186. }, scene?: Nullable<Scene>): LinesMesh;
  145187. /**
  145188. * Creates a dashed line mesh
  145189. * * 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
  145190. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145191. * * The parameter `points` is an array successive Vector3
  145192. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145193. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145194. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145195. * * 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
  145196. * * When updating an instance, remember that only point positions can change, not the number of points
  145197. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145198. * @param name defines the name of the mesh
  145199. * @param options defines the options used to create the mesh
  145200. * @param scene defines the hosting scene
  145201. * @returns the dashed line mesh
  145202. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145203. */
  145204. static CreateDashedLines(name: string, options: {
  145205. points: Vector3[];
  145206. dashSize?: number;
  145207. gapSize?: number;
  145208. dashNb?: number;
  145209. updatable?: boolean;
  145210. instance?: LinesMesh;
  145211. }, scene?: Nullable<Scene>): LinesMesh;
  145212. /**
  145213. * 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.
  145214. * * 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.
  145215. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145216. * * 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.
  145217. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145218. * * 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
  145219. * * 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
  145220. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145221. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145222. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145223. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145224. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145225. * @param name defines the name of the mesh
  145226. * @param options defines the options used to create the mesh
  145227. * @param scene defines the hosting scene
  145228. * @returns the extruded shape mesh
  145229. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145230. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145231. */
  145232. static ExtrudeShape(name: string, options: {
  145233. shape: Vector3[];
  145234. path: Vector3[];
  145235. scale?: number;
  145236. rotation?: number;
  145237. cap?: number;
  145238. updatable?: boolean;
  145239. sideOrientation?: number;
  145240. frontUVs?: Vector4;
  145241. backUVs?: Vector4;
  145242. instance?: Mesh;
  145243. invertUV?: boolean;
  145244. }, scene?: Nullable<Scene>): Mesh;
  145245. /**
  145246. * Creates an custom extruded shape mesh.
  145247. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145248. * * 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.
  145249. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145250. * * 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
  145251. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145252. * * 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
  145253. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145254. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145255. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145256. * * 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
  145257. * * 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
  145258. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145259. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145260. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145261. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145262. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145263. * @param name defines the name of the mesh
  145264. * @param options defines the options used to create the mesh
  145265. * @param scene defines the hosting scene
  145266. * @returns the custom extruded shape mesh
  145267. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145268. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145269. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145270. */
  145271. static ExtrudeShapeCustom(name: string, options: {
  145272. shape: Vector3[];
  145273. path: Vector3[];
  145274. scaleFunction?: any;
  145275. rotationFunction?: any;
  145276. ribbonCloseArray?: boolean;
  145277. ribbonClosePath?: boolean;
  145278. cap?: number;
  145279. updatable?: boolean;
  145280. sideOrientation?: number;
  145281. frontUVs?: Vector4;
  145282. backUVs?: Vector4;
  145283. instance?: Mesh;
  145284. invertUV?: boolean;
  145285. }, scene?: Nullable<Scene>): Mesh;
  145286. /**
  145287. * Creates lathe mesh.
  145288. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145289. * * 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
  145290. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145291. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145292. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145293. * * 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
  145294. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145295. * * 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
  145296. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145297. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145298. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145299. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145300. * @param name defines the name of the mesh
  145301. * @param options defines the options used to create the mesh
  145302. * @param scene defines the hosting scene
  145303. * @returns the lathe mesh
  145304. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145305. */
  145306. static CreateLathe(name: string, options: {
  145307. shape: Vector3[];
  145308. radius?: number;
  145309. tessellation?: number;
  145310. clip?: number;
  145311. arc?: number;
  145312. closed?: boolean;
  145313. updatable?: boolean;
  145314. sideOrientation?: number;
  145315. frontUVs?: Vector4;
  145316. backUVs?: Vector4;
  145317. cap?: number;
  145318. invertUV?: boolean;
  145319. }, scene?: Nullable<Scene>): Mesh;
  145320. /**
  145321. * Creates a tiled plane mesh
  145322. * * You can set a limited pattern arrangement with the tiles
  145323. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145324. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145325. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145326. * @param name defines the name of the mesh
  145327. * @param options defines the options used to create the mesh
  145328. * @param scene defines the hosting scene
  145329. * @returns the plane mesh
  145330. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145331. */
  145332. static CreateTiledPlane(name: string, options: {
  145333. pattern?: number;
  145334. tileSize?: number;
  145335. tileWidth?: number;
  145336. tileHeight?: number;
  145337. size?: number;
  145338. width?: number;
  145339. height?: number;
  145340. alignHorizontal?: number;
  145341. alignVertical?: number;
  145342. sideOrientation?: number;
  145343. frontUVs?: Vector4;
  145344. backUVs?: Vector4;
  145345. updatable?: boolean;
  145346. }, scene?: Nullable<Scene>): Mesh;
  145347. /**
  145348. * Creates a plane mesh
  145349. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145350. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145351. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145352. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145353. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145354. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145355. * @param name defines the name of the mesh
  145356. * @param options defines the options used to create the mesh
  145357. * @param scene defines the hosting scene
  145358. * @returns the plane mesh
  145359. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145360. */
  145361. static CreatePlane(name: string, options: {
  145362. size?: number;
  145363. width?: number;
  145364. height?: number;
  145365. sideOrientation?: number;
  145366. frontUVs?: Vector4;
  145367. backUVs?: Vector4;
  145368. updatable?: boolean;
  145369. sourcePlane?: Plane;
  145370. }, scene?: Nullable<Scene>): Mesh;
  145371. /**
  145372. * Creates a ground mesh
  145373. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145374. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145375. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145376. * @param name defines the name of the mesh
  145377. * @param options defines the options used to create the mesh
  145378. * @param scene defines the hosting scene
  145379. * @returns the ground mesh
  145380. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145381. */
  145382. static CreateGround(name: string, options: {
  145383. width?: number;
  145384. height?: number;
  145385. subdivisions?: number;
  145386. subdivisionsX?: number;
  145387. subdivisionsY?: number;
  145388. updatable?: boolean;
  145389. }, scene?: Nullable<Scene>): Mesh;
  145390. /**
  145391. * Creates a tiled ground mesh
  145392. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145393. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145394. * * 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
  145395. * * 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
  145396. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145397. * @param name defines the name of the mesh
  145398. * @param options defines the options used to create the mesh
  145399. * @param scene defines the hosting scene
  145400. * @returns the tiled ground mesh
  145401. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145402. */
  145403. static CreateTiledGround(name: string, options: {
  145404. xmin: number;
  145405. zmin: number;
  145406. xmax: number;
  145407. zmax: number;
  145408. subdivisions?: {
  145409. w: number;
  145410. h: number;
  145411. };
  145412. precision?: {
  145413. w: number;
  145414. h: number;
  145415. };
  145416. updatable?: boolean;
  145417. }, scene?: Nullable<Scene>): Mesh;
  145418. /**
  145419. * Creates a ground mesh from a height map
  145420. * * The parameter `url` sets the URL of the height map image resource.
  145421. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  145422. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  145423. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  145424. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  145425. * * 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.
  145426. * * 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).
  145427. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  145428. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145429. * @param name defines the name of the mesh
  145430. * @param url defines the url to the height map
  145431. * @param options defines the options used to create the mesh
  145432. * @param scene defines the hosting scene
  145433. * @returns the ground mesh
  145434. * @see https://doc.babylonjs.com/babylon101/height_map
  145435. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  145436. */
  145437. static CreateGroundFromHeightMap(name: string, url: string, options: {
  145438. width?: number;
  145439. height?: number;
  145440. subdivisions?: number;
  145441. minHeight?: number;
  145442. maxHeight?: number;
  145443. colorFilter?: Color3;
  145444. alphaFilter?: number;
  145445. updatable?: boolean;
  145446. onReady?: (mesh: GroundMesh) => void;
  145447. }, scene?: Nullable<Scene>): GroundMesh;
  145448. /**
  145449. * Creates a polygon mesh
  145450. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145451. * * 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
  145452. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145453. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145454. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145455. * * Remember you can only change the shape positions, not their number when updating a polygon
  145456. * @param name defines the name of the mesh
  145457. * @param options defines the options used to create the mesh
  145458. * @param scene defines the hosting scene
  145459. * @param earcutInjection can be used to inject your own earcut reference
  145460. * @returns the polygon mesh
  145461. */
  145462. static CreatePolygon(name: string, options: {
  145463. shape: Vector3[];
  145464. holes?: Vector3[][];
  145465. depth?: number;
  145466. faceUV?: Vector4[];
  145467. faceColors?: Color4[];
  145468. updatable?: boolean;
  145469. sideOrientation?: number;
  145470. frontUVs?: Vector4;
  145471. backUVs?: Vector4;
  145472. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145473. /**
  145474. * Creates an extruded polygon mesh, with depth in the Y direction.
  145475. * * 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)
  145476. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145477. * @param name defines the name of the mesh
  145478. * @param options defines the options used to create the mesh
  145479. * @param scene defines the hosting scene
  145480. * @param earcutInjection can be used to inject your own earcut reference
  145481. * @returns the polygon mesh
  145482. */
  145483. static ExtrudePolygon(name: string, options: {
  145484. shape: Vector3[];
  145485. holes?: Vector3[][];
  145486. depth?: number;
  145487. faceUV?: Vector4[];
  145488. faceColors?: Color4[];
  145489. updatable?: boolean;
  145490. sideOrientation?: number;
  145491. frontUVs?: Vector4;
  145492. backUVs?: Vector4;
  145493. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145494. /**
  145495. * Creates a tube mesh.
  145496. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145497. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145498. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145499. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145500. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145501. * * 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)
  145502. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145503. * * 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
  145504. * * 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
  145505. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145506. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145507. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145508. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145509. * @param name defines the name of the mesh
  145510. * @param options defines the options used to create the mesh
  145511. * @param scene defines the hosting scene
  145512. * @returns the tube mesh
  145513. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145514. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145515. */
  145516. static CreateTube(name: string, options: {
  145517. path: Vector3[];
  145518. radius?: number;
  145519. tessellation?: number;
  145520. radiusFunction?: {
  145521. (i: number, distance: number): number;
  145522. };
  145523. cap?: number;
  145524. arc?: number;
  145525. updatable?: boolean;
  145526. sideOrientation?: number;
  145527. frontUVs?: Vector4;
  145528. backUVs?: Vector4;
  145529. instance?: Mesh;
  145530. invertUV?: boolean;
  145531. }, scene?: Nullable<Scene>): Mesh;
  145532. /**
  145533. * Creates a polyhedron mesh
  145534. * * 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
  145535. * * The parameter `size` (positive float, default 1) sets the polygon size
  145536. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  145537. * * 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`
  145538. * * 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
  145539. * * 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)`)
  145540. * * 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
  145541. * * 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
  145542. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145543. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145544. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145545. * @param name defines the name of the mesh
  145546. * @param options defines the options used to create the mesh
  145547. * @param scene defines the hosting scene
  145548. * @returns the polyhedron mesh
  145549. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  145550. */
  145551. static CreatePolyhedron(name: string, options: {
  145552. type?: number;
  145553. size?: number;
  145554. sizeX?: number;
  145555. sizeY?: number;
  145556. sizeZ?: number;
  145557. custom?: any;
  145558. faceUV?: Vector4[];
  145559. faceColors?: Color4[];
  145560. flat?: boolean;
  145561. updatable?: boolean;
  145562. sideOrientation?: number;
  145563. frontUVs?: Vector4;
  145564. backUVs?: Vector4;
  145565. }, scene?: Nullable<Scene>): Mesh;
  145566. /**
  145567. * Creates a decal mesh.
  145568. * 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
  145569. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145570. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145571. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145572. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145573. * @param name defines the name of the mesh
  145574. * @param sourceMesh defines the mesh where the decal must be applied
  145575. * @param options defines the options used to create the mesh
  145576. * @param scene defines the hosting scene
  145577. * @returns the decal mesh
  145578. * @see https://doc.babylonjs.com/how_to/decals
  145579. */
  145580. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145581. position?: Vector3;
  145582. normal?: Vector3;
  145583. size?: Vector3;
  145584. angle?: number;
  145585. }): Mesh;
  145586. }
  145587. }
  145588. declare module BABYLON {
  145589. /**
  145590. * A simplifier interface for future simplification implementations
  145591. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145592. */
  145593. export interface ISimplifier {
  145594. /**
  145595. * Simplification of a given mesh according to the given settings.
  145596. * Since this requires computation, it is assumed that the function runs async.
  145597. * @param settings The settings of the simplification, including quality and distance
  145598. * @param successCallback A callback that will be called after the mesh was simplified.
  145599. * @param errorCallback in case of an error, this callback will be called. optional.
  145600. */
  145601. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  145602. }
  145603. /**
  145604. * Expected simplification settings.
  145605. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  145606. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145607. */
  145608. export interface ISimplificationSettings {
  145609. /**
  145610. * Gets or sets the expected quality
  145611. */
  145612. quality: number;
  145613. /**
  145614. * Gets or sets the distance when this optimized version should be used
  145615. */
  145616. distance: number;
  145617. /**
  145618. * Gets an already optimized mesh
  145619. */
  145620. optimizeMesh?: boolean;
  145621. }
  145622. /**
  145623. * Class used to specify simplification options
  145624. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145625. */
  145626. export class SimplificationSettings implements ISimplificationSettings {
  145627. /** expected quality */
  145628. quality: number;
  145629. /** distance when this optimized version should be used */
  145630. distance: number;
  145631. /** already optimized mesh */
  145632. optimizeMesh?: boolean | undefined;
  145633. /**
  145634. * Creates a SimplificationSettings
  145635. * @param quality expected quality
  145636. * @param distance distance when this optimized version should be used
  145637. * @param optimizeMesh already optimized mesh
  145638. */
  145639. constructor(
  145640. /** expected quality */
  145641. quality: number,
  145642. /** distance when this optimized version should be used */
  145643. distance: number,
  145644. /** already optimized mesh */
  145645. optimizeMesh?: boolean | undefined);
  145646. }
  145647. /**
  145648. * Interface used to define a simplification task
  145649. */
  145650. export interface ISimplificationTask {
  145651. /**
  145652. * Array of settings
  145653. */
  145654. settings: Array<ISimplificationSettings>;
  145655. /**
  145656. * Simplification type
  145657. */
  145658. simplificationType: SimplificationType;
  145659. /**
  145660. * Mesh to simplify
  145661. */
  145662. mesh: Mesh;
  145663. /**
  145664. * Callback called on success
  145665. */
  145666. successCallback?: () => void;
  145667. /**
  145668. * Defines if parallel processing can be used
  145669. */
  145670. parallelProcessing: boolean;
  145671. }
  145672. /**
  145673. * Queue used to order the simplification tasks
  145674. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145675. */
  145676. export class SimplificationQueue {
  145677. private _simplificationArray;
  145678. /**
  145679. * Gets a boolean indicating that the process is still running
  145680. */
  145681. running: boolean;
  145682. /**
  145683. * Creates a new queue
  145684. */
  145685. constructor();
  145686. /**
  145687. * Adds a new simplification task
  145688. * @param task defines a task to add
  145689. */
  145690. addTask(task: ISimplificationTask): void;
  145691. /**
  145692. * Execute next task
  145693. */
  145694. executeNext(): void;
  145695. /**
  145696. * Execute a simplification task
  145697. * @param task defines the task to run
  145698. */
  145699. runSimplification(task: ISimplificationTask): void;
  145700. private getSimplifier;
  145701. }
  145702. /**
  145703. * The implemented types of simplification
  145704. * At the moment only Quadratic Error Decimation is implemented
  145705. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145706. */
  145707. export enum SimplificationType {
  145708. /** Quadratic error decimation */
  145709. QUADRATIC = 0
  145710. }
  145711. /**
  145712. * An implementation of the Quadratic Error simplification algorithm.
  145713. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  145714. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  145715. * @author RaananW
  145716. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145717. */
  145718. export class QuadraticErrorSimplification implements ISimplifier {
  145719. private _mesh;
  145720. private triangles;
  145721. private vertices;
  145722. private references;
  145723. private _reconstructedMesh;
  145724. /** Gets or sets the number pf sync interations */
  145725. syncIterations: number;
  145726. /** Gets or sets the aggressiveness of the simplifier */
  145727. aggressiveness: number;
  145728. /** Gets or sets the number of allowed iterations for decimation */
  145729. decimationIterations: number;
  145730. /** Gets or sets the espilon to use for bounding box computation */
  145731. boundingBoxEpsilon: number;
  145732. /**
  145733. * Creates a new QuadraticErrorSimplification
  145734. * @param _mesh defines the target mesh
  145735. */
  145736. constructor(_mesh: Mesh);
  145737. /**
  145738. * Simplification of a given mesh according to the given settings.
  145739. * Since this requires computation, it is assumed that the function runs async.
  145740. * @param settings The settings of the simplification, including quality and distance
  145741. * @param successCallback A callback that will be called after the mesh was simplified.
  145742. */
  145743. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  145744. private runDecimation;
  145745. private initWithMesh;
  145746. private init;
  145747. private reconstructMesh;
  145748. private initDecimatedMesh;
  145749. private isFlipped;
  145750. private updateTriangles;
  145751. private identifyBorder;
  145752. private updateMesh;
  145753. private vertexError;
  145754. private calculateError;
  145755. }
  145756. }
  145757. declare module BABYLON {
  145758. interface Scene {
  145759. /** @hidden (Backing field) */
  145760. _simplificationQueue: SimplificationQueue;
  145761. /**
  145762. * Gets or sets the simplification queue attached to the scene
  145763. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145764. */
  145765. simplificationQueue: SimplificationQueue;
  145766. }
  145767. interface Mesh {
  145768. /**
  145769. * Simplify the mesh according to the given array of settings.
  145770. * Function will return immediately and will simplify async
  145771. * @param settings a collection of simplification settings
  145772. * @param parallelProcessing should all levels calculate parallel or one after the other
  145773. * @param simplificationType the type of simplification to run
  145774. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  145775. * @returns the current mesh
  145776. */
  145777. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  145778. }
  145779. /**
  145780. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  145781. * created in a scene
  145782. */
  145783. export class SimplicationQueueSceneComponent implements ISceneComponent {
  145784. /**
  145785. * The component name helpfull to identify the component in the list of scene components.
  145786. */
  145787. readonly name: string;
  145788. /**
  145789. * The scene the component belongs to.
  145790. */
  145791. scene: Scene;
  145792. /**
  145793. * Creates a new instance of the component for the given scene
  145794. * @param scene Defines the scene to register the component in
  145795. */
  145796. constructor(scene: Scene);
  145797. /**
  145798. * Registers the component in a given scene
  145799. */
  145800. register(): void;
  145801. /**
  145802. * Rebuilds the elements related to this component in case of
  145803. * context lost for instance.
  145804. */
  145805. rebuild(): void;
  145806. /**
  145807. * Disposes the component and the associated ressources
  145808. */
  145809. dispose(): void;
  145810. private _beforeCameraUpdate;
  145811. }
  145812. }
  145813. declare module BABYLON {
  145814. interface Mesh {
  145815. /**
  145816. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  145817. */
  145818. thinInstanceEnablePicking: boolean;
  145819. /**
  145820. * Creates a new thin instance
  145821. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  145822. * @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
  145823. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  145824. */
  145825. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  145826. /**
  145827. * Adds the transformation (matrix) of the current mesh as a thin instance
  145828. * @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
  145829. * @returns the thin instance index number
  145830. */
  145831. thinInstanceAddSelf(refresh: boolean): number;
  145832. /**
  145833. * Registers a custom attribute to be used with thin instances
  145834. * @param kind name of the attribute
  145835. * @param stride size in floats of the attribute
  145836. */
  145837. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  145838. /**
  145839. * Sets the matrix of a thin instance
  145840. * @param index index of the thin instance
  145841. * @param matrix matrix to set
  145842. * @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
  145843. */
  145844. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  145845. /**
  145846. * Sets the value of a custom attribute for a thin instance
  145847. * @param kind name of the attribute
  145848. * @param index index of the thin instance
  145849. * @param value value to set
  145850. * @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
  145851. */
  145852. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  145853. /**
  145854. * 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.
  145855. */
  145856. thinInstanceCount: number;
  145857. /**
  145858. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  145859. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  145860. * @param buffer buffer to set
  145861. * @param stride size in floats of each value of the buffer
  145862. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  145863. */
  145864. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  145865. /**
  145866. * Gets the list of world matrices
  145867. * @return an array containing all the world matrices from the thin instances
  145868. */
  145869. thinInstanceGetWorldMatrices(): Matrix[];
  145870. /**
  145871. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  145872. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  145873. */
  145874. thinInstanceBufferUpdated(kind: string): void;
  145875. /**
  145876. * Refreshes the bounding info, taking into account all the thin instances defined
  145877. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  145878. */
  145879. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  145880. /** @hidden */
  145881. _thinInstanceInitializeUserStorage(): void;
  145882. /** @hidden */
  145883. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  145884. /** @hidden */
  145885. _userThinInstanceBuffersStorage: {
  145886. data: {
  145887. [key: string]: Float32Array;
  145888. };
  145889. sizes: {
  145890. [key: string]: number;
  145891. };
  145892. vertexBuffers: {
  145893. [key: string]: Nullable<VertexBuffer>;
  145894. };
  145895. strides: {
  145896. [key: string]: number;
  145897. };
  145898. };
  145899. }
  145900. }
  145901. declare module BABYLON {
  145902. /**
  145903. * Navigation plugin interface to add navigation constrained by a navigation mesh
  145904. */
  145905. export interface INavigationEnginePlugin {
  145906. /**
  145907. * plugin name
  145908. */
  145909. name: string;
  145910. /**
  145911. * Creates a navigation mesh
  145912. * @param meshes array of all the geometry used to compute the navigatio mesh
  145913. * @param parameters bunch of parameters used to filter geometry
  145914. */
  145915. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  145916. /**
  145917. * Create a navigation mesh debug mesh
  145918. * @param scene is where the mesh will be added
  145919. * @returns debug display mesh
  145920. */
  145921. createDebugNavMesh(scene: Scene): Mesh;
  145922. /**
  145923. * Get a navigation mesh constrained position, closest to the parameter position
  145924. * @param position world position
  145925. * @returns the closest point to position constrained by the navigation mesh
  145926. */
  145927. getClosestPoint(position: Vector3): Vector3;
  145928. /**
  145929. * Get a navigation mesh constrained position, closest to the parameter position
  145930. * @param position world position
  145931. * @param result output the closest point to position constrained by the navigation mesh
  145932. */
  145933. getClosestPointToRef(position: Vector3, result: Vector3): void;
  145934. /**
  145935. * Get a navigation mesh constrained position, within a particular radius
  145936. * @param position world position
  145937. * @param maxRadius the maximum distance to the constrained world position
  145938. * @returns the closest point to position constrained by the navigation mesh
  145939. */
  145940. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  145941. /**
  145942. * Get a navigation mesh constrained position, within a particular radius
  145943. * @param position world position
  145944. * @param maxRadius the maximum distance to the constrained world position
  145945. * @param result output the closest point to position constrained by the navigation mesh
  145946. */
  145947. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  145948. /**
  145949. * Compute the final position from a segment made of destination-position
  145950. * @param position world position
  145951. * @param destination world position
  145952. * @returns the resulting point along the navmesh
  145953. */
  145954. moveAlong(position: Vector3, destination: Vector3): Vector3;
  145955. /**
  145956. * Compute the final position from a segment made of destination-position
  145957. * @param position world position
  145958. * @param destination world position
  145959. * @param result output the resulting point along the navmesh
  145960. */
  145961. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  145962. /**
  145963. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  145964. * @param start world position
  145965. * @param end world position
  145966. * @returns array containing world position composing the path
  145967. */
  145968. computePath(start: Vector3, end: Vector3): Vector3[];
  145969. /**
  145970. * If this plugin is supported
  145971. * @returns true if plugin is supported
  145972. */
  145973. isSupported(): boolean;
  145974. /**
  145975. * Create a new Crowd so you can add agents
  145976. * @param maxAgents the maximum agent count in the crowd
  145977. * @param maxAgentRadius the maximum radius an agent can have
  145978. * @param scene to attach the crowd to
  145979. * @returns the crowd you can add agents to
  145980. */
  145981. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  145982. /**
  145983. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  145984. * The queries will try to find a solution within those bounds
  145985. * default is (1,1,1)
  145986. * @param extent x,y,z value that define the extent around the queries point of reference
  145987. */
  145988. setDefaultQueryExtent(extent: Vector3): void;
  145989. /**
  145990. * Get the Bounding box extent specified by setDefaultQueryExtent
  145991. * @returns the box extent values
  145992. */
  145993. getDefaultQueryExtent(): Vector3;
  145994. /**
  145995. * build the navmesh from a previously saved state using getNavmeshData
  145996. * @param data the Uint8Array returned by getNavmeshData
  145997. */
  145998. buildFromNavmeshData(data: Uint8Array): void;
  145999. /**
  146000. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146001. * @returns data the Uint8Array that can be saved and reused
  146002. */
  146003. getNavmeshData(): Uint8Array;
  146004. /**
  146005. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146006. * @param result output the box extent values
  146007. */
  146008. getDefaultQueryExtentToRef(result: Vector3): void;
  146009. /**
  146010. * Release all resources
  146011. */
  146012. dispose(): void;
  146013. }
  146014. /**
  146015. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146016. */
  146017. export interface ICrowd {
  146018. /**
  146019. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146020. * You can attach anything to that node. The node position is updated in the scene update tick.
  146021. * @param pos world position that will be constrained by the navigation mesh
  146022. * @param parameters agent parameters
  146023. * @param transform hooked to the agent that will be update by the scene
  146024. * @returns agent index
  146025. */
  146026. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146027. /**
  146028. * Returns the agent position in world space
  146029. * @param index agent index returned by addAgent
  146030. * @returns world space position
  146031. */
  146032. getAgentPosition(index: number): Vector3;
  146033. /**
  146034. * Gets the agent position result in world space
  146035. * @param index agent index returned by addAgent
  146036. * @param result output world space position
  146037. */
  146038. getAgentPositionToRef(index: number, result: Vector3): void;
  146039. /**
  146040. * Gets the agent velocity in world space
  146041. * @param index agent index returned by addAgent
  146042. * @returns world space velocity
  146043. */
  146044. getAgentVelocity(index: number): Vector3;
  146045. /**
  146046. * Gets the agent velocity result in world space
  146047. * @param index agent index returned by addAgent
  146048. * @param result output world space velocity
  146049. */
  146050. getAgentVelocityToRef(index: number, result: Vector3): void;
  146051. /**
  146052. * remove a particular agent previously created
  146053. * @param index agent index returned by addAgent
  146054. */
  146055. removeAgent(index: number): void;
  146056. /**
  146057. * get the list of all agents attached to this crowd
  146058. * @returns list of agent indices
  146059. */
  146060. getAgents(): number[];
  146061. /**
  146062. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146063. * @param deltaTime in seconds
  146064. */
  146065. update(deltaTime: number): void;
  146066. /**
  146067. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146068. * @param index agent index returned by addAgent
  146069. * @param destination targeted world position
  146070. */
  146071. agentGoto(index: number, destination: Vector3): void;
  146072. /**
  146073. * Teleport the agent to a new position
  146074. * @param index agent index returned by addAgent
  146075. * @param destination targeted world position
  146076. */
  146077. agentTeleport(index: number, destination: Vector3): void;
  146078. /**
  146079. * Update agent parameters
  146080. * @param index agent index returned by addAgent
  146081. * @param parameters agent parameters
  146082. */
  146083. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146084. /**
  146085. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146086. * The queries will try to find a solution within those bounds
  146087. * default is (1,1,1)
  146088. * @param extent x,y,z value that define the extent around the queries point of reference
  146089. */
  146090. setDefaultQueryExtent(extent: Vector3): void;
  146091. /**
  146092. * Get the Bounding box extent specified by setDefaultQueryExtent
  146093. * @returns the box extent values
  146094. */
  146095. getDefaultQueryExtent(): Vector3;
  146096. /**
  146097. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146098. * @param result output the box extent values
  146099. */
  146100. getDefaultQueryExtentToRef(result: Vector3): void;
  146101. /**
  146102. * Release all resources
  146103. */
  146104. dispose(): void;
  146105. }
  146106. /**
  146107. * Configures an agent
  146108. */
  146109. export interface IAgentParameters {
  146110. /**
  146111. * Agent radius. [Limit: >= 0]
  146112. */
  146113. radius: number;
  146114. /**
  146115. * Agent height. [Limit: > 0]
  146116. */
  146117. height: number;
  146118. /**
  146119. * Maximum allowed acceleration. [Limit: >= 0]
  146120. */
  146121. maxAcceleration: number;
  146122. /**
  146123. * Maximum allowed speed. [Limit: >= 0]
  146124. */
  146125. maxSpeed: number;
  146126. /**
  146127. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146128. */
  146129. collisionQueryRange: number;
  146130. /**
  146131. * The path visibility optimization range. [Limit: > 0]
  146132. */
  146133. pathOptimizationRange: number;
  146134. /**
  146135. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146136. */
  146137. separationWeight: number;
  146138. }
  146139. /**
  146140. * Configures the navigation mesh creation
  146141. */
  146142. export interface INavMeshParameters {
  146143. /**
  146144. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146145. */
  146146. cs: number;
  146147. /**
  146148. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146149. */
  146150. ch: number;
  146151. /**
  146152. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146153. */
  146154. walkableSlopeAngle: number;
  146155. /**
  146156. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146157. * be considered walkable. [Limit: >= 3] [Units: vx]
  146158. */
  146159. walkableHeight: number;
  146160. /**
  146161. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146162. */
  146163. walkableClimb: number;
  146164. /**
  146165. * The distance to erode/shrink the walkable area of the heightfield away from
  146166. * obstructions. [Limit: >=0] [Units: vx]
  146167. */
  146168. walkableRadius: number;
  146169. /**
  146170. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146171. */
  146172. maxEdgeLen: number;
  146173. /**
  146174. * The maximum distance a simplfied contour's border edges should deviate
  146175. * the original raw contour. [Limit: >=0] [Units: vx]
  146176. */
  146177. maxSimplificationError: number;
  146178. /**
  146179. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146180. */
  146181. minRegionArea: number;
  146182. /**
  146183. * Any regions with a span count smaller than this value will, if possible,
  146184. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146185. */
  146186. mergeRegionArea: number;
  146187. /**
  146188. * The maximum number of vertices allowed for polygons generated during the
  146189. * contour to polygon conversion process. [Limit: >= 3]
  146190. */
  146191. maxVertsPerPoly: number;
  146192. /**
  146193. * Sets the sampling distance to use when generating the detail mesh.
  146194. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146195. */
  146196. detailSampleDist: number;
  146197. /**
  146198. * The maximum distance the detail mesh surface should deviate from heightfield
  146199. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146200. */
  146201. detailSampleMaxError: number;
  146202. }
  146203. }
  146204. declare module BABYLON {
  146205. /**
  146206. * RecastJS navigation plugin
  146207. */
  146208. export class RecastJSPlugin implements INavigationEnginePlugin {
  146209. /**
  146210. * Reference to the Recast library
  146211. */
  146212. bjsRECAST: any;
  146213. /**
  146214. * plugin name
  146215. */
  146216. name: string;
  146217. /**
  146218. * the first navmesh created. We might extend this to support multiple navmeshes
  146219. */
  146220. navMesh: any;
  146221. /**
  146222. * Initializes the recastJS plugin
  146223. * @param recastInjection can be used to inject your own recast reference
  146224. */
  146225. constructor(recastInjection?: any);
  146226. /**
  146227. * Creates a navigation mesh
  146228. * @param meshes array of all the geometry used to compute the navigatio mesh
  146229. * @param parameters bunch of parameters used to filter geometry
  146230. */
  146231. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146232. /**
  146233. * Create a navigation mesh debug mesh
  146234. * @param scene is where the mesh will be added
  146235. * @returns debug display mesh
  146236. */
  146237. createDebugNavMesh(scene: Scene): Mesh;
  146238. /**
  146239. * Get a navigation mesh constrained position, closest to the parameter position
  146240. * @param position world position
  146241. * @returns the closest point to position constrained by the navigation mesh
  146242. */
  146243. getClosestPoint(position: Vector3): Vector3;
  146244. /**
  146245. * Get a navigation mesh constrained position, closest to the parameter position
  146246. * @param position world position
  146247. * @param result output the closest point to position constrained by the navigation mesh
  146248. */
  146249. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146250. /**
  146251. * Get a navigation mesh constrained position, within a particular radius
  146252. * @param position world position
  146253. * @param maxRadius the maximum distance to the constrained world position
  146254. * @returns the closest point to position constrained by the navigation mesh
  146255. */
  146256. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146257. /**
  146258. * Get a navigation mesh constrained position, within a particular radius
  146259. * @param position world position
  146260. * @param maxRadius the maximum distance to the constrained world position
  146261. * @param result output the closest point to position constrained by the navigation mesh
  146262. */
  146263. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146264. /**
  146265. * Compute the final position from a segment made of destination-position
  146266. * @param position world position
  146267. * @param destination world position
  146268. * @returns the resulting point along the navmesh
  146269. */
  146270. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146271. /**
  146272. * Compute the final position from a segment made of destination-position
  146273. * @param position world position
  146274. * @param destination world position
  146275. * @param result output the resulting point along the navmesh
  146276. */
  146277. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146278. /**
  146279. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146280. * @param start world position
  146281. * @param end world position
  146282. * @returns array containing world position composing the path
  146283. */
  146284. computePath(start: Vector3, end: Vector3): Vector3[];
  146285. /**
  146286. * Create a new Crowd so you can add agents
  146287. * @param maxAgents the maximum agent count in the crowd
  146288. * @param maxAgentRadius the maximum radius an agent can have
  146289. * @param scene to attach the crowd to
  146290. * @returns the crowd you can add agents to
  146291. */
  146292. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146293. /**
  146294. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146295. * The queries will try to find a solution within those bounds
  146296. * default is (1,1,1)
  146297. * @param extent x,y,z value that define the extent around the queries point of reference
  146298. */
  146299. setDefaultQueryExtent(extent: Vector3): void;
  146300. /**
  146301. * Get the Bounding box extent specified by setDefaultQueryExtent
  146302. * @returns the box extent values
  146303. */
  146304. getDefaultQueryExtent(): Vector3;
  146305. /**
  146306. * build the navmesh from a previously saved state using getNavmeshData
  146307. * @param data the Uint8Array returned by getNavmeshData
  146308. */
  146309. buildFromNavmeshData(data: Uint8Array): void;
  146310. /**
  146311. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146312. * @returns data the Uint8Array that can be saved and reused
  146313. */
  146314. getNavmeshData(): Uint8Array;
  146315. /**
  146316. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146317. * @param result output the box extent values
  146318. */
  146319. getDefaultQueryExtentToRef(result: Vector3): void;
  146320. /**
  146321. * Disposes
  146322. */
  146323. dispose(): void;
  146324. /**
  146325. * If this plugin is supported
  146326. * @returns true if plugin is supported
  146327. */
  146328. isSupported(): boolean;
  146329. }
  146330. /**
  146331. * Recast detour crowd implementation
  146332. */
  146333. export class RecastJSCrowd implements ICrowd {
  146334. /**
  146335. * Recast/detour plugin
  146336. */
  146337. bjsRECASTPlugin: RecastJSPlugin;
  146338. /**
  146339. * Link to the detour crowd
  146340. */
  146341. recastCrowd: any;
  146342. /**
  146343. * One transform per agent
  146344. */
  146345. transforms: TransformNode[];
  146346. /**
  146347. * All agents created
  146348. */
  146349. agents: number[];
  146350. /**
  146351. * Link to the scene is kept to unregister the crowd from the scene
  146352. */
  146353. private _scene;
  146354. /**
  146355. * Observer for crowd updates
  146356. */
  146357. private _onBeforeAnimationsObserver;
  146358. /**
  146359. * Constructor
  146360. * @param plugin recastJS plugin
  146361. * @param maxAgents the maximum agent count in the crowd
  146362. * @param maxAgentRadius the maximum radius an agent can have
  146363. * @param scene to attach the crowd to
  146364. * @returns the crowd you can add agents to
  146365. */
  146366. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146367. /**
  146368. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146369. * You can attach anything to that node. The node position is updated in the scene update tick.
  146370. * @param pos world position that will be constrained by the navigation mesh
  146371. * @param parameters agent parameters
  146372. * @param transform hooked to the agent that will be update by the scene
  146373. * @returns agent index
  146374. */
  146375. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146376. /**
  146377. * Returns the agent position in world space
  146378. * @param index agent index returned by addAgent
  146379. * @returns world space position
  146380. */
  146381. getAgentPosition(index: number): Vector3;
  146382. /**
  146383. * Returns the agent position result in world space
  146384. * @param index agent index returned by addAgent
  146385. * @param result output world space position
  146386. */
  146387. getAgentPositionToRef(index: number, result: Vector3): void;
  146388. /**
  146389. * Returns the agent velocity in world space
  146390. * @param index agent index returned by addAgent
  146391. * @returns world space velocity
  146392. */
  146393. getAgentVelocity(index: number): Vector3;
  146394. /**
  146395. * Returns the agent velocity result in world space
  146396. * @param index agent index returned by addAgent
  146397. * @param result output world space velocity
  146398. */
  146399. getAgentVelocityToRef(index: number, result: Vector3): void;
  146400. /**
  146401. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146402. * @param index agent index returned by addAgent
  146403. * @param destination targeted world position
  146404. */
  146405. agentGoto(index: number, destination: Vector3): void;
  146406. /**
  146407. * Teleport the agent to a new position
  146408. * @param index agent index returned by addAgent
  146409. * @param destination targeted world position
  146410. */
  146411. agentTeleport(index: number, destination: Vector3): void;
  146412. /**
  146413. * Update agent parameters
  146414. * @param index agent index returned by addAgent
  146415. * @param parameters agent parameters
  146416. */
  146417. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146418. /**
  146419. * remove a particular agent previously created
  146420. * @param index agent index returned by addAgent
  146421. */
  146422. removeAgent(index: number): void;
  146423. /**
  146424. * get the list of all agents attached to this crowd
  146425. * @returns list of agent indices
  146426. */
  146427. getAgents(): number[];
  146428. /**
  146429. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146430. * @param deltaTime in seconds
  146431. */
  146432. update(deltaTime: number): void;
  146433. /**
  146434. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146435. * The queries will try to find a solution within those bounds
  146436. * default is (1,1,1)
  146437. * @param extent x,y,z value that define the extent around the queries point of reference
  146438. */
  146439. setDefaultQueryExtent(extent: Vector3): void;
  146440. /**
  146441. * Get the Bounding box extent specified by setDefaultQueryExtent
  146442. * @returns the box extent values
  146443. */
  146444. getDefaultQueryExtent(): Vector3;
  146445. /**
  146446. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146447. * @param result output the box extent values
  146448. */
  146449. getDefaultQueryExtentToRef(result: Vector3): void;
  146450. /**
  146451. * Release all resources
  146452. */
  146453. dispose(): void;
  146454. }
  146455. }
  146456. declare module BABYLON {
  146457. /**
  146458. * Class used to enable access to IndexedDB
  146459. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  146460. */
  146461. export class Database implements IOfflineProvider {
  146462. private _callbackManifestChecked;
  146463. private _currentSceneUrl;
  146464. private _db;
  146465. private _enableSceneOffline;
  146466. private _enableTexturesOffline;
  146467. private _manifestVersionFound;
  146468. private _mustUpdateRessources;
  146469. private _hasReachedQuota;
  146470. private _isSupported;
  146471. private _idbFactory;
  146472. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  146473. private static IsUASupportingBlobStorage;
  146474. /**
  146475. * Gets a boolean indicating if Database storate is enabled (off by default)
  146476. */
  146477. static IDBStorageEnabled: boolean;
  146478. /**
  146479. * Gets a boolean indicating if scene must be saved in the database
  146480. */
  146481. get enableSceneOffline(): boolean;
  146482. /**
  146483. * Gets a boolean indicating if textures must be saved in the database
  146484. */
  146485. get enableTexturesOffline(): boolean;
  146486. /**
  146487. * Creates a new Database
  146488. * @param urlToScene defines the url to load the scene
  146489. * @param callbackManifestChecked defines the callback to use when manifest is checked
  146490. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  146491. */
  146492. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  146493. private static _ParseURL;
  146494. private static _ReturnFullUrlLocation;
  146495. private _checkManifestFile;
  146496. /**
  146497. * Open the database and make it available
  146498. * @param successCallback defines the callback to call on success
  146499. * @param errorCallback defines the callback to call on error
  146500. */
  146501. open(successCallback: () => void, errorCallback: () => void): void;
  146502. /**
  146503. * Loads an image from the database
  146504. * @param url defines the url to load from
  146505. * @param image defines the target DOM image
  146506. */
  146507. loadImage(url: string, image: HTMLImageElement): void;
  146508. private _loadImageFromDBAsync;
  146509. private _saveImageIntoDBAsync;
  146510. private _checkVersionFromDB;
  146511. private _loadVersionFromDBAsync;
  146512. private _saveVersionIntoDBAsync;
  146513. /**
  146514. * Loads a file from database
  146515. * @param url defines the URL to load from
  146516. * @param sceneLoaded defines a callback to call on success
  146517. * @param progressCallBack defines a callback to call when progress changed
  146518. * @param errorCallback defines a callback to call on error
  146519. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  146520. */
  146521. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  146522. private _loadFileAsync;
  146523. private _saveFileAsync;
  146524. /**
  146525. * Validates if xhr data is correct
  146526. * @param xhr defines the request to validate
  146527. * @param dataType defines the expected data type
  146528. * @returns true if data is correct
  146529. */
  146530. private static _ValidateXHRData;
  146531. }
  146532. }
  146533. declare module BABYLON {
  146534. /** @hidden */
  146535. export var gpuUpdateParticlesPixelShader: {
  146536. name: string;
  146537. shader: string;
  146538. };
  146539. }
  146540. declare module BABYLON {
  146541. /** @hidden */
  146542. export var gpuUpdateParticlesVertexShader: {
  146543. name: string;
  146544. shader: string;
  146545. };
  146546. }
  146547. declare module BABYLON {
  146548. /** @hidden */
  146549. export var clipPlaneFragmentDeclaration2: {
  146550. name: string;
  146551. shader: string;
  146552. };
  146553. }
  146554. declare module BABYLON {
  146555. /** @hidden */
  146556. export var gpuRenderParticlesPixelShader: {
  146557. name: string;
  146558. shader: string;
  146559. };
  146560. }
  146561. declare module BABYLON {
  146562. /** @hidden */
  146563. export var clipPlaneVertexDeclaration2: {
  146564. name: string;
  146565. shader: string;
  146566. };
  146567. }
  146568. declare module BABYLON {
  146569. /** @hidden */
  146570. export var gpuRenderParticlesVertexShader: {
  146571. name: string;
  146572. shader: string;
  146573. };
  146574. }
  146575. declare module BABYLON {
  146576. /**
  146577. * This represents a GPU particle system in Babylon
  146578. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  146579. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  146580. */
  146581. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  146582. /**
  146583. * The layer mask we are rendering the particles through.
  146584. */
  146585. layerMask: number;
  146586. private _capacity;
  146587. private _activeCount;
  146588. private _currentActiveCount;
  146589. private _accumulatedCount;
  146590. private _renderEffect;
  146591. private _updateEffect;
  146592. private _buffer0;
  146593. private _buffer1;
  146594. private _spriteBuffer;
  146595. private _updateVAO;
  146596. private _renderVAO;
  146597. private _targetIndex;
  146598. private _sourceBuffer;
  146599. private _targetBuffer;
  146600. private _currentRenderId;
  146601. private _started;
  146602. private _stopped;
  146603. private _timeDelta;
  146604. private _randomTexture;
  146605. private _randomTexture2;
  146606. private _attributesStrideSize;
  146607. private _updateEffectOptions;
  146608. private _randomTextureSize;
  146609. private _actualFrame;
  146610. private _customEffect;
  146611. private readonly _rawTextureWidth;
  146612. /**
  146613. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  146614. */
  146615. static get IsSupported(): boolean;
  146616. /**
  146617. * An event triggered when the system is disposed.
  146618. */
  146619. onDisposeObservable: Observable<IParticleSystem>;
  146620. /**
  146621. * Gets the maximum number of particles active at the same time.
  146622. * @returns The max number of active particles.
  146623. */
  146624. getCapacity(): number;
  146625. /**
  146626. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  146627. * to override the particles.
  146628. */
  146629. forceDepthWrite: boolean;
  146630. /**
  146631. * Gets or set the number of active particles
  146632. */
  146633. get activeParticleCount(): number;
  146634. set activeParticleCount(value: number);
  146635. private _preWarmDone;
  146636. /**
  146637. * Specifies if the particles are updated in emitter local space or world space.
  146638. */
  146639. isLocal: boolean;
  146640. /** Gets or sets a matrix to use to compute projection */
  146641. defaultProjectionMatrix: Matrix;
  146642. /**
  146643. * Is this system ready to be used/rendered
  146644. * @return true if the system is ready
  146645. */
  146646. isReady(): boolean;
  146647. /**
  146648. * Gets if the system has been started. (Note: this will still be true after stop is called)
  146649. * @returns True if it has been started, otherwise false.
  146650. */
  146651. isStarted(): boolean;
  146652. /**
  146653. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  146654. * @returns True if it has been stopped, otherwise false.
  146655. */
  146656. isStopped(): boolean;
  146657. /**
  146658. * Gets a boolean indicating that the system is stopping
  146659. * @returns true if the system is currently stopping
  146660. */
  146661. isStopping(): boolean;
  146662. /**
  146663. * Gets the number of particles active at the same time.
  146664. * @returns The number of active particles.
  146665. */
  146666. getActiveCount(): number;
  146667. /**
  146668. * Starts the particle system and begins to emit
  146669. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  146670. */
  146671. start(delay?: number): void;
  146672. /**
  146673. * Stops the particle system.
  146674. */
  146675. stop(): void;
  146676. /**
  146677. * Remove all active particles
  146678. */
  146679. reset(): void;
  146680. /**
  146681. * Returns the string "GPUParticleSystem"
  146682. * @returns a string containing the class name
  146683. */
  146684. getClassName(): string;
  146685. /**
  146686. * Gets the custom effect used to render the particles
  146687. * @param blendMode Blend mode for which the effect should be retrieved
  146688. * @returns The effect
  146689. */
  146690. getCustomEffect(blendMode?: number): Nullable<Effect>;
  146691. /**
  146692. * Sets the custom effect used to render the particles
  146693. * @param effect The effect to set
  146694. * @param blendMode Blend mode for which the effect should be set
  146695. */
  146696. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  146697. /** @hidden */
  146698. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  146699. /**
  146700. * Observable that will be called just before the particles are drawn
  146701. */
  146702. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  146703. /**
  146704. * Gets the name of the particle vertex shader
  146705. */
  146706. get vertexShaderName(): string;
  146707. private _colorGradientsTexture;
  146708. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  146709. /**
  146710. * Adds a new color gradient
  146711. * @param gradient defines the gradient to use (between 0 and 1)
  146712. * @param color1 defines the color to affect to the specified gradient
  146713. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  146714. * @returns the current particle system
  146715. */
  146716. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  146717. private _refreshColorGradient;
  146718. /** Force the system to rebuild all gradients that need to be resync */
  146719. forceRefreshGradients(): void;
  146720. /**
  146721. * Remove a specific color gradient
  146722. * @param gradient defines the gradient to remove
  146723. * @returns the current particle system
  146724. */
  146725. removeColorGradient(gradient: number): GPUParticleSystem;
  146726. private _angularSpeedGradientsTexture;
  146727. private _sizeGradientsTexture;
  146728. private _velocityGradientsTexture;
  146729. private _limitVelocityGradientsTexture;
  146730. private _dragGradientsTexture;
  146731. private _addFactorGradient;
  146732. /**
  146733. * Adds a new size gradient
  146734. * @param gradient defines the gradient to use (between 0 and 1)
  146735. * @param factor defines the size factor to affect to the specified gradient
  146736. * @returns the current particle system
  146737. */
  146738. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  146739. /**
  146740. * Remove a specific size gradient
  146741. * @param gradient defines the gradient to remove
  146742. * @returns the current particle system
  146743. */
  146744. removeSizeGradient(gradient: number): GPUParticleSystem;
  146745. private _refreshFactorGradient;
  146746. /**
  146747. * Adds a new angular speed gradient
  146748. * @param gradient defines the gradient to use (between 0 and 1)
  146749. * @param factor defines the angular speed to affect to the specified gradient
  146750. * @returns the current particle system
  146751. */
  146752. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  146753. /**
  146754. * Remove a specific angular speed gradient
  146755. * @param gradient defines the gradient to remove
  146756. * @returns the current particle system
  146757. */
  146758. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  146759. /**
  146760. * Adds a new velocity gradient
  146761. * @param gradient defines the gradient to use (between 0 and 1)
  146762. * @param factor defines the velocity to affect to the specified gradient
  146763. * @returns the current particle system
  146764. */
  146765. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  146766. /**
  146767. * Remove a specific velocity gradient
  146768. * @param gradient defines the gradient to remove
  146769. * @returns the current particle system
  146770. */
  146771. removeVelocityGradient(gradient: number): GPUParticleSystem;
  146772. /**
  146773. * Adds a new limit velocity gradient
  146774. * @param gradient defines the gradient to use (between 0 and 1)
  146775. * @param factor defines the limit velocity value to affect to the specified gradient
  146776. * @returns the current particle system
  146777. */
  146778. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  146779. /**
  146780. * Remove a specific limit velocity gradient
  146781. * @param gradient defines the gradient to remove
  146782. * @returns the current particle system
  146783. */
  146784. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  146785. /**
  146786. * Adds a new drag gradient
  146787. * @param gradient defines the gradient to use (between 0 and 1)
  146788. * @param factor defines the drag value to affect to the specified gradient
  146789. * @returns the current particle system
  146790. */
  146791. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  146792. /**
  146793. * Remove a specific drag gradient
  146794. * @param gradient defines the gradient to remove
  146795. * @returns the current particle system
  146796. */
  146797. removeDragGradient(gradient: number): GPUParticleSystem;
  146798. /**
  146799. * Not supported by GPUParticleSystem
  146800. * @param gradient defines the gradient to use (between 0 and 1)
  146801. * @param factor defines the emit rate value to affect to the specified gradient
  146802. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  146803. * @returns the current particle system
  146804. */
  146805. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  146806. /**
  146807. * Not supported by GPUParticleSystem
  146808. * @param gradient defines the gradient to remove
  146809. * @returns the current particle system
  146810. */
  146811. removeEmitRateGradient(gradient: number): IParticleSystem;
  146812. /**
  146813. * Not supported by GPUParticleSystem
  146814. * @param gradient defines the gradient to use (between 0 and 1)
  146815. * @param factor defines the start size value to affect to the specified gradient
  146816. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  146817. * @returns the current particle system
  146818. */
  146819. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  146820. /**
  146821. * Not supported by GPUParticleSystem
  146822. * @param gradient defines the gradient to remove
  146823. * @returns the current particle system
  146824. */
  146825. removeStartSizeGradient(gradient: number): IParticleSystem;
  146826. /**
  146827. * Not supported by GPUParticleSystem
  146828. * @param gradient defines the gradient to use (between 0 and 1)
  146829. * @param min defines the color remap minimal range
  146830. * @param max defines the color remap maximal range
  146831. * @returns the current particle system
  146832. */
  146833. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  146834. /**
  146835. * Not supported by GPUParticleSystem
  146836. * @param gradient defines the gradient to remove
  146837. * @returns the current particle system
  146838. */
  146839. removeColorRemapGradient(): IParticleSystem;
  146840. /**
  146841. * Not supported by GPUParticleSystem
  146842. * @param gradient defines the gradient to use (between 0 and 1)
  146843. * @param min defines the alpha remap minimal range
  146844. * @param max defines the alpha remap maximal range
  146845. * @returns the current particle system
  146846. */
  146847. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  146848. /**
  146849. * Not supported by GPUParticleSystem
  146850. * @param gradient defines the gradient to remove
  146851. * @returns the current particle system
  146852. */
  146853. removeAlphaRemapGradient(): IParticleSystem;
  146854. /**
  146855. * Not supported by GPUParticleSystem
  146856. * @param gradient defines the gradient to use (between 0 and 1)
  146857. * @param color defines the color to affect to the specified gradient
  146858. * @returns the current particle system
  146859. */
  146860. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  146861. /**
  146862. * Not supported by GPUParticleSystem
  146863. * @param gradient defines the gradient to remove
  146864. * @returns the current particle system
  146865. */
  146866. removeRampGradient(): IParticleSystem;
  146867. /**
  146868. * Not supported by GPUParticleSystem
  146869. * @returns the list of ramp gradients
  146870. */
  146871. getRampGradients(): Nullable<Array<Color3Gradient>>;
  146872. /**
  146873. * Not supported by GPUParticleSystem
  146874. * Gets or sets a boolean indicating that ramp gradients must be used
  146875. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  146876. */
  146877. get useRampGradients(): boolean;
  146878. set useRampGradients(value: boolean);
  146879. /**
  146880. * Not supported by GPUParticleSystem
  146881. * @param gradient defines the gradient to use (between 0 and 1)
  146882. * @param factor defines the life time factor to affect to the specified gradient
  146883. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  146884. * @returns the current particle system
  146885. */
  146886. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  146887. /**
  146888. * Not supported by GPUParticleSystem
  146889. * @param gradient defines the gradient to remove
  146890. * @returns the current particle system
  146891. */
  146892. removeLifeTimeGradient(gradient: number): IParticleSystem;
  146893. /**
  146894. * Instantiates a GPU particle system.
  146895. * 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.
  146896. * @param name The name of the particle system
  146897. * @param options The options used to create the system
  146898. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  146899. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  146900. * @param customEffect a custom effect used to change the way particles are rendered by default
  146901. */
  146902. constructor(name: string, options: Partial<{
  146903. capacity: number;
  146904. randomTextureSize: number;
  146905. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  146906. protected _reset(): void;
  146907. private _createUpdateVAO;
  146908. private _createRenderVAO;
  146909. private _initialize;
  146910. /** @hidden */
  146911. _recreateUpdateEffect(): void;
  146912. private _getEffect;
  146913. /**
  146914. * Fill the defines array according to the current settings of the particle system
  146915. * @param defines Array to be updated
  146916. * @param blendMode blend mode to take into account when updating the array
  146917. */
  146918. fillDefines(defines: Array<string>, blendMode?: number): void;
  146919. /**
  146920. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  146921. * @param uniforms Uniforms array to fill
  146922. * @param attributes Attributes array to fill
  146923. * @param samplers Samplers array to fill
  146924. */
  146925. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  146926. /** @hidden */
  146927. _recreateRenderEffect(): Effect;
  146928. /**
  146929. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  146930. * @param preWarm defines if we are in the pre-warmimg phase
  146931. */
  146932. animate(preWarm?: boolean): void;
  146933. private _createFactorGradientTexture;
  146934. private _createSizeGradientTexture;
  146935. private _createAngularSpeedGradientTexture;
  146936. private _createVelocityGradientTexture;
  146937. private _createLimitVelocityGradientTexture;
  146938. private _createDragGradientTexture;
  146939. private _createColorGradientTexture;
  146940. /**
  146941. * Renders the particle system in its current state
  146942. * @param preWarm defines if the system should only update the particles but not render them
  146943. * @returns the current number of particles
  146944. */
  146945. render(preWarm?: boolean): number;
  146946. /**
  146947. * Rebuilds the particle system
  146948. */
  146949. rebuild(): void;
  146950. private _releaseBuffers;
  146951. private _releaseVAOs;
  146952. /**
  146953. * Disposes the particle system and free the associated resources
  146954. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  146955. */
  146956. dispose(disposeTexture?: boolean): void;
  146957. /**
  146958. * Clones the particle system.
  146959. * @param name The name of the cloned object
  146960. * @param newEmitter The new emitter to use
  146961. * @returns the cloned particle system
  146962. */
  146963. clone(name: string, newEmitter: any): GPUParticleSystem;
  146964. /**
  146965. * Serializes the particle system to a JSON object
  146966. * @param serializeTexture defines if the texture must be serialized as well
  146967. * @returns the JSON object
  146968. */
  146969. serialize(serializeTexture?: boolean): any;
  146970. /**
  146971. * Parses a JSON object to create a GPU particle system.
  146972. * @param parsedParticleSystem The JSON object to parse
  146973. * @param sceneOrEngine The scene or the engine to create the particle system in
  146974. * @param rootUrl The root url to use to load external dependencies like texture
  146975. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  146976. * @returns the parsed GPU particle system
  146977. */
  146978. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  146979. }
  146980. }
  146981. declare module BABYLON {
  146982. /**
  146983. * Represents a set of particle systems working together to create a specific effect
  146984. */
  146985. export class ParticleSystemSet implements IDisposable {
  146986. /**
  146987. * Gets or sets base Assets URL
  146988. */
  146989. static BaseAssetsUrl: string;
  146990. private _emitterCreationOptions;
  146991. private _emitterNode;
  146992. /**
  146993. * Gets the particle system list
  146994. */
  146995. systems: IParticleSystem[];
  146996. /**
  146997. * Gets the emitter node used with this set
  146998. */
  146999. get emitterNode(): Nullable<TransformNode>;
  147000. /**
  147001. * Creates a new emitter mesh as a sphere
  147002. * @param options defines the options used to create the sphere
  147003. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147004. * @param scene defines the hosting scene
  147005. */
  147006. setEmitterAsSphere(options: {
  147007. diameter: number;
  147008. segments: number;
  147009. color: Color3;
  147010. }, renderingGroupId: number, scene: Scene): void;
  147011. /**
  147012. * Starts all particle systems of the set
  147013. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147014. */
  147015. start(emitter?: AbstractMesh): void;
  147016. /**
  147017. * Release all associated resources
  147018. */
  147019. dispose(): void;
  147020. /**
  147021. * Serialize the set into a JSON compatible object
  147022. * @param serializeTexture defines if the texture must be serialized as well
  147023. * @returns a JSON compatible representation of the set
  147024. */
  147025. serialize(serializeTexture?: boolean): any;
  147026. /**
  147027. * Parse a new ParticleSystemSet from a serialized source
  147028. * @param data defines a JSON compatible representation of the set
  147029. * @param scene defines the hosting scene
  147030. * @param gpu defines if we want GPU particles or CPU particles
  147031. * @returns a new ParticleSystemSet
  147032. */
  147033. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147034. }
  147035. }
  147036. declare module BABYLON {
  147037. /**
  147038. * This class is made for on one-liner static method to help creating particle system set.
  147039. */
  147040. export class ParticleHelper {
  147041. /**
  147042. * Gets or sets base Assets URL
  147043. */
  147044. static BaseAssetsUrl: string;
  147045. /** Define the Url to load snippets */
  147046. static SnippetUrl: string;
  147047. /**
  147048. * Create a default particle system that you can tweak
  147049. * @param emitter defines the emitter to use
  147050. * @param capacity defines the system capacity (default is 500 particles)
  147051. * @param scene defines the hosting scene
  147052. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147053. * @returns the new Particle system
  147054. */
  147055. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147056. /**
  147057. * This is the main static method (one-liner) of this helper to create different particle systems
  147058. * @param type This string represents the type to the particle system to create
  147059. * @param scene The scene where the particle system should live
  147060. * @param gpu If the system will use gpu
  147061. * @returns the ParticleSystemSet created
  147062. */
  147063. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147064. /**
  147065. * Static function used to export a particle system to a ParticleSystemSet variable.
  147066. * Please note that the emitter shape is not exported
  147067. * @param systems defines the particle systems to export
  147068. * @returns the created particle system set
  147069. */
  147070. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147071. /**
  147072. * Creates a particle system from a snippet saved in a remote file
  147073. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147074. * @param url defines the url to load from
  147075. * @param scene defines the hosting scene
  147076. * @param gpu If the system will use gpu
  147077. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147078. * @returns a promise that will resolve to the new particle system
  147079. */
  147080. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147081. /**
  147082. * Creates a particle system from a snippet saved by the particle system editor
  147083. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147084. * @param scene defines the hosting scene
  147085. * @param gpu If the system will use gpu
  147086. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147087. * @returns a promise that will resolve to the new particle system
  147088. */
  147089. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147090. }
  147091. }
  147092. declare module BABYLON {
  147093. interface Engine {
  147094. /**
  147095. * Create an effect to use with particle systems.
  147096. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147097. * the particle system for which you want to create a custom effect in the last parameter
  147098. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147099. * @param uniformsNames defines a list of attribute names
  147100. * @param samplers defines an array of string used to represent textures
  147101. * @param defines defines the string containing the defines to use to compile the shaders
  147102. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147103. * @param onCompiled defines a function to call when the effect creation is successful
  147104. * @param onError defines a function to call when the effect creation has failed
  147105. * @param particleSystem the particle system you want to create the effect for
  147106. * @returns the new Effect
  147107. */
  147108. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147109. }
  147110. interface Mesh {
  147111. /**
  147112. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147113. * @returns an array of IParticleSystem
  147114. */
  147115. getEmittedParticleSystems(): IParticleSystem[];
  147116. /**
  147117. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147118. * @returns an array of IParticleSystem
  147119. */
  147120. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147121. }
  147122. }
  147123. declare module BABYLON {
  147124. /** Defines the 4 color options */
  147125. export enum PointColor {
  147126. /** color value */
  147127. Color = 2,
  147128. /** uv value */
  147129. UV = 1,
  147130. /** random value */
  147131. Random = 0,
  147132. /** stated value */
  147133. Stated = 3
  147134. }
  147135. /**
  147136. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147137. * 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.
  147138. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147139. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147140. *
  147141. * Full documentation here : TO BE ENTERED
  147142. */
  147143. export class PointsCloudSystem implements IDisposable {
  147144. /**
  147145. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147146. * Example : var p = SPS.particles[i];
  147147. */
  147148. particles: CloudPoint[];
  147149. /**
  147150. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147151. */
  147152. nbParticles: number;
  147153. /**
  147154. * This a counter for your own usage. It's not set by any SPS functions.
  147155. */
  147156. counter: number;
  147157. /**
  147158. * The PCS name. This name is also given to the underlying mesh.
  147159. */
  147160. name: string;
  147161. /**
  147162. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147163. */
  147164. mesh: Mesh;
  147165. /**
  147166. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147167. * Please read :
  147168. */
  147169. vars: any;
  147170. /**
  147171. * @hidden
  147172. */
  147173. _size: number;
  147174. private _scene;
  147175. private _promises;
  147176. private _positions;
  147177. private _indices;
  147178. private _normals;
  147179. private _colors;
  147180. private _uvs;
  147181. private _indices32;
  147182. private _positions32;
  147183. private _colors32;
  147184. private _uvs32;
  147185. private _updatable;
  147186. private _isVisibilityBoxLocked;
  147187. private _alwaysVisible;
  147188. private _groups;
  147189. private _groupCounter;
  147190. private _computeParticleColor;
  147191. private _computeParticleTexture;
  147192. private _computeParticleRotation;
  147193. private _computeBoundingBox;
  147194. private _isReady;
  147195. /**
  147196. * Creates a PCS (Points Cloud System) object
  147197. * @param name (String) is the PCS name, this will be the underlying mesh name
  147198. * @param pointSize (number) is the size for each point
  147199. * @param scene (Scene) is the scene in which the PCS is added
  147200. * @param options defines the options of the PCS e.g.
  147201. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147202. */
  147203. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147204. updatable?: boolean;
  147205. });
  147206. /**
  147207. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147208. * If no points were added to the PCS, the returned mesh is just a single point.
  147209. * @returns a promise for the created mesh
  147210. */
  147211. buildMeshAsync(): Promise<Mesh>;
  147212. /**
  147213. * @hidden
  147214. */
  147215. private _buildMesh;
  147216. private _addParticle;
  147217. private _randomUnitVector;
  147218. private _getColorIndicesForCoord;
  147219. private _setPointsColorOrUV;
  147220. private _colorFromTexture;
  147221. private _calculateDensity;
  147222. /**
  147223. * Adds points to the PCS in random positions within a unit sphere
  147224. * @param nb (positive integer) the number of particles to be created from this model
  147225. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147226. * @returns the number of groups in the system
  147227. */
  147228. addPoints(nb: number, pointFunction?: any): number;
  147229. /**
  147230. * Adds points to the PCS from the surface of the model shape
  147231. * @param mesh is any Mesh object that will be used as a surface model for the points
  147232. * @param nb (positive integer) the number of particles to be created from this model
  147233. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147234. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147235. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147236. * @returns the number of groups in the system
  147237. */
  147238. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147239. /**
  147240. * Adds points to the PCS inside the model shape
  147241. * @param mesh is any Mesh object that will be used as a surface model for the points
  147242. * @param nb (positive integer) the number of particles to be created from this model
  147243. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147244. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147245. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147246. * @returns the number of groups in the system
  147247. */
  147248. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147249. /**
  147250. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147251. * This method calls `updateParticle()` for each particle of the SPS.
  147252. * For an animated SPS, it is usually called within the render loop.
  147253. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147254. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147255. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147256. * @returns the PCS.
  147257. */
  147258. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147259. /**
  147260. * Disposes the PCS.
  147261. */
  147262. dispose(): void;
  147263. /**
  147264. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147265. * doc :
  147266. * @returns the PCS.
  147267. */
  147268. refreshVisibleSize(): PointsCloudSystem;
  147269. /**
  147270. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147271. * @param size the size (float) of the visibility box
  147272. * note : this doesn't lock the PCS mesh bounding box.
  147273. * doc :
  147274. */
  147275. setVisibilityBox(size: number): void;
  147276. /**
  147277. * Gets whether the PCS is always visible or not
  147278. * doc :
  147279. */
  147280. get isAlwaysVisible(): boolean;
  147281. /**
  147282. * Sets the PCS as always visible or not
  147283. * doc :
  147284. */
  147285. set isAlwaysVisible(val: boolean);
  147286. /**
  147287. * Tells to `setParticles()` to compute the particle rotations or not
  147288. * Default value : false. The PCS is faster when it's set to false
  147289. * Note : particle rotations are only applied to parent particles
  147290. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147291. */
  147292. set computeParticleRotation(val: boolean);
  147293. /**
  147294. * Tells to `setParticles()` to compute the particle colors or not.
  147295. * Default value : true. The PCS is faster when it's set to false.
  147296. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147297. */
  147298. set computeParticleColor(val: boolean);
  147299. set computeParticleTexture(val: boolean);
  147300. /**
  147301. * Gets if `setParticles()` computes the particle colors or not.
  147302. * Default value : false. The PCS is faster when it's set to false.
  147303. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147304. */
  147305. get computeParticleColor(): boolean;
  147306. /**
  147307. * Gets if `setParticles()` computes the particle textures or not.
  147308. * Default value : false. The PCS is faster when it's set to false.
  147309. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147310. */
  147311. get computeParticleTexture(): boolean;
  147312. /**
  147313. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147314. */
  147315. set computeBoundingBox(val: boolean);
  147316. /**
  147317. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147318. */
  147319. get computeBoundingBox(): boolean;
  147320. /**
  147321. * This function does nothing. It may be overwritten to set all the particle first values.
  147322. * The PCS doesn't call this function, you may have to call it by your own.
  147323. * doc :
  147324. */
  147325. initParticles(): void;
  147326. /**
  147327. * This function does nothing. It may be overwritten to recycle a particle
  147328. * The PCS doesn't call this function, you can to call it
  147329. * doc :
  147330. * @param particle The particle to recycle
  147331. * @returns the recycled particle
  147332. */
  147333. recycleParticle(particle: CloudPoint): CloudPoint;
  147334. /**
  147335. * Updates a particle : this function should be overwritten by the user.
  147336. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147337. * doc :
  147338. * @example : just set a particle position or velocity and recycle conditions
  147339. * @param particle The particle to update
  147340. * @returns the updated particle
  147341. */
  147342. updateParticle(particle: CloudPoint): CloudPoint;
  147343. /**
  147344. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147345. * This does nothing and may be overwritten by the user.
  147346. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147347. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147348. * @param update the boolean update value actually passed to setParticles()
  147349. */
  147350. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147351. /**
  147352. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147353. * This will be passed three parameters.
  147354. * This does nothing and may be overwritten by the user.
  147355. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147356. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147357. * @param update the boolean update value actually passed to setParticles()
  147358. */
  147359. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147360. }
  147361. }
  147362. declare module BABYLON {
  147363. /**
  147364. * Represents one particle of a points cloud system.
  147365. */
  147366. export class CloudPoint {
  147367. /**
  147368. * particle global index
  147369. */
  147370. idx: number;
  147371. /**
  147372. * The color of the particle
  147373. */
  147374. color: Nullable<Color4>;
  147375. /**
  147376. * The world space position of the particle.
  147377. */
  147378. position: Vector3;
  147379. /**
  147380. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147381. */
  147382. rotation: Vector3;
  147383. /**
  147384. * The world space rotation quaternion of the particle.
  147385. */
  147386. rotationQuaternion: Nullable<Quaternion>;
  147387. /**
  147388. * The uv of the particle.
  147389. */
  147390. uv: Nullable<Vector2>;
  147391. /**
  147392. * The current speed of the particle.
  147393. */
  147394. velocity: Vector3;
  147395. /**
  147396. * The pivot point in the particle local space.
  147397. */
  147398. pivot: Vector3;
  147399. /**
  147400. * Must the particle be translated from its pivot point in its local space ?
  147401. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147402. * Default : false
  147403. */
  147404. translateFromPivot: boolean;
  147405. /**
  147406. * Index of this particle in the global "positions" array (Internal use)
  147407. * @hidden
  147408. */
  147409. _pos: number;
  147410. /**
  147411. * @hidden Index of this particle in the global "indices" array (Internal use)
  147412. */
  147413. _ind: number;
  147414. /**
  147415. * Group this particle belongs to
  147416. */
  147417. _group: PointsGroup;
  147418. /**
  147419. * Group id of this particle
  147420. */
  147421. groupId: number;
  147422. /**
  147423. * Index of the particle in its group id (Internal use)
  147424. */
  147425. idxInGroup: number;
  147426. /**
  147427. * @hidden Particle BoundingInfo object (Internal use)
  147428. */
  147429. _boundingInfo: BoundingInfo;
  147430. /**
  147431. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  147432. */
  147433. _pcs: PointsCloudSystem;
  147434. /**
  147435. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  147436. */
  147437. _stillInvisible: boolean;
  147438. /**
  147439. * @hidden Last computed particle rotation matrix
  147440. */
  147441. _rotationMatrix: number[];
  147442. /**
  147443. * Parent particle Id, if any.
  147444. * Default null.
  147445. */
  147446. parentId: Nullable<number>;
  147447. /**
  147448. * @hidden Internal global position in the PCS.
  147449. */
  147450. _globalPosition: Vector3;
  147451. /**
  147452. * Creates a Point Cloud object.
  147453. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  147454. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  147455. * @param group (PointsGroup) is the group the particle belongs to
  147456. * @param groupId (integer) is the group identifier in the PCS.
  147457. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  147458. * @param pcs defines the PCS it is associated to
  147459. */
  147460. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  147461. /**
  147462. * get point size
  147463. */
  147464. get size(): Vector3;
  147465. /**
  147466. * Set point size
  147467. */
  147468. set size(scale: Vector3);
  147469. /**
  147470. * Legacy support, changed quaternion to rotationQuaternion
  147471. */
  147472. get quaternion(): Nullable<Quaternion>;
  147473. /**
  147474. * Legacy support, changed quaternion to rotationQuaternion
  147475. */
  147476. set quaternion(q: Nullable<Quaternion>);
  147477. /**
  147478. * Returns a boolean. True if the particle intersects a mesh, else false
  147479. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  147480. * @param target is the object (point or mesh) what the intersection is computed against
  147481. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  147482. * @returns true if it intersects
  147483. */
  147484. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  147485. /**
  147486. * get the rotation matrix of the particle
  147487. * @hidden
  147488. */
  147489. getRotationMatrix(m: Matrix): void;
  147490. }
  147491. /**
  147492. * Represents a group of points in a points cloud system
  147493. * * PCS internal tool, don't use it manually.
  147494. */
  147495. export class PointsGroup {
  147496. /**
  147497. * The group id
  147498. * @hidden
  147499. */
  147500. groupID: number;
  147501. /**
  147502. * image data for group (internal use)
  147503. * @hidden
  147504. */
  147505. _groupImageData: Nullable<ArrayBufferView>;
  147506. /**
  147507. * Image Width (internal use)
  147508. * @hidden
  147509. */
  147510. _groupImgWidth: number;
  147511. /**
  147512. * Image Height (internal use)
  147513. * @hidden
  147514. */
  147515. _groupImgHeight: number;
  147516. /**
  147517. * Custom position function (internal use)
  147518. * @hidden
  147519. */
  147520. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  147521. /**
  147522. * density per facet for surface points
  147523. * @hidden
  147524. */
  147525. _groupDensity: number[];
  147526. /**
  147527. * Only when points are colored by texture carries pointer to texture list array
  147528. * @hidden
  147529. */
  147530. _textureNb: number;
  147531. /**
  147532. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  147533. * PCS internal tool, don't use it manually.
  147534. * @hidden
  147535. */
  147536. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  147537. }
  147538. }
  147539. declare module BABYLON {
  147540. interface Scene {
  147541. /** @hidden (Backing field) */
  147542. _physicsEngine: Nullable<IPhysicsEngine>;
  147543. /** @hidden */
  147544. _physicsTimeAccumulator: number;
  147545. /**
  147546. * Gets the current physics engine
  147547. * @returns a IPhysicsEngine or null if none attached
  147548. */
  147549. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  147550. /**
  147551. * Enables physics to the current scene
  147552. * @param gravity defines the scene's gravity for the physics engine
  147553. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  147554. * @return a boolean indicating if the physics engine was initialized
  147555. */
  147556. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  147557. /**
  147558. * Disables and disposes the physics engine associated with the scene
  147559. */
  147560. disablePhysicsEngine(): void;
  147561. /**
  147562. * Gets a boolean indicating if there is an active physics engine
  147563. * @returns a boolean indicating if there is an active physics engine
  147564. */
  147565. isPhysicsEnabled(): boolean;
  147566. /**
  147567. * Deletes a physics compound impostor
  147568. * @param compound defines the compound to delete
  147569. */
  147570. deleteCompoundImpostor(compound: any): void;
  147571. /**
  147572. * An event triggered when physic simulation is about to be run
  147573. */
  147574. onBeforePhysicsObservable: Observable<Scene>;
  147575. /**
  147576. * An event triggered when physic simulation has been done
  147577. */
  147578. onAfterPhysicsObservable: Observable<Scene>;
  147579. }
  147580. interface AbstractMesh {
  147581. /** @hidden */
  147582. _physicsImpostor: Nullable<PhysicsImpostor>;
  147583. /**
  147584. * Gets or sets impostor used for physic simulation
  147585. * @see https://doc.babylonjs.com/features/physics_engine
  147586. */
  147587. physicsImpostor: Nullable<PhysicsImpostor>;
  147588. /**
  147589. * Gets the current physics impostor
  147590. * @see https://doc.babylonjs.com/features/physics_engine
  147591. * @returns a physics impostor or null
  147592. */
  147593. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  147594. /** Apply a physic impulse to the mesh
  147595. * @param force defines the force to apply
  147596. * @param contactPoint defines where to apply the force
  147597. * @returns the current mesh
  147598. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  147599. */
  147600. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  147601. /**
  147602. * Creates a physic joint between two meshes
  147603. * @param otherMesh defines the other mesh to use
  147604. * @param pivot1 defines the pivot to use on this mesh
  147605. * @param pivot2 defines the pivot to use on the other mesh
  147606. * @param options defines additional options (can be plugin dependent)
  147607. * @returns the current mesh
  147608. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  147609. */
  147610. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  147611. /** @hidden */
  147612. _disposePhysicsObserver: Nullable<Observer<Node>>;
  147613. }
  147614. /**
  147615. * Defines the physics engine scene component responsible to manage a physics engine
  147616. */
  147617. export class PhysicsEngineSceneComponent implements ISceneComponent {
  147618. /**
  147619. * The component name helpful to identify the component in the list of scene components.
  147620. */
  147621. readonly name: string;
  147622. /**
  147623. * The scene the component belongs to.
  147624. */
  147625. scene: Scene;
  147626. /**
  147627. * Creates a new instance of the component for the given scene
  147628. * @param scene Defines the scene to register the component in
  147629. */
  147630. constructor(scene: Scene);
  147631. /**
  147632. * Registers the component in a given scene
  147633. */
  147634. register(): void;
  147635. /**
  147636. * Rebuilds the elements related to this component in case of
  147637. * context lost for instance.
  147638. */
  147639. rebuild(): void;
  147640. /**
  147641. * Disposes the component and the associated ressources
  147642. */
  147643. dispose(): void;
  147644. }
  147645. }
  147646. declare module BABYLON {
  147647. /**
  147648. * A helper for physics simulations
  147649. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147650. */
  147651. export class PhysicsHelper {
  147652. private _scene;
  147653. private _physicsEngine;
  147654. /**
  147655. * Initializes the Physics helper
  147656. * @param scene Babylon.js scene
  147657. */
  147658. constructor(scene: Scene);
  147659. /**
  147660. * Applies a radial explosion impulse
  147661. * @param origin the origin of the explosion
  147662. * @param radiusOrEventOptions the radius or the options of radial explosion
  147663. * @param strength the explosion strength
  147664. * @param falloff possible options: Constant & Linear. Defaults to Constant
  147665. * @returns A physics radial explosion event, or null
  147666. */
  147667. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  147668. /**
  147669. * Applies a radial explosion force
  147670. * @param origin the origin of the explosion
  147671. * @param radiusOrEventOptions the radius or the options of radial explosion
  147672. * @param strength the explosion strength
  147673. * @param falloff possible options: Constant & Linear. Defaults to Constant
  147674. * @returns A physics radial explosion event, or null
  147675. */
  147676. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  147677. /**
  147678. * Creates a gravitational field
  147679. * @param origin the origin of the explosion
  147680. * @param radiusOrEventOptions the radius or the options of radial explosion
  147681. * @param strength the explosion strength
  147682. * @param falloff possible options: Constant & Linear. Defaults to Constant
  147683. * @returns A physics gravitational field event, or null
  147684. */
  147685. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  147686. /**
  147687. * Creates a physics updraft event
  147688. * @param origin the origin of the updraft
  147689. * @param radiusOrEventOptions the radius or the options of the updraft
  147690. * @param strength the strength of the updraft
  147691. * @param height the height of the updraft
  147692. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  147693. * @returns A physics updraft event, or null
  147694. */
  147695. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  147696. /**
  147697. * Creates a physics vortex event
  147698. * @param origin the of the vortex
  147699. * @param radiusOrEventOptions the radius or the options of the vortex
  147700. * @param strength the strength of the vortex
  147701. * @param height the height of the vortex
  147702. * @returns a Physics vortex event, or null
  147703. * A physics vortex event or null
  147704. */
  147705. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  147706. }
  147707. /**
  147708. * Represents a physics radial explosion event
  147709. */
  147710. class PhysicsRadialExplosionEvent {
  147711. private _scene;
  147712. private _options;
  147713. private _sphere;
  147714. private _dataFetched;
  147715. /**
  147716. * Initializes a radial explosioin event
  147717. * @param _scene BabylonJS scene
  147718. * @param _options The options for the vortex event
  147719. */
  147720. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  147721. /**
  147722. * Returns the data related to the radial explosion event (sphere).
  147723. * @returns The radial explosion event data
  147724. */
  147725. getData(): PhysicsRadialExplosionEventData;
  147726. /**
  147727. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  147728. * @param impostor A physics imposter
  147729. * @param origin the origin of the explosion
  147730. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  147731. */
  147732. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  147733. /**
  147734. * Triggers affecterd impostors callbacks
  147735. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  147736. */
  147737. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  147738. /**
  147739. * Disposes the sphere.
  147740. * @param force Specifies if the sphere should be disposed by force
  147741. */
  147742. dispose(force?: boolean): void;
  147743. /*** Helpers ***/
  147744. private _prepareSphere;
  147745. private _intersectsWithSphere;
  147746. }
  147747. /**
  147748. * Represents a gravitational field event
  147749. */
  147750. class PhysicsGravitationalFieldEvent {
  147751. private _physicsHelper;
  147752. private _scene;
  147753. private _origin;
  147754. private _options;
  147755. private _tickCallback;
  147756. private _sphere;
  147757. private _dataFetched;
  147758. /**
  147759. * Initializes the physics gravitational field event
  147760. * @param _physicsHelper A physics helper
  147761. * @param _scene BabylonJS scene
  147762. * @param _origin The origin position of the gravitational field event
  147763. * @param _options The options for the vortex event
  147764. */
  147765. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  147766. /**
  147767. * Returns the data related to the gravitational field event (sphere).
  147768. * @returns A gravitational field event
  147769. */
  147770. getData(): PhysicsGravitationalFieldEventData;
  147771. /**
  147772. * Enables the gravitational field.
  147773. */
  147774. enable(): void;
  147775. /**
  147776. * Disables the gravitational field.
  147777. */
  147778. disable(): void;
  147779. /**
  147780. * Disposes the sphere.
  147781. * @param force The force to dispose from the gravitational field event
  147782. */
  147783. dispose(force?: boolean): void;
  147784. private _tick;
  147785. }
  147786. /**
  147787. * Represents a physics updraft event
  147788. */
  147789. class PhysicsUpdraftEvent {
  147790. private _scene;
  147791. private _origin;
  147792. private _options;
  147793. private _physicsEngine;
  147794. private _originTop;
  147795. private _originDirection;
  147796. private _tickCallback;
  147797. private _cylinder;
  147798. private _cylinderPosition;
  147799. private _dataFetched;
  147800. /**
  147801. * Initializes the physics updraft event
  147802. * @param _scene BabylonJS scene
  147803. * @param _origin The origin position of the updraft
  147804. * @param _options The options for the updraft event
  147805. */
  147806. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  147807. /**
  147808. * Returns the data related to the updraft event (cylinder).
  147809. * @returns A physics updraft event
  147810. */
  147811. getData(): PhysicsUpdraftEventData;
  147812. /**
  147813. * Enables the updraft.
  147814. */
  147815. enable(): void;
  147816. /**
  147817. * Disables the updraft.
  147818. */
  147819. disable(): void;
  147820. /**
  147821. * Disposes the cylinder.
  147822. * @param force Specifies if the updraft should be disposed by force
  147823. */
  147824. dispose(force?: boolean): void;
  147825. private getImpostorHitData;
  147826. private _tick;
  147827. /*** Helpers ***/
  147828. private _prepareCylinder;
  147829. private _intersectsWithCylinder;
  147830. }
  147831. /**
  147832. * Represents a physics vortex event
  147833. */
  147834. class PhysicsVortexEvent {
  147835. private _scene;
  147836. private _origin;
  147837. private _options;
  147838. private _physicsEngine;
  147839. private _originTop;
  147840. private _tickCallback;
  147841. private _cylinder;
  147842. private _cylinderPosition;
  147843. private _dataFetched;
  147844. /**
  147845. * Initializes the physics vortex event
  147846. * @param _scene The BabylonJS scene
  147847. * @param _origin The origin position of the vortex
  147848. * @param _options The options for the vortex event
  147849. */
  147850. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  147851. /**
  147852. * Returns the data related to the vortex event (cylinder).
  147853. * @returns The physics vortex event data
  147854. */
  147855. getData(): PhysicsVortexEventData;
  147856. /**
  147857. * Enables the vortex.
  147858. */
  147859. enable(): void;
  147860. /**
  147861. * Disables the cortex.
  147862. */
  147863. disable(): void;
  147864. /**
  147865. * Disposes the sphere.
  147866. * @param force
  147867. */
  147868. dispose(force?: boolean): void;
  147869. private getImpostorHitData;
  147870. private _tick;
  147871. /*** Helpers ***/
  147872. private _prepareCylinder;
  147873. private _intersectsWithCylinder;
  147874. }
  147875. /**
  147876. * Options fot the radial explosion event
  147877. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147878. */
  147879. export class PhysicsRadialExplosionEventOptions {
  147880. /**
  147881. * The radius of the sphere for the radial explosion.
  147882. */
  147883. radius: number;
  147884. /**
  147885. * The strenth of the explosion.
  147886. */
  147887. strength: number;
  147888. /**
  147889. * The strenght of the force in correspondence to the distance of the affected object
  147890. */
  147891. falloff: PhysicsRadialImpulseFalloff;
  147892. /**
  147893. * Sphere options for the radial explosion.
  147894. */
  147895. sphere: {
  147896. segments: number;
  147897. diameter: number;
  147898. };
  147899. /**
  147900. * Sphere options for the radial explosion.
  147901. */
  147902. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  147903. }
  147904. /**
  147905. * Options fot the updraft event
  147906. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147907. */
  147908. export class PhysicsUpdraftEventOptions {
  147909. /**
  147910. * The radius of the cylinder for the vortex
  147911. */
  147912. radius: number;
  147913. /**
  147914. * The strenth of the updraft.
  147915. */
  147916. strength: number;
  147917. /**
  147918. * The height of the cylinder for the updraft.
  147919. */
  147920. height: number;
  147921. /**
  147922. * The mode for the the updraft.
  147923. */
  147924. updraftMode: PhysicsUpdraftMode;
  147925. }
  147926. /**
  147927. * Options fot the vortex event
  147928. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147929. */
  147930. export class PhysicsVortexEventOptions {
  147931. /**
  147932. * The radius of the cylinder for the vortex
  147933. */
  147934. radius: number;
  147935. /**
  147936. * The strenth of the vortex.
  147937. */
  147938. strength: number;
  147939. /**
  147940. * The height of the cylinder for the vortex.
  147941. */
  147942. height: number;
  147943. /**
  147944. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  147945. */
  147946. centripetalForceThreshold: number;
  147947. /**
  147948. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  147949. */
  147950. centripetalForceMultiplier: number;
  147951. /**
  147952. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  147953. */
  147954. centrifugalForceMultiplier: number;
  147955. /**
  147956. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  147957. */
  147958. updraftForceMultiplier: number;
  147959. }
  147960. /**
  147961. * The strenght of the force in correspondence to the distance of the affected object
  147962. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147963. */
  147964. export enum PhysicsRadialImpulseFalloff {
  147965. /** Defines that impulse is constant in strength across it's whole radius */
  147966. Constant = 0,
  147967. /** Defines that impulse gets weaker if it's further from the origin */
  147968. Linear = 1
  147969. }
  147970. /**
  147971. * The strength of the force in correspondence to the distance of the affected object
  147972. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147973. */
  147974. export enum PhysicsUpdraftMode {
  147975. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  147976. Center = 0,
  147977. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  147978. Perpendicular = 1
  147979. }
  147980. /**
  147981. * Interface for a physics hit data
  147982. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147983. */
  147984. export interface PhysicsHitData {
  147985. /**
  147986. * The force applied at the contact point
  147987. */
  147988. force: Vector3;
  147989. /**
  147990. * The contact point
  147991. */
  147992. contactPoint: Vector3;
  147993. /**
  147994. * The distance from the origin to the contact point
  147995. */
  147996. distanceFromOrigin: number;
  147997. }
  147998. /**
  147999. * Interface for radial explosion event data
  148000. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148001. */
  148002. export interface PhysicsRadialExplosionEventData {
  148003. /**
  148004. * A sphere used for the radial explosion event
  148005. */
  148006. sphere: Mesh;
  148007. }
  148008. /**
  148009. * Interface for gravitational field event data
  148010. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148011. */
  148012. export interface PhysicsGravitationalFieldEventData {
  148013. /**
  148014. * A sphere mesh used for the gravitational field event
  148015. */
  148016. sphere: Mesh;
  148017. }
  148018. /**
  148019. * Interface for updraft event data
  148020. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148021. */
  148022. export interface PhysicsUpdraftEventData {
  148023. /**
  148024. * A cylinder used for the updraft event
  148025. */
  148026. cylinder: Mesh;
  148027. }
  148028. /**
  148029. * Interface for vortex event data
  148030. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148031. */
  148032. export interface PhysicsVortexEventData {
  148033. /**
  148034. * A cylinder used for the vortex event
  148035. */
  148036. cylinder: Mesh;
  148037. }
  148038. /**
  148039. * Interface for an affected physics impostor
  148040. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148041. */
  148042. export interface PhysicsAffectedImpostorWithData {
  148043. /**
  148044. * The impostor affected by the effect
  148045. */
  148046. impostor: PhysicsImpostor;
  148047. /**
  148048. * The data about the hit/horce from the explosion
  148049. */
  148050. hitData: PhysicsHitData;
  148051. }
  148052. }
  148053. declare module BABYLON {
  148054. /** @hidden */
  148055. export var blackAndWhitePixelShader: {
  148056. name: string;
  148057. shader: string;
  148058. };
  148059. }
  148060. declare module BABYLON {
  148061. /**
  148062. * Post process used to render in black and white
  148063. */
  148064. export class BlackAndWhitePostProcess extends PostProcess {
  148065. /**
  148066. * Linear about to convert he result to black and white (default: 1)
  148067. */
  148068. degree: number;
  148069. /**
  148070. * Gets a string identifying the name of the class
  148071. * @returns "BlackAndWhitePostProcess" string
  148072. */
  148073. getClassName(): string;
  148074. /**
  148075. * Creates a black and white post process
  148076. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148077. * @param name The name of the effect.
  148078. * @param options The required width/height ratio to downsize to before computing the render pass.
  148079. * @param camera The camera to apply the render pass to.
  148080. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148081. * @param engine The engine which the post process will be applied. (default: current engine)
  148082. * @param reusable If the post process can be reused on the same frame. (default: false)
  148083. */
  148084. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148085. /** @hidden */
  148086. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148087. }
  148088. }
  148089. declare module BABYLON {
  148090. /**
  148091. * This represents a set of one or more post processes in Babylon.
  148092. * A post process can be used to apply a shader to a texture after it is rendered.
  148093. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148094. */
  148095. export class PostProcessRenderEffect {
  148096. private _postProcesses;
  148097. private _getPostProcesses;
  148098. private _singleInstance;
  148099. private _cameras;
  148100. private _indicesForCamera;
  148101. /**
  148102. * Name of the effect
  148103. * @hidden
  148104. */
  148105. _name: string;
  148106. /**
  148107. * Instantiates a post process render effect.
  148108. * A post process can be used to apply a shader to a texture after it is rendered.
  148109. * @param engine The engine the effect is tied to
  148110. * @param name The name of the effect
  148111. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148112. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148113. */
  148114. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148115. /**
  148116. * Checks if all the post processes in the effect are supported.
  148117. */
  148118. get isSupported(): boolean;
  148119. /**
  148120. * Updates the current state of the effect
  148121. * @hidden
  148122. */
  148123. _update(): void;
  148124. /**
  148125. * Attaches the effect on cameras
  148126. * @param cameras The camera to attach to.
  148127. * @hidden
  148128. */
  148129. _attachCameras(cameras: Camera): void;
  148130. /**
  148131. * Attaches the effect on cameras
  148132. * @param cameras The camera to attach to.
  148133. * @hidden
  148134. */
  148135. _attachCameras(cameras: Camera[]): void;
  148136. /**
  148137. * Detaches the effect on cameras
  148138. * @param cameras The camera to detatch from.
  148139. * @hidden
  148140. */
  148141. _detachCameras(cameras: Camera): void;
  148142. /**
  148143. * Detatches the effect on cameras
  148144. * @param cameras The camera to detatch from.
  148145. * @hidden
  148146. */
  148147. _detachCameras(cameras: Camera[]): void;
  148148. /**
  148149. * Enables the effect on given cameras
  148150. * @param cameras The camera to enable.
  148151. * @hidden
  148152. */
  148153. _enable(cameras: Camera): void;
  148154. /**
  148155. * Enables the effect on given cameras
  148156. * @param cameras The camera to enable.
  148157. * @hidden
  148158. */
  148159. _enable(cameras: Nullable<Camera[]>): void;
  148160. /**
  148161. * Disables the effect on the given cameras
  148162. * @param cameras The camera to disable.
  148163. * @hidden
  148164. */
  148165. _disable(cameras: Camera): void;
  148166. /**
  148167. * Disables the effect on the given cameras
  148168. * @param cameras The camera to disable.
  148169. * @hidden
  148170. */
  148171. _disable(cameras: Nullable<Camera[]>): void;
  148172. /**
  148173. * Gets a list of the post processes contained in the effect.
  148174. * @param camera The camera to get the post processes on.
  148175. * @returns The list of the post processes in the effect.
  148176. */
  148177. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148178. }
  148179. }
  148180. declare module BABYLON {
  148181. /** @hidden */
  148182. export var extractHighlightsPixelShader: {
  148183. name: string;
  148184. shader: string;
  148185. };
  148186. }
  148187. declare module BABYLON {
  148188. /**
  148189. * 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.
  148190. */
  148191. export class ExtractHighlightsPostProcess extends PostProcess {
  148192. /**
  148193. * The luminance threshold, pixels below this value will be set to black.
  148194. */
  148195. threshold: number;
  148196. /** @hidden */
  148197. _exposure: number;
  148198. /**
  148199. * Post process which has the input texture to be used when performing highlight extraction
  148200. * @hidden
  148201. */
  148202. _inputPostProcess: Nullable<PostProcess>;
  148203. /**
  148204. * Gets a string identifying the name of the class
  148205. * @returns "ExtractHighlightsPostProcess" string
  148206. */
  148207. getClassName(): string;
  148208. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148209. }
  148210. }
  148211. declare module BABYLON {
  148212. /** @hidden */
  148213. export var bloomMergePixelShader: {
  148214. name: string;
  148215. shader: string;
  148216. };
  148217. }
  148218. declare module BABYLON {
  148219. /**
  148220. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148221. */
  148222. export class BloomMergePostProcess extends PostProcess {
  148223. /** Weight of the bloom to be added to the original input. */
  148224. weight: number;
  148225. /**
  148226. * Gets a string identifying the name of the class
  148227. * @returns "BloomMergePostProcess" string
  148228. */
  148229. getClassName(): string;
  148230. /**
  148231. * Creates a new instance of @see BloomMergePostProcess
  148232. * @param name The name of the effect.
  148233. * @param originalFromInput Post process which's input will be used for the merge.
  148234. * @param blurred Blurred highlights post process which's output will be used.
  148235. * @param weight Weight of the bloom to be added to the original input.
  148236. * @param options The required width/height ratio to downsize to before computing the render pass.
  148237. * @param camera The camera to apply the render pass to.
  148238. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148239. * @param engine The engine which the post process will be applied. (default: current engine)
  148240. * @param reusable If the post process can be reused on the same frame. (default: false)
  148241. * @param textureType Type of textures used when performing the post process. (default: 0)
  148242. * @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)
  148243. */
  148244. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148245. /** Weight of the bloom to be added to the original input. */
  148246. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148247. }
  148248. }
  148249. declare module BABYLON {
  148250. /**
  148251. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148252. */
  148253. export class BloomEffect extends PostProcessRenderEffect {
  148254. private bloomScale;
  148255. /**
  148256. * @hidden Internal
  148257. */
  148258. _effects: Array<PostProcess>;
  148259. /**
  148260. * @hidden Internal
  148261. */
  148262. _downscale: ExtractHighlightsPostProcess;
  148263. private _blurX;
  148264. private _blurY;
  148265. private _merge;
  148266. /**
  148267. * The luminance threshold to find bright areas of the image to bloom.
  148268. */
  148269. get threshold(): number;
  148270. set threshold(value: number);
  148271. /**
  148272. * The strength of the bloom.
  148273. */
  148274. get weight(): number;
  148275. set weight(value: number);
  148276. /**
  148277. * Specifies the size of the bloom blur kernel, relative to the final output size
  148278. */
  148279. get kernel(): number;
  148280. set kernel(value: number);
  148281. /**
  148282. * Creates a new instance of @see BloomEffect
  148283. * @param scene The scene the effect belongs to.
  148284. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148285. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148286. * @param bloomWeight The the strength of bloom.
  148287. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148288. * @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)
  148289. */
  148290. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148291. /**
  148292. * Disposes each of the internal effects for a given camera.
  148293. * @param camera The camera to dispose the effect on.
  148294. */
  148295. disposeEffects(camera: Camera): void;
  148296. /**
  148297. * @hidden Internal
  148298. */
  148299. _updateEffects(): void;
  148300. /**
  148301. * Internal
  148302. * @returns if all the contained post processes are ready.
  148303. * @hidden
  148304. */
  148305. _isReady(): boolean;
  148306. }
  148307. }
  148308. declare module BABYLON {
  148309. /** @hidden */
  148310. export var chromaticAberrationPixelShader: {
  148311. name: string;
  148312. shader: string;
  148313. };
  148314. }
  148315. declare module BABYLON {
  148316. /**
  148317. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148318. */
  148319. export class ChromaticAberrationPostProcess extends PostProcess {
  148320. /**
  148321. * The amount of seperation of rgb channels (default: 30)
  148322. */
  148323. aberrationAmount: number;
  148324. /**
  148325. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148326. */
  148327. radialIntensity: number;
  148328. /**
  148329. * 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))
  148330. */
  148331. direction: Vector2;
  148332. /**
  148333. * 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))
  148334. */
  148335. centerPosition: Vector2;
  148336. /** The width of the screen to apply the effect on */
  148337. screenWidth: number;
  148338. /** The height of the screen to apply the effect on */
  148339. screenHeight: number;
  148340. /**
  148341. * Gets a string identifying the name of the class
  148342. * @returns "ChromaticAberrationPostProcess" string
  148343. */
  148344. getClassName(): string;
  148345. /**
  148346. * Creates a new instance ChromaticAberrationPostProcess
  148347. * @param name The name of the effect.
  148348. * @param screenWidth The width of the screen to apply the effect on.
  148349. * @param screenHeight The height of the screen to apply the effect on.
  148350. * @param options The required width/height ratio to downsize to before computing the render pass.
  148351. * @param camera The camera to apply the render pass to.
  148352. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148353. * @param engine The engine which the post process will be applied. (default: current engine)
  148354. * @param reusable If the post process can be reused on the same frame. (default: false)
  148355. * @param textureType Type of textures used when performing the post process. (default: 0)
  148356. * @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)
  148357. */
  148358. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148359. /** @hidden */
  148360. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148361. }
  148362. }
  148363. declare module BABYLON {
  148364. /** @hidden */
  148365. export var circleOfConfusionPixelShader: {
  148366. name: string;
  148367. shader: string;
  148368. };
  148369. }
  148370. declare module BABYLON {
  148371. /**
  148372. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148373. */
  148374. export class CircleOfConfusionPostProcess extends PostProcess {
  148375. /**
  148376. * 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.
  148377. */
  148378. lensSize: number;
  148379. /**
  148380. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148381. */
  148382. fStop: number;
  148383. /**
  148384. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148385. */
  148386. focusDistance: number;
  148387. /**
  148388. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148389. */
  148390. focalLength: number;
  148391. /**
  148392. * Gets a string identifying the name of the class
  148393. * @returns "CircleOfConfusionPostProcess" string
  148394. */
  148395. getClassName(): string;
  148396. private _depthTexture;
  148397. /**
  148398. * Creates a new instance CircleOfConfusionPostProcess
  148399. * @param name The name of the effect.
  148400. * @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.
  148401. * @param options The required width/height ratio to downsize to before computing the render pass.
  148402. * @param camera The camera to apply the render pass to.
  148403. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148404. * @param engine The engine which the post process will be applied. (default: current engine)
  148405. * @param reusable If the post process can be reused on the same frame. (default: false)
  148406. * @param textureType Type of textures used when performing the post process. (default: 0)
  148407. * @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)
  148408. */
  148409. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148410. /**
  148411. * 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.
  148412. */
  148413. set depthTexture(value: RenderTargetTexture);
  148414. }
  148415. }
  148416. declare module BABYLON {
  148417. /** @hidden */
  148418. export var colorCorrectionPixelShader: {
  148419. name: string;
  148420. shader: string;
  148421. };
  148422. }
  148423. declare module BABYLON {
  148424. /**
  148425. *
  148426. * This post-process allows the modification of rendered colors by using
  148427. * a 'look-up table' (LUT). This effect is also called Color Grading.
  148428. *
  148429. * The object needs to be provided an url to a texture containing the color
  148430. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  148431. * Use an image editing software to tweak the LUT to match your needs.
  148432. *
  148433. * For an example of a color LUT, see here:
  148434. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  148435. * For explanations on color grading, see here:
  148436. * @see http://udn.epicgames.com/Three/ColorGrading.html
  148437. *
  148438. */
  148439. export class ColorCorrectionPostProcess extends PostProcess {
  148440. private _colorTableTexture;
  148441. /**
  148442. * Gets the color table url used to create the LUT texture
  148443. */
  148444. colorTableUrl: string;
  148445. /**
  148446. * Gets a string identifying the name of the class
  148447. * @returns "ColorCorrectionPostProcess" string
  148448. */
  148449. getClassName(): string;
  148450. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148451. /** @hidden */
  148452. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  148453. }
  148454. }
  148455. declare module BABYLON {
  148456. /** @hidden */
  148457. export var convolutionPixelShader: {
  148458. name: string;
  148459. shader: string;
  148460. };
  148461. }
  148462. declare module BABYLON {
  148463. /**
  148464. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  148465. * input texture to perform effects such as edge detection or sharpening
  148466. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148467. */
  148468. export class ConvolutionPostProcess extends PostProcess {
  148469. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  148470. kernel: number[];
  148471. /**
  148472. * Gets a string identifying the name of the class
  148473. * @returns "ConvolutionPostProcess" string
  148474. */
  148475. getClassName(): string;
  148476. /**
  148477. * Creates a new instance ConvolutionPostProcess
  148478. * @param name The name of the effect.
  148479. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  148480. * @param options The required width/height ratio to downsize to before computing the render pass.
  148481. * @param camera The camera to apply the render pass to.
  148482. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148483. * @param engine The engine which the post process will be applied. (default: current engine)
  148484. * @param reusable If the post process can be reused on the same frame. (default: false)
  148485. * @param textureType Type of textures used when performing the post process. (default: 0)
  148486. */
  148487. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148488. /** @hidden */
  148489. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  148490. /**
  148491. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148492. */
  148493. static EdgeDetect0Kernel: number[];
  148494. /**
  148495. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148496. */
  148497. static EdgeDetect1Kernel: number[];
  148498. /**
  148499. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148500. */
  148501. static EdgeDetect2Kernel: number[];
  148502. /**
  148503. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148504. */
  148505. static SharpenKernel: number[];
  148506. /**
  148507. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148508. */
  148509. static EmbossKernel: number[];
  148510. /**
  148511. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148512. */
  148513. static GaussianKernel: number[];
  148514. }
  148515. }
  148516. declare module BABYLON {
  148517. /**
  148518. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  148519. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  148520. * based on samples that have a large difference in distance than the center pixel.
  148521. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  148522. */
  148523. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  148524. /**
  148525. * The direction the blur should be applied
  148526. */
  148527. direction: Vector2;
  148528. /**
  148529. * Gets a string identifying the name of the class
  148530. * @returns "DepthOfFieldBlurPostProcess" string
  148531. */
  148532. getClassName(): string;
  148533. /**
  148534. * Creates a new instance CircleOfConfusionPostProcess
  148535. * @param name The name of the effect.
  148536. * @param scene The scene the effect belongs to.
  148537. * @param direction The direction the blur should be applied.
  148538. * @param kernel The size of the kernel used to blur.
  148539. * @param options The required width/height ratio to downsize to before computing the render pass.
  148540. * @param camera The camera to apply the render pass to.
  148541. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  148542. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  148543. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148544. * @param engine The engine which the post process will be applied. (default: current engine)
  148545. * @param reusable If the post process can be reused on the same frame. (default: false)
  148546. * @param textureType Type of textures used when performing the post process. (default: 0)
  148547. * @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)
  148548. */
  148549. 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);
  148550. }
  148551. }
  148552. declare module BABYLON {
  148553. /** @hidden */
  148554. export var depthOfFieldMergePixelShader: {
  148555. name: string;
  148556. shader: string;
  148557. };
  148558. }
  148559. declare module BABYLON {
  148560. /**
  148561. * Options to be set when merging outputs from the default pipeline.
  148562. */
  148563. export class DepthOfFieldMergePostProcessOptions {
  148564. /**
  148565. * The original image to merge on top of
  148566. */
  148567. originalFromInput: PostProcess;
  148568. /**
  148569. * Parameters to perform the merge of the depth of field effect
  148570. */
  148571. depthOfField?: {
  148572. circleOfConfusion: PostProcess;
  148573. blurSteps: Array<PostProcess>;
  148574. };
  148575. /**
  148576. * Parameters to perform the merge of bloom effect
  148577. */
  148578. bloom?: {
  148579. blurred: PostProcess;
  148580. weight: number;
  148581. };
  148582. }
  148583. /**
  148584. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148585. */
  148586. export class DepthOfFieldMergePostProcess extends PostProcess {
  148587. private blurSteps;
  148588. /**
  148589. * Gets a string identifying the name of the class
  148590. * @returns "DepthOfFieldMergePostProcess" string
  148591. */
  148592. getClassName(): string;
  148593. /**
  148594. * Creates a new instance of DepthOfFieldMergePostProcess
  148595. * @param name The name of the effect.
  148596. * @param originalFromInput Post process which's input will be used for the merge.
  148597. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  148598. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  148599. * @param options The required width/height ratio to downsize to before computing the render pass.
  148600. * @param camera The camera to apply the render pass to.
  148601. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148602. * @param engine The engine which the post process will be applied. (default: current engine)
  148603. * @param reusable If the post process can be reused on the same frame. (default: false)
  148604. * @param textureType Type of textures used when performing the post process. (default: 0)
  148605. * @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)
  148606. */
  148607. 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);
  148608. /**
  148609. * Updates the effect with the current post process compile time values and recompiles the shader.
  148610. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  148611. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  148612. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  148613. * @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
  148614. * @param onCompiled Called when the shader has been compiled.
  148615. * @param onError Called if there is an error when compiling a shader.
  148616. */
  148617. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  148618. }
  148619. }
  148620. declare module BABYLON {
  148621. /**
  148622. * Specifies the level of max blur that should be applied when using the depth of field effect
  148623. */
  148624. export enum DepthOfFieldEffectBlurLevel {
  148625. /**
  148626. * Subtle blur
  148627. */
  148628. Low = 0,
  148629. /**
  148630. * Medium blur
  148631. */
  148632. Medium = 1,
  148633. /**
  148634. * Large blur
  148635. */
  148636. High = 2
  148637. }
  148638. /**
  148639. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  148640. */
  148641. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  148642. private _circleOfConfusion;
  148643. /**
  148644. * @hidden Internal, blurs from high to low
  148645. */
  148646. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  148647. private _depthOfFieldBlurY;
  148648. private _dofMerge;
  148649. /**
  148650. * @hidden Internal post processes in depth of field effect
  148651. */
  148652. _effects: Array<PostProcess>;
  148653. /**
  148654. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  148655. */
  148656. set focalLength(value: number);
  148657. get focalLength(): number;
  148658. /**
  148659. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148660. */
  148661. set fStop(value: number);
  148662. get fStop(): number;
  148663. /**
  148664. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148665. */
  148666. set focusDistance(value: number);
  148667. get focusDistance(): number;
  148668. /**
  148669. * 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.
  148670. */
  148671. set lensSize(value: number);
  148672. get lensSize(): number;
  148673. /**
  148674. * Creates a new instance DepthOfFieldEffect
  148675. * @param scene The scene the effect belongs to.
  148676. * @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.
  148677. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148678. * @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)
  148679. */
  148680. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  148681. /**
  148682. * Get the current class name of the current effet
  148683. * @returns "DepthOfFieldEffect"
  148684. */
  148685. getClassName(): string;
  148686. /**
  148687. * 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.
  148688. */
  148689. set depthTexture(value: RenderTargetTexture);
  148690. /**
  148691. * Disposes each of the internal effects for a given camera.
  148692. * @param camera The camera to dispose the effect on.
  148693. */
  148694. disposeEffects(camera: Camera): void;
  148695. /**
  148696. * @hidden Internal
  148697. */
  148698. _updateEffects(): void;
  148699. /**
  148700. * Internal
  148701. * @returns if all the contained post processes are ready.
  148702. * @hidden
  148703. */
  148704. _isReady(): boolean;
  148705. }
  148706. }
  148707. declare module BABYLON {
  148708. /** @hidden */
  148709. export var displayPassPixelShader: {
  148710. name: string;
  148711. shader: string;
  148712. };
  148713. }
  148714. declare module BABYLON {
  148715. /**
  148716. * DisplayPassPostProcess which produces an output the same as it's input
  148717. */
  148718. export class DisplayPassPostProcess extends PostProcess {
  148719. /**
  148720. * Gets a string identifying the name of the class
  148721. * @returns "DisplayPassPostProcess" string
  148722. */
  148723. getClassName(): string;
  148724. /**
  148725. * Creates the DisplayPassPostProcess
  148726. * @param name The name of the effect.
  148727. * @param options The required width/height ratio to downsize to before computing the render pass.
  148728. * @param camera The camera to apply the render pass to.
  148729. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148730. * @param engine The engine which the post process will be applied. (default: current engine)
  148731. * @param reusable If the post process can be reused on the same frame. (default: false)
  148732. */
  148733. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148734. /** @hidden */
  148735. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  148736. }
  148737. }
  148738. declare module BABYLON {
  148739. /** @hidden */
  148740. export var filterPixelShader: {
  148741. name: string;
  148742. shader: string;
  148743. };
  148744. }
  148745. declare module BABYLON {
  148746. /**
  148747. * Applies a kernel filter to the image
  148748. */
  148749. export class FilterPostProcess extends PostProcess {
  148750. /** The matrix to be applied to the image */
  148751. kernelMatrix: Matrix;
  148752. /**
  148753. * Gets a string identifying the name of the class
  148754. * @returns "FilterPostProcess" string
  148755. */
  148756. getClassName(): string;
  148757. /**
  148758. *
  148759. * @param name The name of the effect.
  148760. * @param kernelMatrix The matrix to be applied to the image
  148761. * @param options The required width/height ratio to downsize to before computing the render pass.
  148762. * @param camera The camera to apply the render pass to.
  148763. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148764. * @param engine The engine which the post process will be applied. (default: current engine)
  148765. * @param reusable If the post process can be reused on the same frame. (default: false)
  148766. */
  148767. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148768. /** @hidden */
  148769. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  148770. }
  148771. }
  148772. declare module BABYLON {
  148773. /** @hidden */
  148774. export var fxaaPixelShader: {
  148775. name: string;
  148776. shader: string;
  148777. };
  148778. }
  148779. declare module BABYLON {
  148780. /** @hidden */
  148781. export var fxaaVertexShader: {
  148782. name: string;
  148783. shader: string;
  148784. };
  148785. }
  148786. declare module BABYLON {
  148787. /**
  148788. * Fxaa post process
  148789. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  148790. */
  148791. export class FxaaPostProcess extends PostProcess {
  148792. /**
  148793. * Gets a string identifying the name of the class
  148794. * @returns "FxaaPostProcess" string
  148795. */
  148796. getClassName(): string;
  148797. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148798. private _getDefines;
  148799. /** @hidden */
  148800. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  148801. }
  148802. }
  148803. declare module BABYLON {
  148804. /** @hidden */
  148805. export var grainPixelShader: {
  148806. name: string;
  148807. shader: string;
  148808. };
  148809. }
  148810. declare module BABYLON {
  148811. /**
  148812. * The GrainPostProcess adds noise to the image at mid luminance levels
  148813. */
  148814. export class GrainPostProcess extends PostProcess {
  148815. /**
  148816. * The intensity of the grain added (default: 30)
  148817. */
  148818. intensity: number;
  148819. /**
  148820. * If the grain should be randomized on every frame
  148821. */
  148822. animated: boolean;
  148823. /**
  148824. * Gets a string identifying the name of the class
  148825. * @returns "GrainPostProcess" string
  148826. */
  148827. getClassName(): string;
  148828. /**
  148829. * Creates a new instance of @see GrainPostProcess
  148830. * @param name The name of the effect.
  148831. * @param options The required width/height ratio to downsize to before computing the render pass.
  148832. * @param camera The camera to apply the render pass to.
  148833. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148834. * @param engine The engine which the post process will be applied. (default: current engine)
  148835. * @param reusable If the post process can be reused on the same frame. (default: false)
  148836. * @param textureType Type of textures used when performing the post process. (default: 0)
  148837. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  148838. */
  148839. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148840. /** @hidden */
  148841. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  148842. }
  148843. }
  148844. declare module BABYLON {
  148845. /** @hidden */
  148846. export var highlightsPixelShader: {
  148847. name: string;
  148848. shader: string;
  148849. };
  148850. }
  148851. declare module BABYLON {
  148852. /**
  148853. * Extracts highlights from the image
  148854. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  148855. */
  148856. export class HighlightsPostProcess extends PostProcess {
  148857. /**
  148858. * Gets a string identifying the name of the class
  148859. * @returns "HighlightsPostProcess" string
  148860. */
  148861. getClassName(): string;
  148862. /**
  148863. * Extracts highlights from the image
  148864. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  148865. * @param name The name of the effect.
  148866. * @param options The required width/height ratio to downsize to before computing the render pass.
  148867. * @param camera The camera to apply the render pass to.
  148868. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148869. * @param engine The engine which the post process will be applied. (default: current engine)
  148870. * @param reusable If the post process can be reused on the same frame. (default: false)
  148871. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  148872. */
  148873. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148874. }
  148875. }
  148876. declare module BABYLON {
  148877. /** @hidden */
  148878. export var mrtFragmentDeclaration: {
  148879. name: string;
  148880. shader: string;
  148881. };
  148882. }
  148883. declare module BABYLON {
  148884. /** @hidden */
  148885. export var geometryPixelShader: {
  148886. name: string;
  148887. shader: string;
  148888. };
  148889. }
  148890. declare module BABYLON {
  148891. /** @hidden */
  148892. export var geometryVertexShader: {
  148893. name: string;
  148894. shader: string;
  148895. };
  148896. }
  148897. declare module BABYLON {
  148898. /** @hidden */
  148899. interface ISavedTransformationMatrix {
  148900. world: Matrix;
  148901. viewProjection: Matrix;
  148902. }
  148903. /**
  148904. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  148905. */
  148906. export class GeometryBufferRenderer {
  148907. /**
  148908. * Constant used to retrieve the position texture index in the G-Buffer textures array
  148909. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  148910. */
  148911. static readonly POSITION_TEXTURE_TYPE: number;
  148912. /**
  148913. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  148914. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  148915. */
  148916. static readonly VELOCITY_TEXTURE_TYPE: number;
  148917. /**
  148918. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  148919. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  148920. */
  148921. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  148922. /**
  148923. * Dictionary used to store the previous transformation matrices of each rendered mesh
  148924. * in order to compute objects velocities when enableVelocity is set to "true"
  148925. * @hidden
  148926. */
  148927. _previousTransformationMatrices: {
  148928. [index: number]: ISavedTransformationMatrix;
  148929. };
  148930. /**
  148931. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  148932. * in order to compute objects velocities when enableVelocity is set to "true"
  148933. * @hidden
  148934. */
  148935. _previousBonesTransformationMatrices: {
  148936. [index: number]: Float32Array;
  148937. };
  148938. /**
  148939. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  148940. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  148941. */
  148942. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  148943. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  148944. renderTransparentMeshes: boolean;
  148945. private _scene;
  148946. private _resizeObserver;
  148947. private _multiRenderTarget;
  148948. private _ratio;
  148949. private _enablePosition;
  148950. private _enableVelocity;
  148951. private _enableReflectivity;
  148952. private _positionIndex;
  148953. private _velocityIndex;
  148954. private _reflectivityIndex;
  148955. protected _effect: Effect;
  148956. protected _cachedDefines: string;
  148957. /**
  148958. * Set the render list (meshes to be rendered) used in the G buffer.
  148959. */
  148960. set renderList(meshes: Mesh[]);
  148961. /**
  148962. * Gets wether or not G buffer are supported by the running hardware.
  148963. * This requires draw buffer supports
  148964. */
  148965. get isSupported(): boolean;
  148966. /**
  148967. * Returns the index of the given texture type in the G-Buffer textures array
  148968. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  148969. * @returns the index of the given texture type in the G-Buffer textures array
  148970. */
  148971. getTextureIndex(textureType: number): number;
  148972. /**
  148973. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  148974. */
  148975. get enablePosition(): boolean;
  148976. /**
  148977. * Sets whether or not objects positions are enabled for the G buffer.
  148978. */
  148979. set enablePosition(enable: boolean);
  148980. /**
  148981. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  148982. */
  148983. get enableVelocity(): boolean;
  148984. /**
  148985. * Sets wether or not objects velocities are enabled for the G buffer.
  148986. */
  148987. set enableVelocity(enable: boolean);
  148988. /**
  148989. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  148990. */
  148991. get enableReflectivity(): boolean;
  148992. /**
  148993. * Sets wether or not objects roughness are enabled for the G buffer.
  148994. */
  148995. set enableReflectivity(enable: boolean);
  148996. /**
  148997. * Gets the scene associated with the buffer.
  148998. */
  148999. get scene(): Scene;
  149000. /**
  149001. * Gets the ratio used by the buffer during its creation.
  149002. * How big is the buffer related to the main canvas.
  149003. */
  149004. get ratio(): number;
  149005. /** @hidden */
  149006. static _SceneComponentInitialization: (scene: Scene) => void;
  149007. /**
  149008. * Creates a new G Buffer for the scene
  149009. * @param scene The scene the buffer belongs to
  149010. * @param ratio How big is the buffer related to the main canvas.
  149011. */
  149012. constructor(scene: Scene, ratio?: number);
  149013. /**
  149014. * Checks wether everything is ready to render a submesh to the G buffer.
  149015. * @param subMesh the submesh to check readiness for
  149016. * @param useInstances is the mesh drawn using instance or not
  149017. * @returns true if ready otherwise false
  149018. */
  149019. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149020. /**
  149021. * Gets the current underlying G Buffer.
  149022. * @returns the buffer
  149023. */
  149024. getGBuffer(): MultiRenderTarget;
  149025. /**
  149026. * Gets the number of samples used to render the buffer (anti aliasing).
  149027. */
  149028. get samples(): number;
  149029. /**
  149030. * Sets the number of samples used to render the buffer (anti aliasing).
  149031. */
  149032. set samples(value: number);
  149033. /**
  149034. * Disposes the renderer and frees up associated resources.
  149035. */
  149036. dispose(): void;
  149037. protected _createRenderTargets(): void;
  149038. private _copyBonesTransformationMatrices;
  149039. }
  149040. }
  149041. declare module BABYLON {
  149042. interface Scene {
  149043. /** @hidden (Backing field) */
  149044. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149045. /**
  149046. * Gets or Sets the current geometry buffer associated to the scene.
  149047. */
  149048. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149049. /**
  149050. * Enables a GeometryBufferRender and associates it with the scene
  149051. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149052. * @returns the GeometryBufferRenderer
  149053. */
  149054. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149055. /**
  149056. * Disables the GeometryBufferRender associated with the scene
  149057. */
  149058. disableGeometryBufferRenderer(): void;
  149059. }
  149060. /**
  149061. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149062. * in several rendering techniques.
  149063. */
  149064. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149065. /**
  149066. * The component name helpful to identify the component in the list of scene components.
  149067. */
  149068. readonly name: string;
  149069. /**
  149070. * The scene the component belongs to.
  149071. */
  149072. scene: Scene;
  149073. /**
  149074. * Creates a new instance of the component for the given scene
  149075. * @param scene Defines the scene to register the component in
  149076. */
  149077. constructor(scene: Scene);
  149078. /**
  149079. * Registers the component in a given scene
  149080. */
  149081. register(): void;
  149082. /**
  149083. * Rebuilds the elements related to this component in case of
  149084. * context lost for instance.
  149085. */
  149086. rebuild(): void;
  149087. /**
  149088. * Disposes the component and the associated ressources
  149089. */
  149090. dispose(): void;
  149091. private _gatherRenderTargets;
  149092. }
  149093. }
  149094. declare module BABYLON {
  149095. /** @hidden */
  149096. export var motionBlurPixelShader: {
  149097. name: string;
  149098. shader: string;
  149099. };
  149100. }
  149101. declare module BABYLON {
  149102. /**
  149103. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149104. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149105. * As an example, all you have to do is to create the post-process:
  149106. * var mb = new BABYLON.MotionBlurPostProcess(
  149107. * 'mb', // The name of the effect.
  149108. * scene, // The scene containing the objects to blur according to their velocity.
  149109. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149110. * camera // The camera to apply the render pass to.
  149111. * );
  149112. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149113. */
  149114. export class MotionBlurPostProcess extends PostProcess {
  149115. /**
  149116. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149117. */
  149118. motionStrength: number;
  149119. /**
  149120. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149121. */
  149122. get motionBlurSamples(): number;
  149123. /**
  149124. * Sets the number of iterations to be used for motion blur quality
  149125. */
  149126. set motionBlurSamples(samples: number);
  149127. private _motionBlurSamples;
  149128. private _geometryBufferRenderer;
  149129. /**
  149130. * Gets a string identifying the name of the class
  149131. * @returns "MotionBlurPostProcess" string
  149132. */
  149133. getClassName(): string;
  149134. /**
  149135. * Creates a new instance MotionBlurPostProcess
  149136. * @param name The name of the effect.
  149137. * @param scene The scene containing the objects to blur according to their velocity.
  149138. * @param options The required width/height ratio to downsize to before computing the render pass.
  149139. * @param camera The camera to apply the render pass to.
  149140. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149141. * @param engine The engine which the post process will be applied. (default: current engine)
  149142. * @param reusable If the post process can be reused on the same frame. (default: false)
  149143. * @param textureType Type of textures used when performing the post process. (default: 0)
  149144. * @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)
  149145. */
  149146. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149147. /**
  149148. * Excludes the given skinned mesh from computing bones velocities.
  149149. * 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.
  149150. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149151. */
  149152. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149153. /**
  149154. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149155. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149156. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149157. */
  149158. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149159. /**
  149160. * Disposes the post process.
  149161. * @param camera The camera to dispose the post process on.
  149162. */
  149163. dispose(camera?: Camera): void;
  149164. /** @hidden */
  149165. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149166. }
  149167. }
  149168. declare module BABYLON {
  149169. /** @hidden */
  149170. export var refractionPixelShader: {
  149171. name: string;
  149172. shader: string;
  149173. };
  149174. }
  149175. declare module BABYLON {
  149176. /**
  149177. * Post process which applies a refractin texture
  149178. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149179. */
  149180. export class RefractionPostProcess extends PostProcess {
  149181. private _refTexture;
  149182. private _ownRefractionTexture;
  149183. /** the base color of the refraction (used to taint the rendering) */
  149184. color: Color3;
  149185. /** simulated refraction depth */
  149186. depth: number;
  149187. /** the coefficient of the base color (0 to remove base color tainting) */
  149188. colorLevel: number;
  149189. /** Gets the url used to load the refraction texture */
  149190. refractionTextureUrl: string;
  149191. /**
  149192. * Gets or sets the refraction texture
  149193. * Please note that you are responsible for disposing the texture if you set it manually
  149194. */
  149195. get refractionTexture(): Texture;
  149196. set refractionTexture(value: Texture);
  149197. /**
  149198. * Gets a string identifying the name of the class
  149199. * @returns "RefractionPostProcess" string
  149200. */
  149201. getClassName(): string;
  149202. /**
  149203. * Initializes the RefractionPostProcess
  149204. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149205. * @param name The name of the effect.
  149206. * @param refractionTextureUrl Url of the refraction texture to use
  149207. * @param color the base color of the refraction (used to taint the rendering)
  149208. * @param depth simulated refraction depth
  149209. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149210. * @param camera The camera to apply the render pass to.
  149211. * @param options The required width/height ratio to downsize to before computing the render pass.
  149212. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149213. * @param engine The engine which the post process will be applied. (default: current engine)
  149214. * @param reusable If the post process can be reused on the same frame. (default: false)
  149215. */
  149216. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149217. /**
  149218. * Disposes of the post process
  149219. * @param camera Camera to dispose post process on
  149220. */
  149221. dispose(camera: Camera): void;
  149222. /** @hidden */
  149223. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149224. }
  149225. }
  149226. declare module BABYLON {
  149227. /** @hidden */
  149228. export var sharpenPixelShader: {
  149229. name: string;
  149230. shader: string;
  149231. };
  149232. }
  149233. declare module BABYLON {
  149234. /**
  149235. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149236. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149237. */
  149238. export class SharpenPostProcess extends PostProcess {
  149239. /**
  149240. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149241. */
  149242. colorAmount: number;
  149243. /**
  149244. * How much sharpness should be applied (default: 0.3)
  149245. */
  149246. edgeAmount: number;
  149247. /**
  149248. * Gets a string identifying the name of the class
  149249. * @returns "SharpenPostProcess" string
  149250. */
  149251. getClassName(): string;
  149252. /**
  149253. * Creates a new instance ConvolutionPostProcess
  149254. * @param name The name of the effect.
  149255. * @param options The required width/height ratio to downsize to before computing the render pass.
  149256. * @param camera The camera to apply the render pass to.
  149257. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149258. * @param engine The engine which the post process will be applied. (default: current engine)
  149259. * @param reusable If the post process can be reused on the same frame. (default: false)
  149260. * @param textureType Type of textures used when performing the post process. (default: 0)
  149261. * @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)
  149262. */
  149263. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149264. /** @hidden */
  149265. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149266. }
  149267. }
  149268. declare module BABYLON {
  149269. /**
  149270. * PostProcessRenderPipeline
  149271. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149272. */
  149273. export class PostProcessRenderPipeline {
  149274. private engine;
  149275. private _renderEffects;
  149276. private _renderEffectsForIsolatedPass;
  149277. /**
  149278. * List of inspectable custom properties (used by the Inspector)
  149279. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149280. */
  149281. inspectableCustomProperties: IInspectable[];
  149282. /**
  149283. * @hidden
  149284. */
  149285. protected _cameras: Camera[];
  149286. /** @hidden */
  149287. _name: string;
  149288. /**
  149289. * Gets pipeline name
  149290. */
  149291. get name(): string;
  149292. /** Gets the list of attached cameras */
  149293. get cameras(): Camera[];
  149294. /**
  149295. * Initializes a PostProcessRenderPipeline
  149296. * @param engine engine to add the pipeline to
  149297. * @param name name of the pipeline
  149298. */
  149299. constructor(engine: Engine, name: string);
  149300. /**
  149301. * Gets the class name
  149302. * @returns "PostProcessRenderPipeline"
  149303. */
  149304. getClassName(): string;
  149305. /**
  149306. * If all the render effects in the pipeline are supported
  149307. */
  149308. get isSupported(): boolean;
  149309. /**
  149310. * Adds an effect to the pipeline
  149311. * @param renderEffect the effect to add
  149312. */
  149313. addEffect(renderEffect: PostProcessRenderEffect): void;
  149314. /** @hidden */
  149315. _rebuild(): void;
  149316. /** @hidden */
  149317. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149318. /** @hidden */
  149319. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149320. /** @hidden */
  149321. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149322. /** @hidden */
  149323. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149324. /** @hidden */
  149325. _attachCameras(cameras: Camera, unique: boolean): void;
  149326. /** @hidden */
  149327. _attachCameras(cameras: Camera[], unique: boolean): void;
  149328. /** @hidden */
  149329. _detachCameras(cameras: Camera): void;
  149330. /** @hidden */
  149331. _detachCameras(cameras: Nullable<Camera[]>): void;
  149332. /** @hidden */
  149333. _update(): void;
  149334. /** @hidden */
  149335. _reset(): void;
  149336. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149337. /**
  149338. * Sets the required values to the prepass renderer.
  149339. * @param prePassRenderer defines the prepass renderer to setup.
  149340. * @returns true if the pre pass is needed.
  149341. */
  149342. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149343. /**
  149344. * Disposes of the pipeline
  149345. */
  149346. dispose(): void;
  149347. }
  149348. }
  149349. declare module BABYLON {
  149350. /**
  149351. * PostProcessRenderPipelineManager class
  149352. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149353. */
  149354. export class PostProcessRenderPipelineManager {
  149355. private _renderPipelines;
  149356. /**
  149357. * Initializes a PostProcessRenderPipelineManager
  149358. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149359. */
  149360. constructor();
  149361. /**
  149362. * Gets the list of supported render pipelines
  149363. */
  149364. get supportedPipelines(): PostProcessRenderPipeline[];
  149365. /**
  149366. * Adds a pipeline to the manager
  149367. * @param renderPipeline The pipeline to add
  149368. */
  149369. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149370. /**
  149371. * Attaches a camera to the pipeline
  149372. * @param renderPipelineName The name of the pipeline to attach to
  149373. * @param cameras the camera to attach
  149374. * @param unique if the camera can be attached multiple times to the pipeline
  149375. */
  149376. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149377. /**
  149378. * Detaches a camera from the pipeline
  149379. * @param renderPipelineName The name of the pipeline to detach from
  149380. * @param cameras the camera to detach
  149381. */
  149382. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149383. /**
  149384. * Enables an effect by name on a pipeline
  149385. * @param renderPipelineName the name of the pipeline to enable the effect in
  149386. * @param renderEffectName the name of the effect to enable
  149387. * @param cameras the cameras that the effect should be enabled on
  149388. */
  149389. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149390. /**
  149391. * Disables an effect by name on a pipeline
  149392. * @param renderPipelineName the name of the pipeline to disable the effect in
  149393. * @param renderEffectName the name of the effect to disable
  149394. * @param cameras the cameras that the effect should be disabled on
  149395. */
  149396. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149397. /**
  149398. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149399. */
  149400. update(): void;
  149401. /** @hidden */
  149402. _rebuild(): void;
  149403. /**
  149404. * Disposes of the manager and pipelines
  149405. */
  149406. dispose(): void;
  149407. }
  149408. }
  149409. declare module BABYLON {
  149410. interface Scene {
  149411. /** @hidden (Backing field) */
  149412. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149413. /**
  149414. * Gets the postprocess render pipeline manager
  149415. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149416. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149417. */
  149418. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149419. }
  149420. /**
  149421. * Defines the Render Pipeline scene component responsible to rendering pipelines
  149422. */
  149423. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  149424. /**
  149425. * The component name helpfull to identify the component in the list of scene components.
  149426. */
  149427. readonly name: string;
  149428. /**
  149429. * The scene the component belongs to.
  149430. */
  149431. scene: Scene;
  149432. /**
  149433. * Creates a new instance of the component for the given scene
  149434. * @param scene Defines the scene to register the component in
  149435. */
  149436. constructor(scene: Scene);
  149437. /**
  149438. * Registers the component in a given scene
  149439. */
  149440. register(): void;
  149441. /**
  149442. * Rebuilds the elements related to this component in case of
  149443. * context lost for instance.
  149444. */
  149445. rebuild(): void;
  149446. /**
  149447. * Disposes the component and the associated ressources
  149448. */
  149449. dispose(): void;
  149450. private _gatherRenderTargets;
  149451. }
  149452. }
  149453. declare module BABYLON {
  149454. /**
  149455. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  149456. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149457. */
  149458. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149459. private _scene;
  149460. private _camerasToBeAttached;
  149461. /**
  149462. * ID of the sharpen post process,
  149463. */
  149464. private readonly SharpenPostProcessId;
  149465. /**
  149466. * @ignore
  149467. * ID of the image processing post process;
  149468. */
  149469. readonly ImageProcessingPostProcessId: string;
  149470. /**
  149471. * @ignore
  149472. * ID of the Fast Approximate Anti-Aliasing post process;
  149473. */
  149474. readonly FxaaPostProcessId: string;
  149475. /**
  149476. * ID of the chromatic aberration post process,
  149477. */
  149478. private readonly ChromaticAberrationPostProcessId;
  149479. /**
  149480. * ID of the grain post process
  149481. */
  149482. private readonly GrainPostProcessId;
  149483. /**
  149484. * Sharpen post process which will apply a sharpen convolution to enhance edges
  149485. */
  149486. sharpen: SharpenPostProcess;
  149487. private _sharpenEffect;
  149488. private bloom;
  149489. /**
  149490. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  149491. */
  149492. depthOfField: DepthOfFieldEffect;
  149493. /**
  149494. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149495. */
  149496. fxaa: FxaaPostProcess;
  149497. /**
  149498. * Image post processing pass used to perform operations such as tone mapping or color grading.
  149499. */
  149500. imageProcessing: ImageProcessingPostProcess;
  149501. /**
  149502. * Chromatic aberration post process which will shift rgb colors in the image
  149503. */
  149504. chromaticAberration: ChromaticAberrationPostProcess;
  149505. private _chromaticAberrationEffect;
  149506. /**
  149507. * Grain post process which add noise to the image
  149508. */
  149509. grain: GrainPostProcess;
  149510. private _grainEffect;
  149511. /**
  149512. * Glow post process which adds a glow to emissive areas of the image
  149513. */
  149514. private _glowLayer;
  149515. /**
  149516. * Animations which can be used to tweak settings over a period of time
  149517. */
  149518. animations: Animation[];
  149519. private _imageProcessingConfigurationObserver;
  149520. private _sharpenEnabled;
  149521. private _bloomEnabled;
  149522. private _depthOfFieldEnabled;
  149523. private _depthOfFieldBlurLevel;
  149524. private _fxaaEnabled;
  149525. private _imageProcessingEnabled;
  149526. private _defaultPipelineTextureType;
  149527. private _bloomScale;
  149528. private _chromaticAberrationEnabled;
  149529. private _grainEnabled;
  149530. private _buildAllowed;
  149531. /**
  149532. * Gets active scene
  149533. */
  149534. get scene(): Scene;
  149535. /**
  149536. * Enable or disable the sharpen process from the pipeline
  149537. */
  149538. set sharpenEnabled(enabled: boolean);
  149539. get sharpenEnabled(): boolean;
  149540. private _resizeObserver;
  149541. private _hardwareScaleLevel;
  149542. private _bloomKernel;
  149543. /**
  149544. * Specifies the size of the bloom blur kernel, relative to the final output size
  149545. */
  149546. get bloomKernel(): number;
  149547. set bloomKernel(value: number);
  149548. /**
  149549. * Specifies the weight of the bloom in the final rendering
  149550. */
  149551. private _bloomWeight;
  149552. /**
  149553. * Specifies the luma threshold for the area that will be blurred by the bloom
  149554. */
  149555. private _bloomThreshold;
  149556. private _hdr;
  149557. /**
  149558. * The strength of the bloom.
  149559. */
  149560. set bloomWeight(value: number);
  149561. get bloomWeight(): number;
  149562. /**
  149563. * The strength of the bloom.
  149564. */
  149565. set bloomThreshold(value: number);
  149566. get bloomThreshold(): number;
  149567. /**
  149568. * The scale of the bloom, lower value will provide better performance.
  149569. */
  149570. set bloomScale(value: number);
  149571. get bloomScale(): number;
  149572. /**
  149573. * Enable or disable the bloom from the pipeline
  149574. */
  149575. set bloomEnabled(enabled: boolean);
  149576. get bloomEnabled(): boolean;
  149577. private _rebuildBloom;
  149578. /**
  149579. * If the depth of field is enabled.
  149580. */
  149581. get depthOfFieldEnabled(): boolean;
  149582. set depthOfFieldEnabled(enabled: boolean);
  149583. /**
  149584. * Blur level of the depth of field effect. (Higher blur will effect performance)
  149585. */
  149586. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  149587. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  149588. /**
  149589. * If the anti aliasing is enabled.
  149590. */
  149591. set fxaaEnabled(enabled: boolean);
  149592. get fxaaEnabled(): boolean;
  149593. private _samples;
  149594. /**
  149595. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  149596. */
  149597. set samples(sampleCount: number);
  149598. get samples(): number;
  149599. /**
  149600. * If image processing is enabled.
  149601. */
  149602. set imageProcessingEnabled(enabled: boolean);
  149603. get imageProcessingEnabled(): boolean;
  149604. /**
  149605. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  149606. */
  149607. set glowLayerEnabled(enabled: boolean);
  149608. get glowLayerEnabled(): boolean;
  149609. /**
  149610. * Gets the glow layer (or null if not defined)
  149611. */
  149612. get glowLayer(): Nullable<GlowLayer>;
  149613. /**
  149614. * Enable or disable the chromaticAberration process from the pipeline
  149615. */
  149616. set chromaticAberrationEnabled(enabled: boolean);
  149617. get chromaticAberrationEnabled(): boolean;
  149618. /**
  149619. * Enable or disable the grain process from the pipeline
  149620. */
  149621. set grainEnabled(enabled: boolean);
  149622. get grainEnabled(): boolean;
  149623. /**
  149624. * @constructor
  149625. * @param name - The rendering pipeline name (default: "")
  149626. * @param hdr - If high dynamic range textures should be used (default: true)
  149627. * @param scene - The scene linked to this pipeline (default: the last created scene)
  149628. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  149629. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  149630. */
  149631. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  149632. /**
  149633. * Get the class name
  149634. * @returns "DefaultRenderingPipeline"
  149635. */
  149636. getClassName(): string;
  149637. /**
  149638. * Force the compilation of the entire pipeline.
  149639. */
  149640. prepare(): void;
  149641. private _hasCleared;
  149642. private _prevPostProcess;
  149643. private _prevPrevPostProcess;
  149644. private _setAutoClearAndTextureSharing;
  149645. private _depthOfFieldSceneObserver;
  149646. private _buildPipeline;
  149647. private _disposePostProcesses;
  149648. /**
  149649. * Adds a camera to the pipeline
  149650. * @param camera the camera to be added
  149651. */
  149652. addCamera(camera: Camera): void;
  149653. /**
  149654. * Removes a camera from the pipeline
  149655. * @param camera the camera to remove
  149656. */
  149657. removeCamera(camera: Camera): void;
  149658. /**
  149659. * Dispose of the pipeline and stop all post processes
  149660. */
  149661. dispose(): void;
  149662. /**
  149663. * Serialize the rendering pipeline (Used when exporting)
  149664. * @returns the serialized object
  149665. */
  149666. serialize(): any;
  149667. /**
  149668. * Parse the serialized pipeline
  149669. * @param source Source pipeline.
  149670. * @param scene The scene to load the pipeline to.
  149671. * @param rootUrl The URL of the serialized pipeline.
  149672. * @returns An instantiated pipeline from the serialized object.
  149673. */
  149674. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  149675. }
  149676. }
  149677. declare module BABYLON {
  149678. /** @hidden */
  149679. export var lensHighlightsPixelShader: {
  149680. name: string;
  149681. shader: string;
  149682. };
  149683. }
  149684. declare module BABYLON {
  149685. /** @hidden */
  149686. export var depthOfFieldPixelShader: {
  149687. name: string;
  149688. shader: string;
  149689. };
  149690. }
  149691. declare module BABYLON {
  149692. /**
  149693. * BABYLON.JS Chromatic Aberration GLSL Shader
  149694. * Author: Olivier Guyot
  149695. * Separates very slightly R, G and B colors on the edges of the screen
  149696. * Inspired by Francois Tarlier & Martins Upitis
  149697. */
  149698. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  149699. /**
  149700. * @ignore
  149701. * The chromatic aberration PostProcess id in the pipeline
  149702. */
  149703. LensChromaticAberrationEffect: string;
  149704. /**
  149705. * @ignore
  149706. * The highlights enhancing PostProcess id in the pipeline
  149707. */
  149708. HighlightsEnhancingEffect: string;
  149709. /**
  149710. * @ignore
  149711. * The depth-of-field PostProcess id in the pipeline
  149712. */
  149713. LensDepthOfFieldEffect: string;
  149714. private _scene;
  149715. private _depthTexture;
  149716. private _grainTexture;
  149717. private _chromaticAberrationPostProcess;
  149718. private _highlightsPostProcess;
  149719. private _depthOfFieldPostProcess;
  149720. private _edgeBlur;
  149721. private _grainAmount;
  149722. private _chromaticAberration;
  149723. private _distortion;
  149724. private _highlightsGain;
  149725. private _highlightsThreshold;
  149726. private _dofDistance;
  149727. private _dofAperture;
  149728. private _dofDarken;
  149729. private _dofPentagon;
  149730. private _blurNoise;
  149731. /**
  149732. * @constructor
  149733. *
  149734. * Effect parameters are as follow:
  149735. * {
  149736. * chromatic_aberration: number; // from 0 to x (1 for realism)
  149737. * edge_blur: number; // from 0 to x (1 for realism)
  149738. * distortion: number; // from 0 to x (1 for realism)
  149739. * grain_amount: number; // from 0 to 1
  149740. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  149741. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  149742. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  149743. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  149744. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  149745. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  149746. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  149747. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  149748. * }
  149749. * Note: if an effect parameter is unset, effect is disabled
  149750. *
  149751. * @param name The rendering pipeline name
  149752. * @param parameters - An object containing all parameters (see above)
  149753. * @param scene The scene linked to this pipeline
  149754. * @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)
  149755. * @param cameras The array of cameras that the rendering pipeline will be attached to
  149756. */
  149757. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  149758. /**
  149759. * Get the class name
  149760. * @returns "LensRenderingPipeline"
  149761. */
  149762. getClassName(): string;
  149763. /**
  149764. * Gets associated scene
  149765. */
  149766. get scene(): Scene;
  149767. /**
  149768. * Gets or sets the edge blur
  149769. */
  149770. get edgeBlur(): number;
  149771. set edgeBlur(value: number);
  149772. /**
  149773. * Gets or sets the grain amount
  149774. */
  149775. get grainAmount(): number;
  149776. set grainAmount(value: number);
  149777. /**
  149778. * Gets or sets the chromatic aberration amount
  149779. */
  149780. get chromaticAberration(): number;
  149781. set chromaticAberration(value: number);
  149782. /**
  149783. * Gets or sets the depth of field aperture
  149784. */
  149785. get dofAperture(): number;
  149786. set dofAperture(value: number);
  149787. /**
  149788. * Gets or sets the edge distortion
  149789. */
  149790. get edgeDistortion(): number;
  149791. set edgeDistortion(value: number);
  149792. /**
  149793. * Gets or sets the depth of field distortion
  149794. */
  149795. get dofDistortion(): number;
  149796. set dofDistortion(value: number);
  149797. /**
  149798. * Gets or sets the darken out of focus amount
  149799. */
  149800. get darkenOutOfFocus(): number;
  149801. set darkenOutOfFocus(value: number);
  149802. /**
  149803. * Gets or sets a boolean indicating if blur noise is enabled
  149804. */
  149805. get blurNoise(): boolean;
  149806. set blurNoise(value: boolean);
  149807. /**
  149808. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  149809. */
  149810. get pentagonBokeh(): boolean;
  149811. set pentagonBokeh(value: boolean);
  149812. /**
  149813. * Gets or sets the highlight grain amount
  149814. */
  149815. get highlightsGain(): number;
  149816. set highlightsGain(value: number);
  149817. /**
  149818. * Gets or sets the highlight threshold
  149819. */
  149820. get highlightsThreshold(): number;
  149821. set highlightsThreshold(value: number);
  149822. /**
  149823. * Sets the amount of blur at the edges
  149824. * @param amount blur amount
  149825. */
  149826. setEdgeBlur(amount: number): void;
  149827. /**
  149828. * Sets edge blur to 0
  149829. */
  149830. disableEdgeBlur(): void;
  149831. /**
  149832. * Sets the amout of grain
  149833. * @param amount Amount of grain
  149834. */
  149835. setGrainAmount(amount: number): void;
  149836. /**
  149837. * Set grain amount to 0
  149838. */
  149839. disableGrain(): void;
  149840. /**
  149841. * Sets the chromatic aberration amount
  149842. * @param amount amount of chromatic aberration
  149843. */
  149844. setChromaticAberration(amount: number): void;
  149845. /**
  149846. * Sets chromatic aberration amount to 0
  149847. */
  149848. disableChromaticAberration(): void;
  149849. /**
  149850. * Sets the EdgeDistortion amount
  149851. * @param amount amount of EdgeDistortion
  149852. */
  149853. setEdgeDistortion(amount: number): void;
  149854. /**
  149855. * Sets edge distortion to 0
  149856. */
  149857. disableEdgeDistortion(): void;
  149858. /**
  149859. * Sets the FocusDistance amount
  149860. * @param amount amount of FocusDistance
  149861. */
  149862. setFocusDistance(amount: number): void;
  149863. /**
  149864. * Disables depth of field
  149865. */
  149866. disableDepthOfField(): void;
  149867. /**
  149868. * Sets the Aperture amount
  149869. * @param amount amount of Aperture
  149870. */
  149871. setAperture(amount: number): void;
  149872. /**
  149873. * Sets the DarkenOutOfFocus amount
  149874. * @param amount amount of DarkenOutOfFocus
  149875. */
  149876. setDarkenOutOfFocus(amount: number): void;
  149877. private _pentagonBokehIsEnabled;
  149878. /**
  149879. * Creates a pentagon bokeh effect
  149880. */
  149881. enablePentagonBokeh(): void;
  149882. /**
  149883. * Disables the pentagon bokeh effect
  149884. */
  149885. disablePentagonBokeh(): void;
  149886. /**
  149887. * Enables noise blur
  149888. */
  149889. enableNoiseBlur(): void;
  149890. /**
  149891. * Disables noise blur
  149892. */
  149893. disableNoiseBlur(): void;
  149894. /**
  149895. * Sets the HighlightsGain amount
  149896. * @param amount amount of HighlightsGain
  149897. */
  149898. setHighlightsGain(amount: number): void;
  149899. /**
  149900. * Sets the HighlightsThreshold amount
  149901. * @param amount amount of HighlightsThreshold
  149902. */
  149903. setHighlightsThreshold(amount: number): void;
  149904. /**
  149905. * Disables highlights
  149906. */
  149907. disableHighlights(): void;
  149908. /**
  149909. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  149910. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  149911. */
  149912. dispose(disableDepthRender?: boolean): void;
  149913. private _createChromaticAberrationPostProcess;
  149914. private _createHighlightsPostProcess;
  149915. private _createDepthOfFieldPostProcess;
  149916. private _createGrainTexture;
  149917. }
  149918. }
  149919. declare module BABYLON {
  149920. /** @hidden */
  149921. export var ssao2PixelShader: {
  149922. name: string;
  149923. shader: string;
  149924. };
  149925. }
  149926. declare module BABYLON {
  149927. /** @hidden */
  149928. export var ssaoCombinePixelShader: {
  149929. name: string;
  149930. shader: string;
  149931. };
  149932. }
  149933. declare module BABYLON {
  149934. /**
  149935. * Render pipeline to produce ssao effect
  149936. */
  149937. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  149938. /**
  149939. * @ignore
  149940. * The PassPostProcess id in the pipeline that contains the original scene color
  149941. */
  149942. SSAOOriginalSceneColorEffect: string;
  149943. /**
  149944. * @ignore
  149945. * The SSAO PostProcess id in the pipeline
  149946. */
  149947. SSAORenderEffect: string;
  149948. /**
  149949. * @ignore
  149950. * The horizontal blur PostProcess id in the pipeline
  149951. */
  149952. SSAOBlurHRenderEffect: string;
  149953. /**
  149954. * @ignore
  149955. * The vertical blur PostProcess id in the pipeline
  149956. */
  149957. SSAOBlurVRenderEffect: string;
  149958. /**
  149959. * @ignore
  149960. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  149961. */
  149962. SSAOCombineRenderEffect: string;
  149963. /**
  149964. * The output strength of the SSAO post-process. Default value is 1.0.
  149965. */
  149966. totalStrength: number;
  149967. /**
  149968. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  149969. */
  149970. maxZ: number;
  149971. /**
  149972. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  149973. */
  149974. minZAspect: number;
  149975. private _samples;
  149976. /**
  149977. * Number of samples used for the SSAO calculations. Default value is 8
  149978. */
  149979. set samples(n: number);
  149980. get samples(): number;
  149981. private _textureSamples;
  149982. /**
  149983. * Number of samples to use for antialiasing
  149984. */
  149985. set textureSamples(n: number);
  149986. get textureSamples(): number;
  149987. /**
  149988. * Force rendering the geometry through geometry buffer
  149989. */
  149990. private _forceGeometryBuffer;
  149991. /**
  149992. * Ratio object used for SSAO ratio and blur ratio
  149993. */
  149994. private _ratio;
  149995. /**
  149996. * Dynamically generated sphere sampler.
  149997. */
  149998. private _sampleSphere;
  149999. /**
  150000. * Blur filter offsets
  150001. */
  150002. private _samplerOffsets;
  150003. private _expensiveBlur;
  150004. /**
  150005. * If bilateral blur should be used
  150006. */
  150007. set expensiveBlur(b: boolean);
  150008. get expensiveBlur(): boolean;
  150009. /**
  150010. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150011. */
  150012. radius: number;
  150013. /**
  150014. * The base color of the SSAO post-process
  150015. * The final result is "base + ssao" between [0, 1]
  150016. */
  150017. base: number;
  150018. /**
  150019. * Support test.
  150020. */
  150021. static get IsSupported(): boolean;
  150022. private _scene;
  150023. private _randomTexture;
  150024. private _originalColorPostProcess;
  150025. private _ssaoPostProcess;
  150026. private _blurHPostProcess;
  150027. private _blurVPostProcess;
  150028. private _ssaoCombinePostProcess;
  150029. private _prePassRenderer;
  150030. /**
  150031. * Gets active scene
  150032. */
  150033. get scene(): Scene;
  150034. /**
  150035. * @constructor
  150036. * @param name The rendering pipeline name
  150037. * @param scene The scene linked to this pipeline
  150038. * @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 }
  150039. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150040. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150041. */
  150042. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150043. /**
  150044. * Get the class name
  150045. * @returns "SSAO2RenderingPipeline"
  150046. */
  150047. getClassName(): string;
  150048. /**
  150049. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150050. */
  150051. dispose(disableGeometryBufferRenderer?: boolean): void;
  150052. private _createBlurPostProcess;
  150053. /** @hidden */
  150054. _rebuild(): void;
  150055. private _bits;
  150056. private _radicalInverse_VdC;
  150057. private _hammersley;
  150058. private _hemisphereSample_uniform;
  150059. private _generateHemisphere;
  150060. private _getDefinesForSSAO;
  150061. private _createSSAOPostProcess;
  150062. private _createSSAOCombinePostProcess;
  150063. private _createRandomTexture;
  150064. /**
  150065. * Serialize the rendering pipeline (Used when exporting)
  150066. * @returns the serialized object
  150067. */
  150068. serialize(): any;
  150069. /**
  150070. * Parse the serialized pipeline
  150071. * @param source Source pipeline.
  150072. * @param scene The scene to load the pipeline to.
  150073. * @param rootUrl The URL of the serialized pipeline.
  150074. * @returns An instantiated pipeline from the serialized object.
  150075. */
  150076. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150077. /**
  150078. * Sets the required values to the prepass renderer.
  150079. * @param prePassRenderer defines the prepass renderer to setup
  150080. * @returns true if the pre pass is needed.
  150081. */
  150082. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150083. }
  150084. }
  150085. declare module BABYLON {
  150086. /** @hidden */
  150087. export var ssaoPixelShader: {
  150088. name: string;
  150089. shader: string;
  150090. };
  150091. }
  150092. declare module BABYLON {
  150093. /**
  150094. * Render pipeline to produce ssao effect
  150095. */
  150096. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150097. /**
  150098. * @ignore
  150099. * The PassPostProcess id in the pipeline that contains the original scene color
  150100. */
  150101. SSAOOriginalSceneColorEffect: string;
  150102. /**
  150103. * @ignore
  150104. * The SSAO PostProcess id in the pipeline
  150105. */
  150106. SSAORenderEffect: string;
  150107. /**
  150108. * @ignore
  150109. * The horizontal blur PostProcess id in the pipeline
  150110. */
  150111. SSAOBlurHRenderEffect: string;
  150112. /**
  150113. * @ignore
  150114. * The vertical blur PostProcess id in the pipeline
  150115. */
  150116. SSAOBlurVRenderEffect: string;
  150117. /**
  150118. * @ignore
  150119. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150120. */
  150121. SSAOCombineRenderEffect: string;
  150122. /**
  150123. * The output strength of the SSAO post-process. Default value is 1.0.
  150124. */
  150125. totalStrength: number;
  150126. /**
  150127. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150128. */
  150129. radius: number;
  150130. /**
  150131. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150132. * Must not be equal to fallOff and superior to fallOff.
  150133. * Default value is 0.0075
  150134. */
  150135. area: number;
  150136. /**
  150137. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150138. * Must not be equal to area and inferior to area.
  150139. * Default value is 0.000001
  150140. */
  150141. fallOff: number;
  150142. /**
  150143. * The base color of the SSAO post-process
  150144. * The final result is "base + ssao" between [0, 1]
  150145. */
  150146. base: number;
  150147. private _scene;
  150148. private _depthTexture;
  150149. private _randomTexture;
  150150. private _originalColorPostProcess;
  150151. private _ssaoPostProcess;
  150152. private _blurHPostProcess;
  150153. private _blurVPostProcess;
  150154. private _ssaoCombinePostProcess;
  150155. private _firstUpdate;
  150156. /**
  150157. * Gets active scene
  150158. */
  150159. get scene(): Scene;
  150160. /**
  150161. * @constructor
  150162. * @param name - The rendering pipeline name
  150163. * @param scene - The scene linked to this pipeline
  150164. * @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 }
  150165. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150166. */
  150167. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150168. /**
  150169. * Get the class name
  150170. * @returns "SSAORenderingPipeline"
  150171. */
  150172. getClassName(): string;
  150173. /**
  150174. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150175. */
  150176. dispose(disableDepthRender?: boolean): void;
  150177. private _createBlurPostProcess;
  150178. /** @hidden */
  150179. _rebuild(): void;
  150180. private _createSSAOPostProcess;
  150181. private _createSSAOCombinePostProcess;
  150182. private _createRandomTexture;
  150183. }
  150184. }
  150185. declare module BABYLON {
  150186. /** @hidden */
  150187. export var screenSpaceReflectionPixelShader: {
  150188. name: string;
  150189. shader: string;
  150190. };
  150191. }
  150192. declare module BABYLON {
  150193. /**
  150194. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150195. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150196. */
  150197. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150198. /**
  150199. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150200. */
  150201. threshold: number;
  150202. /**
  150203. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150204. */
  150205. strength: number;
  150206. /**
  150207. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150208. */
  150209. reflectionSpecularFalloffExponent: number;
  150210. /**
  150211. * 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]
  150212. */
  150213. step: number;
  150214. /**
  150215. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150216. */
  150217. roughnessFactor: number;
  150218. private _geometryBufferRenderer;
  150219. private _enableSmoothReflections;
  150220. private _reflectionSamples;
  150221. private _smoothSteps;
  150222. /**
  150223. * Gets a string identifying the name of the class
  150224. * @returns "ScreenSpaceReflectionPostProcess" string
  150225. */
  150226. getClassName(): string;
  150227. /**
  150228. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150229. * @param name The name of the effect.
  150230. * @param scene The scene containing the objects to calculate reflections.
  150231. * @param options The required width/height ratio to downsize to before computing the render pass.
  150232. * @param camera The camera to apply the render pass to.
  150233. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150234. * @param engine The engine which the post process will be applied. (default: current engine)
  150235. * @param reusable If the post process can be reused on the same frame. (default: false)
  150236. * @param textureType Type of textures used when performing the post process. (default: 0)
  150237. * @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)
  150238. */
  150239. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150240. /**
  150241. * Gets wether or not smoothing reflections is enabled.
  150242. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150243. */
  150244. get enableSmoothReflections(): boolean;
  150245. /**
  150246. * Sets wether or not smoothing reflections is enabled.
  150247. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150248. */
  150249. set enableSmoothReflections(enabled: boolean);
  150250. /**
  150251. * Gets the number of samples taken while computing reflections. More samples count is high,
  150252. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150253. */
  150254. get reflectionSamples(): number;
  150255. /**
  150256. * Sets the number of samples taken while computing reflections. More samples count is high,
  150257. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150258. */
  150259. set reflectionSamples(samples: number);
  150260. /**
  150261. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150262. * more the post-process will require GPU power and can generate a drop in FPS.
  150263. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150264. */
  150265. get smoothSteps(): number;
  150266. set smoothSteps(steps: number);
  150267. private _updateEffectDefines;
  150268. /** @hidden */
  150269. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150270. }
  150271. }
  150272. declare module BABYLON {
  150273. /** @hidden */
  150274. export var standardPixelShader: {
  150275. name: string;
  150276. shader: string;
  150277. };
  150278. }
  150279. declare module BABYLON {
  150280. /**
  150281. * Standard rendering pipeline
  150282. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150283. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150284. */
  150285. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150286. /**
  150287. * Public members
  150288. */
  150289. /**
  150290. * Post-process which contains the original scene color before the pipeline applies all the effects
  150291. */
  150292. originalPostProcess: Nullable<PostProcess>;
  150293. /**
  150294. * Post-process used to down scale an image x4
  150295. */
  150296. downSampleX4PostProcess: Nullable<PostProcess>;
  150297. /**
  150298. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150299. */
  150300. brightPassPostProcess: Nullable<PostProcess>;
  150301. /**
  150302. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150303. */
  150304. blurHPostProcesses: PostProcess[];
  150305. /**
  150306. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150307. */
  150308. blurVPostProcesses: PostProcess[];
  150309. /**
  150310. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150311. */
  150312. textureAdderPostProcess: Nullable<PostProcess>;
  150313. /**
  150314. * Post-process used to create volumetric lighting effect
  150315. */
  150316. volumetricLightPostProcess: Nullable<PostProcess>;
  150317. /**
  150318. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150319. */
  150320. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150321. /**
  150322. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150323. */
  150324. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150325. /**
  150326. * Post-process used to merge the volumetric light effect and the real scene color
  150327. */
  150328. volumetricLightMergePostProces: Nullable<PostProcess>;
  150329. /**
  150330. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150331. */
  150332. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150333. /**
  150334. * Base post-process used to calculate the average luminance of the final image for HDR
  150335. */
  150336. luminancePostProcess: Nullable<PostProcess>;
  150337. /**
  150338. * Post-processes used to create down sample post-processes in order to get
  150339. * the average luminance of the final image for HDR
  150340. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150341. */
  150342. luminanceDownSamplePostProcesses: PostProcess[];
  150343. /**
  150344. * Post-process used to create a HDR effect (light adaptation)
  150345. */
  150346. hdrPostProcess: Nullable<PostProcess>;
  150347. /**
  150348. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150349. */
  150350. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150351. /**
  150352. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150353. */
  150354. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150355. /**
  150356. * Post-process used to merge the final HDR post-process and the real scene color
  150357. */
  150358. hdrFinalPostProcess: Nullable<PostProcess>;
  150359. /**
  150360. * Post-process used to create a lens flare effect
  150361. */
  150362. lensFlarePostProcess: Nullable<PostProcess>;
  150363. /**
  150364. * Post-process that merges the result of the lens flare post-process and the real scene color
  150365. */
  150366. lensFlareComposePostProcess: Nullable<PostProcess>;
  150367. /**
  150368. * Post-process used to create a motion blur effect
  150369. */
  150370. motionBlurPostProcess: Nullable<PostProcess>;
  150371. /**
  150372. * Post-process used to create a depth of field effect
  150373. */
  150374. depthOfFieldPostProcess: Nullable<PostProcess>;
  150375. /**
  150376. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150377. */
  150378. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150379. /**
  150380. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150381. */
  150382. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150383. /**
  150384. * Represents the brightness threshold in order to configure the illuminated surfaces
  150385. */
  150386. brightThreshold: number;
  150387. /**
  150388. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150389. */
  150390. blurWidth: number;
  150391. /**
  150392. * Sets if the blur for highlighted surfaces must be only horizontal
  150393. */
  150394. horizontalBlur: boolean;
  150395. /**
  150396. * Gets the overall exposure used by the pipeline
  150397. */
  150398. get exposure(): number;
  150399. /**
  150400. * Sets the overall exposure used by the pipeline
  150401. */
  150402. set exposure(value: number);
  150403. /**
  150404. * Texture used typically to simulate "dirty" on camera lens
  150405. */
  150406. lensTexture: Nullable<Texture>;
  150407. /**
  150408. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  150409. */
  150410. volumetricLightCoefficient: number;
  150411. /**
  150412. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  150413. */
  150414. volumetricLightPower: number;
  150415. /**
  150416. * Used the set the blur intensity to smooth the volumetric lights
  150417. */
  150418. volumetricLightBlurScale: number;
  150419. /**
  150420. * Light (spot or directional) used to generate the volumetric lights rays
  150421. * The source light must have a shadow generate so the pipeline can get its
  150422. * depth map
  150423. */
  150424. sourceLight: Nullable<SpotLight | DirectionalLight>;
  150425. /**
  150426. * For eye adaptation, represents the minimum luminance the eye can see
  150427. */
  150428. hdrMinimumLuminance: number;
  150429. /**
  150430. * For eye adaptation, represents the decrease luminance speed
  150431. */
  150432. hdrDecreaseRate: number;
  150433. /**
  150434. * For eye adaptation, represents the increase luminance speed
  150435. */
  150436. hdrIncreaseRate: number;
  150437. /**
  150438. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150439. */
  150440. get hdrAutoExposure(): boolean;
  150441. /**
  150442. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150443. */
  150444. set hdrAutoExposure(value: boolean);
  150445. /**
  150446. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  150447. */
  150448. lensColorTexture: Nullable<Texture>;
  150449. /**
  150450. * The overall strengh for the lens flare effect
  150451. */
  150452. lensFlareStrength: number;
  150453. /**
  150454. * Dispersion coefficient for lens flare ghosts
  150455. */
  150456. lensFlareGhostDispersal: number;
  150457. /**
  150458. * Main lens flare halo width
  150459. */
  150460. lensFlareHaloWidth: number;
  150461. /**
  150462. * Based on the lens distortion effect, defines how much the lens flare result
  150463. * is distorted
  150464. */
  150465. lensFlareDistortionStrength: number;
  150466. /**
  150467. * Configures the blur intensity used for for lens flare (halo)
  150468. */
  150469. lensFlareBlurWidth: number;
  150470. /**
  150471. * Lens star texture must be used to simulate rays on the flares and is available
  150472. * in the documentation
  150473. */
  150474. lensStarTexture: Nullable<Texture>;
  150475. /**
  150476. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  150477. * flare effect by taking account of the dirt texture
  150478. */
  150479. lensFlareDirtTexture: Nullable<Texture>;
  150480. /**
  150481. * Represents the focal length for the depth of field effect
  150482. */
  150483. depthOfFieldDistance: number;
  150484. /**
  150485. * Represents the blur intensity for the blurred part of the depth of field effect
  150486. */
  150487. depthOfFieldBlurWidth: number;
  150488. /**
  150489. * Gets how much the image is blurred by the movement while using the motion blur post-process
  150490. */
  150491. get motionStrength(): number;
  150492. /**
  150493. * Sets how much the image is blurred by the movement while using the motion blur post-process
  150494. */
  150495. set motionStrength(strength: number);
  150496. /**
  150497. * Gets wether or not the motion blur post-process is object based or screen based.
  150498. */
  150499. get objectBasedMotionBlur(): boolean;
  150500. /**
  150501. * Sets wether or not the motion blur post-process should be object based or screen based
  150502. */
  150503. set objectBasedMotionBlur(value: boolean);
  150504. /**
  150505. * List of animations for the pipeline (IAnimatable implementation)
  150506. */
  150507. animations: Animation[];
  150508. /**
  150509. * Private members
  150510. */
  150511. private _scene;
  150512. private _currentDepthOfFieldSource;
  150513. private _basePostProcess;
  150514. private _fixedExposure;
  150515. private _currentExposure;
  150516. private _hdrAutoExposure;
  150517. private _hdrCurrentLuminance;
  150518. private _motionStrength;
  150519. private _isObjectBasedMotionBlur;
  150520. private _floatTextureType;
  150521. private _camerasToBeAttached;
  150522. private _ratio;
  150523. private _bloomEnabled;
  150524. private _depthOfFieldEnabled;
  150525. private _vlsEnabled;
  150526. private _lensFlareEnabled;
  150527. private _hdrEnabled;
  150528. private _motionBlurEnabled;
  150529. private _fxaaEnabled;
  150530. private _screenSpaceReflectionsEnabled;
  150531. private _motionBlurSamples;
  150532. private _volumetricLightStepsCount;
  150533. private _samples;
  150534. /**
  150535. * @ignore
  150536. * Specifies if the bloom pipeline is enabled
  150537. */
  150538. get BloomEnabled(): boolean;
  150539. set BloomEnabled(enabled: boolean);
  150540. /**
  150541. * @ignore
  150542. * Specifies if the depth of field pipeline is enabed
  150543. */
  150544. get DepthOfFieldEnabled(): boolean;
  150545. set DepthOfFieldEnabled(enabled: boolean);
  150546. /**
  150547. * @ignore
  150548. * Specifies if the lens flare pipeline is enabed
  150549. */
  150550. get LensFlareEnabled(): boolean;
  150551. set LensFlareEnabled(enabled: boolean);
  150552. /**
  150553. * @ignore
  150554. * Specifies if the HDR pipeline is enabled
  150555. */
  150556. get HDREnabled(): boolean;
  150557. set HDREnabled(enabled: boolean);
  150558. /**
  150559. * @ignore
  150560. * Specifies if the volumetric lights scattering effect is enabled
  150561. */
  150562. get VLSEnabled(): boolean;
  150563. set VLSEnabled(enabled: boolean);
  150564. /**
  150565. * @ignore
  150566. * Specifies if the motion blur effect is enabled
  150567. */
  150568. get MotionBlurEnabled(): boolean;
  150569. set MotionBlurEnabled(enabled: boolean);
  150570. /**
  150571. * Specifies if anti-aliasing is enabled
  150572. */
  150573. get fxaaEnabled(): boolean;
  150574. set fxaaEnabled(enabled: boolean);
  150575. /**
  150576. * Specifies if screen space reflections are enabled.
  150577. */
  150578. get screenSpaceReflectionsEnabled(): boolean;
  150579. set screenSpaceReflectionsEnabled(enabled: boolean);
  150580. /**
  150581. * Specifies the number of steps used to calculate the volumetric lights
  150582. * Typically in interval [50, 200]
  150583. */
  150584. get volumetricLightStepsCount(): number;
  150585. set volumetricLightStepsCount(count: number);
  150586. /**
  150587. * Specifies the number of samples used for the motion blur effect
  150588. * Typically in interval [16, 64]
  150589. */
  150590. get motionBlurSamples(): number;
  150591. set motionBlurSamples(samples: number);
  150592. /**
  150593. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150594. */
  150595. get samples(): number;
  150596. set samples(sampleCount: number);
  150597. /**
  150598. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150599. * @constructor
  150600. * @param name The rendering pipeline name
  150601. * @param scene The scene linked to this pipeline
  150602. * @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)
  150603. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  150604. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150605. */
  150606. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  150607. private _buildPipeline;
  150608. private _createDownSampleX4PostProcess;
  150609. private _createBrightPassPostProcess;
  150610. private _createBlurPostProcesses;
  150611. private _createTextureAdderPostProcess;
  150612. private _createVolumetricLightPostProcess;
  150613. private _createLuminancePostProcesses;
  150614. private _createHdrPostProcess;
  150615. private _createLensFlarePostProcess;
  150616. private _createDepthOfFieldPostProcess;
  150617. private _createMotionBlurPostProcess;
  150618. private _getDepthTexture;
  150619. private _disposePostProcesses;
  150620. /**
  150621. * Dispose of the pipeline and stop all post processes
  150622. */
  150623. dispose(): void;
  150624. /**
  150625. * Serialize the rendering pipeline (Used when exporting)
  150626. * @returns the serialized object
  150627. */
  150628. serialize(): any;
  150629. /**
  150630. * Parse the serialized pipeline
  150631. * @param source Source pipeline.
  150632. * @param scene The scene to load the pipeline to.
  150633. * @param rootUrl The URL of the serialized pipeline.
  150634. * @returns An instantiated pipeline from the serialized object.
  150635. */
  150636. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  150637. /**
  150638. * Luminance steps
  150639. */
  150640. static LuminanceSteps: number;
  150641. }
  150642. }
  150643. declare module BABYLON {
  150644. /** @hidden */
  150645. export var stereoscopicInterlacePixelShader: {
  150646. name: string;
  150647. shader: string;
  150648. };
  150649. }
  150650. declare module BABYLON {
  150651. /**
  150652. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  150653. */
  150654. export class StereoscopicInterlacePostProcessI extends PostProcess {
  150655. private _stepSize;
  150656. private _passedProcess;
  150657. /**
  150658. * Gets a string identifying the name of the class
  150659. * @returns "StereoscopicInterlacePostProcessI" string
  150660. */
  150661. getClassName(): string;
  150662. /**
  150663. * Initializes a StereoscopicInterlacePostProcessI
  150664. * @param name The name of the effect.
  150665. * @param rigCameras The rig cameras to be appled to the post process
  150666. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  150667. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  150668. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150669. * @param engine The engine which the post process will be applied. (default: current engine)
  150670. * @param reusable If the post process can be reused on the same frame. (default: false)
  150671. */
  150672. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150673. }
  150674. /**
  150675. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  150676. */
  150677. export class StereoscopicInterlacePostProcess extends PostProcess {
  150678. private _stepSize;
  150679. private _passedProcess;
  150680. /**
  150681. * Gets a string identifying the name of the class
  150682. * @returns "StereoscopicInterlacePostProcess" string
  150683. */
  150684. getClassName(): string;
  150685. /**
  150686. * Initializes a StereoscopicInterlacePostProcess
  150687. * @param name The name of the effect.
  150688. * @param rigCameras The rig cameras to be appled to the post process
  150689. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  150690. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150691. * @param engine The engine which the post process will be applied. (default: current engine)
  150692. * @param reusable If the post process can be reused on the same frame. (default: false)
  150693. */
  150694. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150695. }
  150696. }
  150697. declare module BABYLON {
  150698. /** @hidden */
  150699. export var tonemapPixelShader: {
  150700. name: string;
  150701. shader: string;
  150702. };
  150703. }
  150704. declare module BABYLON {
  150705. /** Defines operator used for tonemapping */
  150706. export enum TonemappingOperator {
  150707. /** Hable */
  150708. Hable = 0,
  150709. /** Reinhard */
  150710. Reinhard = 1,
  150711. /** HejiDawson */
  150712. HejiDawson = 2,
  150713. /** Photographic */
  150714. Photographic = 3
  150715. }
  150716. /**
  150717. * Defines a post process to apply tone mapping
  150718. */
  150719. export class TonemapPostProcess extends PostProcess {
  150720. private _operator;
  150721. /** Defines the required exposure adjustement */
  150722. exposureAdjustment: number;
  150723. /**
  150724. * Gets a string identifying the name of the class
  150725. * @returns "TonemapPostProcess" string
  150726. */
  150727. getClassName(): string;
  150728. /**
  150729. * Creates a new TonemapPostProcess
  150730. * @param name defines the name of the postprocess
  150731. * @param _operator defines the operator to use
  150732. * @param exposureAdjustment defines the required exposure adjustement
  150733. * @param camera defines the camera to use (can be null)
  150734. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  150735. * @param engine defines the hosting engine (can be ignore if camera is set)
  150736. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  150737. */
  150738. constructor(name: string, _operator: TonemappingOperator,
  150739. /** Defines the required exposure adjustement */
  150740. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  150741. }
  150742. }
  150743. declare module BABYLON {
  150744. /** @hidden */
  150745. export var volumetricLightScatteringPixelShader: {
  150746. name: string;
  150747. shader: string;
  150748. };
  150749. }
  150750. declare module BABYLON {
  150751. /** @hidden */
  150752. export var volumetricLightScatteringPassVertexShader: {
  150753. name: string;
  150754. shader: string;
  150755. };
  150756. }
  150757. declare module BABYLON {
  150758. /** @hidden */
  150759. export var volumetricLightScatteringPassPixelShader: {
  150760. name: string;
  150761. shader: string;
  150762. };
  150763. }
  150764. declare module BABYLON {
  150765. /**
  150766. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  150767. */
  150768. export class VolumetricLightScatteringPostProcess extends PostProcess {
  150769. private _volumetricLightScatteringPass;
  150770. private _volumetricLightScatteringRTT;
  150771. private _viewPort;
  150772. private _screenCoordinates;
  150773. private _cachedDefines;
  150774. /**
  150775. * If not undefined, the mesh position is computed from the attached node position
  150776. */
  150777. attachedNode: {
  150778. position: Vector3;
  150779. };
  150780. /**
  150781. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  150782. */
  150783. customMeshPosition: Vector3;
  150784. /**
  150785. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  150786. */
  150787. useCustomMeshPosition: boolean;
  150788. /**
  150789. * If the post-process should inverse the light scattering direction
  150790. */
  150791. invert: boolean;
  150792. /**
  150793. * The internal mesh used by the post-process
  150794. */
  150795. mesh: Mesh;
  150796. /**
  150797. * @hidden
  150798. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  150799. */
  150800. get useDiffuseColor(): boolean;
  150801. set useDiffuseColor(useDiffuseColor: boolean);
  150802. /**
  150803. * Array containing the excluded meshes not rendered in the internal pass
  150804. */
  150805. excludedMeshes: AbstractMesh[];
  150806. /**
  150807. * Controls the overall intensity of the post-process
  150808. */
  150809. exposure: number;
  150810. /**
  150811. * Dissipates each sample's contribution in range [0, 1]
  150812. */
  150813. decay: number;
  150814. /**
  150815. * Controls the overall intensity of each sample
  150816. */
  150817. weight: number;
  150818. /**
  150819. * Controls the density of each sample
  150820. */
  150821. density: number;
  150822. /**
  150823. * @constructor
  150824. * @param name The post-process name
  150825. * @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)
  150826. * @param camera The camera that the post-process will be attached to
  150827. * @param mesh The mesh used to create the light scattering
  150828. * @param samples The post-process quality, default 100
  150829. * @param samplingModeThe post-process filtering mode
  150830. * @param engine The babylon engine
  150831. * @param reusable If the post-process is reusable
  150832. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  150833. */
  150834. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  150835. /**
  150836. * Returns the string "VolumetricLightScatteringPostProcess"
  150837. * @returns "VolumetricLightScatteringPostProcess"
  150838. */
  150839. getClassName(): string;
  150840. private _isReady;
  150841. /**
  150842. * Sets the new light position for light scattering effect
  150843. * @param position The new custom light position
  150844. */
  150845. setCustomMeshPosition(position: Vector3): void;
  150846. /**
  150847. * Returns the light position for light scattering effect
  150848. * @return Vector3 The custom light position
  150849. */
  150850. getCustomMeshPosition(): Vector3;
  150851. /**
  150852. * Disposes the internal assets and detaches the post-process from the camera
  150853. */
  150854. dispose(camera: Camera): void;
  150855. /**
  150856. * Returns the render target texture used by the post-process
  150857. * @return the render target texture used by the post-process
  150858. */
  150859. getPass(): RenderTargetTexture;
  150860. private _meshExcluded;
  150861. private _createPass;
  150862. private _updateMeshScreenCoordinates;
  150863. /**
  150864. * Creates a default mesh for the Volumeric Light Scattering post-process
  150865. * @param name The mesh name
  150866. * @param scene The scene where to create the mesh
  150867. * @return the default mesh
  150868. */
  150869. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  150870. }
  150871. }
  150872. declare module BABYLON {
  150873. /** @hidden */
  150874. export var screenSpaceCurvaturePixelShader: {
  150875. name: string;
  150876. shader: string;
  150877. };
  150878. }
  150879. declare module BABYLON {
  150880. /**
  150881. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  150882. */
  150883. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  150884. /**
  150885. * Defines how much ridge the curvature effect displays.
  150886. */
  150887. ridge: number;
  150888. /**
  150889. * Defines how much valley the curvature effect displays.
  150890. */
  150891. valley: number;
  150892. private _geometryBufferRenderer;
  150893. /**
  150894. * Gets a string identifying the name of the class
  150895. * @returns "ScreenSpaceCurvaturePostProcess" string
  150896. */
  150897. getClassName(): string;
  150898. /**
  150899. * Creates a new instance ScreenSpaceCurvaturePostProcess
  150900. * @param name The name of the effect.
  150901. * @param scene The scene containing the objects to blur according to their velocity.
  150902. * @param options The required width/height ratio to downsize to before computing the render pass.
  150903. * @param camera The camera to apply the render pass to.
  150904. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150905. * @param engine The engine which the post process will be applied. (default: current engine)
  150906. * @param reusable If the post process can be reused on the same frame. (default: false)
  150907. * @param textureType Type of textures used when performing the post process. (default: 0)
  150908. * @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)
  150909. */
  150910. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150911. /**
  150912. * Support test.
  150913. */
  150914. static get IsSupported(): boolean;
  150915. /** @hidden */
  150916. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  150917. }
  150918. }
  150919. declare module BABYLON {
  150920. interface Scene {
  150921. /** @hidden (Backing field) */
  150922. _boundingBoxRenderer: BoundingBoxRenderer;
  150923. /** @hidden (Backing field) */
  150924. _forceShowBoundingBoxes: boolean;
  150925. /**
  150926. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  150927. */
  150928. forceShowBoundingBoxes: boolean;
  150929. /**
  150930. * Gets the bounding box renderer associated with the scene
  150931. * @returns a BoundingBoxRenderer
  150932. */
  150933. getBoundingBoxRenderer(): BoundingBoxRenderer;
  150934. }
  150935. interface AbstractMesh {
  150936. /** @hidden (Backing field) */
  150937. _showBoundingBox: boolean;
  150938. /**
  150939. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  150940. */
  150941. showBoundingBox: boolean;
  150942. }
  150943. /**
  150944. * Component responsible of rendering the bounding box of the meshes in a scene.
  150945. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  150946. */
  150947. export class BoundingBoxRenderer implements ISceneComponent {
  150948. /**
  150949. * The component name helpfull to identify the component in the list of scene components.
  150950. */
  150951. readonly name: string;
  150952. /**
  150953. * The scene the component belongs to.
  150954. */
  150955. scene: Scene;
  150956. /**
  150957. * Color of the bounding box lines placed in front of an object
  150958. */
  150959. frontColor: Color3;
  150960. /**
  150961. * Color of the bounding box lines placed behind an object
  150962. */
  150963. backColor: Color3;
  150964. /**
  150965. * Defines if the renderer should show the back lines or not
  150966. */
  150967. showBackLines: boolean;
  150968. /**
  150969. * Observable raised before rendering a bounding box
  150970. */
  150971. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  150972. /**
  150973. * Observable raised after rendering a bounding box
  150974. */
  150975. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  150976. /**
  150977. * @hidden
  150978. */
  150979. renderList: SmartArray<BoundingBox>;
  150980. private _colorShader;
  150981. private _vertexBuffers;
  150982. private _indexBuffer;
  150983. private _fillIndexBuffer;
  150984. private _fillIndexData;
  150985. /**
  150986. * Instantiates a new bounding box renderer in a scene.
  150987. * @param scene the scene the renderer renders in
  150988. */
  150989. constructor(scene: Scene);
  150990. /**
  150991. * Registers the component in a given scene
  150992. */
  150993. register(): void;
  150994. private _evaluateSubMesh;
  150995. private _activeMesh;
  150996. private _prepareRessources;
  150997. private _createIndexBuffer;
  150998. /**
  150999. * Rebuilds the elements related to this component in case of
  151000. * context lost for instance.
  151001. */
  151002. rebuild(): void;
  151003. /**
  151004. * @hidden
  151005. */
  151006. reset(): void;
  151007. /**
  151008. * Render the bounding boxes of a specific rendering group
  151009. * @param renderingGroupId defines the rendering group to render
  151010. */
  151011. render(renderingGroupId: number): void;
  151012. /**
  151013. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151014. * @param mesh Define the mesh to render the occlusion bounding box for
  151015. */
  151016. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151017. /**
  151018. * Dispose and release the resources attached to this renderer.
  151019. */
  151020. dispose(): void;
  151021. }
  151022. }
  151023. declare module BABYLON {
  151024. interface Scene {
  151025. /** @hidden (Backing field) */
  151026. _depthRenderer: {
  151027. [id: string]: DepthRenderer;
  151028. };
  151029. /**
  151030. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151031. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151032. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151033. * @returns the created depth renderer
  151034. */
  151035. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151036. /**
  151037. * Disables a depth renderer for a given camera
  151038. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151039. */
  151040. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151041. }
  151042. /**
  151043. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151044. * in several rendering techniques.
  151045. */
  151046. export class DepthRendererSceneComponent implements ISceneComponent {
  151047. /**
  151048. * The component name helpfull to identify the component in the list of scene components.
  151049. */
  151050. readonly name: string;
  151051. /**
  151052. * The scene the component belongs to.
  151053. */
  151054. scene: Scene;
  151055. /**
  151056. * Creates a new instance of the component for the given scene
  151057. * @param scene Defines the scene to register the component in
  151058. */
  151059. constructor(scene: Scene);
  151060. /**
  151061. * Registers the component in a given scene
  151062. */
  151063. register(): void;
  151064. /**
  151065. * Rebuilds the elements related to this component in case of
  151066. * context lost for instance.
  151067. */
  151068. rebuild(): void;
  151069. /**
  151070. * Disposes the component and the associated ressources
  151071. */
  151072. dispose(): void;
  151073. private _gatherRenderTargets;
  151074. private _gatherActiveCameraRenderTargets;
  151075. }
  151076. }
  151077. declare module BABYLON {
  151078. interface AbstractScene {
  151079. /** @hidden (Backing field) */
  151080. _prePassRenderer: Nullable<PrePassRenderer>;
  151081. /**
  151082. * Gets or Sets the current prepass renderer associated to the scene.
  151083. */
  151084. prePassRenderer: Nullable<PrePassRenderer>;
  151085. /**
  151086. * Enables the prepass and associates it with the scene
  151087. * @returns the PrePassRenderer
  151088. */
  151089. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151090. /**
  151091. * Disables the prepass associated with the scene
  151092. */
  151093. disablePrePassRenderer(): void;
  151094. }
  151095. /**
  151096. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151097. * in several rendering techniques.
  151098. */
  151099. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151100. /**
  151101. * The component name helpful to identify the component in the list of scene components.
  151102. */
  151103. readonly name: string;
  151104. /**
  151105. * The scene the component belongs to.
  151106. */
  151107. scene: Scene;
  151108. /**
  151109. * Creates a new instance of the component for the given scene
  151110. * @param scene Defines the scene to register the component in
  151111. */
  151112. constructor(scene: Scene);
  151113. /**
  151114. * Registers the component in a given scene
  151115. */
  151116. register(): void;
  151117. private _beforeCameraDraw;
  151118. private _afterCameraDraw;
  151119. private _beforeClearStage;
  151120. /**
  151121. * Serializes the component data to the specified json object
  151122. * @param serializationObject The object to serialize to
  151123. */
  151124. serialize(serializationObject: any): void;
  151125. /**
  151126. * Adds all the elements from the container to the scene
  151127. * @param container the container holding the elements
  151128. */
  151129. addFromContainer(container: AbstractScene): void;
  151130. /**
  151131. * Removes all the elements in the container from the scene
  151132. * @param container contains the elements to remove
  151133. * @param dispose if the removed element should be disposed (default: false)
  151134. */
  151135. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151136. /**
  151137. * Rebuilds the elements related to this component in case of
  151138. * context lost for instance.
  151139. */
  151140. rebuild(): void;
  151141. /**
  151142. * Disposes the component and the associated ressources
  151143. */
  151144. dispose(): void;
  151145. }
  151146. }
  151147. declare module BABYLON {
  151148. /** @hidden */
  151149. export var outlinePixelShader: {
  151150. name: string;
  151151. shader: string;
  151152. };
  151153. }
  151154. declare module BABYLON {
  151155. /** @hidden */
  151156. export var outlineVertexShader: {
  151157. name: string;
  151158. shader: string;
  151159. };
  151160. }
  151161. declare module BABYLON {
  151162. interface Scene {
  151163. /** @hidden */
  151164. _outlineRenderer: OutlineRenderer;
  151165. /**
  151166. * Gets the outline renderer associated with the scene
  151167. * @returns a OutlineRenderer
  151168. */
  151169. getOutlineRenderer(): OutlineRenderer;
  151170. }
  151171. interface AbstractMesh {
  151172. /** @hidden (Backing field) */
  151173. _renderOutline: boolean;
  151174. /**
  151175. * Gets or sets a boolean indicating if the outline must be rendered as well
  151176. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151177. */
  151178. renderOutline: boolean;
  151179. /** @hidden (Backing field) */
  151180. _renderOverlay: boolean;
  151181. /**
  151182. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151183. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151184. */
  151185. renderOverlay: boolean;
  151186. }
  151187. /**
  151188. * This class is responsible to draw bothe outline/overlay of meshes.
  151189. * It should not be used directly but through the available method on mesh.
  151190. */
  151191. export class OutlineRenderer implements ISceneComponent {
  151192. /**
  151193. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151194. */
  151195. private static _StencilReference;
  151196. /**
  151197. * The name of the component. Each component must have a unique name.
  151198. */
  151199. name: string;
  151200. /**
  151201. * The scene the component belongs to.
  151202. */
  151203. scene: Scene;
  151204. /**
  151205. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151206. */
  151207. zOffset: number;
  151208. private _engine;
  151209. private _effect;
  151210. private _cachedDefines;
  151211. private _savedDepthWrite;
  151212. /**
  151213. * Instantiates a new outline renderer. (There could be only one per scene).
  151214. * @param scene Defines the scene it belongs to
  151215. */
  151216. constructor(scene: Scene);
  151217. /**
  151218. * Register the component to one instance of a scene.
  151219. */
  151220. register(): void;
  151221. /**
  151222. * Rebuilds the elements related to this component in case of
  151223. * context lost for instance.
  151224. */
  151225. rebuild(): void;
  151226. /**
  151227. * Disposes the component and the associated ressources.
  151228. */
  151229. dispose(): void;
  151230. /**
  151231. * Renders the outline in the canvas.
  151232. * @param subMesh Defines the sumesh to render
  151233. * @param batch Defines the batch of meshes in case of instances
  151234. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151235. */
  151236. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151237. /**
  151238. * Returns whether or not the outline renderer is ready for a given submesh.
  151239. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151240. * @param subMesh Defines the submesh to check readyness for
  151241. * @param useInstances Defines wheter wee are trying to render instances or not
  151242. * @returns true if ready otherwise false
  151243. */
  151244. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151245. private _beforeRenderingMesh;
  151246. private _afterRenderingMesh;
  151247. }
  151248. }
  151249. declare module BABYLON {
  151250. /**
  151251. * Defines the basic options interface of a Sprite Frame Source Size.
  151252. */
  151253. export interface ISpriteJSONSpriteSourceSize {
  151254. /**
  151255. * number of the original width of the Frame
  151256. */
  151257. w: number;
  151258. /**
  151259. * number of the original height of the Frame
  151260. */
  151261. h: number;
  151262. }
  151263. /**
  151264. * Defines the basic options interface of a Sprite Frame Data.
  151265. */
  151266. export interface ISpriteJSONSpriteFrameData {
  151267. /**
  151268. * number of the x offset of the Frame
  151269. */
  151270. x: number;
  151271. /**
  151272. * number of the y offset of the Frame
  151273. */
  151274. y: number;
  151275. /**
  151276. * number of the width of the Frame
  151277. */
  151278. w: number;
  151279. /**
  151280. * number of the height of the Frame
  151281. */
  151282. h: number;
  151283. }
  151284. /**
  151285. * Defines the basic options interface of a JSON Sprite.
  151286. */
  151287. export interface ISpriteJSONSprite {
  151288. /**
  151289. * string name of the Frame
  151290. */
  151291. filename: string;
  151292. /**
  151293. * ISpriteJSONSpriteFrame basic object of the frame data
  151294. */
  151295. frame: ISpriteJSONSpriteFrameData;
  151296. /**
  151297. * boolean to flag is the frame was rotated.
  151298. */
  151299. rotated: boolean;
  151300. /**
  151301. * boolean to flag is the frame was trimmed.
  151302. */
  151303. trimmed: boolean;
  151304. /**
  151305. * ISpriteJSONSpriteFrame basic object of the source data
  151306. */
  151307. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151308. /**
  151309. * ISpriteJSONSpriteFrame basic object of the source data
  151310. */
  151311. sourceSize: ISpriteJSONSpriteSourceSize;
  151312. }
  151313. /**
  151314. * Defines the basic options interface of a JSON atlas.
  151315. */
  151316. export interface ISpriteJSONAtlas {
  151317. /**
  151318. * Array of objects that contain the frame data.
  151319. */
  151320. frames: Array<ISpriteJSONSprite>;
  151321. /**
  151322. * object basic object containing the sprite meta data.
  151323. */
  151324. meta?: object;
  151325. }
  151326. }
  151327. declare module BABYLON {
  151328. /** @hidden */
  151329. export var spriteMapPixelShader: {
  151330. name: string;
  151331. shader: string;
  151332. };
  151333. }
  151334. declare module BABYLON {
  151335. /** @hidden */
  151336. export var spriteMapVertexShader: {
  151337. name: string;
  151338. shader: string;
  151339. };
  151340. }
  151341. declare module BABYLON {
  151342. /**
  151343. * Defines the basic options interface of a SpriteMap
  151344. */
  151345. export interface ISpriteMapOptions {
  151346. /**
  151347. * Vector2 of the number of cells in the grid.
  151348. */
  151349. stageSize?: Vector2;
  151350. /**
  151351. * Vector2 of the size of the output plane in World Units.
  151352. */
  151353. outputSize?: Vector2;
  151354. /**
  151355. * Vector3 of the position of the output plane in World Units.
  151356. */
  151357. outputPosition?: Vector3;
  151358. /**
  151359. * Vector3 of the rotation of the output plane.
  151360. */
  151361. outputRotation?: Vector3;
  151362. /**
  151363. * number of layers that the system will reserve in resources.
  151364. */
  151365. layerCount?: number;
  151366. /**
  151367. * number of max animation frames a single cell will reserve in resources.
  151368. */
  151369. maxAnimationFrames?: number;
  151370. /**
  151371. * number cell index of the base tile when the system compiles.
  151372. */
  151373. baseTile?: number;
  151374. /**
  151375. * boolean flip the sprite after its been repositioned by the framing data.
  151376. */
  151377. flipU?: boolean;
  151378. /**
  151379. * Vector3 scalar of the global RGB values of the SpriteMap.
  151380. */
  151381. colorMultiply?: Vector3;
  151382. }
  151383. /**
  151384. * Defines the IDisposable interface in order to be cleanable from resources.
  151385. */
  151386. export interface ISpriteMap extends IDisposable {
  151387. /**
  151388. * String name of the SpriteMap.
  151389. */
  151390. name: string;
  151391. /**
  151392. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151393. */
  151394. atlasJSON: ISpriteJSONAtlas;
  151395. /**
  151396. * Texture of the SpriteMap.
  151397. */
  151398. spriteSheet: Texture;
  151399. /**
  151400. * The parameters to initialize the SpriteMap with.
  151401. */
  151402. options: ISpriteMapOptions;
  151403. }
  151404. /**
  151405. * Class used to manage a grid restricted sprite deployment on an Output plane.
  151406. */
  151407. export class SpriteMap implements ISpriteMap {
  151408. /** The Name of the spriteMap */
  151409. name: string;
  151410. /** The JSON file with the frame and meta data */
  151411. atlasJSON: ISpriteJSONAtlas;
  151412. /** The systems Sprite Sheet Texture */
  151413. spriteSheet: Texture;
  151414. /** Arguments passed with the Constructor */
  151415. options: ISpriteMapOptions;
  151416. /** Public Sprite Storage array, parsed from atlasJSON */
  151417. sprites: Array<ISpriteJSONSprite>;
  151418. /** Returns the Number of Sprites in the System */
  151419. get spriteCount(): number;
  151420. /** Returns the Position of Output Plane*/
  151421. get position(): Vector3;
  151422. /** Returns the Position of Output Plane*/
  151423. set position(v: Vector3);
  151424. /** Returns the Rotation of Output Plane*/
  151425. get rotation(): Vector3;
  151426. /** Returns the Rotation of Output Plane*/
  151427. set rotation(v: Vector3);
  151428. /** Sets the AnimationMap*/
  151429. get animationMap(): RawTexture;
  151430. /** Sets the AnimationMap*/
  151431. set animationMap(v: RawTexture);
  151432. /** Scene that the SpriteMap was created in */
  151433. private _scene;
  151434. /** Texture Buffer of Float32 that holds tile frame data*/
  151435. private _frameMap;
  151436. /** Texture Buffers of Float32 that holds tileMap data*/
  151437. private _tileMaps;
  151438. /** Texture Buffer of Float32 that holds Animation Data*/
  151439. private _animationMap;
  151440. /** Custom ShaderMaterial Central to the System*/
  151441. private _material;
  151442. /** Custom ShaderMaterial Central to the System*/
  151443. private _output;
  151444. /** Systems Time Ticker*/
  151445. private _time;
  151446. /**
  151447. * Creates a new SpriteMap
  151448. * @param name defines the SpriteMaps Name
  151449. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  151450. * @param spriteSheet is the Texture that the Sprites are on.
  151451. * @param options a basic deployment configuration
  151452. * @param scene The Scene that the map is deployed on
  151453. */
  151454. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  151455. /**
  151456. * Returns tileID location
  151457. * @returns Vector2 the cell position ID
  151458. */
  151459. getTileID(): Vector2;
  151460. /**
  151461. * Gets the UV location of the mouse over the SpriteMap.
  151462. * @returns Vector2 the UV position of the mouse interaction
  151463. */
  151464. getMousePosition(): Vector2;
  151465. /**
  151466. * Creates the "frame" texture Buffer
  151467. * -------------------------------------
  151468. * Structure of frames
  151469. * "filename": "Falling-Water-2.png",
  151470. * "frame": {"x":69,"y":103,"w":24,"h":32},
  151471. * "rotated": true,
  151472. * "trimmed": true,
  151473. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  151474. * "sourceSize": {"w":32,"h":32}
  151475. * @returns RawTexture of the frameMap
  151476. */
  151477. private _createFrameBuffer;
  151478. /**
  151479. * Creates the tileMap texture Buffer
  151480. * @param buffer normally and array of numbers, or a false to generate from scratch
  151481. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  151482. * @returns RawTexture of the tileMap
  151483. */
  151484. private _createTileBuffer;
  151485. /**
  151486. * Modifies the data of the tileMaps
  151487. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  151488. * @param pos is the iVector2 Coordinates of the Tile
  151489. * @param tile The SpriteIndex of the new Tile
  151490. */
  151491. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  151492. /**
  151493. * Creates the animationMap texture Buffer
  151494. * @param buffer normally and array of numbers, or a false to generate from scratch
  151495. * @returns RawTexture of the animationMap
  151496. */
  151497. private _createTileAnimationBuffer;
  151498. /**
  151499. * Modifies the data of the animationMap
  151500. * @param cellID is the Index of the Sprite
  151501. * @param _frame is the target Animation frame
  151502. * @param toCell is the Target Index of the next frame of the animation
  151503. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  151504. * @param speed is a global scalar of the time variable on the map.
  151505. */
  151506. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  151507. /**
  151508. * Exports the .tilemaps file
  151509. */
  151510. saveTileMaps(): void;
  151511. /**
  151512. * Imports the .tilemaps file
  151513. * @param url of the .tilemaps file
  151514. */
  151515. loadTileMaps(url: string): void;
  151516. /**
  151517. * Release associated resources
  151518. */
  151519. dispose(): void;
  151520. }
  151521. }
  151522. declare module BABYLON {
  151523. /**
  151524. * Class used to manage multiple sprites of different sizes on the same spritesheet
  151525. * @see https://doc.babylonjs.com/babylon101/sprites
  151526. */
  151527. export class SpritePackedManager extends SpriteManager {
  151528. /** defines the packed manager's name */
  151529. name: string;
  151530. /**
  151531. * Creates a new sprite manager from a packed sprite sheet
  151532. * @param name defines the manager's name
  151533. * @param imgUrl defines the sprite sheet url
  151534. * @param capacity defines the maximum allowed number of sprites
  151535. * @param scene defines the hosting scene
  151536. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  151537. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  151538. * @param samplingMode defines the smapling mode to use with spritesheet
  151539. * @param fromPacked set to true; do not alter
  151540. */
  151541. constructor(
  151542. /** defines the packed manager's name */
  151543. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  151544. }
  151545. }
  151546. declare module BABYLON {
  151547. /**
  151548. * Defines the list of states available for a task inside a AssetsManager
  151549. */
  151550. export enum AssetTaskState {
  151551. /**
  151552. * Initialization
  151553. */
  151554. INIT = 0,
  151555. /**
  151556. * Running
  151557. */
  151558. RUNNING = 1,
  151559. /**
  151560. * Done
  151561. */
  151562. DONE = 2,
  151563. /**
  151564. * Error
  151565. */
  151566. ERROR = 3
  151567. }
  151568. /**
  151569. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  151570. */
  151571. export abstract class AbstractAssetTask {
  151572. /**
  151573. * Task name
  151574. */ name: string;
  151575. /**
  151576. * Callback called when the task is successful
  151577. */
  151578. onSuccess: (task: any) => void;
  151579. /**
  151580. * Callback called when the task is not successful
  151581. */
  151582. onError: (task: any, message?: string, exception?: any) => void;
  151583. /**
  151584. * Creates a new AssetsManager
  151585. * @param name defines the name of the task
  151586. */
  151587. constructor(
  151588. /**
  151589. * Task name
  151590. */ name: string);
  151591. private _isCompleted;
  151592. private _taskState;
  151593. private _errorObject;
  151594. /**
  151595. * Get if the task is completed
  151596. */
  151597. get isCompleted(): boolean;
  151598. /**
  151599. * Gets the current state of the task
  151600. */
  151601. get taskState(): AssetTaskState;
  151602. /**
  151603. * Gets the current error object (if task is in error)
  151604. */
  151605. get errorObject(): {
  151606. message?: string;
  151607. exception?: any;
  151608. };
  151609. /**
  151610. * Internal only
  151611. * @hidden
  151612. */
  151613. _setErrorObject(message?: string, exception?: any): void;
  151614. /**
  151615. * Execute the current task
  151616. * @param scene defines the scene where you want your assets to be loaded
  151617. * @param onSuccess is a callback called when the task is successfully executed
  151618. * @param onError is a callback called if an error occurs
  151619. */
  151620. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151621. /**
  151622. * Execute the current task
  151623. * @param scene defines the scene where you want your assets to be loaded
  151624. * @param onSuccess is a callback called when the task is successfully executed
  151625. * @param onError is a callback called if an error occurs
  151626. */
  151627. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151628. /**
  151629. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  151630. * This can be used with failed tasks that have the reason for failure fixed.
  151631. */
  151632. reset(): void;
  151633. private onErrorCallback;
  151634. private onDoneCallback;
  151635. }
  151636. /**
  151637. * Define the interface used by progress events raised during assets loading
  151638. */
  151639. export interface IAssetsProgressEvent {
  151640. /**
  151641. * Defines the number of remaining tasks to process
  151642. */
  151643. remainingCount: number;
  151644. /**
  151645. * Defines the total number of tasks
  151646. */
  151647. totalCount: number;
  151648. /**
  151649. * Defines the task that was just processed
  151650. */
  151651. task: AbstractAssetTask;
  151652. }
  151653. /**
  151654. * Class used to share progress information about assets loading
  151655. */
  151656. export class AssetsProgressEvent implements IAssetsProgressEvent {
  151657. /**
  151658. * Defines the number of remaining tasks to process
  151659. */
  151660. remainingCount: number;
  151661. /**
  151662. * Defines the total number of tasks
  151663. */
  151664. totalCount: number;
  151665. /**
  151666. * Defines the task that was just processed
  151667. */
  151668. task: AbstractAssetTask;
  151669. /**
  151670. * Creates a AssetsProgressEvent
  151671. * @param remainingCount defines the number of remaining tasks to process
  151672. * @param totalCount defines the total number of tasks
  151673. * @param task defines the task that was just processed
  151674. */
  151675. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  151676. }
  151677. /**
  151678. * Define a task used by AssetsManager to load assets into a container
  151679. */
  151680. export class ContainerAssetTask extends AbstractAssetTask {
  151681. /**
  151682. * Defines the name of the task
  151683. */
  151684. name: string;
  151685. /**
  151686. * Defines the list of mesh's names you want to load
  151687. */
  151688. meshesNames: any;
  151689. /**
  151690. * Defines the root url to use as a base to load your meshes and associated resources
  151691. */
  151692. rootUrl: string;
  151693. /**
  151694. * Defines the filename or File of the scene to load from
  151695. */
  151696. sceneFilename: string | File;
  151697. /**
  151698. * Get the loaded asset container
  151699. */
  151700. loadedContainer: AssetContainer;
  151701. /**
  151702. * Gets the list of loaded meshes
  151703. */
  151704. loadedMeshes: Array<AbstractMesh>;
  151705. /**
  151706. * Gets the list of loaded particle systems
  151707. */
  151708. loadedParticleSystems: Array<IParticleSystem>;
  151709. /**
  151710. * Gets the list of loaded skeletons
  151711. */
  151712. loadedSkeletons: Array<Skeleton>;
  151713. /**
  151714. * Gets the list of loaded animation groups
  151715. */
  151716. loadedAnimationGroups: Array<AnimationGroup>;
  151717. /**
  151718. * Callback called when the task is successful
  151719. */
  151720. onSuccess: (task: ContainerAssetTask) => void;
  151721. /**
  151722. * Callback called when the task is successful
  151723. */
  151724. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  151725. /**
  151726. * Creates a new ContainerAssetTask
  151727. * @param name defines the name of the task
  151728. * @param meshesNames defines the list of mesh's names you want to load
  151729. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  151730. * @param sceneFilename defines the filename or File of the scene to load from
  151731. */
  151732. constructor(
  151733. /**
  151734. * Defines the name of the task
  151735. */
  151736. name: string,
  151737. /**
  151738. * Defines the list of mesh's names you want to load
  151739. */
  151740. meshesNames: any,
  151741. /**
  151742. * Defines the root url to use as a base to load your meshes and associated resources
  151743. */
  151744. rootUrl: string,
  151745. /**
  151746. * Defines the filename or File of the scene to load from
  151747. */
  151748. sceneFilename: string | File);
  151749. /**
  151750. * Execute the current task
  151751. * @param scene defines the scene where you want your assets to be loaded
  151752. * @param onSuccess is a callback called when the task is successfully executed
  151753. * @param onError is a callback called if an error occurs
  151754. */
  151755. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151756. }
  151757. /**
  151758. * Define a task used by AssetsManager to load meshes
  151759. */
  151760. export class MeshAssetTask extends AbstractAssetTask {
  151761. /**
  151762. * Defines the name of the task
  151763. */
  151764. name: string;
  151765. /**
  151766. * Defines the list of mesh's names you want to load
  151767. */
  151768. meshesNames: any;
  151769. /**
  151770. * Defines the root url to use as a base to load your meshes and associated resources
  151771. */
  151772. rootUrl: string;
  151773. /**
  151774. * Defines the filename or File of the scene to load from
  151775. */
  151776. sceneFilename: string | File;
  151777. /**
  151778. * Gets the list of loaded meshes
  151779. */
  151780. loadedMeshes: Array<AbstractMesh>;
  151781. /**
  151782. * Gets the list of loaded particle systems
  151783. */
  151784. loadedParticleSystems: Array<IParticleSystem>;
  151785. /**
  151786. * Gets the list of loaded skeletons
  151787. */
  151788. loadedSkeletons: Array<Skeleton>;
  151789. /**
  151790. * Gets the list of loaded animation groups
  151791. */
  151792. loadedAnimationGroups: Array<AnimationGroup>;
  151793. /**
  151794. * Callback called when the task is successful
  151795. */
  151796. onSuccess: (task: MeshAssetTask) => void;
  151797. /**
  151798. * Callback called when the task is successful
  151799. */
  151800. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  151801. /**
  151802. * Creates a new MeshAssetTask
  151803. * @param name defines the name of the task
  151804. * @param meshesNames defines the list of mesh's names you want to load
  151805. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  151806. * @param sceneFilename defines the filename or File of the scene to load from
  151807. */
  151808. constructor(
  151809. /**
  151810. * Defines the name of the task
  151811. */
  151812. name: string,
  151813. /**
  151814. * Defines the list of mesh's names you want to load
  151815. */
  151816. meshesNames: any,
  151817. /**
  151818. * Defines the root url to use as a base to load your meshes and associated resources
  151819. */
  151820. rootUrl: string,
  151821. /**
  151822. * Defines the filename or File of the scene to load from
  151823. */
  151824. sceneFilename: string | File);
  151825. /**
  151826. * Execute the current task
  151827. * @param scene defines the scene where you want your assets to be loaded
  151828. * @param onSuccess is a callback called when the task is successfully executed
  151829. * @param onError is a callback called if an error occurs
  151830. */
  151831. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151832. }
  151833. /**
  151834. * Define a task used by AssetsManager to load text content
  151835. */
  151836. export class TextFileAssetTask extends AbstractAssetTask {
  151837. /**
  151838. * Defines the name of the task
  151839. */
  151840. name: string;
  151841. /**
  151842. * Defines the location of the file to load
  151843. */
  151844. url: string;
  151845. /**
  151846. * Gets the loaded text string
  151847. */
  151848. text: string;
  151849. /**
  151850. * Callback called when the task is successful
  151851. */
  151852. onSuccess: (task: TextFileAssetTask) => void;
  151853. /**
  151854. * Callback called when the task is successful
  151855. */
  151856. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  151857. /**
  151858. * Creates a new TextFileAssetTask object
  151859. * @param name defines the name of the task
  151860. * @param url defines the location of the file to load
  151861. */
  151862. constructor(
  151863. /**
  151864. * Defines the name of the task
  151865. */
  151866. name: string,
  151867. /**
  151868. * Defines the location of the file to load
  151869. */
  151870. url: string);
  151871. /**
  151872. * Execute the current task
  151873. * @param scene defines the scene where you want your assets to be loaded
  151874. * @param onSuccess is a callback called when the task is successfully executed
  151875. * @param onError is a callback called if an error occurs
  151876. */
  151877. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151878. }
  151879. /**
  151880. * Define a task used by AssetsManager to load binary data
  151881. */
  151882. export class BinaryFileAssetTask extends AbstractAssetTask {
  151883. /**
  151884. * Defines the name of the task
  151885. */
  151886. name: string;
  151887. /**
  151888. * Defines the location of the file to load
  151889. */
  151890. url: string;
  151891. /**
  151892. * Gets the lodaded data (as an array buffer)
  151893. */
  151894. data: ArrayBuffer;
  151895. /**
  151896. * Callback called when the task is successful
  151897. */
  151898. onSuccess: (task: BinaryFileAssetTask) => void;
  151899. /**
  151900. * Callback called when the task is successful
  151901. */
  151902. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  151903. /**
  151904. * Creates a new BinaryFileAssetTask object
  151905. * @param name defines the name of the new task
  151906. * @param url defines the location of the file to load
  151907. */
  151908. constructor(
  151909. /**
  151910. * Defines the name of the task
  151911. */
  151912. name: string,
  151913. /**
  151914. * Defines the location of the file to load
  151915. */
  151916. url: string);
  151917. /**
  151918. * Execute the current task
  151919. * @param scene defines the scene where you want your assets to be loaded
  151920. * @param onSuccess is a callback called when the task is successfully executed
  151921. * @param onError is a callback called if an error occurs
  151922. */
  151923. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151924. }
  151925. /**
  151926. * Define a task used by AssetsManager to load images
  151927. */
  151928. export class ImageAssetTask extends AbstractAssetTask {
  151929. /**
  151930. * Defines the name of the task
  151931. */
  151932. name: string;
  151933. /**
  151934. * Defines the location of the image to load
  151935. */
  151936. url: string;
  151937. /**
  151938. * Gets the loaded images
  151939. */
  151940. image: HTMLImageElement;
  151941. /**
  151942. * Callback called when the task is successful
  151943. */
  151944. onSuccess: (task: ImageAssetTask) => void;
  151945. /**
  151946. * Callback called when the task is successful
  151947. */
  151948. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  151949. /**
  151950. * Creates a new ImageAssetTask
  151951. * @param name defines the name of the task
  151952. * @param url defines the location of the image to load
  151953. */
  151954. constructor(
  151955. /**
  151956. * Defines the name of the task
  151957. */
  151958. name: string,
  151959. /**
  151960. * Defines the location of the image to load
  151961. */
  151962. url: string);
  151963. /**
  151964. * Execute the current task
  151965. * @param scene defines the scene where you want your assets to be loaded
  151966. * @param onSuccess is a callback called when the task is successfully executed
  151967. * @param onError is a callback called if an error occurs
  151968. */
  151969. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151970. }
  151971. /**
  151972. * Defines the interface used by texture loading tasks
  151973. */
  151974. export interface ITextureAssetTask<TEX extends BaseTexture> {
  151975. /**
  151976. * Gets the loaded texture
  151977. */
  151978. texture: TEX;
  151979. }
  151980. /**
  151981. * Define a task used by AssetsManager to load 2D textures
  151982. */
  151983. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  151984. /**
  151985. * Defines the name of the task
  151986. */
  151987. name: string;
  151988. /**
  151989. * Defines the location of the file to load
  151990. */
  151991. url: string;
  151992. /**
  151993. * Defines if mipmap should not be generated (default is false)
  151994. */
  151995. noMipmap?: boolean | undefined;
  151996. /**
  151997. * Defines if texture must be inverted on Y axis (default is true)
  151998. */
  151999. invertY: boolean;
  152000. /**
  152001. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152002. */
  152003. samplingMode: number;
  152004. /**
  152005. * Gets the loaded texture
  152006. */
  152007. texture: Texture;
  152008. /**
  152009. * Callback called when the task is successful
  152010. */
  152011. onSuccess: (task: TextureAssetTask) => void;
  152012. /**
  152013. * Callback called when the task is successful
  152014. */
  152015. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152016. /**
  152017. * Creates a new TextureAssetTask object
  152018. * @param name defines the name of the task
  152019. * @param url defines the location of the file to load
  152020. * @param noMipmap defines if mipmap should not be generated (default is false)
  152021. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152022. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152023. */
  152024. constructor(
  152025. /**
  152026. * Defines the name of the task
  152027. */
  152028. name: string,
  152029. /**
  152030. * Defines the location of the file to load
  152031. */
  152032. url: string,
  152033. /**
  152034. * Defines if mipmap should not be generated (default is false)
  152035. */
  152036. noMipmap?: boolean | undefined,
  152037. /**
  152038. * Defines if texture must be inverted on Y axis (default is true)
  152039. */
  152040. invertY?: boolean,
  152041. /**
  152042. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152043. */
  152044. samplingMode?: number);
  152045. /**
  152046. * Execute the current task
  152047. * @param scene defines the scene where you want your assets to be loaded
  152048. * @param onSuccess is a callback called when the task is successfully executed
  152049. * @param onError is a callback called if an error occurs
  152050. */
  152051. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152052. }
  152053. /**
  152054. * Define a task used by AssetsManager to load cube textures
  152055. */
  152056. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152057. /**
  152058. * Defines the name of the task
  152059. */
  152060. name: string;
  152061. /**
  152062. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152063. */
  152064. url: string;
  152065. /**
  152066. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152067. */
  152068. extensions?: string[] | undefined;
  152069. /**
  152070. * Defines if mipmaps should not be generated (default is false)
  152071. */
  152072. noMipmap?: boolean | undefined;
  152073. /**
  152074. * Defines the explicit list of files (undefined by default)
  152075. */
  152076. files?: string[] | undefined;
  152077. /**
  152078. * Gets the loaded texture
  152079. */
  152080. texture: CubeTexture;
  152081. /**
  152082. * Callback called when the task is successful
  152083. */
  152084. onSuccess: (task: CubeTextureAssetTask) => void;
  152085. /**
  152086. * Callback called when the task is successful
  152087. */
  152088. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152089. /**
  152090. * Creates a new CubeTextureAssetTask
  152091. * @param name defines the name of the task
  152092. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152093. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152094. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152095. * @param files defines the explicit list of files (undefined by default)
  152096. */
  152097. constructor(
  152098. /**
  152099. * Defines the name of the task
  152100. */
  152101. name: string,
  152102. /**
  152103. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152104. */
  152105. url: string,
  152106. /**
  152107. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152108. */
  152109. extensions?: string[] | undefined,
  152110. /**
  152111. * Defines if mipmaps should not be generated (default is false)
  152112. */
  152113. noMipmap?: boolean | undefined,
  152114. /**
  152115. * Defines the explicit list of files (undefined by default)
  152116. */
  152117. files?: string[] | undefined);
  152118. /**
  152119. * Execute the current task
  152120. * @param scene defines the scene where you want your assets to be loaded
  152121. * @param onSuccess is a callback called when the task is successfully executed
  152122. * @param onError is a callback called if an error occurs
  152123. */
  152124. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152125. }
  152126. /**
  152127. * Define a task used by AssetsManager to load HDR cube textures
  152128. */
  152129. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152130. /**
  152131. * Defines the name of the task
  152132. */
  152133. name: string;
  152134. /**
  152135. * Defines the location of the file to load
  152136. */
  152137. url: string;
  152138. /**
  152139. * Defines the desired size (the more it increases the longer the generation will be)
  152140. */
  152141. size: number;
  152142. /**
  152143. * Defines if mipmaps should not be generated (default is false)
  152144. */
  152145. noMipmap: boolean;
  152146. /**
  152147. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152148. */
  152149. generateHarmonics: boolean;
  152150. /**
  152151. * 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)
  152152. */
  152153. gammaSpace: boolean;
  152154. /**
  152155. * Internal Use Only
  152156. */
  152157. reserved: boolean;
  152158. /**
  152159. * Gets the loaded texture
  152160. */
  152161. texture: HDRCubeTexture;
  152162. /**
  152163. * Callback called when the task is successful
  152164. */
  152165. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152166. /**
  152167. * Callback called when the task is successful
  152168. */
  152169. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152170. /**
  152171. * Creates a new HDRCubeTextureAssetTask object
  152172. * @param name defines the name of the task
  152173. * @param url defines the location of the file to load
  152174. * @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.
  152175. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152176. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152177. * @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)
  152178. * @param reserved Internal use only
  152179. */
  152180. constructor(
  152181. /**
  152182. * Defines the name of the task
  152183. */
  152184. name: string,
  152185. /**
  152186. * Defines the location of the file to load
  152187. */
  152188. url: string,
  152189. /**
  152190. * Defines the desired size (the more it increases the longer the generation will be)
  152191. */
  152192. size: number,
  152193. /**
  152194. * Defines if mipmaps should not be generated (default is false)
  152195. */
  152196. noMipmap?: boolean,
  152197. /**
  152198. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152199. */
  152200. generateHarmonics?: boolean,
  152201. /**
  152202. * 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)
  152203. */
  152204. gammaSpace?: boolean,
  152205. /**
  152206. * Internal Use Only
  152207. */
  152208. reserved?: boolean);
  152209. /**
  152210. * Execute the current task
  152211. * @param scene defines the scene where you want your assets to be loaded
  152212. * @param onSuccess is a callback called when the task is successfully executed
  152213. * @param onError is a callback called if an error occurs
  152214. */
  152215. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152216. }
  152217. /**
  152218. * Define a task used by AssetsManager to load Equirectangular cube textures
  152219. */
  152220. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152221. /**
  152222. * Defines the name of the task
  152223. */
  152224. name: string;
  152225. /**
  152226. * Defines the location of the file to load
  152227. */
  152228. url: string;
  152229. /**
  152230. * Defines the desired size (the more it increases the longer the generation will be)
  152231. */
  152232. size: number;
  152233. /**
  152234. * Defines if mipmaps should not be generated (default is false)
  152235. */
  152236. noMipmap: boolean;
  152237. /**
  152238. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152239. * but the standard material would require them in Gamma space) (default is true)
  152240. */
  152241. gammaSpace: boolean;
  152242. /**
  152243. * Gets the loaded texture
  152244. */
  152245. texture: EquiRectangularCubeTexture;
  152246. /**
  152247. * Callback called when the task is successful
  152248. */
  152249. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152250. /**
  152251. * Callback called when the task is successful
  152252. */
  152253. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152254. /**
  152255. * Creates a new EquiRectangularCubeTextureAssetTask object
  152256. * @param name defines the name of the task
  152257. * @param url defines the location of the file to load
  152258. * @param size defines the desired size (the more it increases the longer the generation will be)
  152259. * If the size is omitted this implies you are using a preprocessed cubemap.
  152260. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152261. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152262. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152263. * (default is true)
  152264. */
  152265. constructor(
  152266. /**
  152267. * Defines the name of the task
  152268. */
  152269. name: string,
  152270. /**
  152271. * Defines the location of the file to load
  152272. */
  152273. url: string,
  152274. /**
  152275. * Defines the desired size (the more it increases the longer the generation will be)
  152276. */
  152277. size: number,
  152278. /**
  152279. * Defines if mipmaps should not be generated (default is false)
  152280. */
  152281. noMipmap?: boolean,
  152282. /**
  152283. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152284. * but the standard material would require them in Gamma space) (default is true)
  152285. */
  152286. gammaSpace?: boolean);
  152287. /**
  152288. * Execute the current task
  152289. * @param scene defines the scene where you want your assets to be loaded
  152290. * @param onSuccess is a callback called when the task is successfully executed
  152291. * @param onError is a callback called if an error occurs
  152292. */
  152293. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152294. }
  152295. /**
  152296. * This class can be used to easily import assets into a scene
  152297. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152298. */
  152299. export class AssetsManager {
  152300. private _scene;
  152301. private _isLoading;
  152302. protected _tasks: AbstractAssetTask[];
  152303. protected _waitingTasksCount: number;
  152304. protected _totalTasksCount: number;
  152305. /**
  152306. * Callback called when all tasks are processed
  152307. */
  152308. onFinish: (tasks: AbstractAssetTask[]) => void;
  152309. /**
  152310. * Callback called when a task is successful
  152311. */
  152312. onTaskSuccess: (task: AbstractAssetTask) => void;
  152313. /**
  152314. * Callback called when a task had an error
  152315. */
  152316. onTaskError: (task: AbstractAssetTask) => void;
  152317. /**
  152318. * Callback called when a task is done (whatever the result is)
  152319. */
  152320. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152321. /**
  152322. * Observable called when all tasks are processed
  152323. */
  152324. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152325. /**
  152326. * Observable called when a task had an error
  152327. */
  152328. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152329. /**
  152330. * Observable called when all tasks were executed
  152331. */
  152332. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152333. /**
  152334. * Observable called when a task is done (whatever the result is)
  152335. */
  152336. onProgressObservable: Observable<IAssetsProgressEvent>;
  152337. /**
  152338. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152339. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152340. */
  152341. useDefaultLoadingScreen: boolean;
  152342. /**
  152343. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152344. * when all assets have been downloaded.
  152345. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152346. */
  152347. autoHideLoadingUI: boolean;
  152348. /**
  152349. * Creates a new AssetsManager
  152350. * @param scene defines the scene to work on
  152351. */
  152352. constructor(scene: Scene);
  152353. /**
  152354. * Add a ContainerAssetTask to the list of active tasks
  152355. * @param taskName defines the name of the new task
  152356. * @param meshesNames defines the name of meshes to load
  152357. * @param rootUrl defines the root url to use to locate files
  152358. * @param sceneFilename defines the filename of the scene file
  152359. * @returns a new ContainerAssetTask object
  152360. */
  152361. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152362. /**
  152363. * Add a MeshAssetTask to the list of active tasks
  152364. * @param taskName defines the name of the new task
  152365. * @param meshesNames defines the name of meshes to load
  152366. * @param rootUrl defines the root url to use to locate files
  152367. * @param sceneFilename defines the filename of the scene file
  152368. * @returns a new MeshAssetTask object
  152369. */
  152370. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152371. /**
  152372. * Add a TextFileAssetTask to the list of active tasks
  152373. * @param taskName defines the name of the new task
  152374. * @param url defines the url of the file to load
  152375. * @returns a new TextFileAssetTask object
  152376. */
  152377. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152378. /**
  152379. * Add a BinaryFileAssetTask to the list of active tasks
  152380. * @param taskName defines the name of the new task
  152381. * @param url defines the url of the file to load
  152382. * @returns a new BinaryFileAssetTask object
  152383. */
  152384. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152385. /**
  152386. * Add a ImageAssetTask to the list of active tasks
  152387. * @param taskName defines the name of the new task
  152388. * @param url defines the url of the file to load
  152389. * @returns a new ImageAssetTask object
  152390. */
  152391. addImageTask(taskName: string, url: string): ImageAssetTask;
  152392. /**
  152393. * Add a TextureAssetTask to the list of active tasks
  152394. * @param taskName defines the name of the new task
  152395. * @param url defines the url of the file to load
  152396. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152397. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152398. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152399. * @returns a new TextureAssetTask object
  152400. */
  152401. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152402. /**
  152403. * Add a CubeTextureAssetTask to the list of active tasks
  152404. * @param taskName defines the name of the new task
  152405. * @param url defines the url of the file to load
  152406. * @param extensions defines the extension to use to load the cube map (can be null)
  152407. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152408. * @param files defines the list of files to load (can be null)
  152409. * @returns a new CubeTextureAssetTask object
  152410. */
  152411. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  152412. /**
  152413. *
  152414. * Add a HDRCubeTextureAssetTask to the list of active tasks
  152415. * @param taskName defines the name of the new task
  152416. * @param url defines the url of the file to load
  152417. * @param size defines the size you want for the cubemap (can be null)
  152418. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152419. * @param generateHarmonics defines if you want to automatically generate (true by default)
  152420. * @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)
  152421. * @param reserved Internal use only
  152422. * @returns a new HDRCubeTextureAssetTask object
  152423. */
  152424. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  152425. /**
  152426. *
  152427. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  152428. * @param taskName defines the name of the new task
  152429. * @param url defines the url of the file to load
  152430. * @param size defines the size you want for the cubemap (can be null)
  152431. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152432. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  152433. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  152434. * @returns a new EquiRectangularCubeTextureAssetTask object
  152435. */
  152436. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  152437. /**
  152438. * Remove a task from the assets manager.
  152439. * @param task the task to remove
  152440. */
  152441. removeTask(task: AbstractAssetTask): void;
  152442. private _decreaseWaitingTasksCount;
  152443. private _runTask;
  152444. /**
  152445. * Reset the AssetsManager and remove all tasks
  152446. * @return the current instance of the AssetsManager
  152447. */
  152448. reset(): AssetsManager;
  152449. /**
  152450. * Start the loading process
  152451. * @return the current instance of the AssetsManager
  152452. */
  152453. load(): AssetsManager;
  152454. /**
  152455. * Start the loading process as an async operation
  152456. * @return a promise returning the list of failed tasks
  152457. */
  152458. loadAsync(): Promise<void>;
  152459. }
  152460. }
  152461. declare module BABYLON {
  152462. /**
  152463. * Wrapper class for promise with external resolve and reject.
  152464. */
  152465. export class Deferred<T> {
  152466. /**
  152467. * The promise associated with this deferred object.
  152468. */
  152469. readonly promise: Promise<T>;
  152470. private _resolve;
  152471. private _reject;
  152472. /**
  152473. * The resolve method of the promise associated with this deferred object.
  152474. */
  152475. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  152476. /**
  152477. * The reject method of the promise associated with this deferred object.
  152478. */
  152479. get reject(): (reason?: any) => void;
  152480. /**
  152481. * Constructor for this deferred object.
  152482. */
  152483. constructor();
  152484. }
  152485. }
  152486. declare module BABYLON {
  152487. /**
  152488. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  152489. */
  152490. export class MeshExploder {
  152491. private _centerMesh;
  152492. private _meshes;
  152493. private _meshesOrigins;
  152494. private _toCenterVectors;
  152495. private _scaledDirection;
  152496. private _newPosition;
  152497. private _centerPosition;
  152498. /**
  152499. * Explodes meshes from a center mesh.
  152500. * @param meshes The meshes to explode.
  152501. * @param centerMesh The mesh to be center of explosion.
  152502. */
  152503. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  152504. private _setCenterMesh;
  152505. /**
  152506. * Get class name
  152507. * @returns "MeshExploder"
  152508. */
  152509. getClassName(): string;
  152510. /**
  152511. * "Exploded meshes"
  152512. * @returns Array of meshes with the centerMesh at index 0.
  152513. */
  152514. getMeshes(): Array<Mesh>;
  152515. /**
  152516. * Explodes meshes giving a specific direction
  152517. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  152518. */
  152519. explode(direction?: number): void;
  152520. }
  152521. }
  152522. declare module BABYLON {
  152523. /**
  152524. * Class used to help managing file picking and drag'n'drop
  152525. */
  152526. export class FilesInput {
  152527. /**
  152528. * List of files ready to be loaded
  152529. */
  152530. static get FilesToLoad(): {
  152531. [key: string]: File;
  152532. };
  152533. /**
  152534. * Callback called when a file is processed
  152535. */
  152536. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  152537. private _engine;
  152538. private _currentScene;
  152539. private _sceneLoadedCallback;
  152540. private _progressCallback;
  152541. private _additionalRenderLoopLogicCallback;
  152542. private _textureLoadingCallback;
  152543. private _startingProcessingFilesCallback;
  152544. private _onReloadCallback;
  152545. private _errorCallback;
  152546. private _elementToMonitor;
  152547. private _sceneFileToLoad;
  152548. private _filesToLoad;
  152549. /**
  152550. * Creates a new FilesInput
  152551. * @param engine defines the rendering engine
  152552. * @param scene defines the hosting scene
  152553. * @param sceneLoadedCallback callback called when scene is loaded
  152554. * @param progressCallback callback called to track progress
  152555. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  152556. * @param textureLoadingCallback callback called when a texture is loading
  152557. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  152558. * @param onReloadCallback callback called when a reload is requested
  152559. * @param errorCallback callback call if an error occurs
  152560. */
  152561. 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>);
  152562. private _dragEnterHandler;
  152563. private _dragOverHandler;
  152564. private _dropHandler;
  152565. /**
  152566. * Calls this function to listen to drag'n'drop events on a specific DOM element
  152567. * @param elementToMonitor defines the DOM element to track
  152568. */
  152569. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  152570. /** Gets the current list of files to load */
  152571. get filesToLoad(): File[];
  152572. /**
  152573. * Release all associated resources
  152574. */
  152575. dispose(): void;
  152576. private renderFunction;
  152577. private drag;
  152578. private drop;
  152579. private _traverseFolder;
  152580. private _processFiles;
  152581. /**
  152582. * Load files from a drop event
  152583. * @param event defines the drop event to use as source
  152584. */
  152585. loadFiles(event: any): void;
  152586. private _processReload;
  152587. /**
  152588. * Reload the current scene from the loaded files
  152589. */
  152590. reload(): void;
  152591. }
  152592. }
  152593. declare module BABYLON {
  152594. /**
  152595. * Defines the root class used to create scene optimization to use with SceneOptimizer
  152596. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152597. */
  152598. export class SceneOptimization {
  152599. /**
  152600. * Defines the priority of this optimization (0 by default which means first in the list)
  152601. */
  152602. priority: number;
  152603. /**
  152604. * Gets a string describing the action executed by the current optimization
  152605. * @returns description string
  152606. */
  152607. getDescription(): string;
  152608. /**
  152609. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152610. * @param scene defines the current scene where to apply this optimization
  152611. * @param optimizer defines the current optimizer
  152612. * @returns true if everything that can be done was applied
  152613. */
  152614. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152615. /**
  152616. * Creates the SceneOptimization object
  152617. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152618. * @param desc defines the description associated with the optimization
  152619. */
  152620. constructor(
  152621. /**
  152622. * Defines the priority of this optimization (0 by default which means first in the list)
  152623. */
  152624. priority?: number);
  152625. }
  152626. /**
  152627. * Defines an optimization used to reduce the size of render target textures
  152628. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152629. */
  152630. export class TextureOptimization extends SceneOptimization {
  152631. /**
  152632. * Defines the priority of this optimization (0 by default which means first in the list)
  152633. */
  152634. priority: number;
  152635. /**
  152636. * 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
  152637. */
  152638. maximumSize: number;
  152639. /**
  152640. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  152641. */
  152642. step: number;
  152643. /**
  152644. * Gets a string describing the action executed by the current optimization
  152645. * @returns description string
  152646. */
  152647. getDescription(): string;
  152648. /**
  152649. * Creates the TextureOptimization object
  152650. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152651. * @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
  152652. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  152653. */
  152654. constructor(
  152655. /**
  152656. * Defines the priority of this optimization (0 by default which means first in the list)
  152657. */
  152658. priority?: number,
  152659. /**
  152660. * 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
  152661. */
  152662. maximumSize?: number,
  152663. /**
  152664. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  152665. */
  152666. step?: number);
  152667. /**
  152668. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152669. * @param scene defines the current scene where to apply this optimization
  152670. * @param optimizer defines the current optimizer
  152671. * @returns true if everything that can be done was applied
  152672. */
  152673. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152674. }
  152675. /**
  152676. * Defines an optimization used to increase or decrease the rendering resolution
  152677. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152678. */
  152679. export class HardwareScalingOptimization extends SceneOptimization {
  152680. /**
  152681. * Defines the priority of this optimization (0 by default which means first in the list)
  152682. */
  152683. priority: number;
  152684. /**
  152685. * Defines the maximum scale to use (2 by default)
  152686. */
  152687. maximumScale: number;
  152688. /**
  152689. * Defines the step to use between two passes (0.5 by default)
  152690. */
  152691. step: number;
  152692. private _currentScale;
  152693. private _directionOffset;
  152694. /**
  152695. * Gets a string describing the action executed by the current optimization
  152696. * @return description string
  152697. */
  152698. getDescription(): string;
  152699. /**
  152700. * Creates the HardwareScalingOptimization object
  152701. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152702. * @param maximumScale defines the maximum scale to use (2 by default)
  152703. * @param step defines the step to use between two passes (0.5 by default)
  152704. */
  152705. constructor(
  152706. /**
  152707. * Defines the priority of this optimization (0 by default which means first in the list)
  152708. */
  152709. priority?: number,
  152710. /**
  152711. * Defines the maximum scale to use (2 by default)
  152712. */
  152713. maximumScale?: number,
  152714. /**
  152715. * Defines the step to use between two passes (0.5 by default)
  152716. */
  152717. step?: number);
  152718. /**
  152719. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152720. * @param scene defines the current scene where to apply this optimization
  152721. * @param optimizer defines the current optimizer
  152722. * @returns true if everything that can be done was applied
  152723. */
  152724. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152725. }
  152726. /**
  152727. * Defines an optimization used to remove shadows
  152728. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152729. */
  152730. export class ShadowsOptimization extends SceneOptimization {
  152731. /**
  152732. * Gets a string describing the action executed by the current optimization
  152733. * @return description string
  152734. */
  152735. getDescription(): string;
  152736. /**
  152737. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152738. * @param scene defines the current scene where to apply this optimization
  152739. * @param optimizer defines the current optimizer
  152740. * @returns true if everything that can be done was applied
  152741. */
  152742. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152743. }
  152744. /**
  152745. * Defines an optimization used to turn post-processes off
  152746. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152747. */
  152748. export class PostProcessesOptimization extends SceneOptimization {
  152749. /**
  152750. * Gets a string describing the action executed by the current optimization
  152751. * @return description string
  152752. */
  152753. getDescription(): string;
  152754. /**
  152755. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152756. * @param scene defines the current scene where to apply this optimization
  152757. * @param optimizer defines the current optimizer
  152758. * @returns true if everything that can be done was applied
  152759. */
  152760. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152761. }
  152762. /**
  152763. * Defines an optimization used to turn lens flares off
  152764. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152765. */
  152766. export class LensFlaresOptimization extends SceneOptimization {
  152767. /**
  152768. * Gets a string describing the action executed by the current optimization
  152769. * @return description string
  152770. */
  152771. getDescription(): string;
  152772. /**
  152773. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152774. * @param scene defines the current scene where to apply this optimization
  152775. * @param optimizer defines the current optimizer
  152776. * @returns true if everything that can be done was applied
  152777. */
  152778. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152779. }
  152780. /**
  152781. * Defines an optimization based on user defined callback.
  152782. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152783. */
  152784. export class CustomOptimization extends SceneOptimization {
  152785. /**
  152786. * Callback called to apply the custom optimization.
  152787. */
  152788. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  152789. /**
  152790. * Callback called to get custom description
  152791. */
  152792. onGetDescription: () => string;
  152793. /**
  152794. * Gets a string describing the action executed by the current optimization
  152795. * @returns description string
  152796. */
  152797. getDescription(): string;
  152798. /**
  152799. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152800. * @param scene defines the current scene where to apply this optimization
  152801. * @param optimizer defines the current optimizer
  152802. * @returns true if everything that can be done was applied
  152803. */
  152804. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152805. }
  152806. /**
  152807. * Defines an optimization used to turn particles off
  152808. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152809. */
  152810. export class ParticlesOptimization extends SceneOptimization {
  152811. /**
  152812. * Gets a string describing the action executed by the current optimization
  152813. * @return description string
  152814. */
  152815. getDescription(): string;
  152816. /**
  152817. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152818. * @param scene defines the current scene where to apply this optimization
  152819. * @param optimizer defines the current optimizer
  152820. * @returns true if everything that can be done was applied
  152821. */
  152822. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152823. }
  152824. /**
  152825. * Defines an optimization used to turn render targets off
  152826. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152827. */
  152828. export class RenderTargetsOptimization extends SceneOptimization {
  152829. /**
  152830. * Gets a string describing the action executed by the current optimization
  152831. * @return description string
  152832. */
  152833. getDescription(): string;
  152834. /**
  152835. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152836. * @param scene defines the current scene where to apply this optimization
  152837. * @param optimizer defines the current optimizer
  152838. * @returns true if everything that can be done was applied
  152839. */
  152840. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152841. }
  152842. /**
  152843. * Defines an optimization used to merge meshes with compatible materials
  152844. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152845. */
  152846. export class MergeMeshesOptimization extends SceneOptimization {
  152847. private static _UpdateSelectionTree;
  152848. /**
  152849. * Gets or sets a boolean which defines if optimization octree has to be updated
  152850. */
  152851. static get UpdateSelectionTree(): boolean;
  152852. /**
  152853. * Gets or sets a boolean which defines if optimization octree has to be updated
  152854. */
  152855. static set UpdateSelectionTree(value: boolean);
  152856. /**
  152857. * Gets a string describing the action executed by the current optimization
  152858. * @return description string
  152859. */
  152860. getDescription(): string;
  152861. private _canBeMerged;
  152862. /**
  152863. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152864. * @param scene defines the current scene where to apply this optimization
  152865. * @param optimizer defines the current optimizer
  152866. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  152867. * @returns true if everything that can be done was applied
  152868. */
  152869. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  152870. }
  152871. /**
  152872. * Defines a list of options used by SceneOptimizer
  152873. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152874. */
  152875. export class SceneOptimizerOptions {
  152876. /**
  152877. * Defines the target frame rate to reach (60 by default)
  152878. */
  152879. targetFrameRate: number;
  152880. /**
  152881. * Defines the interval between two checkes (2000ms by default)
  152882. */
  152883. trackerDuration: number;
  152884. /**
  152885. * Gets the list of optimizations to apply
  152886. */
  152887. optimizations: SceneOptimization[];
  152888. /**
  152889. * Creates a new list of options used by SceneOptimizer
  152890. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  152891. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  152892. */
  152893. constructor(
  152894. /**
  152895. * Defines the target frame rate to reach (60 by default)
  152896. */
  152897. targetFrameRate?: number,
  152898. /**
  152899. * Defines the interval between two checkes (2000ms by default)
  152900. */
  152901. trackerDuration?: number);
  152902. /**
  152903. * Add a new optimization
  152904. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  152905. * @returns the current SceneOptimizerOptions
  152906. */
  152907. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  152908. /**
  152909. * Add a new custom optimization
  152910. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  152911. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  152912. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152913. * @returns the current SceneOptimizerOptions
  152914. */
  152915. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  152916. /**
  152917. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  152918. * @param targetFrameRate defines the target frame rate (60 by default)
  152919. * @returns a SceneOptimizerOptions object
  152920. */
  152921. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  152922. /**
  152923. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  152924. * @param targetFrameRate defines the target frame rate (60 by default)
  152925. * @returns a SceneOptimizerOptions object
  152926. */
  152927. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  152928. /**
  152929. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  152930. * @param targetFrameRate defines the target frame rate (60 by default)
  152931. * @returns a SceneOptimizerOptions object
  152932. */
  152933. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  152934. }
  152935. /**
  152936. * Class used to run optimizations in order to reach a target frame rate
  152937. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152938. */
  152939. export class SceneOptimizer implements IDisposable {
  152940. private _isRunning;
  152941. private _options;
  152942. private _scene;
  152943. private _currentPriorityLevel;
  152944. private _targetFrameRate;
  152945. private _trackerDuration;
  152946. private _currentFrameRate;
  152947. private _sceneDisposeObserver;
  152948. private _improvementMode;
  152949. /**
  152950. * Defines an observable called when the optimizer reaches the target frame rate
  152951. */
  152952. onSuccessObservable: Observable<SceneOptimizer>;
  152953. /**
  152954. * Defines an observable called when the optimizer enables an optimization
  152955. */
  152956. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  152957. /**
  152958. * Defines an observable called when the optimizer is not able to reach the target frame rate
  152959. */
  152960. onFailureObservable: Observable<SceneOptimizer>;
  152961. /**
  152962. * Gets a boolean indicating if the optimizer is in improvement mode
  152963. */
  152964. get isInImprovementMode(): boolean;
  152965. /**
  152966. * Gets the current priority level (0 at start)
  152967. */
  152968. get currentPriorityLevel(): number;
  152969. /**
  152970. * Gets the current frame rate checked by the SceneOptimizer
  152971. */
  152972. get currentFrameRate(): number;
  152973. /**
  152974. * Gets or sets the current target frame rate (60 by default)
  152975. */
  152976. get targetFrameRate(): number;
  152977. /**
  152978. * Gets or sets the current target frame rate (60 by default)
  152979. */
  152980. set targetFrameRate(value: number);
  152981. /**
  152982. * Gets or sets the current interval between two checks (every 2000ms by default)
  152983. */
  152984. get trackerDuration(): number;
  152985. /**
  152986. * Gets or sets the current interval between two checks (every 2000ms by default)
  152987. */
  152988. set trackerDuration(value: number);
  152989. /**
  152990. * Gets the list of active optimizations
  152991. */
  152992. get optimizations(): SceneOptimization[];
  152993. /**
  152994. * Creates a new SceneOptimizer
  152995. * @param scene defines the scene to work on
  152996. * @param options defines the options to use with the SceneOptimizer
  152997. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  152998. * @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)
  152999. */
  153000. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153001. /**
  153002. * Stops the current optimizer
  153003. */
  153004. stop(): void;
  153005. /**
  153006. * Reset the optimizer to initial step (current priority level = 0)
  153007. */
  153008. reset(): void;
  153009. /**
  153010. * Start the optimizer. By default it will try to reach a specific framerate
  153011. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153012. */
  153013. start(): void;
  153014. private _checkCurrentState;
  153015. /**
  153016. * Release all resources
  153017. */
  153018. dispose(): void;
  153019. /**
  153020. * Helper function to create a SceneOptimizer with one single line of code
  153021. * @param scene defines the scene to work on
  153022. * @param options defines the options to use with the SceneOptimizer
  153023. * @param onSuccess defines a callback to call on success
  153024. * @param onFailure defines a callback to call on failure
  153025. * @returns the new SceneOptimizer object
  153026. */
  153027. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153028. }
  153029. }
  153030. declare module BABYLON {
  153031. /**
  153032. * Class used to serialize a scene into a string
  153033. */
  153034. export class SceneSerializer {
  153035. /**
  153036. * Clear cache used by a previous serialization
  153037. */
  153038. static ClearCache(): void;
  153039. /**
  153040. * Serialize a scene into a JSON compatible object
  153041. * @param scene defines the scene to serialize
  153042. * @returns a JSON compatible object
  153043. */
  153044. static Serialize(scene: Scene): any;
  153045. /**
  153046. * Serialize a mesh into a JSON compatible object
  153047. * @param toSerialize defines the mesh to serialize
  153048. * @param withParents defines if parents must be serialized as well
  153049. * @param withChildren defines if children must be serialized as well
  153050. * @returns a JSON compatible object
  153051. */
  153052. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153053. }
  153054. }
  153055. declare module BABYLON {
  153056. /**
  153057. * Class used to host texture specific utilities
  153058. */
  153059. export class TextureTools {
  153060. /**
  153061. * Uses the GPU to create a copy texture rescaled at a given size
  153062. * @param texture Texture to copy from
  153063. * @param width defines the desired width
  153064. * @param height defines the desired height
  153065. * @param useBilinearMode defines if bilinear mode has to be used
  153066. * @return the generated texture
  153067. */
  153068. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153069. }
  153070. }
  153071. declare module BABYLON {
  153072. /**
  153073. * This represents the different options available for the video capture.
  153074. */
  153075. export interface VideoRecorderOptions {
  153076. /** Defines the mime type of the video. */
  153077. mimeType: string;
  153078. /** Defines the FPS the video should be recorded at. */
  153079. fps: number;
  153080. /** Defines the chunk size for the recording data. */
  153081. recordChunckSize: number;
  153082. /** The audio tracks to attach to the recording. */
  153083. audioTracks?: MediaStreamTrack[];
  153084. }
  153085. /**
  153086. * This can help with recording videos from BabylonJS.
  153087. * This is based on the available WebRTC functionalities of the browser.
  153088. *
  153089. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153090. */
  153091. export class VideoRecorder {
  153092. private static readonly _defaultOptions;
  153093. /**
  153094. * Returns whether or not the VideoRecorder is available in your browser.
  153095. * @param engine Defines the Babylon Engine.
  153096. * @returns true if supported otherwise false.
  153097. */
  153098. static IsSupported(engine: Engine): boolean;
  153099. private readonly _options;
  153100. private _canvas;
  153101. private _mediaRecorder;
  153102. private _recordedChunks;
  153103. private _fileName;
  153104. private _resolve;
  153105. private _reject;
  153106. /**
  153107. * True when a recording is already in progress.
  153108. */
  153109. get isRecording(): boolean;
  153110. /**
  153111. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153112. * @param engine Defines the BabylonJS Engine you wish to record.
  153113. * @param options Defines options that can be used to customize the capture.
  153114. */
  153115. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153116. /**
  153117. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153118. */
  153119. stopRecording(): void;
  153120. /**
  153121. * Starts recording the canvas for a max duration specified in parameters.
  153122. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153123. * If null no automatic download will start and you can rely on the promise to get the data back.
  153124. * @param maxDuration Defines the maximum recording time in seconds.
  153125. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153126. * @return A promise callback at the end of the recording with the video data in Blob.
  153127. */
  153128. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153129. /**
  153130. * Releases internal resources used during the recording.
  153131. */
  153132. dispose(): void;
  153133. private _handleDataAvailable;
  153134. private _handleError;
  153135. private _handleStop;
  153136. }
  153137. }
  153138. declare module BABYLON {
  153139. /**
  153140. * Class containing a set of static utilities functions for screenshots
  153141. */
  153142. export class ScreenshotTools {
  153143. /**
  153144. * Captures a screenshot of the current rendering
  153145. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153146. * @param engine defines the rendering engine
  153147. * @param camera defines the source camera
  153148. * @param size This parameter can be set to a single number or to an object with the
  153149. * following (optional) properties: precision, width, height. If a single number is passed,
  153150. * it will be used for both width and height. If an object is passed, the screenshot size
  153151. * will be derived from the parameters. The precision property is a multiplier allowing
  153152. * rendering at a higher or lower resolution
  153153. * @param successCallback defines the callback receives a single parameter which contains the
  153154. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153155. * src parameter of an <img> to display it
  153156. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153157. * Check your browser for supported MIME types
  153158. */
  153159. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153160. /**
  153161. * Captures a screenshot of the current rendering
  153162. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153163. * @param engine defines the rendering engine
  153164. * @param camera defines the source camera
  153165. * @param size This parameter can be set to a single number or to an object with the
  153166. * following (optional) properties: precision, width, height. If a single number is passed,
  153167. * it will be used for both width and height. If an object is passed, the screenshot size
  153168. * will be derived from the parameters. The precision property is a multiplier allowing
  153169. * rendering at a higher or lower resolution
  153170. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153171. * Check your browser for supported MIME types
  153172. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153173. * to the src parameter of an <img> to display it
  153174. */
  153175. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153176. /**
  153177. * Generates an image screenshot from the specified camera.
  153178. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153179. * @param engine The engine to use for rendering
  153180. * @param camera The camera to use for rendering
  153181. * @param size This parameter can be set to a single number or to an object with the
  153182. * following (optional) properties: precision, width, height. If a single number is passed,
  153183. * it will be used for both width and height. If an object is passed, the screenshot size
  153184. * will be derived from the parameters. The precision property is a multiplier allowing
  153185. * rendering at a higher or lower resolution
  153186. * @param successCallback The callback receives a single parameter which contains the
  153187. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153188. * src parameter of an <img> to display it
  153189. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153190. * Check your browser for supported MIME types
  153191. * @param samples Texture samples (default: 1)
  153192. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153193. * @param fileName A name for for the downloaded file.
  153194. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153195. */
  153196. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): void;
  153197. /**
  153198. * Generates an image screenshot from the specified camera.
  153199. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153200. * @param engine The engine to use for rendering
  153201. * @param camera The camera to use for rendering
  153202. * @param size This parameter can be set to a single number or to an object with the
  153203. * following (optional) properties: precision, width, height. If a single number is passed,
  153204. * it will be used for both width and height. If an object is passed, the screenshot size
  153205. * will be derived from the parameters. The precision property is a multiplier allowing
  153206. * rendering at a higher or lower resolution
  153207. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153208. * Check your browser for supported MIME types
  153209. * @param samples Texture samples (default: 1)
  153210. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153211. * @param fileName A name for for the downloaded file.
  153212. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153213. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153214. * to the src parameter of an <img> to display it
  153215. */
  153216. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153217. /**
  153218. * Gets height and width for screenshot size
  153219. * @private
  153220. */
  153221. private static _getScreenshotSize;
  153222. }
  153223. }
  153224. declare module BABYLON {
  153225. /**
  153226. * Interface for a data buffer
  153227. */
  153228. export interface IDataBuffer {
  153229. /**
  153230. * Reads bytes from the data buffer.
  153231. * @param byteOffset The byte offset to read
  153232. * @param byteLength The byte length to read
  153233. * @returns A promise that resolves when the bytes are read
  153234. */
  153235. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153236. /**
  153237. * The byte length of the buffer.
  153238. */
  153239. readonly byteLength: number;
  153240. }
  153241. /**
  153242. * Utility class for reading from a data buffer
  153243. */
  153244. export class DataReader {
  153245. /**
  153246. * The data buffer associated with this data reader.
  153247. */
  153248. readonly buffer: IDataBuffer;
  153249. /**
  153250. * The current byte offset from the beginning of the data buffer.
  153251. */
  153252. byteOffset: number;
  153253. private _dataView;
  153254. private _dataByteOffset;
  153255. /**
  153256. * Constructor
  153257. * @param buffer The buffer to read
  153258. */
  153259. constructor(buffer: IDataBuffer);
  153260. /**
  153261. * Loads the given byte length.
  153262. * @param byteLength The byte length to load
  153263. * @returns A promise that resolves when the load is complete
  153264. */
  153265. loadAsync(byteLength: number): Promise<void>;
  153266. /**
  153267. * Read a unsigned 32-bit integer from the currently loaded data range.
  153268. * @returns The 32-bit integer read
  153269. */
  153270. readUint32(): number;
  153271. /**
  153272. * Read a byte array from the currently loaded data range.
  153273. * @param byteLength The byte length to read
  153274. * @returns The byte array read
  153275. */
  153276. readUint8Array(byteLength: number): Uint8Array;
  153277. /**
  153278. * Read a string from the currently loaded data range.
  153279. * @param byteLength The byte length to read
  153280. * @returns The string read
  153281. */
  153282. readString(byteLength: number): string;
  153283. /**
  153284. * Skips the given byte length the currently loaded data range.
  153285. * @param byteLength The byte length to skip
  153286. */
  153287. skipBytes(byteLength: number): void;
  153288. }
  153289. }
  153290. declare module BABYLON {
  153291. /**
  153292. * Class for storing data to local storage if available or in-memory storage otherwise
  153293. */
  153294. export class DataStorage {
  153295. private static _Storage;
  153296. private static _GetStorage;
  153297. /**
  153298. * Reads a string from the data storage
  153299. * @param key The key to read
  153300. * @param defaultValue The value if the key doesn't exist
  153301. * @returns The string value
  153302. */
  153303. static ReadString(key: string, defaultValue: string): string;
  153304. /**
  153305. * Writes a string to the data storage
  153306. * @param key The key to write
  153307. * @param value The value to write
  153308. */
  153309. static WriteString(key: string, value: string): void;
  153310. /**
  153311. * Reads a boolean from the data storage
  153312. * @param key The key to read
  153313. * @param defaultValue The value if the key doesn't exist
  153314. * @returns The boolean value
  153315. */
  153316. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153317. /**
  153318. * Writes a boolean to the data storage
  153319. * @param key The key to write
  153320. * @param value The value to write
  153321. */
  153322. static WriteBoolean(key: string, value: boolean): void;
  153323. /**
  153324. * Reads a number from the data storage
  153325. * @param key The key to read
  153326. * @param defaultValue The value if the key doesn't exist
  153327. * @returns The number value
  153328. */
  153329. static ReadNumber(key: string, defaultValue: number): number;
  153330. /**
  153331. * Writes a number to the data storage
  153332. * @param key The key to write
  153333. * @param value The value to write
  153334. */
  153335. static WriteNumber(key: string, value: number): void;
  153336. }
  153337. }
  153338. declare module BABYLON {
  153339. /**
  153340. * Class used to record delta files between 2 scene states
  153341. */
  153342. export class SceneRecorder {
  153343. private _trackedScene;
  153344. private _savedJSON;
  153345. /**
  153346. * Track a given scene. This means the current scene state will be considered the original state
  153347. * @param scene defines the scene to track
  153348. */
  153349. track(scene: Scene): void;
  153350. /**
  153351. * Get the delta between current state and original state
  153352. * @returns a string containing the delta
  153353. */
  153354. getDelta(): any;
  153355. private _compareArray;
  153356. private _compareObjects;
  153357. private _compareCollections;
  153358. private static GetShadowGeneratorById;
  153359. /**
  153360. * Apply a given delta to a given scene
  153361. * @param deltaJSON defines the JSON containing the delta
  153362. * @param scene defines the scene to apply the delta to
  153363. */
  153364. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153365. private static _ApplyPropertiesToEntity;
  153366. private static _ApplyDeltaForEntity;
  153367. }
  153368. }
  153369. declare module BABYLON {
  153370. /**
  153371. * An interface for all Hit test features
  153372. */
  153373. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153374. /**
  153375. * Triggered when new babylon (transformed) hit test results are available
  153376. */
  153377. onHitTestResultObservable: Observable<T[]>;
  153378. }
  153379. /**
  153380. * Options used for hit testing
  153381. */
  153382. export interface IWebXRLegacyHitTestOptions {
  153383. /**
  153384. * Only test when user interacted with the scene. Default - hit test every frame
  153385. */
  153386. testOnPointerDownOnly?: boolean;
  153387. /**
  153388. * The node to use to transform the local results to world coordinates
  153389. */
  153390. worldParentNode?: TransformNode;
  153391. }
  153392. /**
  153393. * Interface defining the babylon result of raycasting/hit-test
  153394. */
  153395. export interface IWebXRLegacyHitResult {
  153396. /**
  153397. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153398. */
  153399. transformationMatrix: Matrix;
  153400. /**
  153401. * The native hit test result
  153402. */
  153403. xrHitResult: XRHitResult | XRHitTestResult;
  153404. }
  153405. /**
  153406. * The currently-working hit-test module.
  153407. * Hit test (or Ray-casting) is used to interact with the real world.
  153408. * For further information read here - https://github.com/immersive-web/hit-test
  153409. */
  153410. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  153411. /**
  153412. * options to use when constructing this feature
  153413. */
  153414. readonly options: IWebXRLegacyHitTestOptions;
  153415. private _direction;
  153416. private _mat;
  153417. private _onSelectEnabled;
  153418. private _origin;
  153419. /**
  153420. * The module's name
  153421. */
  153422. static readonly Name: string;
  153423. /**
  153424. * The (Babylon) version of this module.
  153425. * This is an integer representing the implementation version.
  153426. * This number does not correspond to the WebXR specs version
  153427. */
  153428. static readonly Version: number;
  153429. /**
  153430. * Populated with the last native XR Hit Results
  153431. */
  153432. lastNativeXRHitResults: XRHitResult[];
  153433. /**
  153434. * Triggered when new babylon (transformed) hit test results are available
  153435. */
  153436. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  153437. /**
  153438. * Creates a new instance of the (legacy version) hit test feature
  153439. * @param _xrSessionManager an instance of WebXRSessionManager
  153440. * @param options options to use when constructing this feature
  153441. */
  153442. constructor(_xrSessionManager: WebXRSessionManager,
  153443. /**
  153444. * options to use when constructing this feature
  153445. */
  153446. options?: IWebXRLegacyHitTestOptions);
  153447. /**
  153448. * execute a hit test with an XR Ray
  153449. *
  153450. * @param xrSession a native xrSession that will execute this hit test
  153451. * @param xrRay the ray (position and direction) to use for ray-casting
  153452. * @param referenceSpace native XR reference space to use for the hit-test
  153453. * @param filter filter function that will filter the results
  153454. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153455. */
  153456. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  153457. /**
  153458. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  153459. * @param event the (select) event to use to select with
  153460. * @param referenceSpace the reference space to use for this hit test
  153461. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153462. */
  153463. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153464. /**
  153465. * attach this feature
  153466. * Will usually be called by the features manager
  153467. *
  153468. * @returns true if successful.
  153469. */
  153470. attach(): boolean;
  153471. /**
  153472. * detach this feature.
  153473. * Will usually be called by the features manager
  153474. *
  153475. * @returns true if successful.
  153476. */
  153477. detach(): boolean;
  153478. /**
  153479. * Dispose this feature and all of the resources attached
  153480. */
  153481. dispose(): void;
  153482. protected _onXRFrame(frame: XRFrame): void;
  153483. private _onHitTestResults;
  153484. private _onSelect;
  153485. }
  153486. }
  153487. declare module BABYLON {
  153488. /**
  153489. * Options used for hit testing (version 2)
  153490. */
  153491. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  153492. /**
  153493. * Do not create a permanent hit test. Will usually be used when only
  153494. * transient inputs are needed.
  153495. */
  153496. disablePermanentHitTest?: boolean;
  153497. /**
  153498. * Enable transient (for example touch-based) hit test inspections
  153499. */
  153500. enableTransientHitTest?: boolean;
  153501. /**
  153502. * Offset ray for the permanent hit test
  153503. */
  153504. offsetRay?: Vector3;
  153505. /**
  153506. * Offset ray for the transient hit test
  153507. */
  153508. transientOffsetRay?: Vector3;
  153509. /**
  153510. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  153511. */
  153512. useReferenceSpace?: boolean;
  153513. /**
  153514. * Override the default entity type(s) of the hit-test result
  153515. */
  153516. entityTypes?: XRHitTestTrackableType[];
  153517. }
  153518. /**
  153519. * Interface defining the babylon result of hit-test
  153520. */
  153521. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  153522. /**
  153523. * The input source that generated this hit test (if transient)
  153524. */
  153525. inputSource?: XRInputSource;
  153526. /**
  153527. * Is this a transient hit test
  153528. */
  153529. isTransient?: boolean;
  153530. /**
  153531. * Position of the hit test result
  153532. */
  153533. position: Vector3;
  153534. /**
  153535. * Rotation of the hit test result
  153536. */
  153537. rotationQuaternion: Quaternion;
  153538. /**
  153539. * The native hit test result
  153540. */
  153541. xrHitResult: XRHitTestResult;
  153542. }
  153543. /**
  153544. * The currently-working hit-test module.
  153545. * Hit test (or Ray-casting) is used to interact with the real world.
  153546. * For further information read here - https://github.com/immersive-web/hit-test
  153547. *
  153548. * Tested on chrome (mobile) 80.
  153549. */
  153550. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  153551. /**
  153552. * options to use when constructing this feature
  153553. */
  153554. readonly options: IWebXRHitTestOptions;
  153555. private _tmpMat;
  153556. private _tmpPos;
  153557. private _tmpQuat;
  153558. private _transientXrHitTestSource;
  153559. private _xrHitTestSource;
  153560. private initHitTestSource;
  153561. /**
  153562. * The module's name
  153563. */
  153564. static readonly Name: string;
  153565. /**
  153566. * The (Babylon) version of this module.
  153567. * This is an integer representing the implementation version.
  153568. * This number does not correspond to the WebXR specs version
  153569. */
  153570. static readonly Version: number;
  153571. /**
  153572. * When set to true, each hit test will have its own position/rotation objects
  153573. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  153574. * the developers will clone them or copy them as they see fit.
  153575. */
  153576. autoCloneTransformation: boolean;
  153577. /**
  153578. * Triggered when new babylon (transformed) hit test results are available
  153579. */
  153580. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  153581. /**
  153582. * Use this to temporarily pause hit test checks.
  153583. */
  153584. paused: boolean;
  153585. /**
  153586. * Creates a new instance of the hit test feature
  153587. * @param _xrSessionManager an instance of WebXRSessionManager
  153588. * @param options options to use when constructing this feature
  153589. */
  153590. constructor(_xrSessionManager: WebXRSessionManager,
  153591. /**
  153592. * options to use when constructing this feature
  153593. */
  153594. options?: IWebXRHitTestOptions);
  153595. /**
  153596. * attach this feature
  153597. * Will usually be called by the features manager
  153598. *
  153599. * @returns true if successful.
  153600. */
  153601. attach(): boolean;
  153602. /**
  153603. * detach this feature.
  153604. * Will usually be called by the features manager
  153605. *
  153606. * @returns true if successful.
  153607. */
  153608. detach(): boolean;
  153609. /**
  153610. * Dispose this feature and all of the resources attached
  153611. */
  153612. dispose(): void;
  153613. protected _onXRFrame(frame: XRFrame): void;
  153614. private _processWebXRHitTestResult;
  153615. }
  153616. }
  153617. declare module BABYLON {
  153618. /**
  153619. * Configuration options of the anchor system
  153620. */
  153621. export interface IWebXRAnchorSystemOptions {
  153622. /**
  153623. * a node that will be used to convert local to world coordinates
  153624. */
  153625. worldParentNode?: TransformNode;
  153626. /**
  153627. * If set to true a reference of the created anchors will be kept until the next session starts
  153628. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  153629. */
  153630. doNotRemoveAnchorsOnSessionEnded?: boolean;
  153631. }
  153632. /**
  153633. * A babylon container for an XR Anchor
  153634. */
  153635. export interface IWebXRAnchor {
  153636. /**
  153637. * A babylon-assigned ID for this anchor
  153638. */
  153639. id: number;
  153640. /**
  153641. * Transformation matrix to apply to an object attached to this anchor
  153642. */
  153643. transformationMatrix: Matrix;
  153644. /**
  153645. * The native anchor object
  153646. */
  153647. xrAnchor: XRAnchor;
  153648. /**
  153649. * if defined, this object will be constantly updated by the anchor's position and rotation
  153650. */
  153651. attachedNode?: TransformNode;
  153652. }
  153653. /**
  153654. * An implementation of the anchor system for WebXR.
  153655. * For further information see https://github.com/immersive-web/anchors/
  153656. */
  153657. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  153658. private _options;
  153659. private _lastFrameDetected;
  153660. private _trackedAnchors;
  153661. private _referenceSpaceForFrameAnchors;
  153662. private _futureAnchors;
  153663. /**
  153664. * The module's name
  153665. */
  153666. static readonly Name: string;
  153667. /**
  153668. * The (Babylon) version of this module.
  153669. * This is an integer representing the implementation version.
  153670. * This number does not correspond to the WebXR specs version
  153671. */
  153672. static readonly Version: number;
  153673. /**
  153674. * Observers registered here will be executed when a new anchor was added to the session
  153675. */
  153676. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  153677. /**
  153678. * Observers registered here will be executed when an anchor was removed from the session
  153679. */
  153680. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  153681. /**
  153682. * Observers registered here will be executed when an existing anchor updates
  153683. * This can execute N times every frame
  153684. */
  153685. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  153686. /**
  153687. * Set the reference space to use for anchor creation, when not using a hit test.
  153688. * Will default to the session's reference space if not defined
  153689. */
  153690. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  153691. /**
  153692. * constructs a new anchor system
  153693. * @param _xrSessionManager an instance of WebXRSessionManager
  153694. * @param _options configuration object for this feature
  153695. */
  153696. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  153697. private _tmpVector;
  153698. private _tmpQuaternion;
  153699. private _populateTmpTransformation;
  153700. /**
  153701. * Create a new anchor point using a hit test result at a specific point in the scene
  153702. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  153703. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  153704. *
  153705. * @param hitTestResult The hit test result to use for this anchor creation
  153706. * @param position an optional position offset for this anchor
  153707. * @param rotationQuaternion an optional rotation offset for this anchor
  153708. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  153709. */
  153710. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  153711. /**
  153712. * Add a new anchor at a specific position and rotation
  153713. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  153714. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  153715. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  153716. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  153717. *
  153718. * @param position the position in which to add an anchor
  153719. * @param rotationQuaternion an optional rotation for the anchor transformation
  153720. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  153721. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  153722. */
  153723. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  153724. /**
  153725. * detach this feature.
  153726. * Will usually be called by the features manager
  153727. *
  153728. * @returns true if successful.
  153729. */
  153730. detach(): boolean;
  153731. /**
  153732. * Dispose this feature and all of the resources attached
  153733. */
  153734. dispose(): void;
  153735. protected _onXRFrame(frame: XRFrame): void;
  153736. /**
  153737. * avoiding using Array.find for global support.
  153738. * @param xrAnchor the plane to find in the array
  153739. */
  153740. private _findIndexInAnchorArray;
  153741. private _updateAnchorWithXRFrame;
  153742. private _createAnchorAtTransformation;
  153743. }
  153744. }
  153745. declare module BABYLON {
  153746. /**
  153747. * Options used in the plane detector module
  153748. */
  153749. export interface IWebXRPlaneDetectorOptions {
  153750. /**
  153751. * The node to use to transform the local results to world coordinates
  153752. */
  153753. worldParentNode?: TransformNode;
  153754. /**
  153755. * If set to true a reference of the created planes will be kept until the next session starts
  153756. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  153757. */
  153758. doNotRemovePlanesOnSessionEnded?: boolean;
  153759. }
  153760. /**
  153761. * A babylon interface for a WebXR plane.
  153762. * A Plane is actually a polygon, built from N points in space
  153763. *
  153764. * Supported in chrome 79, not supported in canary 81 ATM
  153765. */
  153766. export interface IWebXRPlane {
  153767. /**
  153768. * a babylon-assigned ID for this polygon
  153769. */
  153770. id: number;
  153771. /**
  153772. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  153773. */
  153774. polygonDefinition: Array<Vector3>;
  153775. /**
  153776. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  153777. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  153778. */
  153779. transformationMatrix: Matrix;
  153780. /**
  153781. * the native xr-plane object
  153782. */
  153783. xrPlane: XRPlane;
  153784. }
  153785. /**
  153786. * The plane detector is used to detect planes in the real world when in AR
  153787. * For more information see https://github.com/immersive-web/real-world-geometry/
  153788. */
  153789. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  153790. private _options;
  153791. private _detectedPlanes;
  153792. private _enabled;
  153793. private _lastFrameDetected;
  153794. /**
  153795. * The module's name
  153796. */
  153797. static readonly Name: string;
  153798. /**
  153799. * The (Babylon) version of this module.
  153800. * This is an integer representing the implementation version.
  153801. * This number does not correspond to the WebXR specs version
  153802. */
  153803. static readonly Version: number;
  153804. /**
  153805. * Observers registered here will be executed when a new plane was added to the session
  153806. */
  153807. onPlaneAddedObservable: Observable<IWebXRPlane>;
  153808. /**
  153809. * Observers registered here will be executed when a plane is no longer detected in the session
  153810. */
  153811. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  153812. /**
  153813. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  153814. * This can execute N times every frame
  153815. */
  153816. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  153817. /**
  153818. * construct a new Plane Detector
  153819. * @param _xrSessionManager an instance of xr Session manager
  153820. * @param _options configuration to use when constructing this feature
  153821. */
  153822. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  153823. /**
  153824. * detach this feature.
  153825. * Will usually be called by the features manager
  153826. *
  153827. * @returns true if successful.
  153828. */
  153829. detach(): boolean;
  153830. /**
  153831. * Dispose this feature and all of the resources attached
  153832. */
  153833. dispose(): void;
  153834. protected _onXRFrame(frame: XRFrame): void;
  153835. private _init;
  153836. private _updatePlaneWithXRPlane;
  153837. /**
  153838. * avoiding using Array.find for global support.
  153839. * @param xrPlane the plane to find in the array
  153840. */
  153841. private findIndexInPlaneArray;
  153842. }
  153843. }
  153844. declare module BABYLON {
  153845. /**
  153846. * Options interface for the background remover plugin
  153847. */
  153848. export interface IWebXRBackgroundRemoverOptions {
  153849. /**
  153850. * Further background meshes to disable when entering AR
  153851. */
  153852. backgroundMeshes?: AbstractMesh[];
  153853. /**
  153854. * flags to configure the removal of the environment helper.
  153855. * If not set, the entire background will be removed. If set, flags should be set as well.
  153856. */
  153857. environmentHelperRemovalFlags?: {
  153858. /**
  153859. * Should the skybox be removed (default false)
  153860. */
  153861. skyBox?: boolean;
  153862. /**
  153863. * Should the ground be removed (default false)
  153864. */
  153865. ground?: boolean;
  153866. };
  153867. /**
  153868. * don't disable the environment helper
  153869. */
  153870. ignoreEnvironmentHelper?: boolean;
  153871. }
  153872. /**
  153873. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  153874. */
  153875. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  153876. /**
  153877. * read-only options to be used in this module
  153878. */
  153879. readonly options: IWebXRBackgroundRemoverOptions;
  153880. /**
  153881. * The module's name
  153882. */
  153883. static readonly Name: string;
  153884. /**
  153885. * The (Babylon) version of this module.
  153886. * This is an integer representing the implementation version.
  153887. * This number does not correspond to the WebXR specs version
  153888. */
  153889. static readonly Version: number;
  153890. /**
  153891. * registered observers will be triggered when the background state changes
  153892. */
  153893. onBackgroundStateChangedObservable: Observable<boolean>;
  153894. /**
  153895. * constructs a new background remover module
  153896. * @param _xrSessionManager the session manager for this module
  153897. * @param options read-only options to be used in this module
  153898. */
  153899. constructor(_xrSessionManager: WebXRSessionManager,
  153900. /**
  153901. * read-only options to be used in this module
  153902. */
  153903. options?: IWebXRBackgroundRemoverOptions);
  153904. /**
  153905. * attach this feature
  153906. * Will usually be called by the features manager
  153907. *
  153908. * @returns true if successful.
  153909. */
  153910. attach(): boolean;
  153911. /**
  153912. * detach this feature.
  153913. * Will usually be called by the features manager
  153914. *
  153915. * @returns true if successful.
  153916. */
  153917. detach(): boolean;
  153918. /**
  153919. * Dispose this feature and all of the resources attached
  153920. */
  153921. dispose(): void;
  153922. protected _onXRFrame(_xrFrame: XRFrame): void;
  153923. private _setBackgroundState;
  153924. }
  153925. }
  153926. declare module BABYLON {
  153927. /**
  153928. * Options for the controller physics feature
  153929. */
  153930. export class IWebXRControllerPhysicsOptions {
  153931. /**
  153932. * Should the headset get its own impostor
  153933. */
  153934. enableHeadsetImpostor?: boolean;
  153935. /**
  153936. * Optional parameters for the headset impostor
  153937. */
  153938. headsetImpostorParams?: {
  153939. /**
  153940. * The type of impostor to create. Default is sphere
  153941. */
  153942. impostorType: number;
  153943. /**
  153944. * the size of the impostor. Defaults to 10cm
  153945. */
  153946. impostorSize?: number | {
  153947. width: number;
  153948. height: number;
  153949. depth: number;
  153950. };
  153951. /**
  153952. * Friction definitions
  153953. */
  153954. friction?: number;
  153955. /**
  153956. * Restitution
  153957. */
  153958. restitution?: number;
  153959. };
  153960. /**
  153961. * The physics properties of the future impostors
  153962. */
  153963. physicsProperties?: {
  153964. /**
  153965. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  153966. * Note that this requires a physics engine that supports mesh impostors!
  153967. */
  153968. useControllerMesh?: boolean;
  153969. /**
  153970. * The type of impostor to create. Default is sphere
  153971. */
  153972. impostorType?: number;
  153973. /**
  153974. * the size of the impostor. Defaults to 10cm
  153975. */
  153976. impostorSize?: number | {
  153977. width: number;
  153978. height: number;
  153979. depth: number;
  153980. };
  153981. /**
  153982. * Friction definitions
  153983. */
  153984. friction?: number;
  153985. /**
  153986. * Restitution
  153987. */
  153988. restitution?: number;
  153989. };
  153990. /**
  153991. * the xr input to use with this pointer selection
  153992. */
  153993. xrInput: WebXRInput;
  153994. }
  153995. /**
  153996. * Add physics impostor to your webxr controllers,
  153997. * including naive calculation of their linear and angular velocity
  153998. */
  153999. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154000. private readonly _options;
  154001. private _attachController;
  154002. private _controllers;
  154003. private _debugMode;
  154004. private _delta;
  154005. private _headsetImpostor?;
  154006. private _headsetMesh?;
  154007. private _lastTimestamp;
  154008. private _tmpQuaternion;
  154009. private _tmpVector;
  154010. /**
  154011. * The module's name
  154012. */
  154013. static readonly Name: string;
  154014. /**
  154015. * The (Babylon) version of this module.
  154016. * This is an integer representing the implementation version.
  154017. * This number does not correspond to the webxr specs version
  154018. */
  154019. static readonly Version: number;
  154020. /**
  154021. * Construct a new Controller Physics Feature
  154022. * @param _xrSessionManager the corresponding xr session manager
  154023. * @param _options options to create this feature with
  154024. */
  154025. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154026. /**
  154027. * @hidden
  154028. * enable debugging - will show console outputs and the impostor mesh
  154029. */
  154030. _enablePhysicsDebug(): void;
  154031. /**
  154032. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154033. * @param xrController the controller to add
  154034. */
  154035. addController(xrController: WebXRInputSource): void;
  154036. /**
  154037. * attach this feature
  154038. * Will usually be called by the features manager
  154039. *
  154040. * @returns true if successful.
  154041. */
  154042. attach(): boolean;
  154043. /**
  154044. * detach this feature.
  154045. * Will usually be called by the features manager
  154046. *
  154047. * @returns true if successful.
  154048. */
  154049. detach(): boolean;
  154050. /**
  154051. * Get the headset impostor, if enabled
  154052. * @returns the impostor
  154053. */
  154054. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154055. /**
  154056. * Get the physics impostor of a specific controller.
  154057. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154058. * @param controller the controller or the controller id of which to get the impostor
  154059. * @returns the impostor or null
  154060. */
  154061. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154062. /**
  154063. * Update the physics properties provided in the constructor
  154064. * @param newProperties the new properties object
  154065. */
  154066. setPhysicsProperties(newProperties: {
  154067. impostorType?: number;
  154068. impostorSize?: number | {
  154069. width: number;
  154070. height: number;
  154071. depth: number;
  154072. };
  154073. friction?: number;
  154074. restitution?: number;
  154075. }): void;
  154076. protected _onXRFrame(_xrFrame: any): void;
  154077. private _detachController;
  154078. }
  154079. }
  154080. declare module BABYLON {
  154081. /**
  154082. * The motion controller class for all microsoft mixed reality controllers
  154083. */
  154084. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154085. protected readonly _mapping: {
  154086. defaultButton: {
  154087. valueNodeName: string;
  154088. unpressedNodeName: string;
  154089. pressedNodeName: string;
  154090. };
  154091. defaultAxis: {
  154092. valueNodeName: string;
  154093. minNodeName: string;
  154094. maxNodeName: string;
  154095. };
  154096. buttons: {
  154097. "xr-standard-trigger": {
  154098. rootNodeName: string;
  154099. componentProperty: string;
  154100. states: string[];
  154101. };
  154102. "xr-standard-squeeze": {
  154103. rootNodeName: string;
  154104. componentProperty: string;
  154105. states: string[];
  154106. };
  154107. "xr-standard-touchpad": {
  154108. rootNodeName: string;
  154109. labelAnchorNodeName: string;
  154110. touchPointNodeName: string;
  154111. };
  154112. "xr-standard-thumbstick": {
  154113. rootNodeName: string;
  154114. componentProperty: string;
  154115. states: string[];
  154116. };
  154117. };
  154118. axes: {
  154119. "xr-standard-touchpad": {
  154120. "x-axis": {
  154121. rootNodeName: string;
  154122. };
  154123. "y-axis": {
  154124. rootNodeName: string;
  154125. };
  154126. };
  154127. "xr-standard-thumbstick": {
  154128. "x-axis": {
  154129. rootNodeName: string;
  154130. };
  154131. "y-axis": {
  154132. rootNodeName: string;
  154133. };
  154134. };
  154135. };
  154136. };
  154137. /**
  154138. * The base url used to load the left and right controller models
  154139. */
  154140. static MODEL_BASE_URL: string;
  154141. /**
  154142. * The name of the left controller model file
  154143. */
  154144. static MODEL_LEFT_FILENAME: string;
  154145. /**
  154146. * The name of the right controller model file
  154147. */
  154148. static MODEL_RIGHT_FILENAME: string;
  154149. profileId: string;
  154150. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154151. protected _getFilenameAndPath(): {
  154152. filename: string;
  154153. path: string;
  154154. };
  154155. protected _getModelLoadingConstraints(): boolean;
  154156. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154157. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154158. protected _updateModel(): void;
  154159. }
  154160. }
  154161. declare module BABYLON {
  154162. /**
  154163. * The motion controller class for oculus touch (quest, rift).
  154164. * This class supports legacy mapping as well the standard xr mapping
  154165. */
  154166. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  154167. private _forceLegacyControllers;
  154168. private _modelRootNode;
  154169. /**
  154170. * The base url used to load the left and right controller models
  154171. */
  154172. static MODEL_BASE_URL: string;
  154173. /**
  154174. * The name of the left controller model file
  154175. */
  154176. static MODEL_LEFT_FILENAME: string;
  154177. /**
  154178. * The name of the right controller model file
  154179. */
  154180. static MODEL_RIGHT_FILENAME: string;
  154181. /**
  154182. * Base Url for the Quest controller model.
  154183. */
  154184. static QUEST_MODEL_BASE_URL: string;
  154185. profileId: string;
  154186. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  154187. protected _getFilenameAndPath(): {
  154188. filename: string;
  154189. path: string;
  154190. };
  154191. protected _getModelLoadingConstraints(): boolean;
  154192. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154193. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154194. protected _updateModel(): void;
  154195. /**
  154196. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  154197. * between the touch and touch 2.
  154198. */
  154199. private _isQuest;
  154200. }
  154201. }
  154202. declare module BABYLON {
  154203. /**
  154204. * The motion controller class for the standard HTC-Vive controllers
  154205. */
  154206. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  154207. private _modelRootNode;
  154208. /**
  154209. * The base url used to load the left and right controller models
  154210. */
  154211. static MODEL_BASE_URL: string;
  154212. /**
  154213. * File name for the controller model.
  154214. */
  154215. static MODEL_FILENAME: string;
  154216. profileId: string;
  154217. /**
  154218. * Create a new Vive motion controller object
  154219. * @param scene the scene to use to create this controller
  154220. * @param gamepadObject the corresponding gamepad object
  154221. * @param handedness the handedness of the controller
  154222. */
  154223. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154224. protected _getFilenameAndPath(): {
  154225. filename: string;
  154226. path: string;
  154227. };
  154228. protected _getModelLoadingConstraints(): boolean;
  154229. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154230. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154231. protected _updateModel(): void;
  154232. }
  154233. }
  154234. declare module BABYLON {
  154235. /**
  154236. * A cursor which tracks a point on a path
  154237. */
  154238. export class PathCursor {
  154239. private path;
  154240. /**
  154241. * Stores path cursor callbacks for when an onchange event is triggered
  154242. */
  154243. private _onchange;
  154244. /**
  154245. * The value of the path cursor
  154246. */
  154247. value: number;
  154248. /**
  154249. * The animation array of the path cursor
  154250. */
  154251. animations: Animation[];
  154252. /**
  154253. * Initializes the path cursor
  154254. * @param path The path to track
  154255. */
  154256. constructor(path: Path2);
  154257. /**
  154258. * Gets the cursor point on the path
  154259. * @returns A point on the path cursor at the cursor location
  154260. */
  154261. getPoint(): Vector3;
  154262. /**
  154263. * Moves the cursor ahead by the step amount
  154264. * @param step The amount to move the cursor forward
  154265. * @returns This path cursor
  154266. */
  154267. moveAhead(step?: number): PathCursor;
  154268. /**
  154269. * Moves the cursor behind by the step amount
  154270. * @param step The amount to move the cursor back
  154271. * @returns This path cursor
  154272. */
  154273. moveBack(step?: number): PathCursor;
  154274. /**
  154275. * Moves the cursor by the step amount
  154276. * If the step amount is greater than one, an exception is thrown
  154277. * @param step The amount to move the cursor
  154278. * @returns This path cursor
  154279. */
  154280. move(step: number): PathCursor;
  154281. /**
  154282. * Ensures that the value is limited between zero and one
  154283. * @returns This path cursor
  154284. */
  154285. private ensureLimits;
  154286. /**
  154287. * Runs onchange callbacks on change (used by the animation engine)
  154288. * @returns This path cursor
  154289. */
  154290. private raiseOnChange;
  154291. /**
  154292. * Executes a function on change
  154293. * @param f A path cursor onchange callback
  154294. * @returns This path cursor
  154295. */
  154296. onchange(f: (cursor: PathCursor) => void): PathCursor;
  154297. }
  154298. }
  154299. declare module BABYLON {
  154300. /** @hidden */
  154301. export var blurPixelShader: {
  154302. name: string;
  154303. shader: string;
  154304. };
  154305. }
  154306. declare module BABYLON {
  154307. /** @hidden */
  154308. export var pointCloudVertexDeclaration: {
  154309. name: string;
  154310. shader: string;
  154311. };
  154312. }
  154313. // Mixins
  154314. interface Window {
  154315. mozIndexedDB: IDBFactory;
  154316. webkitIndexedDB: IDBFactory;
  154317. msIndexedDB: IDBFactory;
  154318. webkitURL: typeof URL;
  154319. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  154320. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  154321. WebGLRenderingContext: WebGLRenderingContext;
  154322. MSGesture: MSGesture;
  154323. CANNON: any;
  154324. AudioContext: AudioContext;
  154325. webkitAudioContext: AudioContext;
  154326. PointerEvent: any;
  154327. Math: Math;
  154328. Uint8Array: Uint8ArrayConstructor;
  154329. Float32Array: Float32ArrayConstructor;
  154330. mozURL: typeof URL;
  154331. msURL: typeof URL;
  154332. VRFrameData: any; // WebVR, from specs 1.1
  154333. DracoDecoderModule: any;
  154334. setImmediate(handler: (...args: any[]) => void): number;
  154335. }
  154336. interface HTMLCanvasElement {
  154337. requestPointerLock(): void;
  154338. msRequestPointerLock?(): void;
  154339. mozRequestPointerLock?(): void;
  154340. webkitRequestPointerLock?(): void;
  154341. /** Track wether a record is in progress */
  154342. isRecording: boolean;
  154343. /** Capture Stream method defined by some browsers */
  154344. captureStream(fps?: number): MediaStream;
  154345. }
  154346. interface CanvasRenderingContext2D {
  154347. msImageSmoothingEnabled: boolean;
  154348. }
  154349. interface MouseEvent {
  154350. mozMovementX: number;
  154351. mozMovementY: number;
  154352. webkitMovementX: number;
  154353. webkitMovementY: number;
  154354. msMovementX: number;
  154355. msMovementY: number;
  154356. }
  154357. interface Navigator {
  154358. mozGetVRDevices: (any: any) => any;
  154359. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154360. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154361. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154362. webkitGetGamepads(): Gamepad[];
  154363. msGetGamepads(): Gamepad[];
  154364. webkitGamepads(): Gamepad[];
  154365. }
  154366. interface HTMLVideoElement {
  154367. mozSrcObject: any;
  154368. }
  154369. interface Math {
  154370. fround(x: number): number;
  154371. imul(a: number, b: number): number;
  154372. }
  154373. interface WebGLRenderingContext {
  154374. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  154375. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  154376. vertexAttribDivisor(index: number, divisor: number): void;
  154377. createVertexArray(): any;
  154378. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  154379. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  154380. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  154381. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  154382. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  154383. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  154384. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  154385. // Queries
  154386. createQuery(): WebGLQuery;
  154387. deleteQuery(query: WebGLQuery): void;
  154388. beginQuery(target: number, query: WebGLQuery): void;
  154389. endQuery(target: number): void;
  154390. getQueryParameter(query: WebGLQuery, pname: number): any;
  154391. getQuery(target: number, pname: number): any;
  154392. MAX_SAMPLES: number;
  154393. RGBA8: number;
  154394. READ_FRAMEBUFFER: number;
  154395. DRAW_FRAMEBUFFER: number;
  154396. UNIFORM_BUFFER: number;
  154397. HALF_FLOAT_OES: number;
  154398. RGBA16F: number;
  154399. RGBA32F: number;
  154400. R32F: number;
  154401. RG32F: number;
  154402. RGB32F: number;
  154403. R16F: number;
  154404. RG16F: number;
  154405. RGB16F: number;
  154406. RED: number;
  154407. RG: number;
  154408. R8: number;
  154409. RG8: number;
  154410. UNSIGNED_INT_24_8: number;
  154411. DEPTH24_STENCIL8: number;
  154412. MIN: number;
  154413. MAX: number;
  154414. /* Multiple Render Targets */
  154415. drawBuffers(buffers: number[]): void;
  154416. readBuffer(src: number): void;
  154417. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  154418. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  154419. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  154420. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  154421. // Occlusion Query
  154422. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  154423. ANY_SAMPLES_PASSED: number;
  154424. QUERY_RESULT_AVAILABLE: number;
  154425. QUERY_RESULT: number;
  154426. }
  154427. interface WebGLProgram {
  154428. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  154429. }
  154430. interface EXT_disjoint_timer_query {
  154431. QUERY_COUNTER_BITS_EXT: number;
  154432. TIME_ELAPSED_EXT: number;
  154433. TIMESTAMP_EXT: number;
  154434. GPU_DISJOINT_EXT: number;
  154435. QUERY_RESULT_EXT: number;
  154436. QUERY_RESULT_AVAILABLE_EXT: number;
  154437. queryCounterEXT(query: WebGLQuery, target: number): void;
  154438. createQueryEXT(): WebGLQuery;
  154439. beginQueryEXT(target: number, query: WebGLQuery): void;
  154440. endQueryEXT(target: number): void;
  154441. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  154442. deleteQueryEXT(query: WebGLQuery): void;
  154443. }
  154444. interface WebGLUniformLocation {
  154445. _currentState: any;
  154446. }
  154447. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  154448. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  154449. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  154450. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  154451. interface WebGLRenderingContext {
  154452. readonly RASTERIZER_DISCARD: number;
  154453. readonly DEPTH_COMPONENT24: number;
  154454. readonly TEXTURE_3D: number;
  154455. readonly TEXTURE_2D_ARRAY: number;
  154456. readonly TEXTURE_COMPARE_FUNC: number;
  154457. readonly TEXTURE_COMPARE_MODE: number;
  154458. readonly COMPARE_REF_TO_TEXTURE: number;
  154459. readonly TEXTURE_WRAP_R: number;
  154460. readonly HALF_FLOAT: number;
  154461. readonly RGB8: number;
  154462. readonly RED_INTEGER: number;
  154463. readonly RG_INTEGER: number;
  154464. readonly RGB_INTEGER: number;
  154465. readonly RGBA_INTEGER: number;
  154466. readonly R8_SNORM: number;
  154467. readonly RG8_SNORM: number;
  154468. readonly RGB8_SNORM: number;
  154469. readonly RGBA8_SNORM: number;
  154470. readonly R8I: number;
  154471. readonly RG8I: number;
  154472. readonly RGB8I: number;
  154473. readonly RGBA8I: number;
  154474. readonly R8UI: number;
  154475. readonly RG8UI: number;
  154476. readonly RGB8UI: number;
  154477. readonly RGBA8UI: number;
  154478. readonly R16I: number;
  154479. readonly RG16I: number;
  154480. readonly RGB16I: number;
  154481. readonly RGBA16I: number;
  154482. readonly R16UI: number;
  154483. readonly RG16UI: number;
  154484. readonly RGB16UI: number;
  154485. readonly RGBA16UI: number;
  154486. readonly R32I: number;
  154487. readonly RG32I: number;
  154488. readonly RGB32I: number;
  154489. readonly RGBA32I: number;
  154490. readonly R32UI: number;
  154491. readonly RG32UI: number;
  154492. readonly RGB32UI: number;
  154493. readonly RGBA32UI: number;
  154494. readonly RGB10_A2UI: number;
  154495. readonly R11F_G11F_B10F: number;
  154496. readonly RGB9_E5: number;
  154497. readonly RGB10_A2: number;
  154498. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  154499. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  154500. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  154501. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  154502. readonly DEPTH_COMPONENT32F: number;
  154503. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  154504. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  154505. 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;
  154506. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  154507. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  154508. readonly TRANSFORM_FEEDBACK: number;
  154509. readonly INTERLEAVED_ATTRIBS: number;
  154510. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  154511. createTransformFeedback(): WebGLTransformFeedback;
  154512. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  154513. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  154514. beginTransformFeedback(primitiveMode: number): void;
  154515. endTransformFeedback(): void;
  154516. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  154517. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  154518. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  154519. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  154520. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  154521. }
  154522. interface ImageBitmap {
  154523. readonly width: number;
  154524. readonly height: number;
  154525. close(): void;
  154526. }
  154527. interface WebGLQuery extends WebGLObject {
  154528. }
  154529. declare var WebGLQuery: {
  154530. prototype: WebGLQuery;
  154531. new(): WebGLQuery;
  154532. };
  154533. interface WebGLSampler extends WebGLObject {
  154534. }
  154535. declare var WebGLSampler: {
  154536. prototype: WebGLSampler;
  154537. new(): WebGLSampler;
  154538. };
  154539. interface WebGLSync extends WebGLObject {
  154540. }
  154541. declare var WebGLSync: {
  154542. prototype: WebGLSync;
  154543. new(): WebGLSync;
  154544. };
  154545. interface WebGLTransformFeedback extends WebGLObject {
  154546. }
  154547. declare var WebGLTransformFeedback: {
  154548. prototype: WebGLTransformFeedback;
  154549. new(): WebGLTransformFeedback;
  154550. };
  154551. interface WebGLVertexArrayObject extends WebGLObject {
  154552. }
  154553. declare var WebGLVertexArrayObject: {
  154554. prototype: WebGLVertexArrayObject;
  154555. new(): WebGLVertexArrayObject;
  154556. };
  154557. // Type definitions for WebVR API
  154558. // Project: https://w3c.github.io/webvr/
  154559. // Definitions by: six a <https://github.com/lostfictions>
  154560. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  154561. interface VRDisplay extends EventTarget {
  154562. /**
  154563. * Dictionary of capabilities describing the VRDisplay.
  154564. */
  154565. readonly capabilities: VRDisplayCapabilities;
  154566. /**
  154567. * z-depth defining the far plane of the eye view frustum
  154568. * enables mapping of values in the render target depth
  154569. * attachment to scene coordinates. Initially set to 10000.0.
  154570. */
  154571. depthFar: number;
  154572. /**
  154573. * z-depth defining the near plane of the eye view frustum
  154574. * enables mapping of values in the render target depth
  154575. * attachment to scene coordinates. Initially set to 0.01.
  154576. */
  154577. depthNear: number;
  154578. /**
  154579. * An identifier for this distinct VRDisplay. Used as an
  154580. * association point in the Gamepad API.
  154581. */
  154582. readonly displayId: number;
  154583. /**
  154584. * A display name, a user-readable name identifying it.
  154585. */
  154586. readonly displayName: string;
  154587. readonly isConnected: boolean;
  154588. readonly isPresenting: boolean;
  154589. /**
  154590. * If this VRDisplay supports room-scale experiences, the optional
  154591. * stage attribute contains details on the room-scale parameters.
  154592. */
  154593. readonly stageParameters: VRStageParameters | null;
  154594. /**
  154595. * Passing the value returned by `requestAnimationFrame` to
  154596. * `cancelAnimationFrame` will unregister the callback.
  154597. * @param handle Define the hanle of the request to cancel
  154598. */
  154599. cancelAnimationFrame(handle: number): void;
  154600. /**
  154601. * Stops presenting to the VRDisplay.
  154602. * @returns a promise to know when it stopped
  154603. */
  154604. exitPresent(): Promise<void>;
  154605. /**
  154606. * Return the current VREyeParameters for the given eye.
  154607. * @param whichEye Define the eye we want the parameter for
  154608. * @returns the eye parameters
  154609. */
  154610. getEyeParameters(whichEye: string): VREyeParameters;
  154611. /**
  154612. * Populates the passed VRFrameData with the information required to render
  154613. * the current frame.
  154614. * @param frameData Define the data structure to populate
  154615. * @returns true if ok otherwise false
  154616. */
  154617. getFrameData(frameData: VRFrameData): boolean;
  154618. /**
  154619. * Get the layers currently being presented.
  154620. * @returns the list of VR layers
  154621. */
  154622. getLayers(): VRLayer[];
  154623. /**
  154624. * Return a VRPose containing the future predicted pose of the VRDisplay
  154625. * when the current frame will be presented. The value returned will not
  154626. * change until JavaScript has returned control to the browser.
  154627. *
  154628. * The VRPose will contain the position, orientation, velocity,
  154629. * and acceleration of each of these properties.
  154630. * @returns the pose object
  154631. */
  154632. getPose(): VRPose;
  154633. /**
  154634. * Return the current instantaneous pose of the VRDisplay, with no
  154635. * prediction applied.
  154636. * @returns the current instantaneous pose
  154637. */
  154638. getImmediatePose(): VRPose;
  154639. /**
  154640. * The callback passed to `requestAnimationFrame` will be called
  154641. * any time a new frame should be rendered. When the VRDisplay is
  154642. * presenting the callback will be called at the native refresh
  154643. * rate of the HMD. When not presenting this function acts
  154644. * identically to how window.requestAnimationFrame acts. Content should
  154645. * make no assumptions of frame rate or vsync behavior as the HMD runs
  154646. * asynchronously from other displays and at differing refresh rates.
  154647. * @param callback Define the eaction to run next frame
  154648. * @returns the request handle it
  154649. */
  154650. requestAnimationFrame(callback: FrameRequestCallback): number;
  154651. /**
  154652. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  154653. * Repeat calls while already presenting will update the VRLayers being displayed.
  154654. * @param layers Define the list of layer to present
  154655. * @returns a promise to know when the request has been fulfilled
  154656. */
  154657. requestPresent(layers: VRLayer[]): Promise<void>;
  154658. /**
  154659. * Reset the pose for this display, treating its current position and
  154660. * orientation as the "origin/zero" values. VRPose.position,
  154661. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  154662. * updated when calling resetPose(). This should be called in only
  154663. * sitting-space experiences.
  154664. */
  154665. resetPose(): void;
  154666. /**
  154667. * The VRLayer provided to the VRDisplay will be captured and presented
  154668. * in the HMD. Calling this function has the same effect on the source
  154669. * canvas as any other operation that uses its source image, and canvases
  154670. * created without preserveDrawingBuffer set to true will be cleared.
  154671. * @param pose Define the pose to submit
  154672. */
  154673. submitFrame(pose?: VRPose): void;
  154674. }
  154675. declare var VRDisplay: {
  154676. prototype: VRDisplay;
  154677. new(): VRDisplay;
  154678. };
  154679. interface VRLayer {
  154680. leftBounds?: number[] | Float32Array | null;
  154681. rightBounds?: number[] | Float32Array | null;
  154682. source?: HTMLCanvasElement | null;
  154683. }
  154684. interface VRDisplayCapabilities {
  154685. readonly canPresent: boolean;
  154686. readonly hasExternalDisplay: boolean;
  154687. readonly hasOrientation: boolean;
  154688. readonly hasPosition: boolean;
  154689. readonly maxLayers: number;
  154690. }
  154691. interface VREyeParameters {
  154692. /** @deprecated */
  154693. readonly fieldOfView: VRFieldOfView;
  154694. readonly offset: Float32Array;
  154695. readonly renderHeight: number;
  154696. readonly renderWidth: number;
  154697. }
  154698. interface VRFieldOfView {
  154699. readonly downDegrees: number;
  154700. readonly leftDegrees: number;
  154701. readonly rightDegrees: number;
  154702. readonly upDegrees: number;
  154703. }
  154704. interface VRFrameData {
  154705. readonly leftProjectionMatrix: Float32Array;
  154706. readonly leftViewMatrix: Float32Array;
  154707. readonly pose: VRPose;
  154708. readonly rightProjectionMatrix: Float32Array;
  154709. readonly rightViewMatrix: Float32Array;
  154710. readonly timestamp: number;
  154711. }
  154712. interface VRPose {
  154713. readonly angularAcceleration: Float32Array | null;
  154714. readonly angularVelocity: Float32Array | null;
  154715. readonly linearAcceleration: Float32Array | null;
  154716. readonly linearVelocity: Float32Array | null;
  154717. readonly orientation: Float32Array | null;
  154718. readonly position: Float32Array | null;
  154719. readonly timestamp: number;
  154720. }
  154721. interface VRStageParameters {
  154722. sittingToStandingTransform?: Float32Array;
  154723. sizeX?: number;
  154724. sizeY?: number;
  154725. }
  154726. interface Navigator {
  154727. getVRDisplays(): Promise<VRDisplay[]>;
  154728. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  154729. }
  154730. interface Window {
  154731. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  154732. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  154733. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  154734. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  154735. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  154736. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  154737. }
  154738. interface Gamepad {
  154739. readonly displayId: number;
  154740. }
  154741. type XRSessionMode =
  154742. | "inline"
  154743. | "immersive-vr"
  154744. | "immersive-ar";
  154745. type XRReferenceSpaceType =
  154746. | "viewer"
  154747. | "local"
  154748. | "local-floor"
  154749. | "bounded-floor"
  154750. | "unbounded";
  154751. type XREnvironmentBlendMode =
  154752. | "opaque"
  154753. | "additive"
  154754. | "alpha-blend";
  154755. type XRVisibilityState =
  154756. | "visible"
  154757. | "visible-blurred"
  154758. | "hidden";
  154759. type XRHandedness =
  154760. | "none"
  154761. | "left"
  154762. | "right";
  154763. type XRTargetRayMode =
  154764. | "gaze"
  154765. | "tracked-pointer"
  154766. | "screen";
  154767. type XREye =
  154768. | "none"
  154769. | "left"
  154770. | "right";
  154771. type XREventType =
  154772. | "devicechange"
  154773. | "visibilitychange"
  154774. | "end"
  154775. | "inputsourceschange"
  154776. | "select"
  154777. | "selectstart"
  154778. | "selectend"
  154779. | "squeeze"
  154780. | "squeezestart"
  154781. | "squeezeend"
  154782. | "reset";
  154783. interface XRSpace extends EventTarget {
  154784. }
  154785. interface XRRenderState {
  154786. depthNear?: number;
  154787. depthFar?: number;
  154788. inlineVerticalFieldOfView?: number;
  154789. baseLayer?: XRWebGLLayer;
  154790. }
  154791. interface XRInputSource {
  154792. handedness: XRHandedness;
  154793. targetRayMode: XRTargetRayMode;
  154794. targetRaySpace: XRSpace;
  154795. gripSpace: XRSpace | undefined;
  154796. gamepad: Gamepad | undefined;
  154797. profiles: Array<string>;
  154798. }
  154799. interface XRSessionInit {
  154800. optionalFeatures?: string[];
  154801. requiredFeatures?: string[];
  154802. }
  154803. interface XRSession {
  154804. addEventListener: Function;
  154805. removeEventListener: Function;
  154806. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  154807. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  154808. requestAnimationFrame: Function;
  154809. end(): Promise<void>;
  154810. renderState: XRRenderState;
  154811. inputSources: Array<XRInputSource>;
  154812. // hit test
  154813. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  154814. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  154815. // legacy AR hit test
  154816. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  154817. // legacy plane detection
  154818. updateWorldTrackingState(options: {
  154819. planeDetectionState?: { enabled: boolean; }
  154820. }): void;
  154821. }
  154822. interface XRReferenceSpace extends XRSpace {
  154823. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  154824. onreset: any;
  154825. }
  154826. type XRPlaneSet = Set<XRPlane>;
  154827. type XRAnchorSet = Set<XRAnchor>;
  154828. interface XRFrame {
  154829. session: XRSession;
  154830. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  154831. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  154832. // AR
  154833. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult> ;
  154834. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  154835. // Anchors
  154836. trackedAnchors?: XRAnchorSet;
  154837. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  154838. // Planes
  154839. worldInformation: {
  154840. detectedPlanes?: XRPlaneSet;
  154841. };
  154842. }
  154843. interface XRViewerPose extends XRPose {
  154844. views: Array<XRView>;
  154845. }
  154846. interface XRPose {
  154847. transform: XRRigidTransform;
  154848. emulatedPosition: boolean;
  154849. }
  154850. interface XRWebGLLayerOptions {
  154851. antialias?: boolean;
  154852. depth?: boolean;
  154853. stencil?: boolean;
  154854. alpha?: boolean;
  154855. multiview?: boolean;
  154856. framebufferScaleFactor?: number;
  154857. }
  154858. declare var XRWebGLLayer: {
  154859. prototype: XRWebGLLayer;
  154860. new(session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  154861. };
  154862. interface XRWebGLLayer {
  154863. framebuffer: WebGLFramebuffer;
  154864. framebufferWidth: number;
  154865. framebufferHeight: number;
  154866. getViewport: Function;
  154867. }
  154868. declare class XRRigidTransform {
  154869. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  154870. position: DOMPointReadOnly;
  154871. orientation: DOMPointReadOnly;
  154872. matrix: Float32Array;
  154873. inverse: XRRigidTransform;
  154874. }
  154875. interface XRView {
  154876. eye: XREye;
  154877. projectionMatrix: Float32Array;
  154878. transform: XRRigidTransform;
  154879. }
  154880. interface XRInputSourceChangeEvent {
  154881. session: XRSession;
  154882. removed: Array<XRInputSource>;
  154883. added: Array<XRInputSource>;
  154884. }
  154885. interface XRInputSourceEvent extends Event {
  154886. readonly frame: XRFrame;
  154887. readonly inputSource: XRInputSource;
  154888. }
  154889. // Experimental(er) features
  154890. declare class XRRay {
  154891. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  154892. origin: DOMPointReadOnly;
  154893. direction: DOMPointReadOnly;
  154894. matrix: Float32Array;
  154895. }
  154896. declare enum XRHitTestTrackableType {
  154897. "point",
  154898. "plane",
  154899. "mesh"
  154900. }
  154901. interface XRHitResult {
  154902. hitMatrix: Float32Array;
  154903. }
  154904. interface XRTransientInputHitTestResult {
  154905. readonly inputSource: XRInputSource;
  154906. readonly results: Array<XRHitTestResult>;
  154907. }
  154908. interface XRHitTestResult {
  154909. getPose(baseSpace: XRSpace): XRPose | undefined;
  154910. // When anchor system is enabled
  154911. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  154912. }
  154913. interface XRHitTestSource {
  154914. cancel(): void;
  154915. }
  154916. interface XRTransientInputHitTestSource {
  154917. cancel(): void;
  154918. }
  154919. interface XRHitTestOptionsInit {
  154920. space: XRSpace;
  154921. entityTypes?: Array<XRHitTestTrackableType>;
  154922. offsetRay?: XRRay;
  154923. }
  154924. interface XRTransientInputHitTestOptionsInit {
  154925. profile: string;
  154926. entityTypes?: Array<XRHitTestTrackableType>;
  154927. offsetRay?: XRRay;
  154928. }
  154929. interface XRAnchor {
  154930. anchorSpace: XRSpace;
  154931. delete(): void;
  154932. }
  154933. interface XRPlane {
  154934. orientation: "Horizontal" | "Vertical";
  154935. planeSpace: XRSpace;
  154936. polygon: Array<DOMPointReadOnly>;
  154937. lastChangedTime: number;
  154938. }